*: apply shellcheck suggestions to all shellscripts

Author: paulfantom

docker-compose/high-availability/test.sh

@@ -14,8 +14,8 @@
 
 set -euf -o pipefail
 
-SELF_DIR=$(cd $(dirname ${0}) && pwd)
-cd $SELF_DIR
+SELF_DIR="$(cd "$(dirname "${0}")" && pwd)"
+cd "$SELF_DIR"
 
 echo "running tests"
 
@@ -39,9 +39,9 @@ leader_name() {
 }
 
 is_leader() {
-    LEADER1=$(leader_name "promscale_deploy_ha-promscale-connector1-1")
-    LEADER2=$(leader_name "promscale_deploy_ha-promscale-connector2-1")
-    if [[ "$LEADER1" == $1 && "$LEADER2" == $1 ]]; then
+    LEADER1="$(leader_name "promscale_deploy_ha-promscale-connector1-1")"
+    LEADER2="$(leader_name "promscale_deploy_ha-promscale-connector2-1")"
+    if [[ "$LEADER1" == "$1" ]] && [[ "$LEADER2" == "$1" ]]; then
         true
     else
         false
@@ -73,6 +73,7 @@ wait_for() {
 wait_for_leader() {
     echo "waiting for $1 to be leader"
 
+    # shellcheck disable=SC2034
     for i in `seq 10` ; do
         if is_leader "$1"; then
           echo "$1 is leader"

docker-compose/test.sh

@@ -2,8 +2,8 @@
 
 set -euf -o pipefail
 
-SELF_DIR=$(cd $(dirname ${0}) && pwd)
-cd $SELF_DIR
+SELF_DIR="$(cd "$(dirname "${0}")" && pwd)"
+cd "$SELF_DIR"
 
 echo "running tests"
 

docs/scripts/install-crontab.sh

@@ -1,2 +1,2 @@
-#/bin/sh
+#!/bin/sh
 echo "0,30 * * * * /<ABSOLUTE_PATH>/prom-execute-maintenance.sh" | crontab -

docs/scripts/prom-execute-maintenance.sh

@@ -1,3 +1,3 @@
-#/bin/sh
-export PGPASSWORD=<PASSWORD>
+#!/bin/sh
+export PGPASSWORD="<PASSWORD>"
 psql --host localhost --port 5432 --dbname postgres --user postgres -c 'CALL prom_api.execute_maintenance();'

scripts/end_to_end_tests.sh

@@ -11,9 +11,9 @@ case "${unameOut}" in
     *)          ISMAC=0;;
 esac
 
-TIMESCALE_IMAGE=${1:-"timescale/timescaledb:latest-pg14"}
-SCRIPT_DIR=$(cd $(dirname ${0}) && pwd)
-ROOT_DIR=$(dirname ${SCRIPT_DIR})
+TIMESCALE_IMAGE="${1:-"timescale/timescaledb:latest-pg14"}"
+SCRIPT_DIR="$(cd "$(dirname "${0}")" && pwd)"
+ROOT_DIR=$(dirname "${SCRIPT_DIR}")
 DB_URL="localhost:5432"
 CONNECTOR_URL="localhost:9201"
 PROM_URL="localhost:9090"
@@ -28,11 +28,12 @@ fi
 
 CONF=$(mktemp)
 
-chmod 777 $CONF
+chmod 777 "$CONF"
 
 echo "running tests against ${TIMESCALE_IMAGE}"
 
-echo "scrape_configs:
+cat << EOF > "$CONF"
+scrape_configs:
   - job_name: 'connector'
     scrape_interval: 5s
     static_configs:
@@ -44,17 +45,18 @@ remote_read:
 
 remote_write:
 - url: http://$CONNECTOR_URL_CONTAINER/write
-  remote_timeout: 1m" > $CONF
+  remote_timeout: 1m
+EOF
 
 cleanup() {
-    if [[ $PASSED -ne 6 ]]; then
+    if [[ "$PASSED" -ne 6 ]]; then
         docker logs e2e-tsdb || true
     fi
-    rm $CONF || true
+    rm "$CONF" || true
     docker stop e2e-prom || true
     docker stop e2e-tsdb || true
     if [ -n "$CONN_PID" ]; then
-        kill $CONN_PID
+        kill "$CONN_PID"
     fi
 }
 
@@ -135,7 +137,7 @@ curl -v \
     "${CONNECTOR_URL}/write"
 
 
-kill $CONN_PID
+kill "$CONN_PID"
 
 PROMSCALE_TELEMETRY_LOG_LEVEL=debug \
 PROMSCALE_DB_PASSWORD=test \
@@ -158,7 +160,7 @@ curl -f \
     --data "custom_metric{custom_label=\"custom_value_2\"} 5" \
     "${CONNECTOR_URL}/write" || exit 1
 
-kill $CONN_PID
+kill "$CONN_PID"
 
 PROMSCALE_TELEMETRY_LOG_LEVEL=debug \
 PROMSCALE_DB_PASSWORD=test \
@@ -188,8 +190,6 @@ compare_connector_and_prom() {
     fi
 }
 
-END_TIME=$(date +"%s")
-
 DATASET_START_TIME="2020-08-10T10:35:20Z"
 DATASET_END_TIME="2020-08-10T11:43:50Z"
 
@@ -224,7 +224,7 @@ echo "Passed: $PASSED"
 echo "Failed: $FAILED"
 
 
-if [[ $FAILED -eq 0 ]]; then
+if [[ "$FAILED" -eq 0 ]]; then
     exit 0
 else
     exit 1

scripts/generate-deploy-script.sh

@@ -4,9 +4,17 @@ if [ -n "$DEBUG" ]; then
 	set -x
 fi
 
-DIR=$(cd $(dirname "${BASH_SOURCE}") && pwd -P)
-HELMDIR="${DIR}/../deploy/helm-chart"
+# Execute whole script from repository top level
+cd "$(git rev-parse --show-toplevel)"
 
+OUTPUT_FILE="deploy/static/deploy.yaml"
+
+# Default to promscale helm release name i.e. adds the label values as promscale
+RELEASE_NAME=promscale
+# Default to to default namespace
+NAMESPACE=default
+
+HELMDIR="deploy/helm-chart"
 # Default values.yaml file to provide to helm template command.
 FILE_ARG="${HELMDIR}/values.yaml"
 
@@ -21,15 +29,6 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
-# Default to promscale helm release name i.e. adds the label values as promscale
-RELEASE_NAME=promscale
-# Default to to default namespace
-NAMESPACE=default
-
-helm dependency update ${HELMDIR}
-
-OUTPUT_FILE="${DIR}/../deploy/static/deploy.yaml"
-cat << EOF | helm template $RELEASE_NAME ${HELMDIR} --namespace $NAMESPACE --values $FILE_ARG > ${OUTPUT_FILE}
-EOF
+helm dependency update "${HELMDIR}"
 
-echo "$(cat ${OUTPUT_FILE})" > ${OUTPUT_FILE}
+helm template "$RELEASE_NAME" "${HELMDIR}" --namespace "$NAMESPACE" --values "$FILE_ARG" | tee "${OUTPUT_FILE}"

scripts/wait-for.sh

@@ -9,6 +9,7 @@ echoerr() {
 }
 
 usage() {
+  cmdname=${0}
   exitcode="$1"
   cat << USAGE >&2
 Usage:
@@ -21,7 +22,8 @@ USAGE
 }
 
 wait_for() {
-  for i in `seq $TIMEOUT` ; do
+  # shellcheck disable=SC2034
+  for i in $(seq $TIMEOUT) ; do
     nc -z "$HOST" "$PORT" > /dev/null 2>&1
 
     result=$?
@@ -72,7 +74,7 @@ do
   esac
 done
 
-if [ "$HOST" = "" -o "$PORT" = "" ]; then
+if [ "$HOST" = "" ] || [ "$PORT" = "" ]; then
   echoerr "Error: you need to provide a host and port to test."
   usage 2
 fi