fix: Add --env-vars, deprecate --envs (antonbabenko#410)

Author: MaxymVlasov

README.md

@@ -296,9 +296,9 @@ Config example:
 ```yaml
 - id: terraform_validate
   args:
-    - --envs=AWS_DEFAULT_REGION="us-west-2"
-    - --envs=AWS_ACCESS_KEY_ID="anaccesskey"
-    - --envs=AWS_SECRET_ACCESS_KEY="asecretkey"
+    - --env-vars=AWS_DEFAULT_REGION="us-west-2"
+    - --env-vars=AWS_ACCESS_KEY_ID="anaccesskey"
+    - --env-vars=AWS_SECRET_ACCESS_KEY="asecretkey"
 ```
 
 ### All hooks: Disable color output

hooks/_common.sh

@@ -26,7 +26,7 @@ function common::initialize {
 #   ARGS (array) arguments that configure wrapped tool behavior
 #   HOOK_CONFIG (array) arguments that configure hook behavior
 #   TF_INIT_ARGS (array) arguments for `terraform init` command
-#   ENVS (array) environment variables will be available
+#   ENV_VARS (array) environment variables will be available
 #     for all 3rd-party tools executed by a hook.
 #   FILES (array) filenames to check
 # Arguments:
@@ -40,10 +40,11 @@ function common::parse_cmdline {
   # Used inside `common::terraform_init` function
   TF_INIT_ARGS=()
   # Used inside `common::export_provided_env_vars` function
-  ENVS=()
+  ENV_VARS=()
 
   local argv
-  argv=$(getopt -o a:,h:,i:,e: --long args:,hook-config:,init-args:,tf-init-args:,envs: -- "$@") || return
+  # TODO: Planned breaking change: remove `init-args`, `envs` as not self-descriptive
+  argv=$(getopt -o a:,h:,i:,e: --long args:,hook-config:,init-args:,tf-init-args:,envs:,env-vars: -- "$@") || return
   eval "set -- $argv"
 
   for argv; do
@@ -64,9 +65,10 @@ function common::parse_cmdline {
         TF_INIT_ARGS+=("$1")
         shift
         ;;
-      -e | --envs)
+      # TODO: Planned breaking change: remove `--envs` as not self-descriptive
+      -e | --envs | --env-vars)
         shift
-        ENVS+=("$1")
+        ENV_VARS+=("$1")
         shift
         ;;
       --)

hooks/infracost_breakdown.sh

@@ -10,7 +10,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
   # shellcheck disable=SC2153 # False positive
   infracost_breakdown_ "${HOOK_CONFIG[*]}" "${ARGS[*]}"

hooks/terraform_checkov.sh

@@ -10,7 +10,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
   # Support for setting PATH to repo root.
   # shellcheck disable=SC2178 # It's the simplest syntax for that case

hooks/terraform_docs.sh

@@ -10,7 +10,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
   # Support for setting relative PATH to .terraform-docs.yml config.
   # shellcheck disable=SC2178 # It's the simplest syntax for that case

hooks/terraform_fmt.sh

@@ -10,7 +10,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
 
   # Suppress terraform fmt color

hooks/terraform_providers_lock.sh

@@ -11,7 +11,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
   # JFYI: suppress color for `terraform providers lock` is N/A`
 

hooks/terraform_tflint.sh

@@ -11,7 +11,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
   # Support for setting PATH to repo root.
   # shellcheck disable=SC2178 # It's the simplest syntax for that case

hooks/terraform_tfsec.sh

@@ -10,7 +10,7 @@ readonly SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)"
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
   # Support for setting PATH to repo root.
   # shellcheck disable=SC2178 # It's the simplest syntax for that case

hooks/terraform_validate.sh

@@ -13,7 +13,7 @@ export AWS_DEFAULT_REGION=${AWS_DEFAULT_REGION:-us-east-1}
 function main {
   common::initialize "$SCRIPT_DIR"
   common::parse_cmdline "$@"
-  common::export_provided_env_vars "${ENVS[@]}"
+  common::export_provided_env_vars "${ENV_VARS[@]}"
   common::parse_and_export_env_vars
 
   # Suppress terraform validate color
@@ -34,7 +34,7 @@ function main {
 #   args (string with array) arguments that configure wrapped tool behavior
 #   dir_path (string) PATH to dir relative to git repo root.
 #     Can be used in error logging
-#   ENVS (array) environment variables that will be used with
+#   ENV_VARS (array) environment variables that will be used with
 #     `terraform` commands
 # Outputs:
 #   If failed - print out hook checks status