apply some shellcheck warnings and add no_yaml_in_data check (#1)

* apply some shellcheck warnings and add no_yaml_in_data check

* Update trailing_whitespaces.sh

* Update libs.sh

* Create no_yaml_in_data.sh

Author: chrisongthb

modules/libs.sh

@@ -3,7 +3,6 @@
 # declare variables
 _columwidth='60'
 _rc=0
-_files=
 
 # declare bash colors
 declare -A _colors
@@ -15,6 +14,13 @@ _colors[yellow]='[0;33m'
 _colors[default]='[0m'
 _colors[restore]='[0m'
 
+# manage tmp file
+tmp_file="$(mktemp)"
+trap 'rm -f ${tmp_file}' EXIT
+
+# errorhandling
+set -euo pipefail
+
 # get files, that are staged for commit
 _puppet_git_hooks_git_init () {
   # change pwd to toplevel, to match dot files
@@ -29,12 +35,14 @@ _puppet_git_hooks_git_init () {
   fi
   # Fill list of files to test and check if there are
   # unstaged changes in any of these files. See also git-diff(1)
-  _files=$(git diff --staged --name-only --diff-filter=ACM "${revision}" | tr '\n' ' ') # prints staged files
+  git diff --staged --name-only --diff-filter=ACM "${revision}" > "$tmp_file" # prints staged files
   for i in $(git diff --name-only --diff-filter=ACM); do                                # prints unstaged files
-    if grep -q "${i}" <<< "${_files}"; then
-      printf "\n\e${_colors[red]}The file '${i}' has unstaged changes. Abort.\e${_colors[restore]}\n\n"
-      exit 1
-    fi
+    while read -r line; do
+      if grep -q "${i}" <<< "${line}"; then
+        echo -e "\n\e${_colors[red]}The file '${i}' has unstaged changes. Abort.\e${_colors[restore]}\n\n"
+        exit 1
+      fi
+    done < "$tmp_file"
   done
 }
 
@@ -69,19 +77,21 @@ _puppet_git_hooks_check () {
   shift
   local checkcommand=$1
   shift
-  local allfiles=$@
   local filteredfiles=
 
-  if filteredfiles=$(echo $allfiles | tr ' ' '\n' | grep -E "$filenameregex"); then
+  if filteredfiles=$(grep -E "$filenameregex" "$tmp_file"); then
     _puppet_git_hooks_say "checking" "${checkcommand}"
 
-    local _base_command=$(awk '{print $1;}' <<< $checkcommand)
-    if type $_base_command > /dev/null 2>&1; then
+    local _base_command=
+    _base_command="$(awk '{print $1;}' <<< "$checkcommand")"
+    if type "$_base_command" > /dev/null 2>&1; then
+        # shellcheck disable=SC2086
         if ${checkcommand} ${filteredfiles} > /dev/null 2>&1; then
           _puppet_git_hooks_say "OK" "${checkcommand}"
         else
           _puppet_git_hooks_say "nOK" "${checkcommand}"
-          ${checkcommand} ${filteredfiles}
+        # shellcheck disable=SC2086
+          ${checkcommand} ${filteredfiles} || true
         fi
     else
       _puppet_git_hooks_say "FAILED" "${checkcommand}"

modules/no_yaml_in_data.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# shellcheck disable=SC2154
+
+_puppet_git_hooks_check_yaml_in_data () {
+  local say_checkname='.yaml file extension beneath data/'
+
+  if grep -qE '^data' "$tmp_file"; then
+    _puppet_git_hooks_say "checking" "$say_checkname"
+    if grep -E '^data' "$tmp_file" | grep -qv '.yaml$'; then
+      _puppet_git_hooks_say "nOK" "$say_checkname"
+      echo "Found files without .yaml in data/:"
+      grep -E '^data' "$tmp_file" | grep -v '.yaml$'
+    else
+      _puppet_git_hooks_say "OK" "$say_checkname"
+    fi
+  fi
+}

modules/trailing_whitespaces.sh

@@ -1,22 +1,25 @@
 #!/bin/bash
+# shellcheck disable=SC2154
 
 _puppet_git_hooks_check_trailing_whitespaces () {
-  local filteredfiles=
   local say_checkname='trailing whitespaces'
 
-  if filteredfiles=$(echo $@ | tr ' ' '\n' | grep -vE '\.md$|^files\/'); then
-    _puppet_git_hooks_say "checking" "$say_checkname"
-    if type grep > /dev/null 2>&1; then
-      if ! grep -qIE ' $' ${filteredfiles}; then
-        _puppet_git_hooks_say "OK" "$say_checkname"
-      else
-        _puppet_git_hooks_say "nOK" "$say_checkname"
-        echo "Found trailing whitespaces in:"
-        grep --color=auto -HnoE ' $' ${filteredfiles}
+  if grep -qvE '\.md$|^files\/' "$tmp_file"; then
+    _puppet_git_hooks_say 'checking' "$say_checkname"
+
+    files_with_trailing_whitespaces=()
+    while read -r line; do
+      if grep -qIE ' $' <<< "$line"; then
+        files_with_trailing_whitespaces+=("$line")
       fi
+    done < "$tmp_file"
+
+    if [[ "${#files_with_trailing_whitespaces[@]}" -eq 0 ]]; then
+        _puppet_git_hooks_say 'OK' "$say_checkname"
     else
-      _puppet_git_hooks_say "FAILED" "$say_checkname"
-      echo "command not found: grep"
+        _puppet_git_hooks_say 'nOK' "$say_checkname"
+        echo "Found trailing whitespaces in:"
+        echo "${files_with_trailing_whitespaces[@]}"
     fi
   fi
 }

pre-commit

@@ -1,35 +1,38 @@
 #!/bin/bash
+# shellcheck disable=SC2154
+# shellcheck disable=SC1090
 
 # get functions and checks
-if [ -L $0 ]; then # $0 is symlink
-  for i in $(find $(dirname $(readlink $0))/modules/ -type f -name '*.sh' ); do
-    source $i
-  done
+if [ -L "$0" ]; then # $0 is symlink
+  while read -r line; do
+    source "$line"
+  done < <(find "$(dirname "$(readlink "$0")")/modules/" -type f -name '*.sh')
 else
-  for i in $(find $(dirname $0)/modules/ -type f -name '*.sh' ); do
-    source $i
-  done
+  while read -r line; do
+    source "$line"
+  done < <(find "$(dirname "$0")/modules/" -type f -name '*.sh')
 fi
 
 # collect changed files
 _puppet_git_hooks_git_init
 
 # do checks
 #_puppet_git_hooks_check '\.erb$' 'bash -c "erb -x -T - $@ | ruby -c"' ${_files} # not working
-_puppet_git_hooks_check '\.pp$' 'puppet-lint --relative' ${_files}
-_puppet_git_hooks_check '\.pp$' '/opt/puppetlabs/bin/puppet parser validate' ${_files}
-_puppet_git_hooks_check '\.epp$' '/opt/puppetlabs/bin/puppet epp validate' ${_files}
-_puppet_git_hooks_check '\.yaml$' 'yamllint --strict' ${_files}
-_puppet_git_hooks_check '^Puppetfile$' 'r10k puppetfile check' ${_files}
-_puppet_git_hooks_check_trailing_whitespaces ${_files}
+_puppet_git_hooks_check_yaml_in_data 'data'
+_puppet_git_hooks_check '\.pp$' 'puppet-lint --relative'
+_puppet_git_hooks_check '\.pp$' '/opt/puppetlabs/bin/puppet parser validate'
+_puppet_git_hooks_check '\.epp$' '/opt/puppetlabs/bin/puppet epp validate'
+_puppet_git_hooks_check '\.yaml$' 'yamllint --strict'
+_puppet_git_hooks_check '^Puppetfile$' 'r10k puppetfile check'
+_puppet_git_hooks_check_trailing_whitespaces
 
 # exit
-if [ $_rc -eq 0 ]; then
+if [ "$_rc" -eq '0' ]; then
   echo
   exit 0
 else
   echo
   echo
   echo 'git commit aborted.'
-  exit $_rc
+  exit "$_rc"
 fi