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

New error coming from terraform_docs #64

Closed
james-gonzalez opened this issue Sep 6, 2019 · 11 comments
Closed

New error coming from terraform_docs #64

james-gonzalez opened this issue Sep 6, 2019 · 11 comments

Comments

@james-gonzalez
Copy link

james-gonzalez commented Sep 6, 2019

You can see below.

pre-commit run -a
Check for merge conflicts................................................Passed
Trim Trailing Whitespace.................................................Passed
Check JSON...............................................................Passed
Check Yaml...............................................................Passed
Detect Private Key.......................................................Passed
Detect AWS Credentials...................................................Passed
Don't commit to branch...................................................Passed
Pretty format JSON.......................................................Passed
Terraform fmt............................................................Passed
Terraform docs...........................................................Failed
hookid: terraform_docs

2019/09/06 10:53:17 At 60:1: expected: IDENT | STRING | ASSIGN | LBRACE got: RBRACE

Non-executable shell script filename ends in .sh.........................Passed
Check shell style with shfmt.............................................Passed

Maybe being a bit more verbose? Though that looks like Terraform to me? HCL2 syntax?

@antonbabenko
Copy link
Owner

Hi James!

Make sure that you are using Terraform version 0.12. The error you get is because code can't be processed by the hook. Unfortunately, it is pretty hard to make the output more verbose (and useful) because of the way the terraform-docs hack (see awk script) is working.

@james-gonzalez
Copy link
Author

james-gonzalez commented Sep 6, 2019

Hey Anton! Morning :) Hope you and your family are well.

Terraform v0.12.7

@antonbabenko
Copy link
Owner

Ok, then verify that the terraform configs are valid.

Also, if you combine them in one file you will see the problem on line 60. It is likely a bug in awk script because of the way how you define variable block. If you can provide a problem piece of configuration somebody may take a look at awk and improve it.

@james-gonzalez
Copy link
Author

I thought it might be related to the way I've mix/matched the variables syntax :P Let me refactor them.

@james-gonzalez
Copy link
Author

- repo: https://github.com/antonbabenko/pre-commit-terraform
  rev: v1.19.0
  hooks:
    - id: terraform_fmt
    - id: terraform_docs
variable "ecs_name" {
  type        = "string"
  description = "Default name of the ECS cluster"
  default     = "default-cluster"
}

variable "region" {
  description = "region"
  type        = string
  default     = "us-east-2"
}

variable "s3_bucket_name" {
  default = "jamesg-data-test-bucket"
}

variable "bucket_access" {
}

variable "additional_user_data_script" {
  type        = "string"
  description = "extra stuff you want to put into your user-data.sh scripts"
  default     = "echo example ecs cluster being provisioned"
}

variable "ecs_env" {
  default = "development"
}

variable "ecr_repo_name" {
  description = "name of the ECR repo to create for the ECS setup"
  default     = "example-repo"
}

variable "task_definition_name" {
  description = "This must be a prefix to a file in templates/ matching the file name for your service cluster. i.e. slaf "
  default     = "default"
}

variable "container_name_lb" {
  description = "Name of the container which needs to be exposed via the ALB"
  default     = "default"
}

variable "vpc_id" {variable "ecs_name" {
  type        = "string"
  description = "Default name of the ECS cluster"
  default     = "default-cluster"
}

variable "region" {
  description = "region"
  type        = string
  default     = "us-east-2"
}

variable "s3_bucket_name" {
  default = "jamesg-data-test-bucket"
}

variable "bucket_access" {
}

variable "additional_user_data_script" {
  type        = "string"
  description = "extra stuff you want to put into your user-data.sh scripts"
  default     = "echo example ecs cluster being provisioned"
}

variable "ecs_env" {
  default = "development"
}

variable "ecr_repo_name" {
  description = "name of the ECR repo to create for the ECS setup"
  default     = "example-repo"
}

variable "task_definition_name" {
  description = "This must be a prefix to a file in templates/ matching the file name for your service cluster. i.e. slaf "
  default     = "default"
}

variable "container_name_lb" {
  description = "Name of the container which needs to be exposed via the ALB"
  default     = "default"
}

variable "vpc_id" {
  default = ""
}

variable "docdb_cluster_master_password" {
  default = ""
}

variable "azure_credentials_arn" {
  default = ""
}

variable "docdb_endpoint" {
  default = ""
}

variable "account" {}

variable "template_folder" {
  default = "task-definitions"
}

variable "docdb_password" {
  default = ""
}

variable "task_definition_file" {
  default = ""
}

  default = ""
}

variable "docdb_cluster_master_password" {
  default = ""
}

variable "azure_credentials_arn" {
  default = ""
}

variable "docdb_endpoint" {
  default = ""
}

variable "account" {}

variable "template_folder" {
  default = "task-definitions"
}

variable "docdb_password" {
  default = ""
}

variable "task_definition_file" {
  default = ""
}

@james-gonzalez
Copy link
Author

james-gonzalez commented Sep 6, 2019

This was the fix, I think this should be classed as a bug.

variable "account" {}

to

variable "account" {
}

@antonbabenko
Copy link
Owner

Yes, this is definitely a bug which @cytopia may know about.

Btw big kudos to @cytopia for making an awk script we are using in this repo!

@cytopia
Copy link
Contributor

cytopia commented Sep 26, 2019

Yes, this is definitely a bug which @cytopia may know about.

I'll have a look into this

Btw big kudos to @cytopia for making an awk script we are using in this repo!

For credits: The script was originally created by @osterman here

@cytopia
Copy link
Contributor

cytopia commented Sep 27, 2019

@james-gonzalez if this is about:

variable "account" {}

then it should get fixed here: #65

@konstantin-recurly
Copy link
Contributor

Is this one still relevant?
It seems that this one could be resolved as well.
@james-gonzalez Would you, please, check if this still fails for you with the latest release and the latest terraform-docs.

@antonbabenko
Copy link
Owner

It is safe to close a long time ago.

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

No branches or pull requests

4 participants