dataconnect: shellcheck (lint) bash shell scripts (#7215)

Author: dconeybe

.github/workflows/dataconnect.yml

@@ -271,6 +271,17 @@ jobs:
         with:
           args: -color /github/workspace/.github/workflows/dataconnect.yml
 
+  shellcheck:
+    continue-on-error: false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          show-progress: false
+          sparse-checkout: 'firebase-dataconnect/'
+      - name: shellcheck
+        run: find . -name '*.sh' -print0 | xargs --verbose -0 shellcheck --norc --enable=all --shell=bash
+
   python-ci-unit-tests:
     continue-on-error: false
     runs-on: ubuntu-latest

firebase-dataconnect/emulator/emulator.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly SCRIPT_DIR="$(dirname "$0")"
+SCRIPT_DIR="$(dirname "$0")"
+readonly SCRIPT_DIR
 readonly SELF_EXECUTABLE="$0"
 readonly LOG_PREFIX="[$0] "
 readonly DEFAULT_POSTGRESQL_STRING='postgresql://postgres:postgres@localhost:5432?sslmode=disable'
@@ -38,7 +39,7 @@ function parse_args {
   local OPTIND=1
   local OPTERR=0
   while getopts ":c:p:v:hwg" arg ; do
-    case "$arg" in
+    case "${arg}" in
       c) emulator_binary="${OPTARG}" ;;
       g) emulator_binary="gradle" ;;
       p) postgresql_string="${OPTARG}" ;;
@@ -59,21 +60,21 @@ function parse_args {
         exit 2
         ;;
       *)
-        log_error_and_exit "INTERNAL ERROR: unknown argument: $arg"
+        log_error_and_exit "INTERNAL ERROR: unknown argument: ${arg}"
         ;;
     esac
   done
 
-  if [[ $emulator_binary != "gradle" ]] ; then
+  if [[ ${emulator_binary} != "gradle" ]] ; then
     export DATACONNECT_EMULATOR_BINARY_PATH="${emulator_binary}"
   else
     run_command "${SCRIPT_DIR}/../../gradlew" -p "${SCRIPT_DIR}/../.." --configure-on-demand :firebase-dataconnect:connectors:downloadDebugDataConnectExecutable
     local gradle_emulator_binaries=("${SCRIPT_DIR}"/../connectors/build/intermediates/dataconnect/debug/executable/*)
     if [[ ${#gradle_emulator_binaries[@]} -ne 1 ]]; then
       log_error_and_exit "expected exactly 1 emulator binary from gradle, but got ${#gradle_emulator_binaries[@]}: ${gradle_emulator_binaries[*]}"
     fi
-    local gradle_emulator_binary="${gradle_emulator_binaries[@]}"
-    if [[ ! -e $gradle_emulator_binary ]] ; then
+    local gradle_emulator_binary="${gradle_emulator_binaries[0]}"
+    if [[ ! -e ${gradle_emulator_binary} ]] ; then
       log_error_and_exit "emulator binary from gradle does not exist: ${gradle_emulator_binary}"
     fi
     export DATACONNECT_EMULATOR_BINARY_PATH="${gradle_emulator_binary}"
@@ -82,7 +83,7 @@ function parse_args {
   export FIREBASE_DATACONNECT_POSTGRESQL_STRING="${postgresql_string}"
   export DATA_CONNECT_PREVIEW="${preview_flags}"
 
-  if [[ $wipe_and_restart_postgres_pod == "1" ]] ; then
+  if [[ ${wipe_and_restart_postgres_pod} == "1" ]] ; then
     run_command "${SCRIPT_DIR}/wipe_postgres_db.sh"
     run_command "${SCRIPT_DIR}/start_postgres_pod.sh"
   fi

firebase-dataconnect/emulator/start_postgres_pod.sh

@@ -25,8 +25,9 @@ function run_command {
   "$@"
 }
 
-# Determine the absolute path of the directory containing this file.
-readonly SCRIPT_DIR="$(readlink -f $(dirname "$0"))"
+# Determine the path of the directory containing this file.
+SCRIPT_DIR="$(dirname "$0")"
+readonly SCRIPT_DIR
 
 # Create the podman "pod" if it is not already created.
 # Bind the PostgreSQL server to port 5432 on the host, so that the host can connect to it.

firebase-dataconnect/scripts/compile_kotlin.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+readonly PROJECT_ROOT_DIR
 
 readonly TARGETS=(
   ":firebase-dataconnect:compileDebugKotlin"

firebase-dataconnect/scripts/emulator_run.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+readonly PROJECT_ROOT_DIR
 
 (
   set -xv

firebase-dataconnect/scripts/generateApiTxtFile.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+readonly PROJECT_ROOT_DIR
 
 readonly args=(
   "${PROJECT_ROOT_DIR}/gradlew"

firebase-dataconnect/scripts/generate_data_connect_sources.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+readonly PROJECT_ROOT_DIR
 
 readonly TARGETS=(
   ":firebase-dataconnect:connectors:generateDebugDataConnectSources"

firebase-dataconnect/scripts/run_all_tests.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+readonly PROJECT_ROOT_DIR
 
 readonly TARGETS=(
   ":firebase-dataconnect:androidTestutil:connectedDebugAndroidTest"

firebase-dataconnect/scripts/run_integration_tests.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+readonly PROJECT_ROOT_DIR
 
 readonly TARGETS=(
   ":firebase-dataconnect:connectedDebugAndroidTest"

firebase-dataconnect/scripts/run_unit_tests.sh

@@ -16,7 +16,8 @@
 
 set -euo pipefail
 
-readonly PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+PROJECT_ROOT_DIR="$(dirname "$0")/../.."
+readonly PROJECT_ROOT_DIR
 
 readonly TARGETS=(
   ":firebase-dataconnect:testDebugUnitTest"