Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #65: terraform-docs should not fail if complex types contain 'description' keyword #73

Merged
merged 1 commit into from
Nov 2, 2019

Conversation

cytopia
Copy link
Contributor

@cytopia cytopia commented Oct 26, 2019

Fix description key inside type

This PR fixes a when a key named description is inside the type block of a variable section:

variable "ingress_cidr_blocks" {
  description = "Bzzzzz"
  type = list(
    object({
      description = string
      cidr_blocks = string
      from_port   = number
      to_port     = number
      protocol    = string
    })
  )

  default = [
    {
      description = "SG"
      cidr_blocks = "10.0.0.0/32"
      from_port   = 22
      to_port     = 22
      protocol    = "tcp"
    },
  ]
}

Integration tests

Test for this can be found here: https://github.com/cytopia/docker-terraform-docs/blob/master/tests/0.12/main.tf#L60

Reliability

I tried to fix this to the best of my knowledge and currently available test cases. Please do test this before merging on existing files.

@antonbabenko
Copy link
Owner

Thanks, Patrick!

v1.20.0 has been released.

mrwacky42 added a commit to HeadspaceMeditation/pre-commit-terraform that referenced this pull request Feb 15, 2022
* Added terraform-docs integration (#13)

* Add hook to create readme

* Updated README

* Run terraform_docs only if README.md is present

* Run terraform_docs only if README.md is present

* Fixes use of md5 for tempfile name (#16)

* Replace terraform_docs use of GNU sed with perl (#15)

* Fix ShellCheck warning 2219

https://github.com/koalaman/shellcheck/wiki/SC2219

* Replace GNU sed commands with perl

This replaces the sed commands which required GNU sed be installed with
perl versions. This should make this script more universally usable
(e.g., on macOS) without installing additional tools.

* Only run validate if .tf files exist in the directory. (antonbabenko#20)

* Only run validate if .tf files exist in the directory.

* Same fix, different script :)

* Updated README

* Added license file (fixed antonbabenko#21)

* Add feature to pass options to terraform-docs.

* Added followup after antonbabenko#25

* Add new hook for running terraform-docs with replacing README.md from doc in main.tf

* Address requested changes

* Add `--dest` argument

* Address requested changes

* fix typo

* Fix bug not letting terraform_docs_replace work in the root directory of a repo

* Require terraform-docs runs in serial to avoid pre-commit doing parallel operations on similar file paths

* Added chglog (hi @robinbowes :))

* Added CHANGELOG.md

* Add exit code for 'terraform validate' so pre-commit check fails (antonbabenko#34)

* Bump new version

* fix check for errors at the end (antonbabenko#35)

* Updated changelog

* Update README.md (antonbabenko#36)

* Fixed broken "maintained badge"

* Added note about incompatibility of terraform-docs with Terraform 0.12 (antonbabenko#41)

* Updated CHANGELOG

* Added support for terraform_docs for Terraform 0.12 (antonbabenko#45)

* Updated CHANGELOG

* Upgraded to work with Terraform >= 0.12 (antonbabenko#44)

* Updated CHANGELOG

* Fix version in README.md (antonbabenko#46)

* Fixed awk script for terraform-docs (kudos @cytopia) and mktemp on Mac (closes antonbabenko#47, antonbabenko#48, antonbabenko#49)

* Updated CHANGELOG

* Add slash to mktemp dir (fixed antonbabenko#50)

* Updated CHANGELOG

* Fix typo in README (antonbabenko#51)

* Fixed enquoted types in terraform_docs (fixed antonbabenko#52)

* Updated CHANGELOG

* Formatter for Terragrunt HCL files (antonbabenko#60)

* Formatter for Terragrunt HCL files

* Adding Terragrunt documentation

* Updated README with terragrunt_fmt hook

* Updated CHANGELOG

* Added support for TFLint with --deep parameter (antonbabenko#53)

Added support for TFLint (https://github.com/wata727/tflint).

Signed-off-by: Costin Galan <[email protected]>

* Updated README with terraform_tflint hook

* Updated CHANGELOG

* Update rev in README.md (antonbabenko#70)

Updating the version in the README.

In order for `terraform_tflint`, the rev must be at least `v1.19.0`.

* Improve installation instructions and make README more readable (antonbabenko#72)

* Added FUNDING.yml

* Fixes antonbabenko#65: terraform-docs should not fail if complex types contain 'description' keyword (antonbabenko#73)

* Updated CHANGELOG

* use getopt for args in the tflint hook, following the approach in terraform-docs (antonbabenko#75)

* Updated CHANGELOG

* move terraform-docs args after markdown command (antonbabenko#83)

* Updated CHANGELOG

* Added support for terraform-docs 0.8.0 with proper support for Terraform 0.12 syntax (bye-bye awk) (antonbabenko#85)

* Updated CHANGELOG

* Added shfmt to autoformat shell scripts (antonbabenko#86)

* Updated CHANGELOG

* Fixed tflint hook to iterate over files (antonbabenko#77)

* Updated CHANGELOG

* Fixed exit code for terraform 0.11 branch in terraform_docs (antonbabenko#94)

* Updated pre-commit-hooks

* Updated CHANGELOG

* corrected tflint documentation (antonbabenko#95)

* Updated CHANGELOG

* Update installation instructions (antonbabenko#79)

- Fix package name misspell
- TFlint migrate to another organization

* Allow passing multiple args to terraform-docs (antonbabenko#98)

* Updated CHANGELOG

* fix: Change terraform_validate hook functionality for subdirectories with terraform files (antonbabenko#100)

* Update terraform_validate.sh:
-Change to the directory before running terraform validate to use the Terraform
 configuration for the appropriate working directory.

* Neglected to change the terraform validate call to use the default of the
current directory.

* Several changes to improve functionality:
- Switch to checking the path for '*.tf' instead of always checking the current
  directory.
- Try to find a '.terraform' directory (which indicates a `terraform init`) and
  change to that directory before running `terraform validate`.

* Fix the description for the terraform_validate hook to reflect changes that were
made in:
antonbabenko@35e0356

* - Clean up comments.
- Adjust variable names to better reflect what they are holding.

* Updated CHANGELOG

* feat: Support for TFSec (antonbabenko#103)

* Updated pre-commit deps

* Updated CHANGELOG

* docs: Added coreutils as requirements in README.md (antonbabenko#105)

* docs: Fixed the docs to use the latest config syntax(antonbabenko#106)

* fix: Updated formatting in README (closes antonbabenko#113)

* Updated CHANGELOG

* feat: add terragrunt validate hook (antonbabenko#134)

* Updated CHANGELOG

* docs: Update terraform-docs link pointing to new organization (antonbabenko#130)

* fix: Pass args and env vars to terraform validate (antonbabenko#125)

* Updated CHANGELOG

* chore: Use lib_getopt for all hooks and some style tweaks (antonbabenko#137)

* Updated CHANGELOG

* fix: Squash terraform_docs bug (antonbabenko#138)

* Updated CHANGELOG

* feat: have option for terraform_tfsec hook to only run in relevant modified directories (antonbabenko#135)

* Updated CHANGELOG

* fix: make terraform_tfsec.sh executable (antonbabenko#140)

* Updated CHANGELOG

* fix: Correctly handle arrays in terraform_docs.sh (antonbabenko#141)

* Updated CHANGELOG

* feat: Add checkov support (antonbabenko#143)

* Updated CHANGELOG

* feat: Add possibility to share tflint config file for subdirs (antonbabenko#149)

* Updated CHANGELOG

* fix: terraform-docs version 0.10 removed with-aggregate-type-defaults (antonbabenko#150)

* Updated CHANGELOG

* fix: make terraform_docs Windows compatible (antonbabenko#129)

* Updated CHANGELOG

* fix: Fix regex considering terraform-docs v0.10.0 old (antonbabenko#151)

* Updated CHANGELOG

* feat: Make terraform_validate to run init if necessary (antonbabenko#158)

* Updated CHANGELOG

* fix: Correct deprecated parameter to terraform-docs (antonbabenko#156)

* Updated CHANGELOG

* update to upstream hooks

* just report, do not error

* fix: Terraform validate for submodules (antonbabenko#172)

* Updated CHANGELOG

* docs: updates installs for macOS and ubuntu (antonbabenko#175)

* fix: remove sed postprocessing from the terraform_docs_replace hook to fix compatibility with terraform-docs 0.11.0+ (antonbabenko#176)

* Updated CHANGELOG

* docs: Added checkov install (antonbabenko#182)

* chore: add dockerfile (antonbabenko#183)

* Updated CHANGELOG

* Update README.md

* chore: Fix mistake on command (antonbabenko#185)

* fix: Fix and pin versions in Dockerfile (antonbabenko#193)

* Updated CHANGELOG

* feat: Adds support for Terrascan (antonbabenko#195)

* Updated CHANGELOG

* chore: Update Ubuntu install method (antonbabenko#198)

* docs: Initial docs improvement (antonbabenko#218)

* fix: Dockerized pre-commit-terraform (antonbabenko#219)

Co-authored-by: Anton Babenko <[email protected]>

* feat: Add mixed line ending check to prevent possible errors (antonbabenko#221)

* feat: Add GH checks and templates (antonbabenko#222)

* chore: Updated GH stale action config (antonbabenko#223)

* fix: label auto-adding after label rename (antonbabenko#226)

* fix: trigger terraform-docs on changes in lock files (antonbabenko#228)

* Updated CHANGELOG

* fix: remove dead code from terraform-docs script (antonbabenko#229)

* chore: Add shfmt to workflow (antonbabenko#231)

* docs: Describe hooks usage and improve examples (antonbabenko#232)

Co-authored-by: Anton Babenko <[email protected]>

* fix: Dockerfile if INSTALL_ALL is not defined (antonbabenko#233)

* feat: Add PATH outputs when TFLint found any problem (antonbabenko#234)

* fix: terraform_tflint hook executes in a serial way to run less often (antonbabenko#211)

* docs: Add contributing guide and docs about performance tests (antonbabenko#235)

* docs: Make contributors more visible (antonbabenko#236)

* docs: Document terraform_tfsec args usage (antonbabenko#238)

* feat: Add new hook for `terraform providers lock` operation (antonbabenko#173)

* Updated CHANGELOG

* chore: Do not mark issues and PR's in milestone as stale (antonbabenko#241)

* fix: TFSec outputs the same results multiple times (antonbabenko#237)

* docs: Add terraform_fmt usage instructions and how-to debug script with args (antonbabenko#242)

* feat: Allow passing of args to terraform_fmt (antonbabenko#147)

* docs: Document hooks dependencies (antonbabenko#247)

* feat: Add support for specify terraform-docs config file (antonbabenko#244)

* fix: terrafrom_tflint ERROR output for files located in repo root (antonbabenko#243)

* feat: Add `terraform_docs` hook settings (antonbabenko#245)

* docs: fix deps (antonbabenko#249)

* fix: execute tflint once in no errors (antonbabenko#250)

* fix: command not found (antonbabenko#251)

* docs: Add missing space in terrascan install cmd (antonbabenko#253)

* feat: add __GIT_WORKING_DIR__ to tfsec (antonbabenko#255)

* docs: fix protocol to prevent MITM (antonbabenko#257)

* feat: Set up PR reviewers automatically (antonbabenko#258)

* feat: Add infracost_breakdown hook (antonbabenko#252)

* docs: Clarify docs for terraform_tfsec hook (antonbabenko#266)

* docs: Pre-release 1.53 (antonbabenko#267)

* Updated CHANGELOG

* fix: Fixed args expand in terraform_docs (antonbabenko#260)

* docs: Added notes about sponsors (antonbabenko#268)

* feat: Add support for quoted values in `infracost_breakdown` `--hook-config` (antonbabenko#269)

* Updated CHANGELOG

* fix: Fixed 1.54.0 where `terraform_docs` was broken (antonbabenko#272)

* Updated CHANGELOG

* chore: Updated messages shown in terraform_tflint hook (antonbabenko#274)

* feat: Updated Docker image from Ubuntu to Alpine (antonbabenko#278)

* Updated CHANGELOG

* chore: Add deprecation notice to `terraform_docs_replace` (antonbabenko#280)

* fix: typo in arg name for terraform-docs (antonbabenko#283)

* Updated CHANGELOG

* chore: Fix master merge to working branch on pre-commit autofixes (antonbabenko#286)

* chore: Publish container image on release (antonbabenko#285)

* Updated CHANGELOG

* fix: Fixed docker build (antonbabenko#288)

* Updated CHANGELOG

* fix: pre-build docker image (antonbabenko#292)

* Updated CHANGELOG

* fix: analyse all folders with tflint and don't stop on first execution (antonbabenko#289)

* feat: Pass custom arguments to terraform init in `terraform_validate` hook (antonbabenko#293)

* Updated CHANGELOG

* feat: Added semantic release (antonbabenko#296)

* chore(release): version 1.62.0 [skip ci]

# [1.62.0](antonbabenko/pre-commit-terraform@v1.61.0...v1.62.0) (2021-12-12)

### Features

* Added semantic release ([antonbabenko#296](antonbabenko#296)) ([1bcca44](antonbabenko@1bcca44))

* chore: Validate PR title (antonbabenko#297)

* chore: Updated validation PR title types (antonbabenko#298)

* chore: Fixed allowed types for PR titles

* chore: Publish container image only after the release

* fix(terraform_tflint): Restore current working directory behavior (antonbabenko#302)

* chore: Use valid token for the Release GHA

* chore(release): version 1.62.1 [skip ci]

## [1.62.1](antonbabenko/pre-commit-terraform@v1.62.0...v1.62.1) (2021-12-18)

### Bug Fixes

* **terraform_tflint:** Restore current working directory behavior ([antonbabenko#302](antonbabenko#302)) ([93029dc](antonbabenko@93029dc))

* fix: Properly exclude .terraform directory with checkov hook (antonbabenko#306)

* fix: Speedup `terrascan` hook up to x3 times in big repos (antonbabenko#307)

* chore: Release action should track hooks configuration changes (antonbabenko#308)

* chore(release): version 1.62.2 [skip ci]

## [1.62.2](antonbabenko/pre-commit-terraform@v1.62.1...v1.62.2) (2021-12-21)

### Bug Fixes

* Properly exclude .terraform directory with checkov hook ([antonbabenko#306](antonbabenko#306)) ([b431a43](antonbabenko@b431a43))
* Speedup `terrascan` hook up to x3 times in big repos ([antonbabenko#307](antonbabenko#307)) ([2e8dcf9](antonbabenko@2e8dcf9))

* fix: Check all directories with changes and pass all args in terrascan hook (antonbabenko#305)

* chore(release): version 1.62.3 [skip ci]

## [1.62.3](antonbabenko/pre-commit-terraform@v1.62.2...v1.62.3) (2021-12-22)

### Bug Fixes

* Check all directories with changes and pass all args in terrascan hook ([antonbabenko#305](antonbabenko#305)) ([66401d9](antonbabenko@66401d9))

* chore: Refactor all hooks (antonbabenko#310)

* chore: Cleanup file with test data (antonbabenko#311)

* chore: Add shellcheck and make checks passing (antonbabenko#315)

Co-authored-by: Anton Babenko <[email protected]>

* chore: Improved code structure (moved hooks into a separate dir) (antonbabenko#316)

* chore: Specify what we exactly mean (antonbabenko#320)

* chore: Document functions (based on google style guide) (antonbabenko#317)

* chore: Add hadolint check for Dockerfiles (antonbabenko#322)

Co-authored-by: Balazs Hamorszky <[email protected]>

* chore: Add Github Actions Workflow to build if Dockerfile updated (antonbabenko#318)

Co-authored-by: Maksym Vlasov <[email protected]>

* docs: Add workaround for configuration_aliases tf bug (antonbabenko#332)

* chore: fix bug intoduced in antonbabenko#316 (antonbabenko#335)

* feat: Improve performance during `pre-commit --all (-a)` run (antonbabenko#327)

* chore(release): version 1.63.0 [skip ci]

# [1.63.0](antonbabenko/pre-commit-terraform@v1.62.3...v1.63.0) (2022-02-10)

### Features

* Improve performance during `pre-commit --all (-a)` run ([antonbabenko#327](antonbabenko#327)) ([7e7c916](antonbabenko@7e7c916))

* feat: Improved speed of `pre-commit run -a` for multiple hooks (antonbabenko#338)

* chore(release): version 1.64.0 [skip ci]

# [1.64.0](antonbabenko/pre-commit-terraform@v1.63.0...v1.64.0) (2022-02-10)

### Features

* Improved speed of `pre-commit run -a` for multiple hooks ([antonbabenko#338](antonbabenko#338)) ([579dc45](antonbabenko@579dc45))

* chore: Fix docker test workflow (antonbabenko#340)

* chore: Add Docker latest and nightly tag (antonbabenko#343)

Co-authored-by: Anton Babenko <[email protected]>
Co-authored-by: jeremy avnet <[email protected]>
Co-authored-by: Robin Bowes <[email protected]>
Co-authored-by: Martin Etmajer <[email protected]>
Co-authored-by: rothandrew <[email protected]>
Co-authored-by: Chris Gilmer <[email protected]>
Co-authored-by: Josiah Halme <[email protected]>
Co-authored-by: Tyler Christiansen <[email protected]>
Co-authored-by: Guido Dobboletta <[email protected]>
Co-authored-by: Paweł Szczepaniak <[email protected]>
Co-authored-by: Leonhardt Wille <[email protected]>
Co-authored-by: Eric Gonzales <[email protected]>
Co-authored-by: Scott Crooks <[email protected]>
Co-authored-by: Costin GALAN <[email protected]>
Co-authored-by: Dave Gallant <[email protected]>
Co-authored-by: Maksym Vlasov <[email protected]>
Co-authored-by: cytopia <[email protected]>
Co-authored-by: chopped pork <[email protected]>
Co-authored-by: Thierno IB. BARRY <[email protected]>
Co-authored-by: Konstantin Kirpichnikov <[email protected]>
Co-authored-by: Robson Roberto Souza Peixoto <[email protected]>
Co-authored-by: Martin Coxall <[email protected]>
Co-authored-by: Sergei Ivanov <[email protected]>
Co-authored-by: Nick M <[email protected]>
Co-authored-by: Jon Proietti <[email protected]>
Co-authored-by: gchappell99 <[email protected]>
Co-authored-by: snolan-uturn <[email protected]>
Co-authored-by: Prahalad Ramji <[email protected]>
Co-authored-by: Khosrow Moossavi <[email protected]>
Co-authored-by: nkazarian-spokeo <[email protected]>
Co-authored-by: Matias Zilli <[email protected]>
Co-authored-by: Evan Stoddard <[email protected]>
Co-authored-by: Shawn <[email protected]>
Co-authored-by: Manuel Vogel <[email protected]>
Co-authored-by: Sergio Kef <[email protected]>
Co-authored-by: Cesar Rodriguez <[email protected]>
Co-authored-by: Lorenz Vanthillo <[email protected]>
Co-authored-by: balihb <[email protected]>
Co-authored-by: Javier Collado <[email protected]>
Co-authored-by: Dan Arnold <[email protected]>
Co-authored-by: gravitybacklight <[email protected]>
Co-authored-by: Milos Jajac <[email protected]>
Co-authored-by: Birger J. Nordølum <[email protected]>
Co-authored-by: sg70 <[email protected]>
Co-authored-by: Bruno Ferreira <[email protected]>
Co-authored-by: Maxime Brunet <[email protected]>
Co-authored-by: semantic-release-bot <[email protected]>
Co-authored-by: Maxime Brunet <[email protected]>
Co-authored-by: Carlos Miguel Bustillo Rodríguez <[email protected]>
Co-authored-by: Mohit Saxena <[email protected]>
Co-authored-by: Mark Bainter <[email protected]>
Co-authored-by: Pasquale De Vita <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants