Fix shellcheck tests failing

DitZii · Oct 2, 2023 · 5ed595b · 5ed595b
1 parent e21e0c8
commit 5ed595b
Show file tree

Hide file tree

Showing 79 changed files with 595 additions and 290 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
-exclude: (^LICENSE.md$|^src/VERSION$|^src/(bw/misc/root-ca.pem$|deps/src/|common/core/modsecurity/files/coreruleset/|ui/static/js/(editor/|utils/purify/|tsparticles\.bundle\.min\.js))|\.(svg|drawio|patch\d?|ascii|tf|tftpl)$)
+exclude: (^LICENSE.md$|^src/VERSION$|^src/(bw/misc/root-ca.pem$|deps/src/|common/core/modsecurity/files|ui/static/js/(editor/|utils/purify/|tsparticles\.bundle\.min\.js))|\.(svg|drawio|patch\d?|ascii|tf|tftpl)$)
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
@@ -17,12 +17,12 @@ repos:
       - id: black
         language_version: python3.9
 
-  - repo: https://github.com/koalaman/shellcheck-precommit
-    rev: v0.9.0
-    hooks:
-      - id: shellcheck
-
   - repo: https://github.com/gitleaks/gitleaks
     rev: v8.18.0
     hooks:
       - id: gitleaks
+
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.9.0
+    hooks:
+      - id: shellcheck
diff --git a/examples/authelia/setup-linux.sh b/examples/authelia/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/behind-reverse-proxy/cleanup-linux.sh b/examples/behind-reverse-proxy/cleanup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/behind-reverse-proxy/setup-linux.sh b/examples/behind-reverse-proxy/setup-linux.sh
@@ -1,16 +1,16 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi
 
 DNF=$(which dnf)
 APT=$(which apt)
 
-if [ ! -z $DNF ] ; then
+if [ -n "$DNF" ] ; then
 	dnf install -y haproxy
-elif [ ! -z $APT ] ; then
+elif [ -n "$APT" ] ; then
 	apt install -y haproxy
 fi
 

diff --git a/examples/certbot-dns-cloudflare/entrypoint.sh b/examples/certbot-dns-cloudflare/entrypoint.sh
@@ -2,7 +2,7 @@
 
 echo "Certbot started, domains = $DOMAINS"
 
-first_domain="$(echo -n $DOMAINS | cut -d ',' -f 1 | sed 's/*\.//g')"
+first_domain="$(echo "$DOMAINS" | tr -d '\n' | cut -d ',' -f 1 | sed 's/*\.//g')"
 if [ "$EMAIL" = "" ] ; then
 	EMAIL="contact@${first_domain}"
 fi

diff --git a/examples/certbot-dns-digitalocean/entrypoint.sh b/examples/certbot-dns-digitalocean/entrypoint.sh
@@ -2,7 +2,7 @@
 
 echo "Certbot started, domains = $DOMAINS"
 
-first_domain="$(echo -n $DOMAINS | cut -d ',' -f 1 | sed 's/*\.//g')"
+first_domain="$(echo "$DOMAINS" | tr -d '\n' | cut -d ',' -f 1 | sed 's/*\.//g')"
 if [ "$EMAIL" = "" ] ; then
 	EMAIL="contact@${first_domain}"
 fi

diff --git a/examples/certbot-dns-google/entrypoint.sh b/examples/certbot-dns-google/entrypoint.sh
@@ -2,7 +2,7 @@
 
 echo "Certbot started, domains = $DOMAINS"
 
-first_domain="$(echo -n $DOMAINS | cut -d ',' -f 1 | sed 's/*\.//g')"
+first_domain="$(echo "$DOMAINS" | tr -d '\n' | cut -d ',' -f 1 | sed 's/*\.//g')"
 if [ "$EMAIL" = "" ] ; then
 	EMAIL="contact@${first_domain}"
 fi

