feat(lint) applied shellcheck and added a makefile

Author: Tieske

.shellcheckrc

@@ -0,0 +1 @@
+disable=SC2181

Makefile

@@ -0,0 +1,10 @@
+install:
+	mkdir -p ~/.local/bin
+	ln -sf $$(pwd)/pongo.sh ~/.local/bin/pongo
+	if [ ! "$$(command -v pongo)" = "$$(command -v ~/.local/bin/pongo)" ]; then \
+		echo "\033[0;33m[INFO] please add ~/.local/bin/ to your system path \033[0m"; \
+		echo "\033[0;33m[INFO]    export PATH=~/.local/bin/:"'$$'"PATH\033[0m"; \
+	fi
+
+lint:
+	bash -c 'shopt -s globstar nullglob; shellcheck **/*.{sh,ksh,bash}'

assets/add_version.sh

@@ -7,7 +7,8 @@ DRY_RUN=$3
 LOCAL_PATH=$(dirname "$(realpath "$0")")/..
 
 # load variables
-source ${LOCAL_PATH}/assets/set_variables.sh
+# shellcheck source=./assets/set_variables.sh
+source "${LOCAL_PATH}/assets/set_variables.sh"
 
 
 function usage {
@@ -56,7 +57,7 @@ msg "Version to add: $ADD_VERSION"
 
 #TODO: here check we're in a Pongo git repo, and on 'master' branch
 
-if $(version_exists $ADD_VERSION); then
+if version_exists "$ADD_VERSION"; then
   err "Version '$ADD_VERSION' is already available"
   exit 1
 fi
@@ -68,26 +69,27 @@ if [[ ! -f $VERSIONS_FILE ]]; then
 fi
 
 # add the version to the file
-echo "$ADD_VERSION" >> $VERSIONS_FILE
-sort --version-sort $VERSIONS_FILE > ${VERSIONS_FILE}_tmp
+echo "$ADD_VERSION" >> "$VERSIONS_FILE"
+sort --version-sort "$VERSIONS_FILE" > "${VERSIONS_FILE}_tmp"
 
-if [[ ! -f ${VERSIONS_FILE}_tmp ]]; then
+if [[ ! -f "${VERSIONS_FILE}_tmp" ]]; then
   err "Failed to add and sort the new versions file"
   exit 1
 fi
 
-mv ${VERSIONS_FILE}_tmp $VERSIONS_FILE
+mv "${VERSIONS_FILE}_tmp" "$VERSIONS_FILE"
 
 # reload variables to add the new version to our array
-source ${LOCAL_PATH}/assets/set_variables.sh
+# shellcheck source=./assets/set_variables.sh
+source "${LOCAL_PATH}/assets/set_variables.sh"
 
 # add the first commit with just the added version
-pushd ${LOCAL_PATH} > /dev/null
+pushd "${LOCAL_PATH}" > /dev/null || { echo "Failure to enter $LOCAL_PATH"; exit 1; }
 PREVIOUS_BRANCH=$(git rev-parse --abbrev-ref HEAD)
 BRANCH_NAME=add-version-${ADD_VERSION}
-git checkout -b ${BRANCH_NAME}
+git checkout -b "${BRANCH_NAME}"
 
-git add $VERSIONS_FILE
+git add "$VERSIONS_FILE"
 
 if [[ "$CODE_BASE" == "CE" ]]; then
   git commit --message="feat(version) added Kong open source version $ADD_VERSION"
@@ -96,14 +98,15 @@ else
 fi
 
 # add the artifacts and the second commit
-source ${LOCAL_PATH}/assets/update_versions.sh
+# shellcheck source=./assets/update_versions.sh
+source "${LOCAL_PATH}/assets/update_versions.sh"
 update_artifacts
 
 if [[ ! "$?" == "99" ]]; then
   warn "Nothing was updated? nothing to commit. Please check the version"
   warn "you have added to be a valid one."
-  git checkout $PREVIOUS_BRANCH &> /dev/null
-  git branch -D $BRANCH_NAME &> /dev/null
+  git checkout "$PREVIOUS_BRANCH" &> /dev/null
+  git branch -D "$BRANCH_NAME" &> /dev/null
   exit 1
 fi
 
@@ -117,9 +120,9 @@ fi
 
 # push to remote and create a PR
 if [[ "$DRY_RUN" == "" ]]; then
-  git push --set-upstream origin $BRANCH_NAME
+  git push --set-upstream origin "$BRANCH_NAME"
   if [[ ! $? -eq 0 ]]; then
-    git checkout $PREVIOUS_BRANCH &> /dev/null
+    git checkout "$PREVIOUS_BRANCH" &> /dev/null
     err "Failed to push the branch '$BRANCH_NAME' to the remote git repo"
   fi
 else
@@ -129,8 +132,8 @@ msg "Now creating a Github pull-request:"
 if [[ "$DRY_RUN" == "" ]]; then
   hub pull-request --no-edit
   if [[ ! $? -eq 0 ]]; then
-    git checkout $PREVIOUS_BRANCH &> /dev/null
-    git branch -D $BRANCH_NAME &> /dev/null
+    git checkout "$PREVIOUS_BRANCH" &> /dev/null
+    git branch -D "$BRANCH_NAME" &> /dev/null
     err "Failed to create a PR from the '$BRANCH_NAME' branch"
   fi
 else
@@ -141,8 +144,8 @@ msg "Success! A new branch '$BRANCH_NAME' was pushed to the repo (and a PR creat
 msg "with the following commits:"
 git log --oneline -2
 echo
-git checkout $PREVIOUS_BRANCH &> /dev/null
-git branch -D $BRANCH_NAME &> /dev/null
+git checkout "$PREVIOUS_BRANCH" &> /dev/null
+git branch -D "$BRANCH_NAME" &> /dev/null
 msg "done. Goto https://github.com/kong/kong-pongo/pulls to checkout the new PR."
 if [[ ! "$DRY_RUN" == "" ]]; then
   warn "test-run completed, nothing was written! re-run without 'test' to push the changes."

assets/set_variables.sh

@@ -7,23 +7,24 @@ NIGHTLY_CE=nightly
 NIGHTLY_EE=nightly-ee
 
 function err {
-  >&2 echo -e "\033[0;31m[pongo-ERROR] $@\033[0m"
+  >&2 echo -e "\033[0;31m[pongo-ERROR] $*\033[0m"
   exit 1
 }
 
 
 function warn {
-  >&2 echo -e "\033[0;33m[pongo-WARN] $@\033[0m"
+  >&2 echo -e "\033[0;33m[pongo-WARN] $*\033[0m"
 }
 
 
 function msg {
-  >&2 echo -e "\033[0;36m[pongo-INFO] $@\033[0m"
+  >&2 echo -e "\033[0;36m[pongo-INFO] $*\033[0m"
 }
 
 
 # read config from Pongo RC file
 if [[ -f $PONGORC_FILE ]]; then
+  # shellcheck disable=SC2016  # expansion in single quotes: a false positive
   IFS=$'\r\n' GLOBIGNORE='*' command eval  'PONGORC_ARGS=($(cat $PONGORC_FILE))'
 fi
 #echo ".pongorc content:   ${PONGORC_ARGS[@]}"
@@ -33,6 +34,7 @@ fi
 if [[ ! -f $LOCAL_PATH/assets/kong_EE_versions.ver ]]; then
   err "$LOCAL_PATH/assets/kong_EE_versions.ver file is missing!"
 fi
+# shellcheck disable=SC2016  # expansion in single quotes: a false positive
 IFS=$'\r\n' GLOBIGNORE='*' command eval  'KONG_EE_VERSIONS=($(cat $LOCAL_PATH/assets/kong_EE_versions.ver))'
 #echo "Current list:   ${KONG_EE_VERSIONS[@]}"
 
@@ -41,25 +43,31 @@ IFS=$'\r\n' GLOBIGNORE='*' command eval  'KONG_EE_VERSIONS=($(cat $LOCAL_PATH/as
 if [[ ! -f $LOCAL_PATH/assets/kong_CE_versions.ver ]]; then
   err "$LOCAL_PATH/assets/kong_CE_versions.ver file is missing!"
 fi
+# shellcheck disable=SC2016  # expansion in single quotes: a false positive
 IFS=$'\r\n' GLOBIGNORE='*' command eval  'KONG_CE_VERSIONS=($(cat $LOCAL_PATH/assets/kong_CE_versions.ver))'
 #echo "Current list:   ${KONG_CE_VERSIONS[@]}"
 
 
-# Create a new array with all versions combined
+# Create a new array with all versions combined (wrap in function for local vars)
 KONG_VERSIONS=()
-for VERSION in ${KONG_EE_VERSIONS[*]}; do
-  KONG_VERSIONS+=("$VERSION")
-done;
-for VERSION in ${KONG_CE_VERSIONS[*]}; do
-  KONG_VERSIONS+=("$VERSION")
-done;
+function create_all_versions_array {
+  local VERSION
+  for VERSION in ${KONG_EE_VERSIONS[*]}; do
+    KONG_VERSIONS+=("$VERSION")
+  done;
+  for VERSION in ${KONG_CE_VERSIONS[*]}; do
+    KONG_VERSIONS+=("$VERSION")
+  done;
+}
+create_all_versions_array
 
 # take the last one as the default
+# shellcheck disable=SC2034  # Unused variable: this script is 'sourced', so a false positive
 KONG_DEFAULT_VERSION="${KONG_CE_VERSIONS[ ${#KONG_CE_VERSIONS[@]}-1 ]}"
 
-
 function is_enterprise {
   local check_version=$1
+  local VERSION
   for VERSION in ${KONG_EE_VERSIONS[*]} $NIGHTLY_EE; do
     if [[ "$VERSION" == "$check_version" ]]; then
       return 0
@@ -70,6 +78,7 @@ function is_enterprise {
 
 function is_nightly {
   local check_version=$1
+  local VERSION
   for VERSION in $NIGHTLY_CE $NIGHTLY_EE; do
     if [[ "$VERSION" == "$check_version" ]]; then
       return 0
@@ -80,6 +89,7 @@ function is_nightly {
 
 function version_exists {
   local version=$1
+  local entry
   for entry in ${KONG_VERSIONS[*]} $NIGHTLY_CE $NIGHTLY_EE ; do
     if [[ "$version" == "$entry" ]]; then
       return 0
@@ -92,6 +102,7 @@ function version_exists {
 function resolve_version {
   if [[ "${KONG_VERSION: -1}" == "x" ]]; then
     local new_version=$KONG_VERSION
+    local entry
     for entry in ${KONG_VERSIONS[*]}; do
       if [[ "${KONG_VERSION:0:${#KONG_VERSION}-1}" == "${entry:0:${#entry}-1}" ]]; then
         # keep replacing, last one wins

assets/test_plugin_entrypoint.sh

@@ -62,21 +62,22 @@ elif [ -f /kong-plugin/.pongo-setup.sh ]; then
 else
   pongo_setup=none
 fi
-if [ "$pongo_setup" == "none" ]; then
+if [ "$pongo_setup" = "none" ]; then
   # if there is a rockspec, then install it first, so we get any required
   # dependencies installed before testing
   find /kong-plugin -maxdepth 1 -type f -name '*.rockspec' -exec luarocks install --only-deps {} \;
 else
   old_entry_pwd=$(pwd)
-  cd /kong-plugin
-  source $pongo_setup
-  cd $old_entry_pwd
+  cd /kong-plugin || { echo "Failure to enter /kong-plugin"; exit 1; }
+  # shellcheck source=/dev/null  # not checking this since it is user provided
+  . $pongo_setup
+  cd "$old_entry_pwd" || { echo "Failure to enter $old_entry_pwd"; exit 1; }
   unset old_entry_pwd
 fi
 unset pongo_setup
 
 
-if [ ! "$SUPPRESS_KONG_VERSION" == "true" ]; then
+if [ ! "$SUPPRESS_KONG_VERSION" = "true" ]; then
   echo "Kong version: $(kong version)"
 fi