Fix shellcheck

DefectDojo · Jan 11, 2024 · 3bbe6f3 · 3bbe6f3
1 parent 4bbc70f
commit 3bbe6f3
Show file tree

Hide file tree

Showing 22 changed files with 158 additions and 148 deletions.
diff --git a/dc-build.sh b/dc-build.sh
@@ -3,15 +3,16 @@
 bash ./docker/docker-compose-check.sh
 if [[ $? -eq 1 ]]; then exit 1; fi
 
+# Building images for all configurations
+# The docker build doesn't supply any environment variables to the Dockerfile, so we can use any profile.
+
 if [ $# -eq 0 ]
 then
     echo "Building docker compose"
+    # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
+    docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env build
 else
     echo "Building docker compose with additional parameter $1 ..."
+    # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
+    docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env build "$1"
 fi
-
-# Building images for all configurations
-# The docker build doesn't supply any environment variables to the Dockerfile, so we can use any profile.
-
-# Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
-docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env build $1
diff --git a/dc-down.sh b/dc-down.sh
@@ -3,15 +3,16 @@
 bash ./docker/docker-compose-check.sh
 if [[ $? -eq 1 ]]; then exit 1; fi
 
+# Stopping containers for all configurations
+# The environment must be provided but it doesn't make a difference which one
+
 if [ $# -eq 0 ]
 then
     echo "Stopping docker compose and removing containers"
+    # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
+    docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env down
 else
     echo "Stopping docker compose and removing containers with additional parameter $1 ..."
+    # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
+    docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env down "$1"
 fi
-
-# Stopping containers for all configurations
-# The environment must be provided but it doesn't make a difference which one
-
-# Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
-docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env down $1
diff --git a/dc-stop.sh b/dc-stop.sh
@@ -3,15 +3,16 @@
 bash ./docker/docker-compose-check.sh
 if [[ $? -eq 1 ]]; then exit 1; fi
 
+# Stopping containers for all configurations
+# The environment must be provided but it doesn't make a difference which one
+
 if [ $# -eq 0 ]
 then
     echo "Stopping docker compose"
+    # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
+    docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env stop
 else
     echo "Stopping docker compose with additional parameter $1 ..."
+    # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
+    docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env stop "$1"
 fi
-
-# Stopping containers for all configurations
-# The environment must be provided but it doesn't make a difference which one
-
-# Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
-docker compose --profile mysql-rabbitmq --profile postgres-redis --env-file ./docker/environments/postgres-redis.env stop $1
diff --git a/dc-unittest.sh b/dc-unittest.sh
@@ -41,7 +41,7 @@ while [[ $# -gt 0 ]]; do
       usage
       exit 0
       ;;
-    -*|--*)
+    -*)
       echo "Unknown option $1"
       usage
       exit 1
@@ -53,9 +53,9 @@ while [[ $# -gt 0 ]]; do
   esac
 done
 
-if [ -z $PROFILE ]
+if [ -z "$PROFILE" ]
 then
-  if [ -z $DD_PROFILE ]
+  if [ -z "$DD_PROFILE" ]
   then
     echo "No profile supplied."
     usage
@@ -65,7 +65,7 @@ then
   fi
 fi
 
-if [ -z $TEST_CASE ]
+if [ -z "$TEST_CASE" ]
 then
   echo "No test case supplied."
   usage
@@ -75,4 +75,4 @@ fi
 echo "Running docker compose unit tests with profile $PROFILE and test case $TEST_CASE ..."
 
 # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
-docker compose --profile $PROFILE --env-file ./docker/environments/$PROFILE.env exec uwsgi bash -c "python manage.py test $TEST_CASE -v2 --keepdb"
+docker compose --profile "$PROFILE" --env-file "./docker/environments/$PROFILE.env" exec uwsgi bash -c "python manage.py test $TEST_CASE -v2 --keepdb"
diff --git a/dc-up-d.sh b/dc-up-d.sh
@@ -7,7 +7,7 @@ if [[ $? -eq 1 ]]; then exit 1; fi
 
 if [ $# -eq 0 ]
 then
-    if [ -z $DD_PROFILE ]
+    if [ -z "$DD_PROFILE" ]
     then
         echo "No profile supplied, running default: postgres-redis"
         PROFILE="postgres-redis"
@@ -29,4 +29,4 @@ fi
 echo "Starting docker compose with profile $PROFILE in the background ..."
 
 # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
-docker compose --profile $PROFILE --env-file ./docker/environments/$PROFILE.env up --no-deps -d
+docker compose --profile "$PROFILE" --env-file "./docker/environments/$PROFILE.env" up --no-deps -d
diff --git a/dc-up.sh b/dc-up.sh
@@ -6,7 +6,7 @@ bash ./docker/docker-compose-check.sh
 if [[ $? -eq 1 ]]; then exit 1; fi
 
 if [ $# -eq 0 ]; then
-    if [ -z $DD_PROFILE ]
+    if [ -z "$DD_PROFILE" ]
     then
         echo "No profile supplied, running default: postgres-redis"
         PROFILE="postgres-redis"
@@ -28,4 +28,4 @@ fi
 echo "Starting docker compose with profile $PROFILE in the foreground ..."
 
 # Compose V2 integrates compose functions into the Docker platform, continuing to support most of the previous docker-compose features and flags. You can run Compose V2 by replacing the hyphen (-) with a space, using docker compose, instead of docker-compose.
-docker compose --profile $PROFILE --env-file ./docker/environments/$PROFILE.env up --no-deps
+docker compose --profile "$PROFILE" --env-file "./docker/environments/$PROFILE.env" up --no-deps
diff --git a/docker/docker-compose-check.sh b/docker/docker-compose-check.sh
@@ -1,8 +1,8 @@
 #!/bin/bash
 
-main=`docker compose  version  --short | cut -d '.' -f 1`
-minor=`docker compose  version  --short | cut -d '.' -f 2`
-current=`docker compose  version  --short`
+main=$(docker compose  version  --short | cut -d '.' -f 1)
+minor=$(docker compose  version  --short | cut -d '.' -f 2)
+current=$(docker compose  version  --short)
 
 echo 'Checking docker compose version'
 if [[ $main -lt 2 ]]; then

diff --git a/docker/dojo-data.bash b/docker/dojo-data.bash
@@ -1,7 +1,7 @@
 #!/bin/bash
 #Exports and loads sample data for dojo
 
-if [ $# > 1 ]
+if [ $# -gt 1 ]
 then
     if [[ "$1" = "load" ]]
     then

diff --git a/docker/entrypoint-celery-beat.sh b/docker/entrypoint-celery-beat.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 umask 0002
 
 id
@@ -7,7 +7,7 @@ id
 FILES=$(ls /app/docker/extra_settings/* 2>/dev/null)
 NUM_FILES=$(echo "$FILES" | wc -w)
 if [ "$NUM_FILES" -gt 0 ]; then
-    COMMA_LIST=$(echo $FILES | tr -s '[:blank:]' ', ')
+    COMMA_LIST=$(echo "$FILES" | tr -s '[:blank:]' ', ')
     echo "============================================================"
     echo "     Overriding DefectDojo's local_settings.py with multiple"
     echo "     Files: $COMMA_LIST"

diff --git a/docker/entrypoint-celery-worker.sh b/docker/entrypoint-celery-worker.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 umask 0002
 
 id
@@ -7,7 +7,7 @@ id
 FILES=$(ls /app/docker/extra_settings/* 2>/dev/null)
 NUM_FILES=$(echo "$FILES" | wc -w)
 if [ "$NUM_FILES" -gt 0 ]; then
-    COMMA_LIST=$(echo $FILES | tr -s '[:blank:]' ', ')
+    COMMA_LIST=$(echo "$FILES" | tr -s '[:blank:]' ', ')
     echo "============================================================"
     echo "     Overriding DefectDojo's local_settings.py with multiple"
     echo "     Files: $COMMA_LIST"
@@ -25,8 +25,10 @@ done
 echo
 
 if [ "${DD_CELERY_WORKER_POOL_TYPE}" = "prefork" ]; then
-  EXTRA_PARAMS="--autoscale=${DD_CELERY_WORKER_AUTOSCALE_MAX},${DD_CELERY_WORKER_AUTOSCALE_MIN}
-    --prefetch-multiplier=${DD_CELERY_WORKER_PREFETCH_MULTIPLIER}"
+  EXTRA_PARAMS=("--autoscale=${DD_CELERY_WORKER_AUTOSCALE_MAX},${DD_CELERY_WORKER_AUTOSCALE_MIN}"
+    "--prefetch-multiplier=${DD_CELERY_WORKER_PREFETCH_MULTIPLIER}")
+else
+  EXTRA_PARAMS=()
 fi
 
 # do the check with Django stack
@@ -36,5 +38,5 @@ exec celery --app=dojo \
     worker \
   --loglevel="${DD_CELERY_LOG_LEVEL}" \
   --pool="${DD_CELERY_WORKER_POOL_TYPE}" \
-  --concurrency=${DD_CELERY_WORKER_CONCURRENCY:-1} \
-  ${EXTRA_PARAMS}
+  --concurrency="${DD_CELERY_WORKER_CONCURRENCY:-1}" \
+  "${EXTRA_PARAMS[@]}"
diff --git a/docker/entrypoint-initializer.sh b/docker/entrypoint-initializer.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 initialize_data()
 {
@@ -40,7 +40,7 @@ fi
 FILES=$(ls /app/docker/extra_settings/* 2>/dev/null)
 NUM_FILES=$(echo "$FILES" | wc -w)
 if [ "$NUM_FILES" -gt 0 ]; then
-    COMMA_LIST=$(echo $FILES | tr -s '[:blank:]' ', ')
+    COMMA_LIST=$(echo "$FILES" | tr -s '[:blank:]' ', ')
     echo "============================================================"
     echo "     Overriding DefectDojo's local_settings.py with multiple"
     echo "     Files: $COMMA_LIST"
@@ -67,7 +67,7 @@ done
 echo
 
 echo "Checking ENABLE_AUDITLOG"
-cat <<EOD | python manage.py shell
+cat <<EOD | if ! python manage.py shell
 from django.db import connections, DEFAULT_DB_ALIAS
 from django.db.utils import ProgrammingError
 from dojo.settings import settings
@@ -99,7 +99,6 @@ if 'enable_auditlog' in raw_row:  # db is not migrated yet
 else:
     print("Database has been already migrated. Nothing to check.")
 EOD
-if [ $? -ne 0 ]
 then
   echo "You have set 'enable_auditlog' to False in the past. It is not possible to manage auditlog in System settings anymore. If you would like to keep auditlog disabled, you need to set environmental variable DD_ENABLE_AUDITLOG to False for all Django containers (uwsgi, celeryworker & initializer)."
   echo "Or there is some other error in checking script. Check logs of this container."
@@ -114,7 +113,7 @@ python3 manage.py migrate
 echo "Admin user: ${DD_ADMIN_USER}"
 ADMIN_EXISTS=$(echo "SELECT * from auth_user;" | python manage.py dbshell | grep "${DD_ADMIN_USER}")
 # Abort if the admin user already exists, instead of giving a new fake password that won't work
-if [ ! -z "$ADMIN_EXISTS" ]
+if [ -n "$ADMIN_EXISTS" ]
 then
     echo "Admin password: Initialization detected that the admin user ${DD_ADMIN_USER} already exists in your database."
     echo "If you don't remember the ${DD_ADMIN_USER} password, you can create a new superuser with:"
@@ -126,14 +125,16 @@ fi
 
 if [ -z "${DD_ADMIN_PASSWORD}" ]
 then
-  export DD_ADMIN_PASSWORD="$(cat /dev/urandom | LC_ALL=C tr -dc a-zA-Z0-9 | \
+  DD_ADMIN_PASSWORD="$(LC_ALL=C tr -dc a-zA-Z0-9 < /dev/urandom | \
     head -c 22)"
+  export DD_ADMIN_PASSWORD
   echo "Admin password: ${DD_ADMIN_PASSWORD}"
 fi
 
 if [ -z "${DD_JIRA_WEBHOOK_SECRET}" ]
 then
-  export DD_JIRA_WEBHOOK_SECRET="$(uuidgen)"
+  DD_JIRA_WEBHOOK_SECRET="$(uuidgen)"
+  export DD_JIRA_WEBHOOK_SECRET
   echo "JIRA Webhook Secret: ${DD_JIRA_WEBHOOK_SECRET}"
 fi
 
@@ -161,9 +162,9 @@ EOD
 
   echo "Importing extra fixtures"
   # If there is extra fixtures, load them
-  for i in $(ls dojo/fixtures/extra_*.json | sort -n 2>/dev/null) ; do
+  for i in $(find dojo/fixtures/extra_*.json | sort -n 2>/dev/null) ; do
     echo "Loading $i"
-    python3 manage.py loaddata ${i%.*}
+    python3 manage.py loaddata "${i%.*}"
   done
 
   echo "Installing watson search index"