Issue with pre-commit and this ruleset

[Cesarsk]

Hello,

I’m using the following pre-commit config file:

- repo: https://github.com/antonbabenko/pre-commit-terraform
    rev: v1.97.0
    hooks:
      - id: terraform_fmt
      - id: terraform_tflint
        args:
          - --args=--config=__GIT_WORKING_DIR__/.tflint.hcl

And the following .tflint.hcl file:

plugin "aws" {
  enabled = true
  version = "0.37.0"
  source  = "github.com/terraform-linters/tflint-ruleset-aws"
}

Every time I run pre-commit run, I encounter an error:

TFLint in terraform/:
Plugin “aws” SDK version (0.14.0) is incompatible. Compatible versions: >= 0.16.0

If I run tflint -v, I get the following output:

TFLint version 0.55.0
+ ruleset.aws (0.37.0)
+ ruleset.terraform (0.10.0-bundled)

For some reason, the SDK is pointing to the wrong file. If I replace the __GIT_WORKING_DIR__ variable with the absolute file path, I still get the same error. Strangely enough, if I remove the --args= option, it works.

Could you please help me understand what’s causing this issue? I’m running on a Mac and using pre-commit version 4.1.0. The packages are installed using Brew.

[rohan-sanghvi-tr]

I am facing the same issue. I am using pre-commit version 4.0.1 (also installed via homebrew)

[Cesarsk]

Good to know I am not alone in this.

[Cesarsk]

Try my suggested answer @rohan-sanghvi-tr

[bendrucker]

If you can isolate this from pre-commit I can open an issue. Otherwise this is more likely to be a configuration issue between pre-commit and TFLint.

Your provided config has curly quotes which breaks the parser. I used this fixed config with straight quotes:

plugin "aws" {
  enabled = true
  version = "0.37.0"
  source  = "github.com/terraform-linters/tflint-ruleset-aws"
}

tflint -v
TFLint version 0.55.0
+ ruleset.aws (0.37.0)
+ ruleset.terraform (0.10.0-bundled)

And then running tflint works normally.

An error about an out of date plugin version would suggest your config isn't loaded. Is it actually in the repo root and not terraform/?

A public repo reproducing your setup would be helpful.

[Cesarsk]

ps. git version 2.39.5 (Apple Git-154)

[bendrucker]

noticed that the folder containing the root-cause is the .git folder

What do you mean by this?

[Cesarsk]

Basically, the .git folder causes the issue, for reasons unknown to me. Given that two projects are identical in files, with a clean .git folder (by clean I mean right after you type git init), everything runs without issues. With the .git of my original repo, I get the error I mentioned in the post.

Project A (not working)

.git (original)
terraform/foo/main.tf
.tflint.hcl
.pre-commit-config.yaml

Project B (working okay)

.git (just initialized with git init)
terraform/foo/main.tf
.tflint.hcl
.pre-commit-config.yaml

[bendrucker]

Very strange. TFLint has no interaction with Git. Even less than Terraform, which can pull modules via git, but has no interest in whether the root module/working directory is a repository. So I have to assume pre-commit runs differently.

FWIW, the plugin doesn't interact with git either. git rev-parse --show-toplevel is how you ask git what it thinks the top level directory of the working tree is.

https://github.com/antonbabenko/pre-commit-terraform/blob/0ce9d4a3d9b0d02242d056afe199175b64f3b691/hooks/terraform_tflint.sh#L18

No cause comes to mind here.

[Cesarsk]

I will investigate a bit more and let you know. In the meantime, thanks

[Cesarsk]

I was able to find the solution (thanks to a colleague who helped out), and it appeared to be the bash version. Mac OS has bash 3.2 which for some reasons conflicts with some behaviors (most likely some BASHOPT are not supported).

Update your bash version with brew install bash, give it a reboot (or exit, enter a new terminal session) and see if it works. For now I mark it as closed.

Thanks