[#876] make shell changes suggested by shellcheck

Author: andrei-pavel

backend/server/restservice/middleware.go

@@ -129,7 +129,7 @@ func sseMiddleware(next http.Handler, eventCenter eventcenter.EventCenter) http.
 // Install a middleware that is serving Agent installer.
 func agentInstallerMiddleware(next http.Handler, staticFilesDir string) http.Handler {
 	// Agent installer as Bash script.
-	const agentInstallerScript = `#!/bin/bash
+	const agentInstallerScript = `#!/bin/sh
 set -e -x
 
 rm -f /tmp/isc-stork-agent.{deb,rpm,apk}

docker/images/stork.Dockerfile

@@ -65,7 +65,7 @@ RUN apt-get update \
 #############
 
 # Install main dependencies
-FROM base AS prepare 
+FROM base AS prepare
 WORKDIR /app/rakelib
 COPY rakelib/00_init.rake ./
 WORKDIR /app/rakelib/init_deps
@@ -218,7 +218,7 @@ RUN apt-get update \
         --no-install-recommends \
         curl=7.64.* \
         prometheus-node-exporter=0.17.* \
-        default-mysql-client=1.0.* \ 
+        default-mysql-client=1.0.* \
         postgresql-client=11+* \
         apt-transport-https=1.8.* \
         gnupg=2.2.* \
@@ -272,7 +272,7 @@ RUN [ "${KEA_PREMIUM}" != "premium" ] || ( \
 # for this stage.
 # hadolint ignore=DL3006
 FROM kea${KEA_PREMIUM}-base AS kea
-# Install agent    
+# Install agent
 COPY --from=agent-builder /app/dist/agent /
 # Database
 WORKDIR /var/lib/db
@@ -284,7 +284,7 @@ ENV DB_HOST=172.20.0.115
 ENV DB_USER=kea
 ENV DB_PASSWORD=kea
 ENV DB_NAME=kea
-ENTRYPOINT [ "/bin/bash", "-c", \
+ENTRYPOINT [ "/bin/sh", "-c", \
         "/var/lib/db/init_db.sh && supervisord -c /etc/supervisor/supervisord.conf" ]
 # Incoming port
 EXPOSE 8080
@@ -324,7 +324,7 @@ RUN apt-get update \
         && mkdir -p /var/lib/stork-agent \
         && chown bind:bind /var/lib/stork-agent \
         && chmod 755 /var/lib/stork-agent
-# Install agent    
+# Install agent
 COPY --from=agent-builder /app/dist/agent/usr/bin /usr/bin
 # Use dedicated bind user
 USER bind

docker/init/init_db.sh

@@ -1,13 +1,18 @@
 #!/bin/bash
+
+set -eu
+
 # Script directory
-__dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+__dir="$(cd "$(dirname "${0}")" && pwd)"
 
 # Select the specific script. It must be done in a shell script,
 # not in the Dockerfile, An environment variable substitution in
 # Dockerfile is done during the build phase, but in the shell script
 # in runtime.
-if [ "$DB_TYPE" == "pgsql" ] || [ "$DB_TYPE" == "mysql" ]; then
-    source ${__dir}/init_${DB_TYPE}_db.sh
+if [ "$DB_TYPE" = "pgsql" ] || [ "$DB_TYPE" = "mysql" ]; then
+    # shellcheck source=./docker/init/init_mysql_db.sh
+    # shellcheck source=./docker/init/init_pgsql_db.sh
+    . "${__dir}/init_${DB_TYPE}_db.sh"
 elif [ "$DB_TYPE" != "none" ]; then
     echo "Unknown DB_TYPE value: ${DB_TYPE}"
     exit 1

docker/init/init_mysql_db.sh

@@ -1,3 +1,7 @@
+#!/bin/bash
+
+set -eu
+
 echo "Database type: ${DB_TYPE}"
 
 until mysqladmin ping -h"${DB_HOST}" --silent;
@@ -10,20 +14,21 @@ echo "CREATE USER"
 
 create_user_query="CREATE USER IF NOT EXISTS '${DB_USER}'@'%' IDENTIFIED BY '${DB_PASSWORD}';"
 mysql \
-    --user=${DB_ROOT_USER} \
-    --password=${DB_ROOT_PASSWORD} \
-    --host=${DB_HOST} \
-    -e "$create_user_query"
+    --user="${DB_ROOT_USER}" \
+    --password="${DB_ROOT_PASSWORD}" \
+    --host="${DB_HOST}" \
+    -e "${create_user_query}"
 
 echo "Checking if the database exists"
 
+exist_query="USE ${DB_NAME}"
+set +e
 mysql \
-    --user=${DB_ROOT_USER} \
-    --password=${DB_ROOT_PASSWORD} \
-    --host=${DB_HOST} \
-    -e "$exist_query" \
-    ${DB_NAME}
-
+    --user="${DB_ROOT_USER}" \
+    --password="${DB_ROOT_PASSWORD}" \
+    --host="${DB_HOST}" \
+    -e "${exist_query}" \
+    "${DB_NAME}"
 has_db=$?
 set -e
 
@@ -32,36 +37,38 @@ then
     echo "Create the database"
     create_db_query="CREATE DATABASE ${DB_NAME};"
     mysql \
-        --user=${DB_ROOT_USER} \
-        --password=${DB_ROOT_PASSWORD} \
-        --host=${DB_HOST} \
+        --user="${DB_ROOT_USER}" \
+        --password="${DB_ROOT_PASSWORD}" \
+        --host="${DB_HOST}" \
         -e "$create_db_query"
 fi
 
 grant_query="GRANT ALL PRIVILEGES ON ${DB_NAME}.* TO '${DB_USER}'@'%';"
 mysql \
-    --user=${DB_ROOT_USER} \
-    --password=${DB_ROOT_PASSWORD} \
-    --host=${DB_HOST} \
-    -e "$grant_query"
+    --user="${DB_ROOT_USER}" \
+    --password="${DB_ROOT_PASSWORD}" \
+    --host="${DB_HOST}" \
+    -e "${grant_query}"
 
 if [ $has_db -eq 0 ]
 then
     exit 0
 fi
 
 echo "Initializing the database"
-kea-admin db-init ${DB_TYPE} \
-    -u ${DB_USER} \
-    -p ${DB_PASSWORD} \
-    -n ${DB_NAME} \
-    -h ${DB_HOST}
+kea-admin db-init "${DB_TYPE}" \
+    -u "${DB_USER}" \
+    -p "${DB_PASSWORD}" \
+    -n "${DB_NAME}" \
+    -h "${DB_HOST}"
 
 echo "Seed database"
-seed_file="${BASH_SOURCE%/*}/init_mysql_query.sql"
+path=$(dirname "${BASH_SOURCE[0]}")
+seed_file="${path}/init_mysql_query.sql"
 
 mysql \
-    --user=${DB_ROOT_USER} \
-    --password=${DB_ROOT_PASSWORD} \
-    --host=${DB_HOST} \
-    ${DB_NAME} < $seed_file
+    --user="${DB_ROOT_USER}" \
+    --password="${DB_ROOT_PASSWORD}" \
+    --host="${DB_HOST}" \
+    "${DB_NAME}" \
+    < "${seed_file}"

docker/init/init_pgsql_db.sh

@@ -1,6 +1,10 @@
+#!/bin/bash
+
+set -eu
+
 echo "Database type: ${DB_TYPE}"
 
-until PGPASSWORD=${DB_ROOT_PASSWORD} psql -h ${DB_HOST} -U ${DB_ROOT_USER} -c "SELECT 1" > /dev/null 2>&1;
+until PGPASSWORD=${DB_ROOT_PASSWORD} psql -h "${DB_HOST}" -U "${DB_ROOT_USER}" -c "SELECT 1" > /dev/null 2>&1;
 do
     echo "Waiting for database connection..."
     sleep 5
@@ -11,19 +15,20 @@ echo "CREATE USER"
 create_user_query="CREATE USER ${DB_USER} WITH PASSWORD '${DB_PASSWORD}';"
 PGPASSWORD=${DB_ROOT_PASSWORD} \
 psql \
-    -U ${DB_ROOT_USER} \
-    -h ${DB_HOST} \
-    -c "$create_user_query"
+    -U "${DB_ROOT_USER}" \
+    -h "${DB_HOST}" \
+    -c "${create_user_query}"
 
 echo "Checking if the database exists"
 
+exist_query="\c ${DB_NAME}"
+set +e
 PGPASSWORD=${DB_ROOT_PASSWORD} \
 psql \
-        -U ${DB_ROOT_USER} \
-        -h ${DB_HOST} \
-        -d ${DB_NAME} \
-        -c "$exist_query"
-
+    -U "${DB_ROOT_USER}" \
+    -h "${DB_HOST}" \
+    -d "${DB_NAME}" \
+    -c "${exist_query}"
 has_db=$?
 set -e
 
@@ -33,35 +38,37 @@ then
     create_db_query="CREATE DATABASE ${DB_NAME};"
     PGPASSWORD=${DB_ROOT_PASSWORD} \
     psql \
-        -U ${DB_ROOT_USER} \
-        -h ${DB_HOST} \
-        -c "$create_db_query"
+        -U "${DB_ROOT_USER}" \
+        -h "${DB_HOST}" \
+        -c "${create_db_query}"
 fi
 
 grant_query="GRANT ALL PRIVILEGES ON DATABASE ${DB_NAME} TO ${DB_USER};"
 PGPASSWORD=${DB_ROOT_PASSWORD} \
 psql \
-    -U ${DB_ROOT_USER} \
-    -h ${DB_HOST} \
-    -c "$grant_query"
+    -U "${DB_ROOT_USER}" \
+    -h "${DB_HOST}" \
+    -c "${grant_query}"
 
 if [ $has_db -eq 0 ]
 then
     exit 0
 fi
 
 echo "Initializing the database"
-kea-admin db-init ${DB_TYPE} \
-    -u ${DB_USER} \
-    -p ${DB_PASSWORD} \
-    -n ${DB_NAME} \
-    -h ${DB_HOST}
+kea-admin db-init "${DB_TYPE}" \
+    -u "${DB_USER}" \
+    -p "${DB_PASSWORD}" \
+    -n "${DB_NAME}" \
+    -h "${DB_HOST}"
 
 echo "Seed database"
-seed_file="${BASH_SOURCE%/*}/init_pgsql_query.sql"
+path=$(dirname "${BASH_SOURCE[0]}")
+seed_file="${path}/init_pgsql_query.sql"
 
 PGPASSWORD=${DB_ROOT_PASSWORD} \
 psql \
-    -U ${DB_ROOT_USER} \
-    -h ${DB_HOST} \
-    -d ${DB_NAME} < $seed_file
+    -U "${DB_ROOT_USER}" \
+    -h "${DB_HOST}" \
+    -d "${DB_NAME}" \
+    < "${seed_file}"

etc/hooks/apk/isc-stork-agent.postinst

@@ -1,25 +1,27 @@
 #!/bin/sh
 
-set -e
+set -eu
 
 # create folders for storing certs and agent token,
 # they should be available to owner ie. stork-agent user
 home_dir=/var/lib/stork-agent
-mkdir -p -m 700 $home_dir/certs
-mkdir -p -m 700 $home_dir/tokens
+mkdir -p "${home_dir}/certs"
+mkdir -p "${home_dir}/tokens"
+chmod 700 "${home_dir}/certs"
+chmod 700 "${home_dir}/tokens"
 
 addgroup -S stork-agent >/dev/null
-adduser -h $home_dir -D -S -H -g "Stork Agent User" -G stork-agent stork-agent >/dev/null
+adduser -h "${home_dir}" -D -S -H -g "Stork Agent User" -G stork-agent stork-agent >/dev/null
 
 # add stork-agent user to bind so it can read its config files
-if [ $(getent group bind) ]; then
+if getent group bind > /dev/null; then
     addgroup stork-agent bind
 fi
 
 # add stork-agent user to kea so it can read its config files
-if [ $(getent group _kea) ]; then
+if getent group _kea > /dev/null; then
     addgroup stork-agent _kea
 fi
 
 # change ownership of all folders and files in home dir to stork-agent user
-chown -R stork-agent $home_dir
+chown -R stork-agent "${home_dir}"

etc/hooks/apk/isc-stork-agent.postrm

@@ -1,3 +1,5 @@
 #!/bin/sh
 
+set -eu
+
 deluser stork-agent >/dev/null || /bin/true

etc/hooks/apk/isc-stork-agent.prerm

@@ -1,3 +1,5 @@
 #!/bin/sh
 
+set -eu
+
 groups stork-agent | xargs -n 1 | grep -v stork-agent | xargs -r -n 1 delgroup stork-agent

etc/hooks/apk/isc-stork-server.postinst

@@ -1,6 +1,8 @@
 #!/bin/sh
 
-set -e
+set -eu
+
+home_dir=/var/lib/stork-server
 
 addgroup -S stork-server >/dev/null
-adduser -h $home_dir -D -S -H -g "Stork Server User" -G stork-server stork-server >/dev/null
+adduser -h "${home_dir}" -D -S -H -g "Stork Server User" -G stork-server stork-server >/dev/null

etc/hooks/apk/isc-stork-server.postrm

@@ -1,3 +1,5 @@
 #!/bin/sh
 
+set -eu
+
 deluser stork-server >/dev/null || /bin/true

etc/hooks/deb/isc-stork-agent.postinst

@@ -1,27 +1,29 @@
 #!/bin/sh
 
-set -e
+set -eu
 
 # create folders for storing certs and agent token,
 # they should be available to owner ie. stork-agent user
 home_dir=/var/lib/stork-agent
-mkdir -p -m 700 $home_dir/certs
-mkdir -p -m 700 $home_dir/tokens
+mkdir -p "${home_dir}/certs"
+mkdir -p "${home_dir}/tokens"
+chmod 700 "${home_dir}/certs"
+chmod 700 "${home_dir}/tokens"
 
 # add stork-agent user
 adduser --quiet --system --group --home $home_dir \
         --no-create-home --disabled-password --disabled-login \
         --gecos "Stork Agent User" stork-agent >/dev/null
 
 # add stork-agent user to bind so it can read its config files
-if [ $(getent group bind) ]; then
+if getent group bind > /dev/null; then
     usermod -aG bind stork-agent
 fi
 
 # add stork-agent user to kea so it can read its config files
-if [ $(getent group _kea) ]; then
+if getent group _kea > /dev/null; then
     usermod -aG _kea stork-agent
 fi
 
 # change ownership of all folders and files in home dir to stork-agent user
-chown -R stork-agent $home_dir
+chown -R stork-agent "${home_dir}"

etc/hooks/deb/isc-stork-agent.postrm

@@ -1,3 +1,5 @@
 #!/bin/sh
 
+set -eu
+
 deluser --system stork-agent >/dev/null || /bin/true

etc/hooks/deb/isc-stork-agent.prerm

@@ -1,9 +1,11 @@
 #!/bin/sh
 
+set -eu
+
 has_active_systemd=0
-if [ -x "$(command -v systemctl)" ]; then
-    status=$(systemctl is-system-running)
-    if [ $status = "running" ] || [ $status = "degraded" ] || [ $status = "maintenance" ]; then
+if command -v systemctl > /dev/null; then
+    status=$(systemctl is-system-running || true)
+    if [ "${status}" = "running" ] || [ "${status}" = "degraded" ] || [ "${status}" = "maintenance" ]; then
         has_active_systemd=1
     fi
 fi

etc/hooks/deb/isc-stork-server.postinst

@@ -1,6 +1,6 @@
 #!/bin/sh
 
-set -e
+set -eu
 
 adduser --quiet --system --group --home /var/lib/ \
         --no-create-home --disabled-password --disabled-login \