diff --git a/examples/certbot-dns-ovh/entrypoint.sh b/examples/certbot-dns-ovh/entrypoint.sh
@@ -2,7 +2,7 @@
 
 echo "Certbot started, domains = $DOMAINS"
 
-first_domain="$(echo -n $DOMAINS | cut -d ',' -f 1 | sed 's/*\.//g')"
+first_domain="$(echo "$DOMAINS" | tr -d '\n' | cut -d ',' -f 1 | sed 's/*\.//g')"
 if [ "$EMAIL" = "" ] ; then
 	EMAIL="contact@${first_domain}"
 fi

diff --git a/examples/certbot-dns-route53/entrypoint.sh b/examples/certbot-dns-route53/entrypoint.sh
@@ -2,7 +2,7 @@
 
 echo "Certbot started, domains = $DOMAINS"
 
-first_domain="$(echo -n $DOMAINS | cut -d ',' -f 1 | sed 's/*\.//g')"
+first_domain="$(echo "$DOMAINS" | tr -d '\n' | cut -d ',' -f 1 | sed 's/*\.//g')"
 if [ "$EMAIL" = "" ] ; then
 	EMAIL="contact@${first_domain}"
 fi

diff --git a/examples/cors/setup-autoconf.sh b/examples/cors/setup-autoconf.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/cors/setup-docker.sh b/examples/cors/setup-docker.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/cors/setup-linux.sh b/examples/cors/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/drupal/setup-linux.sh b/examples/drupal/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi
@@ -16,11 +16,11 @@ fi
 curl https://ftp.drupal.org/files/projects/drupal-9.5.3.tar.gz -Lo /tmp/drupal.tar.gz
 tar -xzf /tmp/drupal.tar.gz -C /tmp
 current_dir="$(pwd)"
