From 03ebccc6bc9c93a8cfcc986c627a1ed4de49ba44 Mon Sep 17 00:00:00 2001 From: Eric L Frederich Date: Fri, 22 Mar 2024 12:24:03 -0400 Subject: [PATCH] feat: new terraform_fmt_v2 with better Windows support --- .gitignore | 2 ++ .pre-commit-hooks.yaml | 8 +++++ hooks/__init__.py | 4 --- hooks/common.py | 61 +++++++++++++++++++++++++++++++++ hooks/terraform_docs_replace.py | 5 +++ hooks/terraform_fmt.py | 32 +++++++++++++++++ setup.py | 1 + 7 files changed, 109 insertions(+), 4 deletions(-) create mode 100644 hooks/common.py create mode 100644 hooks/terraform_fmt.py diff --git a/.gitignore b/.gitignore index 0bbeada90..1de9c2b4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,3 @@ tests/results/* +__pycache__/ +*.py[cod] diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml index cbe506dd3..4f0ec0fa6 100644 --- a/.pre-commit-hooks.yaml +++ b/.pre-commit-hooks.yaml @@ -15,6 +15,14 @@ files: (\.tf|\.tfvars)$ exclude: \.terraform/.*$ +- id: terraform_fmt_py + name: Terraform fmt + description: Rewrites all Terraform configuration files to a canonical format. + entry: terraform_fmt + language: python + files: (\.tf|\.tfvars)$ + exclude: \.terraform/.*$ + - id: terraform_docs name: Terraform docs description: Inserts input and output documentation into README.md (using terraform-docs). diff --git a/hooks/__init__.py b/hooks/__init__.py index aeb6f9b27..e69de29bb 100644 --- a/hooks/__init__.py +++ b/hooks/__init__.py @@ -1,4 +0,0 @@ -print( - '`terraform_docs_replace` hook is DEPRECATED.' - 'For migration instructions see https://github.com/antonbabenko/pre-commit-terraform/issues/248#issuecomment-1290829226' -) diff --git a/hooks/common.py b/hooks/common.py new file mode 100644 index 000000000..28bef23ef --- /dev/null +++ b/hooks/common.py @@ -0,0 +1,61 @@ +from __future__ import annotations + +import argparse +import logging +import os +from collections.abc import Sequence + +logger = logging.getLogger(__name__) + + +def setup_logging(): + logging.basicConfig( + level={ + "error": logging.ERROR, + "warn": logging.WARNING, + "warning": logging.WARNING, + "info": logging.INFO, + "debug": logging.DEBUG, + }[os.environ.get("PRE_COMMIT_TERRAFORM_LOG_LEVEL", "warning").lower()] + ) + + +def parse_env_vars(env_var_strs: list[str]) -> dict[str, str]: + ret = {} + for env_var_str in env_var_strs: + name, val = env_var_str.split("=", 1) + if val.startswith('"') and val.endswith('"'): + val = val[1:-1] + ret[name] = val + return ret + + +def parse_cmdline( + argv: Sequence[str] | None = None, +) -> tuple[list[str], list[str], list[str], list[str], dict[str, str]]: + parser = argparse.ArgumentParser( + add_help=False, # Allow the use of `-h` for compatiblity with Bash version of the hook + ) + parser.add_argument("-a", "--args", action="append", help="Arguments") + parser.add_argument("-h", "--hook-config", action="append", help="Hook Config") + parser.add_argument("-i", "--init-args", "--tf-init-args", action="append", help="Init Args") + parser.add_argument("-e", "--envs", "--env-vars", action="append", help="Environment Variables") + parser.add_argument("FILES", nargs="*", help="Files") + + parsed_args = parser.parse_args(argv) + + args = parsed_args.args or [] + hook_config = parsed_args.hook_config or [] + files = parsed_args.FILES or [] + tf_init_args = parsed_args.init_args or [] + env_vars = parsed_args.envs or [] + + env_var_dict = parse_env_vars(env_vars) + + if hook_config: + raise NotImplementedError("TODO: implement: hook_config") + + if tf_init_args: + raise NotImplementedError("TODO: implement: tf_init_args") + + return args, hook_config, files, tf_init_args, env_var_dict diff --git a/hooks/terraform_docs_replace.py b/hooks/terraform_docs_replace.py index a9cf6c9bc..600cb08bf 100644 --- a/hooks/terraform_docs_replace.py +++ b/hooks/terraform_docs_replace.py @@ -3,6 +3,11 @@ import subprocess import sys +print( + '`terraform_docs_replace` hook is DEPRECATED.' + 'For migration instructions see https://github.com/antonbabenko/pre-commit-terraform/issues/248#issuecomment-1290829226' +) + def main(argv=None): parser = argparse.ArgumentParser( diff --git a/hooks/terraform_fmt.py b/hooks/terraform_fmt.py new file mode 100644 index 000000000..bd07aba41 --- /dev/null +++ b/hooks/terraform_fmt.py @@ -0,0 +1,32 @@ +from __future__ import annotations + +import logging +import os +import shlex +import sys +from subprocess import PIPE, run +from typing import Sequence + +from .common import parse_cmdline, setup_logging + +logger = logging.getLogger(__name__) + + +def main(argv: Sequence[str] | None = None) -> int: + setup_logging() + logger.debug(sys.version_info) + args, hook_config, files, tf_init_args, env_vars = parse_cmdline(argv) + if os.environ.get("PRE_COMMIT_COLOR") == "never": + args.append("-no-color") + cmd = ["terraform", "fmt", *args, *files] + logger.info("calling %s", shlex.join(cmd)) + logger.debug("env_vars: %r", env_vars) + logger.debug("args: %r", args) + completed_process = run(cmd, env={**os.environ, **env_vars}, text=True, stdout=PIPE) + if completed_process.stdout: + print(completed_process.stdout) + return completed_process.returncode + + +if __name__ == "__main__": + raise SystemExit(main()) diff --git a/setup.py b/setup.py index 2d88425b9..ce1ee2623 100644 --- a/setup.py +++ b/setup.py @@ -28,6 +28,7 @@ entry_points={ 'console_scripts': [ 'terraform_docs_replace = hooks.terraform_docs_replace:main', + 'terraform_fmt = hooks.terraform_fmt:main', ], }, )