provide more friendly output for server-side hooks

Author: David Wahlstrom

commit_hooks/erb_template_syntax_check.sh

@@ -1,19 +1,27 @@
 #!/bin/bash
 
 # This script expects $1 to be passed and for $1 to be the filesystem location
-# to an ERB file for which it will run syntax checks against.
+# to an ERB file for which it will run syntax checks against. If $2 is passed,
+# it will be stripped off of the path to provide prettier output, which is
+# particularly useful for server-side hooks when tempdirs are created.
 
 syntax_errors=0
 error_msg=$(mktemp /tmp/error_msg_erb-syntax.XXXXX)
 
+if [ $2 ]; then
+    module_path=$(echo $1 | sed -e 's|'$2'||')
+else
+    module_path=$1
+fi
+
 # Check ERB template syntax
-echo -e "\e[0;36mChecking erb template syntax for $1...\e[0m"
+echo -e "\e[0;36mChecking erb template syntax for $module_path...\e[0m"
 cat $1 | erb -x -T - | ruby -c 2>&1 > $error_msg
 if [ $? -ne 0 ]; then
     echo -en "\e[0;31m"
     cat $error_msg
     syntax_errors=`expr $syntax_errors + 1`
-    echo -e "Error: erb syntax error in $1 (see above)\e[0m"
+    echo -e "Error: erb syntax error in $module_path (see above)\e[0m"
 fi
 rm $error_msg
 

commit_hooks/puppet_lint_checks.sh

@@ -6,15 +6,21 @@
 syntax_errors=0
 error_msg=$(mktemp /tmp/error_msg_puppet-lint.XXXXX)
 
+if [ $2 ]; then
+    module_path=$(echo $1 | sed -e 's|'$2'||')
+else
+    module_path=$1
+fi
+
 # De-lint puppet manifests
-echo -e "\e[0;36mChecking puppet style guide compliance for $1...\e[0m"
+echo -e "\e[0;36mChecking puppet style guide compliance for $module_path...\e[0m"
 puppet-lint --fail-on-warnings --with-filename --no-80chars-check $1 2>&1 > $error_msg
 RC=$?
 if [ $RC -ne 0 ]; then
     echo -en "\e[0;31m"
     syntax_errors=$(expr $syntax_errors + 1)
     cat $error_msg
-    echo -e "Error: styleguide violation in $1 (see above)\e[0m"
+    echo -e "Error: styleguide violation in $module_path (see above)\e[0m"
 fi
 rm -f $error_msg
 

commit_hooks/puppet_manifest_syntax_check.sh

@@ -6,15 +6,21 @@
 syntax_errors=0
 error_msg=$(mktemp /tmp/error_msg_puppet-syntax.XXXXX)
 
+if [ $2 ]; then
+    module_path=$(echo $1 | sed -e 's|'$2'||')
+else
+    module_path=$1
+fi
+
 # Get list of new/modified manifest and template files to check (in git index)
 # Check puppet manifest syntax
-echo -e "\e[0;36mChecking puppet manifest syntax for $1...\e[0m"
+echo -e "\e[0;36mChecking puppet manifest syntax for $module_path...\e[0m"
 puppet parser validate --color=false $1 2>&1 > $error_msg
 if [ $? -ne 0 ]; then
     echo -en "\e[0;31m"
     syntax_errors=`expr $syntax_errors + 1`
     cat $error_msg
-    echo -e "Error: puppet syntax error in $1 (see above)\e[0m"
+    echo -e "Error: puppet syntax error in $module_path (see above)\e[0m"
 fi
 rm -f $error_msg
 

commit_hooks/rspec_puppet_checks.sh

@@ -4,6 +4,12 @@ git_root=`git rev-parse --show-toplevel`
 syntax_errors=0
 error_msg=$(mktemp /tmp/error_msg_rspec-puppet.XXXXX)
 
+if [ $2 ]; then
+    module_path=$(echo $1 | sed -e 's|'$2'||')
+else
+    module_path=$1
+fi
+
 # Run rspec-puppet tests
 oldpwd=$(pwd)
 tmpchangedmodules=''
