refactor(env): unify truthy env var checks in scripts

Introduce a common `is_truthy` function in Bash scripts and a Python
`is_truthy_env_var` helper to standardize environment variable checks for
truthy values. Refactor all relevant Bash and Python scripts to use these
helpers, improving consistency and maintainability across the codebase.

Author: mkoura

.github/common.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+
+is_truthy() {
+  local val="${1:-}"
+  val=${val,,}
+
+  case "$val" in
+    1 | true | yes | on | enabled )
+      return 0
+      ;;
+    *)
+      return 1
+      ;;
+  esac
+}

.github/node_upgrade_pytest.sh

@@ -22,6 +22,9 @@ export REPORTS_DIR="${REPORTS_DIR:-".reports"}"
 rm -rf "${REPORTS_DIR:?}"
 mkdir -p "$REPORTS_DIR"
 
+# shellcheck disable=SC1090,SC1091
+. .github/common.sh
+
 #
 # STEP1 - start local cluster and run smoke tests for the first time
 #
@@ -50,7 +53,7 @@ if [ "$1" = "step1" ]; then
     export PATH="${BASE_REV_BIN}:${PATH}"
   fi
 
-  if [ "${CI_BYRON_CLUSTER:-"false"}" != "false" ]; then
+  if is_truthy "${CI_BYRON_CLUSTER:-}"; then
     : "${TESTNET_VARIANT:="${CLUSTER_ERA}_slow"}"
   else
     : "${TESTNET_VARIANT:="${CLUSTER_ERA}_fast"}"

.github/regression.sh

@@ -19,6 +19,9 @@ cd "$REPODIR"
 export WORKDIR="$REPODIR/run_workdir"
 export PATH_PREPEND="${PWD}/.bin"
 
+# shellcheck disable=SC1090,SC1091
+. .github/common.sh
+
 # shellcheck disable=SC1090,SC1091
 . .github/stop_cluster_instances.sh
 
@@ -68,14 +71,10 @@ fi
 
 if [ -n "${TESTNET_VARIANT:-}" ]; then
   export TESTNET_VARIANT
-elif [ "${CI_BYRON_CLUSTER:-"false"}" != "false" ]; then
+elif is_truthy "${CI_BYRON_CLUSTER:-}"; then
   export TESTNET_VARIANT="${CLUSTER_ERA:-conway}_slow"
 fi
 
-if [ "${ALLOW_UNSTABLE_ERROR_MESSAGES:-"false"}" == "false" ]; then
-  unset ALLOW_UNSTABLE_ERROR_MESSAGES
-fi
-
 export CARDANO_NODE_SOCKET_PATH_CI="$WORKDIR/state-cluster0/bft1.socket"
 
 # assume we run tests on testnet when `BOOTSTRAP_DIR` is set

.github/source_dbsync.sh

@@ -7,6 +7,9 @@ export TEST_THREADS CLUSTERS_COUNT
 _origpwd="$PWD"
 cd "$WORKDIR" || exit 1
 