-cd /tmp/drupal-*
-cp -r * /var/www/html
+cd /tmp/drupal-* || exit 1
+cp -r ./* /var/www/html
 chown -R $user:nginx /var/www/html
 find /var/www/html -type f -exec chmod 0640 {} \;
 find /var/www/html -type d -exec chmod 0750 {} \;
-cd "$current_dir"
+cd "$current_dir" || exit 1
 cp -r ./bw-data/configs/* /etc/bunkerweb/configs
 chown -R nginx:nginx /etc/bunkerweb/configs
diff --git a/examples/joomla/setup-linux.sh b/examples/joomla/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/mattermost/setup-autoconf.sh b/examples/mattermost/setup-autoconf.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/mattermost/setup-docker.sh b/examples/mattermost/setup-docker.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/moodle/setup-linux.sh b/examples/moodle/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/nextcloud/setup-linux.sh b/examples/nextcloud/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/php-cookie-flags/setup-docker.sh b/examples/php-cookie-flags/setup-docker.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/php-cookie-flags/setup-linux.sh b/examples/php-cookie-flags/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/php-multisite/setup-autoconf.sh b/examples/php-multisite/setup-autoconf.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/php-multisite/setup-docker.sh b/examples/php-multisite/setup-docker.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/php-multisite/setup-linux.sh b/examples/php-multisite/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/php-singlesite/setup-docker.sh b/examples/php-singlesite/setup-docker.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/php-singlesite/setup-linux.sh b/examples/php-singlesite/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/proxy-protocol/cleanup-linux.sh b/examples/proxy-protocol/cleanup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/examples/proxy-protocol/setup-linux.sh b/examples/proxy-protocol/setup-linux.sh
@@ -1,16 +1,16 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi
 
 DNF=$(which dnf)
 APT=$(which apt)
 
-if [ ! -z $DNF ] ; then
+if [ -n "$DNF" ] ; then
 	dnf install -y haproxy
-elif [ ! -z $APT ] ; then
+elif [ -n "$APT" ] ; then
 	apt install -y haproxy
 fi
 

diff --git a/examples/wordpress/setup-linux.sh b/examples/wordpress/setup-linux.sh
@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [ $(id -u) -ne 0 ] ; then
+if [ "$(id -u)" -ne 0 ] ; then
 	echo "❌ Run me as root"
 	exit 1
 fi

diff --git a/misc/update-version.sh b/misc/update-version.sh
@@ -1,30 +1,38 @@
-#/bin/bash
+#!/bin/bash
 
 if [ $# -ne 1 ] ; then
     echo "Missing version argument"
     exit 1
 fi
 
-OLD_VERSION="$(cat src/VERSION | tr -d '\n' | sed 's/\./\\./g' | sed 's/\-/\\-/g')"
+OLD_VERSION="$(tr -d '\n' < src/VERSION | sed 's/\./\\./g' | sed 's/\-/\\-/g')"
 NEW_VERSION="$(echo -n "$1" | sed 's/\./\\./g' | sed 's/\-/\\-/g')"
 
 # VERSION
-echo -en "$NEW_VERSION" | sed 's/\\//g' > src/VERSION
+echo -en "$NEW_VERSION" | sed 's/\\//g' | tee src/VERSION
 # integrations
 sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" misc/integrations/*.yml
 # examples
+shopt -s globstar
 for example in examples/* ; do
-    sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" ${example}/*.yml
+    if [ -d "$test" ] ; then
+        sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" "$example/*.yml"
+    fi
 done
+shopt -u globstar
 # docs
 sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" docs/*.md
 # README
 sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" README.md
 # tests
 sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" tests/ui/docker-compose.yml
+shopt -s globstar
 for test in tests/core/* ; do
-    sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" ${test}/docker-compose.yml
+    if [ -d "$test" ] ; then
+        sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" "$test/docker-compose.yml"
+    fi
 done
+shopt -u globstar
 # linux
 sed -i "s@${OLD_VERSION}@${NEW_VERSION}@g" src/linux/scripts/*.sh
 # db

diff --git a/src/bw/entrypoint.sh b/src/bw/entrypoint.sh
@@ -1,9 +1,12 @@
 #!/bin/bash
 
+# shellcheck disable=SC1091
 . /usr/share/bunkerweb/helpers/utils.sh
 
-ascii_array=($(ls /usr/share/bunkerweb/misc/*.ascii))
-cat ${ascii_array[$(($RANDOM % ${#ascii_array[@]}))]}
+shopt -s nullglob
+ascii_array=(/usr/share/bunkerweb/misc/*.ascii)
+shopt -u nullglob
+cat "${ascii_array[$((RANDOM % ${#ascii_array[@]}))]}"
 
 log "ENTRYPOINT" "ℹ️" "Starting BunkerWeb v$(cat /usr/share/bunkerweb/VERSION) ..."
 
@@ -12,18 +15,23 @@ log "ENTRYPOINT" "ℹ️" "Starting BunkerWeb v$(cat /usr/share/bunkerweb/VERSIO
 
 # trap SIGTERM and SIGINT
 function trap_exit() {
-	log "ENTRYPOINT" "ℹ️" "Catched stop operation"
-	log "ENTRYPOINT" "ℹ️" "Stopping nginx ..."
+	# shellcheck disable=SC2317
+	log "ENTRYPOINT" "ℹ️" "Catched stop operation, stopping nginx ..."
+	# shellcheck disable=SC2317
 	nginx -s stop
 }
 trap "trap_exit" TERM INT QUIT
 
 # trap SIGHUP
 function trap_reload() {
+	# shellcheck disable=SC2317
 	log "ENTRYPOINT" "ℹ️" "Catched reload operation"
+	# shellcheck disable=SC2317
 	if [ -f /var/run/bunkerweb/nginx.pid ] ; then
+		# shellcheck disable=SC2317
 		log "ENTRYPOINT" "ℹ️" "Reloading nginx ..."
 		nginx -s reload
+		# shellcheck disable=SC2181,SC2317
 		if [ $? -eq 0 ] ; then
 			log "ENTRYPOINT" "ℹ️" "Reload successful"
 		else