chore: Refactor all hooks (#310)

terraform_tflint.sh

@@ -2,41 +2,65 @@
 
 set -eo pipefail
 
-main() {
-  initialize_
-  parse_cmdline_ "$@"
-  tflint_
+function main {
+  common::initialize
+  common::parse_cmdline "$@"
+  # Support for setting PATH to repo root.
+  ARGS=${ARGS[*]/__GIT_WORKING_DIR__/$(pwd)\/}
+  common::per_dir_hook "$ARGS" "${FILES[@]}"
 }
 
-initialize_() {
+function common::colorify {
+  # shellcheck disable=SC2034
+  local -r red="\e[0m\e[31m"
+  # shellcheck disable=SC2034
+  local -r green="\e[0m\e[32m"
+  # shellcheck disable=SC2034
+  local -r yellow="\e[0m\e[33m"
+  # Color reset
+  local -r RESET="\e[0m"
+
+  # Params start #
+  local COLOR="${!1}"
+  local -r TEXT=$2
+  # Params end #
+
+  if [ "$PRE_COMMIT_COLOR" = "never" ]; then
+    COLOR=$RESET
+  fi
+
+  echo -e "${COLOR}${TEXT}${RESET}"
+}
+
+function common::initialize {
+  local SCRIPT_DIR
   # get directory containing this script
-  local dir
-  local source
-  source="${BASH_SOURCE[0]}"
-  while [[ -L $source ]]; do # resolve $source until the file is no longer a symlink
-    dir="$(cd -P "$(dirname "$source")" > /dev/null && pwd)"
-    source="$(readlink "$source")"
-    # if $source was a relative symlink, we need to resolve it relative to the path where the symlink file was located
-    [[ $source != /* ]] && source="$dir/$source"
-  done
-  _SCRIPT_DIR="$(dirname "$source")"
+  SCRIPT_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
 
   # source getopt function
   # shellcheck source=lib_getopt
-  . "$_SCRIPT_DIR/lib_getopt"
+  . "$SCRIPT_DIR/lib_getopt"
 }
 
-parse_cmdline_() {
-  declare argv
-  argv=$(getopt -o a: --long args: -- "$@") || return
+function common::parse_cmdline {
+  # common global arrays.
+  # Populated via `common::parse_cmdline` and can be used inside hooks' functions
+  declare -g -a ARGS=() FILES=() HOOK_CONFIG=()
+
+  local argv
+  argv=$(getopt -o a:,h: --long args:,hook-config: -- "$@") || return
   eval "set -- $argv"
 
   for argv; do
     case $argv in
       -a | --args)
         shift
-        expanded_arg="${1//__GIT_WORKING_DIR__/$PWD}"
-        ARGS+=("$expanded_arg")
+        ARGS+=("$1")
+        shift
+        ;;
+      -h | --hook-config)
+        shift
+        HOOK_CONFIG+=("$1;")
         shift
         ;;
       --)
@@ -46,43 +70,68 @@ parse_cmdline_() {
         ;;
     esac
   done
-
 }
 
-tflint_() {
+function common::per_dir_hook {
+  local -r args="$1"
+  shift 1
+  local -a -r files=("$@")
+
+  # consume modified files passed from pre-commit so that
+  # hook runs against only those relevant directories
   local index=0
-  for file_with_path in "${FILES[@]}"; do
+  for file_with_path in "${files[@]}"; do
     file_with_path="${file_with_path// /__REPLACED__SPACE__}"
 
-    paths[index]=$(dirname "$file_with_path")
+    dir_paths[index]=$(dirname "$file_with_path")
 
     ((index += 1))
   done
-  set +e
-  tflint_final_exit_code=0
-  for path_uniq in $(echo "${paths[*]}" | tr ' ' '\n' | sort -u); do
-    path_uniq="${path_uniq//__REPLACED__SPACE__/ }"
-    pushd "$path_uniq" > /dev/null
 
-    # Print checked PATH **only** if TFLint have any messages
-    # shellcheck disable=SC2091 # Suppress error output
-    $(tflint "${ARGS[@]}" 2>&1) 2> /dev/null || {
-      echo >&2 -e "\033[1;33m\nTFLint in $path_uniq/:\033[0m"
-      tflint "${ARGS[@]}"
-    }
+  # preserve errexit status
+  shopt -qo errexit && ERREXIT_IS_SET=true
+  # allow hook to continue if exit_code is greater than 0
+  set +e
+  local final_exit_code=0
+
+  # run hook for each path
+  for dir_path in $(echo "${dir_paths[*]}" | tr ' ' '\n' | sort -u); do
+    dir_path="${dir_path//__REPLACED__SPACE__/ }"
+    pushd "$dir_path" > /dev/null || continue
+
+    per_dir_hook_unique_part "$args" "$dir_path"
+
     local exit_code=$?
-    if [ $exit_code != 0 ]; then
-      tflint_final_exit_code=$exit_code
+    if [ $exit_code -ne 0 ]; then
+      final_exit_code=$exit_code
     fi
 
     popd > /dev/null
   done
-  set -e
-  exit $tflint_final_exit_code
+
+  # restore errexit if it was set before the "for" loop
+  [[ $ERREXIT_IS_SET ]] && set -e
+  # return the hook final exit_code
+  exit $final_exit_code
 }
 
-# global arrays
-declare -a ARGS
-declare -a FILES
+function per_dir_hook_unique_part {
+  # common logic located in common::per_dir_hook
+  local -r args="$1"
+  local -r dir_path="$2"
 
-[[ ${BASH_SOURCE[0]} != "$0" ]] || main "$@"
+  # Print checked PATH **only** if TFLint have any messages
+  # shellcheck disable=SC2091,SC2068 # Suppress error output
+  $(tflint ${args[@]} 2>&1) 2> /dev/null || {
+    common::colorify "yellow" "TFLint in $dir_path/:"
+
+    # shellcheck disable=SC2068 # hook fails when quoting is used ("$arg[@]")
+    tflint ${args[@]}
+  }
+
+  # return exit code to common::per_dir_hook
+  local exit_code=$?
+  return $exit_code
+}
+
+[ "${BASH_SOURCE[0]}" != "$0" ] || main "$@"