+# shellcheck disable=SC1090,SC1091
+. .github/common.sh
+
 stop_postgres() {
   echo "Stopping postgres"
 
@@ -111,7 +114,7 @@ else
     || exit 1
 
   # Build cardano-smash-server
-  if [ "${SMASH:-"false"}" != "false" ]; then
+  if is_truthy "${SMASH:-}"; then
     nix build --accept-flake-config .#cardano-smash-server -o "${WORKDIR}/smash-server" || exit 1
   fi
 
@@ -127,7 +130,7 @@ if [ ! -e "${WORKDIR}/db-sync-node/bin/cardano-db-sync" ]; then
   echo "The \`cardano-db-sync\` binary not found, line $LINENO in sourced db-sync setup" >&2  # assert
   exit 1
 fi
-if  [ "${SMASH:-"false"}" != "false" ] && [ ! -e "${WORKDIR}/smash-server/bin/cardano-smash-server" ]; then
+if is_truthy "${SMASH:-}" && [ ! -e "${WORKDIR}/smash-server/bin/cardano-smash-server" ]; then
   echo "The \`cardano-smash-server\` binary not found, line $LINENO in sourced db-sync setup" >&2  # assert
   exit 1
 fi

cardano_node_tests/tests/conftest.py

@@ -124,7 +124,7 @@ def pytest_configure(config: tp.Any) -> None:
 
     testrun_name = os.environ.get("CI_TESTRUN_NAME")
     if testrun_name:
-        skip_passed = os.environ.get("CI_SKIP_PASSED") == "true"
+        skip_passed = helpers.is_truthy_env_var("CI_SKIP_PASSED")
         config.stash[metadata_key]["CI_TESTRUN_NAME"] = testrun_name
         config.stash[metadata_key]["CI_SKIP_PASSED"] = str(skip_passed)
 

cardano_node_tests/tests/test_reconnect.py

@@ -21,8 +21,8 @@
 
 LOGGER = logging.getLogger(__name__)
 
-TEST_RECONNECT = os.environ.get("TEST_RECONNECT") is not None
-TEST_METRICS_RECONNECT = os.environ.get("TEST_METRICS_RECONNECT") is not None
+TEST_RECONNECT = helpers.is_truthy_env_var("TEST_RECONNECT")
+TEST_METRICS_RECONNECT = helpers.is_truthy_env_var("TEST_METRICS_RECONNECT")
 
 
 @common.SKIPIF_ON_TESTNET

cardano_node_tests/utils/configuration.py

@@ -3,6 +3,8 @@
 import os
 import pathlib as pl
 
+from cardano_node_tests.utils import helpers
+
 LAUNCH_PATH = pl.Path.cwd()
 
 NETWORK_MAGIC_LOCAL = 42
@@ -14,13 +16,12 @@
 # See `cat /proc/sys/net/ipv4/ip_local_port_range`.
 PORTS_BASE = int(os.environ.get("PORTS_BASE") or 23000)
 
-# Used also in startup scripts as `if [ -n "$VAR" ]...`
-ENABLE_LEGACY = (os.environ.get("ENABLE_LEGACY") or "") != ""
-# Used also in startup scripts as `if [ -n "$VAR" ]...`
-MIXED_P2P = (os.environ.get("MIXED_P2P") or "") != ""
+# Used also in startup scripts
+ENABLE_LEGACY = helpers.is_truthy_env_var("ENABLE_LEGACY")
+# Used also in startup scripts
+MIXED_P2P = helpers.is_truthy_env_var("MIXED_P2P")
 
-# Used also in startup scripts as `if [ -n "$VAR" ]...`
-HAS_CC = (os.environ.get("NO_CC") or "") == ""
+HAS_CC = not helpers.is_truthy_env_var("NO_CC")
 
 # Number of new blocks before the Tx is considered confirmed. Use default value if set to 0.
 CONFIRM_BLOCKS_NUM = int(os.environ.get("CONFIRM_BLOCKS_NUM") or 0)
@@ -65,8 +66,8 @@
 CLUSTERS_COUNT = int(os.environ.get("CLUSTERS_COUNT") or 0)
 CLUSTERS_COUNT = int(CLUSTERS_COUNT or (min(XDIST_WORKERS_COUNT, 9)) or 1)
 
-DEV_CLUSTER_RUNNING = bool(os.environ.get("DEV_CLUSTER_RUNNING"))
-FORBID_RESTART = bool(os.environ.get("FORBID_RESTART"))
+DEV_CLUSTER_RUNNING = helpers.is_truthy_env_var("DEV_CLUSTER_RUNNING")
+FORBID_RESTART = helpers.is_truthy_env_var("FORBID_RESTART")
 
 BOOTSTRAP_DIR = os.environ.get("BOOTSTRAP_DIR") or ""
 
@@ -76,15 +77,15 @@
     raise RuntimeError(msg)
 
 HAS_DBSYNC = bool(os.environ.get("DBSYNC_SCHEMA_DIR"))
-HAS_SMASH = HAS_DBSYNC and bool(os.environ.get("SMASH"))
+HAS_SMASH = HAS_DBSYNC and helpers.is_truthy_env_var("SMASH")
 
-DONT_OVERWRITE_OUTFILES = bool(os.environ.get("DONT_OVERWRITE_OUTFILES"))
+DONT_OVERWRITE_OUTFILES = helpers.is_truthy_env_var("DONT_OVERWRITE_OUTFILES")
 
 # Allow unstable error messages in tests
-ALLOW_UNSTABLE_ERROR_MESSAGES = bool(os.environ.get("ALLOW_UNSTABLE_ERROR_MESSAGES"))
+ALLOW_UNSTABLE_ERROR_MESSAGES = helpers.is_truthy_env_var("ALLOW_UNSTABLE_ERROR_MESSAGES")
 
 # Cluster instances are kept running after tests finish
-KEEP_CLUSTERS_RUNNING = bool(os.environ.get("KEEP_CLUSTERS_RUNNING"))
+KEEP_CLUSTERS_RUNNING = helpers.is_truthy_env_var("KEEP_CLUSTERS_RUNNING")
 
 # Determine what scripts to use to start the cluster
 TESTNET_VARIANT = os.environ.get("TESTNET_VARIANT") or ""

cardano_node_tests/utils/helpers.py

@@ -75,6 +75,11 @@ def environ(env: dict) -> tp.Iterator[None]:
                 os.environ[key] = value
 
 
+def is_truthy_env_var(var: str) -> bool:
+    """Check if an environment variable is set to a truthy value."""
+    return (os.environ.get(var) or "").lower() in ("1", "true", "yes", "on", "enabled")
+
+
 def run_command(
     command: str | list,
     *,