Add tput color and puppetlint.rc support

This merge provides terminal color control with tput (which makes it
infinitely easier to read) and allows for users to provide a
.puppetlint.rc file to configure puppet-lint to their liking.

commit be634db
Merge: 4611611 5c21034
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 23:42:51 2014 -0700

    Merge branch 'feature/smart-colors'

commit 5c21034
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 23:29:32 2014 -0700

    Replaced remaining escape sequences with tput

commit 4611611
Merge: c7f46d5 a89de65
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 22:23:20 2014 -0700

    Merge branch 'feature/smart-colors'

commit c7f46d5
Merge: 0934391 95ea4b7
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 22:23:15 2014 -0700

    Merge branch 'feature/puppet-lintrc'

commit 0934391
Merge: 9c90b18 3379aee
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 22:23:04 2014 -0700

    Merge branch 'feature/symlink-pre-receive'

commit a89de65
Merge: 06facd8 3379aee
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 22:22:38 2014 -0700

    Merge branch 'feature/symlink-pre-receive' into feature/smart-colors

commit 95ea4b7
Merge: 621ccdf 3379aee
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 22:22:24 2014 -0700

    Merge branch 'feature/symlink-pre-receive' into feature/puppet-lintrc

commit 3379aee
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 21:31:22 2014 -0700

    Removed dependency on realpath command

commit 06facd8
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 20:34:21 2014 -0700

    Preventing sed from getting an empty expression when the module directory argument is not passed

commit 9c90b18
Merge: 6cf9441 621ccdf
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 20:05:13 2014 -0700

    Merged puppet-lintrc feature with smart-colors feature

commit 621ccdf
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 20:01:04 2014 -0700

    Added a check for a .puppet-lint.rc file in the module root. The custom config will be applied with the --config flag if the file exists. This reproduces the behavior you would see when running the puppet-lint command within the module directory without the --config option.

commit 6cf9441
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 19:17:07 2014 -0700

    Added tput-based coloring to pre-receive, puppet_lint_checks.sh and puppet_manifest_syntaxt_check.sh. Fixed the STDERR output redirection for puppet_lint_checks.sh and puppet_manifest_syntaxt_check.sh.

commit e92c665
Author: Henry Goodman <github@henrygoodman.com>
Date:   Tue Oct 21 17:16:22 2014 -0700

    Allow the pre-receive hook to be used as a relative symlink

Author: David Wahlstrom

commit_hooks/erb_template_syntax_check.sh

@@ -15,18 +15,17 @@ else
 fi
 
 # Check ERB template syntax
-echo -e "\x1B[0;36mChecking erb template syntax for $module_path...\x1B[0m"
-cat $1 | erb -x -T - | ruby -c 2>&1 > $error_msg
+echo -e "$(tput setaf 6)Checking erb template syntax for $module_path...$(tput sgr0)"
+cat $1 | erb -x -T - | ruby -c > $error_msg 2>&1
 if [ $? -ne 0 ]; then
-    echo -en "\x1B[0;31m"
-    cat $error_msg
+    cat $error_msg | sed -e "s/^/$(tput setaf 1)/" -e "s/$/$(tput sgr0)/"
     syntax_errors=`expr $syntax_errors + 1`
