Add test that verifies cypher file references

Author: JohT

scripts/testCypherReferences.sh

@@ -0,0 +1,111 @@
+#!/usr/bin/env bash
+
+# Tests: scan all *.sh files (current directory including subdirectories)
+# for occurrences of '/...*.cypher' references and ensure a file with
+# the referenced basename exists somewhere in the tree.
+
+# Fail on any error
+set -o errexit
+
+# Fail if any command in a pipeline fails (not just the last one)
+if set -o pipefail 2>/dev/null; then
+  set -o pipefail
+fi
+
+SCRIPT_NAME="testCypherReferences.sh"
+COLOR_ERROR='\033[0;31m'
+COLOR_DE_EMPHASIZED='\033[0;90m'
+COLOR_SUCCESSFUL="\033[0;32m"
+COLOR_DEFAULT='\033[0m'
+
+# Determine this scripts dir (POSIX-friendly)
+SCRIPTS_DIR=${SCRIPTS_DIR:-$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)}
+
+tearDown() {
+  rm -rf "${temporaryTestDirectory}"
+}
+
+successful() {
+  echo -e "${COLOR_DE_EMPHASIZED}${SCRIPT_NAME}:${COLOR_DEFAULT} ${COLOR_SUCCESSFUL}✅ Tests finished successfully.${COLOR_DEFAULT}"
+  tearDown
+}
+
+info() {
+  local infoMessage="${1}"
+  echo -e "${COLOR_DE_EMPHASIZED}${SCRIPT_NAME}:${COLOR_DEFAULT} ${infoMessage}"
+}
+
+fail() {
+  local errorMessage="${1}"
+  echo -e "${COLOR_DE_EMPHASIZED}${SCRIPT_NAME}: ${COLOR_ERROR}${errorMessage}${COLOR_DEFAULT}"
+  tearDown
+  return 1
+}
+
+printTestLogFileContent() {
+  local logFileName="${temporaryTestDirectory}/${SCRIPT_NAME}.log"
+  if [ -f "${logFileName}" ]; then
+    local logFileContent
+    logFileContent=$(cat "${logFileName}")
+    # Remove common color codes for readability
+    echo -e "${COLOR_DE_EMPHASIZED}${logFileContent}${COLOR_DEFAULT}"
+  else
+    echo -e "${COLOR_ERROR}No log file found at expected location: %s${COLOR_DEFAULT}" "${logFileName}"
+  fi
+}
+
+info "Starting tests...."
+
+temporaryTestDirectory=$(mktemp -d 2>/dev/null || mktemp -d -t "temporaryTestDirectory_${SCRIPT_NAME}")
+mkdir -p "${temporaryTestDirectory}"
+
+# ------- Integration-style Test Case
+info "Scan all .sh files for '/...*.cypher' references and verify filenames exist."
+
+# Capture stdout/stderr into a log file for this run
+{
+  missing_file="${temporaryTestDirectory}/missing_references.txt"
+  : > "${missing_file}"
+
+  # Collect all cypher filenames without path present in the repo
+  cypher_filenames="${temporaryTestDirectory}/cypher_filenames.txt"
+  find . -type d -name "temp" -prune -o -type f -name '*.cypher' -print 2>/dev/null | sed 's#.*/##' > "${cypher_filenames}"
+
+  # Iterate over all .sh files
+  find . -type d -name "temp" -prune -o -type f -name '*.sh' -print0 | while IFS= read -r -d '' script_file; do
+    # Skip this test file itself
+    if [ "$(basename "${script_file}")" = "${SCRIPT_NAME}" ]; then
+        continue
+    fi
+    # Use awk to extract all '/...*.cypher' matches from non-comment lines
+    awk '
+    /^[[:space:]]*#/ { next }
+    {
+      line = $0
+      while (match(line, /\/[^[:space:]]+\.cypher/)) {
+        ref = substr(line, RSTART, RLENGTH)
+        if (ref !~ /\$/) {
+           print ref
+        }
+        line = substr(line, RSTART + RLENGTH)
+        }
+      }
+    ' "${script_file}" | while IFS= read -r ref; do
+      [ -z "${ref}" ] && continue
+      base=$(basename "${ref}")
+      if ! grep -Fx -- "${base}" "${cypher_filenames}" >/dev/null 2>&1; then
+        printf '%s\t%s\n' "${script_file#./}" "${ref}" >> "${missing_file}"
+      fi
+    done
+  done
+} > "${temporaryTestDirectory}/${SCRIPT_NAME}.log" 2>&1
+
+if [ -s "${missing_file}" ]; then
+    echo -e "${COLOR_DE_EMPHASIZED}${SCRIPT_NAME}:${COLOR_ERROR}ERROR: Missing referenced cypher files (by basename):\n${COLOR_DEFAULT}"
+    awk -F"\t" '{ printf("  - In %s -> referenced %s\n", $1, $2) }' "${missing_file}"
+    printTestLogFileContent
+    fail "❌ Test failed."
+fi
+
+successful
+return 0