add shellcheck test (#27)

* add shellcheck test

* constrain the bash grep

Author: bwagner5

.travis.yml

@@ -18,6 +18,9 @@ jobs:
     - stage: Test
       script: make spellcheck
       name: Markdown Spellcheck
+    - stage: Test
+      script: make shellcheck
+      name: Shell Script Check
     - stage: Test
       script: make homebrew-sync-dry-run
       name: Homebrew Sync Dry-Run

Makefile

@@ -69,6 +69,9 @@ go-report-card-test:
 spellcheck:
 	${MAKEFILE_PATH}/test/readme-test/run-readme-spellcheck
 
+shellcheck:
+	${MAKEFILE_PATH}/test/shellcheck/run-shellcheck
+
 ## requires aws credentials
 readme-codeblock-test: 
 	${MAKEFILE_PATH}/test/readme-test/run-readme-codeblocks
@@ -101,8 +104,8 @@ build: compile
 
 release: build-binaries build-docker-images push-docker-images upload-resources-to-github
 
-test: spellcheck unit-test license-test go-report-card-test output-validation-test readme-codeblock-test
+test: spellcheck shellcheck unit-test license-test go-report-card-test output-validation-test readme-codeblock-test
 
 help:
 	@echo $(CURDIR)
-	@grep -E '^[a-zA-Z_-]+:.*$$' $(MAKEFILE_LIST) | sort
+	@grep -E '^[a-zA-Z_-]+:.*$$' $(MAKEFILE_LIST) | sort

test/readme-test/run-readme-codeblocks

@@ -13,7 +13,7 @@ trap exit_and_fail INT ERR
 docker build --target=builder --build-arg="GOPROXY=direct" -t codeblocks -f $SCRIPTPATH/../../Dockerfile $SCRIPTPATH/../../
 docker build -t rundoc -f $SCRIPTPATH/rundoc-Dockerfile $SCRIPTPATH/
 function rd() {
-   docker run -it --rm -v $SCRIPTPATH/../../:/aeis rundoc rundoc $@
+   docker run -it --rm -v $SCRIPTPATH/../../:/aeis rundoc rundoc "$@"
 }
 
 rundoc_output=$(rd list-blocks /aeis/README.md)

test/readme-test/run-readme-spellcheck

@@ -1,13 +1,13 @@
 #!/bin/bash
-set -euo errexit
+set -euo pipefail
 
 SCRIPTPATH="$( cd "$(dirname "$0")" ; pwd -P )"
 
 function exit_and_fail() {
    echo "❌ Test Failed! Found a markdown file with spelling errors."
    exit 1
 }
-trap exit_and_fail INT ERR
+trap exit_and_fail INT ERR TERM
 
 docker build -t misspell -f $SCRIPTPATH/spellcheck-Dockerfile $SCRIPTPATH/
 docker run -i --rm -v $SCRIPTPATH/../../:/aeis misspell /bin/bash -c 'find /aeis/ -type f -name "*.md" -not -path "build" | grep -v "/build/" | xargs misspell -error -debug'

test/shellcheck/run-shellcheck

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+SCRIPTPATH="$( cd "$(dirname "$0")" ; pwd -P )"
+BUILD_DIR="${SCRIPTPATH}/../../build"
+
+KERNEL=$(uname -s | tr '[:upper:]' '[:lower:]')
+SHELLCHECK_VERSION="0.7.1"
+
+function exit_and_fail() {
+   echo "❌ Test Failed! Found a shell script with errors."
+   exit 1
+}
+trap exit_and_fail INT ERR TERM
+
+curl -Lo ${BUILD_DIR}/shellcheck.tar.xz https://github.com/koalaman/shellcheck/releases/download/v${SHELLCHECK_VERSION}/shellcheck-v${SHELLCHECK_VERSION}.${KERNEL}.x86_64.tar.xz
+tar -C ${BUILD_DIR} -xvf "${BUILD_DIR}/shellcheck.tar.xz"
+export PATH="${BUILD_DIR}/shellcheck-v${SHELLCHECK_VERSION}:$PATH"
+
+shellcheck -S error $(grep -Rn -e '#!.*/bin/bash' -e '#!.*/usr/bin/env bash' ${SCRIPTPATH}/../../ | grep ":[1-5]:" | cut -d':' -f1)
+
+echo "✅ All shell scripts look good! 😎"