-    echo -e "Error: erb syntax error in $module_path (see above)\x1B[0m"
+    echo -e "$(tput setaf 1)Error: erb syntax error in $module_path (see above)$(tput sgr0)"
 fi
 rm $error_msg
 
 if [ "$syntax_errors" -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $syntax_errors syntax errors found in templates. Commit will be aborted.\x1B[0m"
+    echo -e "$(tput setaf 1)Error: $syntax_errors syntax errors found in templates. Commit will be aborted.$(tput sgr0)"
     exit 1
 fi
 

commit_hooks/json_syntax_check.sh

@@ -12,20 +12,18 @@ else
     module_path=$1
 fi
 
-# Get list of new/modified manifest and template files to check (in git index)
 # Check json file syntax
-echo -e "\x1B[0;36mChecking json syntax for $module_path...\x1B[0m"
+echo -e "$(tput setaf 6)Checking json syntax for $module_path...$(tput sgr0)"
 ruby -e "require 'json'; JSON.parse(File.read($1))" 2> $error_msg > /dev/null
 if [ $? -ne 0 ]; then
-    echo -en "\x1B[0;31m"
-    cat $error_msg
+    cat $error_msg | sed -e "s/^/$(tput setaf 1)/" -e "s/$/$(tput sgr0)/"
     syntax_errors=`expr $syntax_errors + 1`
-    echo -e "Error: json syntax error in $module_path (see above)\x1B[0m"
+    echo -e "$(tput setaf 1)Error: json syntax error in $module_path (see above)$(tput sgr0)"
 fi
 rm -f $error_msg
 
 if [ "$syntax_errors" -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $syntax_errors syntax error(s) found in json file.  Commit will be aborted.\x1B[0m"
+    echo -e "$(tput setaf 1)Error: $syntax_errors syntax error(s) found in json file.  Commit will be aborted.$(tput sgr0)"
     exit 1
 fi
 

commit_hooks/puppet_lint_checks.sh

@@ -3,31 +3,47 @@
 # This script expects $1 to be passed and for $1 to be the filesystem location
 # to a puppet manifest file for which it will run style guide checks against.
 
+manifest_path="$1"
+module_dir="$2"
+
 syntax_errors=0
 error_msg=$(mktemp /tmp/error_msg_puppet-lint.XXXXX)
 
-if [ $2 ]; then
-    module_path=$(echo $1 | sed -e 's|'$2'||')
+if [ $module_dir ]; then
+    manifest_name=$(echo $manifest_path | sed -e 's|'$module_dir'||')
+    error_msg_filter="sed -e s|$module_dir||"
 else
-    module_path=$1
+    manifest_name="$manifest_path"
+    error_msg_filter="sed"
 fi
 
 # De-lint puppet manifests
-echo -e "\x1B[0;36mChecking puppet style guide compliance for $module_path...\x1B[0m"
-puppet-lint --fail-on-warnings --with-filename --no-80chars-check $1 2>&1 > $error_msg
+echo -e "$(tput setaf 6)Checking puppet style guide compliance for $manifest_name...$(tput sgr0)"
+
+# If a file named .puppet-lint.rc exists at the base of the repo then use it to
+# enable or disable checks.
+puppet_lint_cmd="puppet-lint --fail-on-warnings --with-filename"
+puppet_lint_rcfile="${2}.puppet-lint.rc"
+if [ -f $puppet_lint_rcfile ]; then
+    echo -e "$(tput setaf 6)Applying custom config from .puppet-lint.rc$(tput sgr0)"
+    puppet_lint_cmd="$puppet_lint_cmd --config $puppet_lint_rcfile"
+else
+    puppet_lint_cmd="$puppet_lint_cmd --no-80chars-check"
+fi
+
+$puppet_lint_cmd $1 2>&1 > $error_msg
 RC=$?
 if [ $RC -ne 0 ]; then
-    echo -en "\x1B[0;31m"
     syntax_errors=$(expr $syntax_errors + 1)
-    cat $error_msg
-    echo -e "Error: styleguide violation in $module_path (see above)\x1B[0m"
+    cat $error_msg | $error_msg_filter -e "s/^/$(tput setaf 1)/" -e "s/$/$(tput sgr0)/"
+    echo -e "$(tput setaf 1)Error: styleguide violation in $manifest_name (see above)$(tput sgr0)"
 fi
 rm -f $error_msg
 
 if [ $syntax_errors -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $syntax_errors styleguide violation(s) found. Commit will be aborted.
+    echo -e "Error: $syntax_errors styleguide violation(s) found. Commit will be aborted.
 Please follow the puppet style guide outlined at:
-http://docs.puppetlabs.com/guides/style_guide.html\x1B[0m"
+http://docs.puppetlabs.com/guides/style_guide.html" | sed -e "s/^/$(tput setaf 1)/" -e "s/$/$(tput sgr0)/"
     exit 1
 fi
 

commit_hooks/puppet_manifest_syntax_check.sh

@@ -3,29 +3,33 @@
 # This script expects $1 to be passed and for $1 to be the filesystem location
 # to a puppet manifest file for which it will run syntax checks against.
 
+manifest_path="$1"
+module_dir="$2"
+
 syntax_errors=0
 error_msg=$(mktemp /tmp/error_msg_puppet-syntax.XXXXX)
 
-if [ $2 ]; then
-    module_path=$(echo $1 | sed -e 's|'$2'||')
+if [ $module_dir ]; then
+    manifest_name=$(echo $manifest_path | sed -e 's|'$module_dir'||')
+    error_msg_filter="sed -e s|$module_dir||"
 else
-    module_path=$1
+    manifest_name="$manifest_path"
+    error_msg_filter="sed"
 fi
 
 # Get list of new/modified manifest and template files to check (in git index)
 # Check puppet manifest syntax
-echo -e "\x1B[0;36mChecking puppet manifest syntax for $module_path...\x1B[0m"
-puppet parser validate --color=false $1 2>&1 > $error_msg
+echo -e "$(tput setaf 6)Checking puppet manifest syntax for $manifest_name...$(tput sgr0)"
+puppet parser validate --color=false $1 > $error_msg 2>&1
 if [ $? -ne 0 ]; then
-    echo -en "\x1B[0;31m"
     syntax_errors=`expr $syntax_errors + 1`
-    cat $error_msg
-    echo -e "Error: puppet syntax error in $module_path (see above)\x1B[0m"
+    cat $error_msg | $error_msg_filter -e "s/^/$(tput setaf 1)/" -e "s/$/$(tput sgr0)/"
+    echo -e "$(tput setaf 1)Error: puppet syntax error in $manifest_name (see above)$(tput sgr0)"
 fi
 rm -f $error_msg
 
 if [ "$syntax_errors" -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $syntax_errors syntax error(s) found in puppet manifests. Commit will be aborted.\x1B[0m"
+    echo -e "$(tput setaf 1)Error: $syntax_errors syntax error(s) found in puppet manifests. Commit will be aborted.$(tput sgr0)"
     exit 1
 fi
 

commit_hooks/rspec_puppet_checks.sh

@@ -28,17 +28,16 @@ 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 "\x1B[0;36mRunning rspec-puppet tests for module $module_path...\x1B[0m"
-	cd $module_dir
-	#this will run rspec for every test in the module
-	rspec > $error_msg
-	RC=$?
-	if [ $RC -ne 0 ]; then
-	    echo -en "\x1B[0;31m"
-	    cat $error_msg
-	    echo -e "Error: rspec-puppet test(s) failed for $module_dir (see above)\x1B[0m"
-	    syntax_errors=`expr $syntax_errors + 1`
-	fi
+        echo -e "$(tput setaf 6)Running rspec-puppet tests for module $module_path...$(tput sgr0)"
+        cd $module_dir
+        #this will run rspec for every test in the module
+        rspec > $error_msg
+        RC=$?
+        if [ $RC -ne 0 ]; then
+            cat $error_msg | sed -e "s/^/$(tput setaf 1)/" -e "s/$/$(tput sgr0)/"
+            echo -e "$(tput setaf 1)Error: rspec-puppet test(s) failed for $module_dir (see above)$(tput sgr0)"
+            syntax_errors=`expr $syntax_errors + 1`
+        fi
     fi
 done
 
@@ -47,7 +46,7 @@ cd $oldpwd > /dev/null
 rm $error_msg
 
 if [ "$syntax_errors" -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $syntax_errors rspec-puppet test(s) failed. Commit will be aborted.\x1B[0m"
+    echo -e "$(tput setaf 1)Error: $syntax_errors rspec-puppet test(s) failed. Commit will be aborted.$(tput sgr0)"
     exit 1
 fi
 

commit_hooks/yaml_syntax_check.sh

@@ -12,20 +12,18 @@ 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 "\x1B[0;36mChecking yaml syntax for $module_path...\x1B[0m"
+echo -e "$(tput setaf 6)Checking yaml syntax for $module_path...$(tput sgr0)"
 ruby -e "require 'yaml'; YAML.parse(File.open('$1'))" 2> $error_msg > /dev/null
 if [ $? -ne 0 ]; then
-    echo -en "\x1B[0;31m"
-    cat $error_msg
+    cat $error_msg | sed -e "s/^/$(tput setaf 1)/" -e "s/$/$(tput sgr0)/"
     syntax_errors=`expr $syntax_errors + 1`
-    echo -e "Error: yaml syntax error in $module_path (see above)\x1B[0m"
+    echo -e "$(tput setaf 1)Error: yaml syntax error in $module_path (see above)$(tput sgr0)"
 fi
 rm -f $error_msg
 
 if [ "$syntax_errors" -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $syntax_errors syntax error(s) found in hiera yaml. Commit will be aborted.\x1B[0m"
+    echo -e "$(tput setaf 1)Error: $syntax_errors syntax error(s) found in hiera yaml. Commit will be aborted.$(tput sgr0)"
     exit 1
 fi
 

pre-commit

@@ -108,7 +108,7 @@ fi
 
 #summary
 if [ "$failures" -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $failures subhooks failed. Aborting commit.\x1B[0m"
+    echo -e "$(tput setaf 1)Error: $failures subhooks failed. Aborting commit.$(tput sgr0)"
     exit 1
 fi
 

pre-receive

@@ -3,9 +3,24 @@
 failures=0
 RC=0
 
-subhook_root=hooks/commit_hooks
+hook_dir="$(dirname $0)"
+hook_symlink="$(readlink -f $0)"
+
+# Figure out where commit hooks are if pre-receive is setup as a symlink
+if [ ! -z "$hook_symlink" ]; then
+  subhook_root="$(dirname $hook_symlink)/commit_hooks"
+else
+  subhook_root="$hook_dir/commit_hooks"
+fi
+
 tmptree=$(mktemp -d)
 
+# Prevent tput from throwing an error by ensuring that $TERM is always set
+if [ -z "$TERM" ]; then
+    TERM=dumb
+fi
+export TERM
+
 while read oldrev newrev refname; do
     git archive $newrev | tar x -C ${tmptree}
     for changedfile in $(git diff --name-only $oldrev $newrev --diff-filter=ACM); do
@@ -67,7 +82,7 @@ rm -rf ${tmptree}
 
 #summary
 if [ "$failures" -ne 0 ]; then
-    echo -e "\x1B[0;31mError: $failures subhooks failed. Declining push.\x1B[0m"
+    echo -e "$(tput setaf 1)Error: $failures subhooks failed. Declining push.$(tput sgr0)"
     exit 1
 fi