move shellcheck to local script (project-chip#364)

* move shellcheck to local script

* newline

* no -x

* shellharden

* shfmt

Author: Rob Walker

.github/workflows/shellcheck.yml

@@ -3,13 +3,11 @@ name: Shellcheck
 on: [pull_request]
 
 jobs:
-  shellcheck:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: shellcheck
-        id: shellcheck
-        uses: project-chip/action-shellcheck@master
-        env:
-          EXCLUDE_DIRS: third_party
+shellcheck:
+runs-on: ubuntu-latest
+
+steps:
+- uses: actions/checkout@v2
+
+- name: shellcheck
+run: integrations/docker/images/chip-build/run.sh integrations/shellcheck_tree.sh

.shellcheck_tree

@@ -0,0 +1,2 @@
+# configuration for shellcheck_tree.sh
+excludes+=('third_party/*' 'build/*')

integrations/docker/build.sh

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+# build.sh   - utility for building (and optionally) tagging and pushing
+#               the a Docker image
+#
+# This script expects to find a Dockerfile next to $0, so symlink
+#  in an image name directory is the expected use case.
+
+me=$(basename "$0")
+cd "$(dirname "$0")"
+
+ORG=${DOCKER_BUILD_ORG:-connectedhomeip}
+
+# directory name is
+IMAGE=${DOCKER_BUILD_IMAGE:-$(basename "$(pwd)")}
+
+# version
+VERSION=${DOCKER_BUILD_VERSION:-$(cat version)}
+
+[[ ${*/--help//} != "${*}" ]] && {
+  set +x
+  echo "Usage: $me <OPTIONS>
+
+  Build and (optionally tag as latest, push) a docker image from Dockerfile in CWD
+
+  Options:
+   --latest   update latest to the current built version (\"$VERSION\")
+   --push     push image(s) to docker.io (requires docker login for \"$ORG\")
+   --help     get this message
+
+"
+  exit 0
+}
+
+die() {
+  echo "$me: *** ERROR: $*"
+  exit 1
+}
+
+set -ex
+
+[[ -n $VERSION ]] || die "version cannot be empty"
+
+docker build -t "$ORG/$IMAGE:$VERSION" .
+
+[[ ${*/--latest//} != "${*}" ]] && {
+  docker tag "$ORG"/"$IMAGE":"$VERSION" "$ORG"/"$IMAGE":latest
+}
+
+[[ ${*/--push//} != "${*}" ]] && {
+  docker push "$ORG"/"$IMAGE":"$VERSION"
+  [[ ${*/--latest//} != "${*}" ]] && {
+    docker push "$ORG"/"$IMAGE":latest
+  }
+}
+
+exit 0

integrations/docker/images/chip-build/build.sh

@@ -0,0 +1 @@
+../../build.sh

integrations/docker/images/chip-build/build.sh

@@ -0,0 +1 @@
+../../run.sh

integrations/docker/images/chip-build/run.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# run.sh   - utility for running a Docker image
+#
+# This script expects to live in a directory named after the image
+#  with a version file next to it.  So: use symlinks
+#
+here=$(cd "$(dirname "$0")" && pwd)
+me=$(basename "$0")
+
+ORG=${DOCKER_RUN_ORG:-connectedhomeip}
+
+# directory name is
+IMAGE=${DOCKER_RUN_IMAGE:-$(basename "$here")}
+
+# version
+VERSION=${DOCKER_RUN_VERSION:-$(cat "$here/version")}
+
+# where
+RUN_DIR=${DOCKER_RUN_DIR:-$(pwd)}
+
+[[ ${*/--help//} != "${*}" ]] && {
+  set +x
+  echo "Usage: $me command
+
+  Run a command in a docker image described by $here
+
+  Options:
+   --help     get this message
+
+"
+  exit 0
+}
+
+docker run --rm -w "$RUN_DIR" -v "$RUN_DIR:$RUN_DIR" "$ORG/$IMAGE:$VERSION" "$@"

integrations/docker/run.sh

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+me=$(basename "$0")
+
+# Run shellcheck on all the shell-ish files in the tree
+patterns=('*.bash*' 'bash*'
+  '*.ksh*' 'ksh*'
+  '*.zsh*' 'zsh*'
+  '.zlogin*' 'zlogin*'
+  '.zlogout*' 'zlogout*'
+  '.zprofile*' 'zprofile*'
+  '*.sh' '.shlib*' 'shlib*'
+  '.profile*' 'profile*'
+  'suid_profile')
+
+# excluding these directories (e.g. third_party/* )
+excludes=()
+
+# shellcheck disable=SC1091
+[[ -f .shellcheck_tree ]] && . .shellcheck_tree
+
+[[ ${*/--help//} != "${*}" ]] && {
+  echo "Usage: $me <OPTIONS>
+
+  Shellcheck all scripts in the tree.
+
+  Options:
+   --git      shellcheck via git ls-files, default is 'find .'
+   --help     get this message
+
+"
+  exit 0
+}
+
+if [[ ${*/--git//} != "${*}" ]]; then
+  #
+  #  To run on git-files only
+  #
+  git ls-files -- "${patterns[@]}" | while read -r file; do
+    for exclude in "${excludes[@]}"; do
+      [[ $file =~ $exclude ]] && continue 2
+    done
+    shellcheck -f gcc "$file"
+  done
+else
+  #
+  # use find
+  #
+  exclude_args=()
+  for exclude in "${excludes[@]}"; do
+    exclude_args+=('!' -path "./$exclude" -a)
+  done
+
+  pattern_args=()
+  for pattern in "${patterns[@]}"; do
+    pattern_args+=(-o -name "$pattern")
+  done
+
+  find . "${exclude_args[@]}" '(' "${pattern_args[@]:1}" ')' -exec shellcheck -f gcc {} +
+fi