refactor: convert postgres check harness from runCommand to writeShellApplication

Migrate test harness to use writeShellApplication for better shell script handling,
fix shellcheck warnings.

Author: jfroche

nix/checks.nix

@@ -153,27 +153,32 @@
               ) filteredSqlTests;
               sortedTestList = builtins.sort (a: b: a < b) testList;
             in
-            pkgs.runCommand "postgres-${pgpkg.version}-check-harness"
-              {
-                nativeBuildInputs = with pkgs; [
-                  coreutils
-                  bash
-                  perl
-                  pgpkg
-                  pg_prove
-                  pg_regress
-                  procps
-                  start-postgres-server-bin
-                  which
-                  getkey-script
-                  supabase-groonga
-                  python3
-                  netcat
-                ];
-              }
-              ''
+            pkgs.writeShellApplication rec {
+              name = "postgres-${pgpkg.version}-check-harness";
+              bashOptions = [ "nounset" "pipefail" ];
+              runtimeInputs = with pkgs; [
+                coreutils
+                bash
+                perl
+                pgpkg
+                pg_prove
+                pg_regress
+                procps
+                start-postgres-server-bin
+                which
+                getkey-script
+                supabase-groonga
+                python3
+                netcat
+              ];
+
+              text = ''
+
+                #shellcheck disable=SC1091
                 source ${bashlog}
-                set -uo pipefail
+                #shellcheck disable=SC1091
+                source ${pkgs.stdenv}/setup
+                export PATH="${lib.makeBinPath runtimeInputs}:$PATH"
 
                 export BASHLOG_FILE=1
                 export BASHLOG_FILE_PATH=debug.log
@@ -184,10 +189,11 @@
                 function log_cmd {
                   local cmd_name="$1"
                   shift
-                  log debug "Executing: $cmd_name $@"
+                  log debug "Executing: $cmd_name $*"
                   local exit_code=0
-                  echo "\$ $cmd_name $@" >> debug.log
-                  "$cmd_name" "$@" 2>&1 >> debug.log || exit_code=$?
+                  echo "\$ $cmd_name $*" >> debug.log
+
+                  "$cmd_name" "$@" >> debug.log 2>&1 || exit_code=$?
                   log debug "Exit code: $exit_code"
                   return $exit_code
                 }
@@ -207,12 +213,12 @@
 
                 function check_postgres_ready {
                   for i in {1..60}; do
-                      if log_cmd pg_isready -h ${self.supabase.defaults.host} -p ${pgPort} -U supabase_admin -q; then
+                      if log_cmd pg_isready -h localhost -p ${pgPort} -U supabase_admin -q; then
                           log info "PostgreSQL is ready"
                           break
                       fi
                       sleep 1
-                      if [ $i -eq 60 ]; then
+                      if [ "$i" -eq 60 ]; then
                           log error "PostgreSQL failed to start"
                           exit 1
                       fi
@@ -253,13 +259,14 @@
                 log_cmd initdb --locale=C --username=supabase_admin -D "$PGTAP_CLUSTER"
                 substitute ${./tests/postgresql.conf.in} "$PGTAP_CLUSTER"/postgresql.conf \
                   --subst-var-by PGSODIUM_GETKEY_SCRIPT "${getkey-script}/bin/pgsodium-getkey"
-                echo "listen_addresses = '*'" >> "$PGTAP_CLUSTER"/postgresql.conf
+                echo "listen_addresses = '127.0.0.1'" >> "$PGTAP_CLUSTER"/postgresql.conf
                 echo "port = ${pgPort}" >> "$PGTAP_CLUSTER"/postgresql.conf
-                echo "host all all 127.0.0.1/32 trust" >> $PGTAP_CLUSTER/pg_hba.conf
+                echo "host all all 127.0.0.1/32 trust" >> "$PGTAP_CLUSTER/pg_hba.conf"
                 log info "Checking shared_preload_libraries setting:"
-                log info $(grep -rn "shared_preload_libraries" "$PGTAP_CLUSTER"/postgresql.conf)
+                log info "$(grep -rn "shared_preload_libraries" "$PGTAP_CLUSTER"/postgresql.conf)"
                 # Remove timescaledb if running orioledb-17 check
                 log info "pgpkg.version is: ${pgpkg.version}"
+                #shellcheck disable=SC2193
                 if [[ "${pgpkg.version}" == *"17"* ]]; then
                   perl -pi -e 's/ timescaledb,//g' "$PGTAP_CLUSTER/postgresql.conf"
                 fi
@@ -273,10 +280,10 @@
 
                 # PostgreSQL startup
                 if [[ "$(uname)" == "Darwin" ]]; then
-                log_cmd pg_ctl -D "$PGTAP_CLUSTER" -l "$PGTAP_CLUSTER"/postgresql.log -o "-k "$PGTAP_CLUSTER" -p ${pgPort} -d 5" start
+                log_cmd pg_ctl -D "$PGTAP_CLUSTER" -l "$PGTAP_CLUSTER/postgresql.log" -o "-k $PGTAP_CLUSTER -p ${pgPort} -d 5" start
                 else
                 mkdir -p "$PGTAP_CLUSTER/sockets"
-                log_cmd pg_ctl -D "$PGTAP_CLUSTER" -l "$PGTAP_CLUSTER"/postgresql.log -o "-k $PGTAP_CLUSTER/sockets -p ${pgPort} -d 5" start
+                log_cmd pg_ctl -D "$PGTAP_CLUSTER" -l "$PGTAP_CLUSTER/postgresql.log" -o "-k $PGTAP_CLUSTER/sockets -p ${pgPort} -d 5" start
                 fi || {
                 log error "pg_ctl failed to start PostgreSQL"
                 log error "Contents of postgresql.log:"
@@ -288,10 +295,10 @@
                 check_postgres_ready
 
                 log info "Creating test database"
-                log_cmd createdb -p ${pgPort} -h ${self.supabase.defaults.host} --username=supabase_admin testing
+                log_cmd createdb -p ${pgPort} -h localhost --username=supabase_admin testing
 
                 log info "Loading prime SQL file"
-                if ! log_cmd psql -p ${pgPort} -h ${self.supabase.defaults.host} --username=supabase_admin -d testing -v ON_ERROR_STOP=1 -Xf ${./tests/prime.sql}; then
+                if ! log_cmd psql -p ${pgPort} -h localhost --username=supabase_admin -d testing -v ON_ERROR_STOP=1 -Xf ${./tests/prime.sql}; then
                   log error "Error executing SQL file. PostgreSQL log content:"
                   cat "$PGTAP_CLUSTER"/postgresql.log
                   pg_ctl -D "$PGTAP_CLUSTER" stop
@@ -300,7 +307,7 @@
 
                 # Create a table to store test configuration
                 log info "Creating test_config table"
-                log_cmd psql -p ${pgPort} -h ${self.supabase.defaults.host} --username=supabase_admin -d testing -c "
+                log_cmd psql -p ${pgPort} -h localhost --username=supabase_admin -d testing -c "
                   CREATE TABLE IF NOT EXISTS test_config (key TEXT PRIMARY KEY, value TEXT);
                   INSERT INTO test_config (key, value) VALUES ('http_mock_port', '$HTTP_MOCK_PORT')
                   ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value;
@@ -309,11 +316,11 @@
                 for t in $(printf "%s\n" ${builtins.concatStringsSep " " sortedTestList}); do
                   log info "Running pgtap test: $t.sql"
                   #XXX enable ON_ERROR_STOP ?
-                  log_cmd psql -p ${pgPort} -h ${self.supabase.defaults.host} --username=supabase_admin -d testing -f "${./tests/sql}/$t.sql"
+                  log_cmd psql -p ${pgPort} -h localhost --username=supabase_admin -d testing -f "${./tests/sql}/$t.sql"
                 done
                 rm -rf "$SORTED_DIR"
                 log_cmd pg_ctl -D "$PGTAP_CLUSTER" stop
-                rm -rf $PGTAP_CLUSTER
+                rm -rf "$PGTAP_CLUSTER"
 
                 # End of pgtap tests
                 # from here on out we are running pg_regress tests, we use a different cluster for this
@@ -322,50 +329,55 @@
 
                 log info "Starting PostgreSQL server for pg_regress tests"
                 unset GRN_PLUGINS_DIR
-                log_cmd ${start-postgres-server-bin}/bin/start-postgres-server ${getVersionArg pgpkg} --daemonize
+                if ! log_cmd ${start-postgres-server-bin}/bin/start-postgres-server ${getVersionArg pgpkg} --daemonize; then
+                  log error "Failed to start PostgreSQL server for pg_regress tests"
+                  exit 1
+                fi
 
                 check_postgres_ready
 
                 log info "Loading prime SQL file"
-                if ! log_cmd psql -p ${pgPort} -h ${self.supabase.defaults.host} --no-password --username=supabase_admin -d postgres -v ON_ERROR_STOP=1 -Xf ${./tests/prime.sql} 2>&1; then
+                if ! log_cmd psql -p ${pgPort} -h localhost --no-password --username=supabase_admin -d postgres -v ON_ERROR_STOP=1 -Xf ${./tests/prime.sql} 2>&1; then
                   log error "Error executing SQL file"
                   exit 1
                 fi
 
                 # Create a table to store test configuration for pg_regress tests
                 log info "Creating test_config table for pg_regress tests"
-                log_cmd psql -p ${pgPort} -h ${self.supabase.defaults.host} --no-password --username=supabase_admin -d postgres -c "
+                log_cmd psql -p ${pgPort} -h localhost --no-password --username=supabase_admin -d postgres -c "
                   CREATE TABLE IF NOT EXISTS test_config (key TEXT PRIMARY KEY, value TEXT);
                   INSERT INTO test_config (key, value) VALUES ('http_mock_port', '$HTTP_MOCK_PORT')
                   ON CONFLICT (key) DO UPDATE SET value = EXCLUDED.value;
                 "
 
-                mkdir -p $out/regression_output
+                #shellcheck disable=SC2154
+                mkdir -p "$out/regression_output"
                 log info "Running pg_regress tests"
                 if ! log_cmd pg_regress \
                   --use-existing \
                   --dbname=postgres \
                   --inputdir=${./tests} \
-                  --outputdir=$out/regression_output \
-                  --host=${self.supabase.defaults.host} \
+                  --outputdir="$out/regression_output" \
+                  --host=localhost \
                   --port=${pgPort} \
                   --user=supabase_admin \
                   ${builtins.concatStringsSep " " sortedTestList} 2>&1; then
                   log error "pg_regress tests failed"
-                  cat $out/regression_output/regression.diffs
+                  cat "$out/regression_output/regression.diffs"
                   exit 1
                 fi
                 log info "pg_regress tests completed successfully"
 
                 log info "Running migrations tests"
-                log_cmd pg_prove -p ${pgPort} -U supabase_admin -h ${self.supabase.defaults.host} -d postgres -v ${../migrations/tests}/test.sql
+                log_cmd pg_prove -p ${pgPort} -U supabase_admin -h localhost -d postgres -v ${../migrations/tests}/test.sql
                 log info "Migrations tests completed successfully"
               '';
+            };
         in
         {
-          psql_15 = makeCheckHarness self'.packages."psql_15/bin";
-          psql_17 = makeCheckHarness self'.packages."psql_17/bin";
-          psql_orioledb-17 = makeCheckHarness self'.packages."psql_orioledb-17/bin";
+          psql_15 = pkgs.runCommand "run-check-harness-psql-15" {} (lib.getExe (makeCheckHarness self'.packages."psql_15/bin"));
+          psql_17 = pkgs.runCommand "run-check-harness-psql-17" {} (lib.getExe (makeCheckHarness self'.packages."psql_17/bin"));
+          psql_orioledb-17 = pkgs.runCommand "run-check-harness-psql-orioledb-17" {} (lib.getExe (makeCheckHarness self'.packages."psql_orioledb-17/bin"));
           inherit (self'.packages)
             wal-g-2
             wal-g-3