@@ -22,7 +28,7 @@ changedmodules=$(echo -e "$tmpchangedmodules" | sort -u)
 for module_dir in $changedmodules; do
     #only run rspec if the "spec" directory exists
     if [ -d "${module_dir}/spec" ]; then
-	echo -e "\e[0;36mRunning rspec-puppet tests for module $1...\e[0m"
+	echo -e "\e[0;36mRunning rspec-puppet tests for module $module_path...\e[0m"
 	cd $module_dir
 	#this will run rspec for every test in the module
 	rspec > $error_msg

commit_hooks/yaml_syntax_check.sh

@@ -6,15 +6,21 @@
 syntax_errors=0
 error_msg=$(mktemp /tmp/error_msg_yaml-syntax.XXXXX)
 
+if [ $2 ]; then
+    module_path=$(echo $1 | sed -e 's|'$2'||')
+else
+    module_path=$1
+fi
+
 # Get list of new/modified manifest and template files to check (in git index)
 # Check YAML file syntax
-echo -e "\e[0;36mChecking yaml syntax for $1...\e[0m"
+echo -e "\e[0;36mChecking yaml syntax for $module_path...\e[0m"
 ruby -e "require 'yaml'; YAML.parse(File.open('$1'))" 2> $error_msg > /dev/null
 if [ $? -ne 0 ]; then
     echo -en "\e[0;31m"
     cat $error_msg
     syntax_errors=`expr $syntax_errors + 1`
-    echo -e "Error: yaml syntax error in $1 (see above)\e[0m"
+    echo -e "Error: yaml syntax error in $module_path (see above)\e[0m"
 fi
 rm -f $error_msg
 

pre-receive

@@ -13,7 +13,7 @@ while read oldrev newrev refname; do
         #check puppet manifest syntax
         if type puppet >/dev/null 2>&1; then
             if [ $(echo $changedfile | grep -q '\.*.pp$'; echo $?) -eq 0 ]; then
-                ${subhook_root}/puppet_manifest_syntax_check.sh $tmpmodule
+                ${subhook_root}/puppet_manifest_syntax_check.sh $tmpmodule "${tmptree}/"
                 RC=$?
                 if [ "$RC" -ne 0 ]; then
                     failures=`expr $failures + 1`
@@ -27,7 +27,7 @@ while read oldrev newrev refname; do
             #check erb (template file) syntax
             if type erb >/dev/null 2>&1; then
                 if [ $(echo $changedfile | grep -q '\.*.erb$'; echo $?) -eq 0 ]; then
-                    ${subhook_root}/erb_template_syntax_check.sh $tmpmodule
+                    ${subhook_root}/erb_template_syntax_check.sh $tmpmodule "${tmptree}/"
                     RC=$?
                     if [ "$RC" -ne 0 ]; then
                         failures=`expr $failures + 1`
@@ -39,7 +39,7 @@ while read oldrev newrev refname; do
 
             #check hiera data (yaml/yml) syntax
             if [ $(echo $changedfile | grep -q '\.*.yaml$\|\.*.yml$'; echo $?) -eq 0 ]; then 
-                ${subhook_root}/yaml_syntax_check.sh $tmpmodule
+                ${subhook_root}/yaml_syntax_check.sh $tmpmodule "${tmptree}/"
                 RC=$?
                 if [ "$RC" -ne 0 ]; then
                     failures=`expr $failures + 1`
@@ -52,7 +52,7 @@ while read oldrev newrev refname; do
         #puppet manifest styleguide compliance
         if type puppet-lint >/dev/null 2>&1; then
             if [ $(echo $changedfile | grep -q '\.*.pp$' ; echo $?) -eq 0 ]; then 
-                ${subhook_root}/puppet_lint_checks.sh $tmpmodule
+                ${subhook_root}/puppet_lint_checks.sh $tmpmodule "${tmptree}/"
                 RC=$?
                 if [ "$RC" -ne 0 ]; then
                     failures=`expr $failures + 1`