Merge pull request #547 from TypedDevs/feat/546-bootstrap-args

Add bootstrap argument passing support

Author: Chemaclass

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 ### Added
+- Add bootstrap argument passing support via `--env "file.sh arg1 arg2"` or `BASHUNIT_BOOTSTRAP_ARGS` (fixes #546)
 - Add `--strict` flag to enable strict shell mode (`set -euo pipefail`) for tests (fixes #540)
 - Add `BASHUNIT_STRICT_MODE` configuration option (default: `false`)
 - Add `-R, --run-all` flag to run all assertions even when one fails (fixes #536)

src/console_header.sh

@@ -101,7 +101,7 @@ Arguments:
 
 Options:
   -a, --assert <fn> <args>    Run a standalone assert function
-  -e, --env, --boot <file>    Load a custom env/bootstrap file
+  -e, --env, --boot <file>    Load a custom env/bootstrap file (supports args)
   -f, --filter <name>         Only run tests matching the name
   -l, --log-junit <file>      Write JUnit XML report
   -p, --parallel              Run tests in parallel (default)
@@ -135,7 +135,7 @@ Arguments:
   path                        File or directory containing benchmarks
 
 Options:
-  -e, --env, --boot <file>    Load a custom env/bootstrap file
+  -e, --env, --boot <file>    Load a custom env/bootstrap file (supports args)
   -f, --filter <name>         Only run benchmarks matching the name
   -s, --simple                Simple output
   --detailed                  Detailed output (default)

src/env.sh

@@ -16,6 +16,7 @@ _BASHUNIT_DEFAULT_REPORT_HTML=""
 : "${BASHUNIT_DEFAULT_PATH:=${DEFAULT_PATH:=$_BASHUNIT_DEFAULT_DEFAULT_PATH}}"
 : "${BASHUNIT_DEV_LOG:=${DEV_LOG:=$_BASHUNIT_DEFAULT_DEV_LOG}}"
 : "${BASHUNIT_BOOTSTRAP:=${BOOTSTRAP:=$_BASHUNIT_DEFAULT_BOOTSTRAP}}"
+: "${BASHUNIT_BOOTSTRAP_ARGS:=${BOOTSTRAP_ARGS:=}}"
 : "${BASHUNIT_LOG_JUNIT:=${LOG_JUNIT:=$_BASHUNIT_DEFAULT_LOG_JUNIT}}"
 : "${BASHUNIT_REPORT_HTML:=${REPORT_HTML:=$_BASHUNIT_DEFAULT_REPORT_HTML}}"
 
@@ -149,6 +150,7 @@ function bashunit::env::print_verbose() {
     "BASHUNIT_DEFAULT_PATH"
     "BASHUNIT_DEV_LOG"
     "BASHUNIT_BOOTSTRAP"
+    "BASHUNIT_BOOTSTRAP_ARGS"
     "BASHUNIT_LOG_JUNIT"
     "BASHUNIT_REPORT_HTML"
     "BASHUNIT_PARALLEL_RUN"

src/main.sh

@@ -44,8 +44,14 @@ function bashunit::main::cmd_test() {
         export BASHUNIT_PARALLEL_RUN=false
         ;;
       -e|--env|--boot)
-        # shellcheck disable=SC1090
-        source "$2"
+        # Support: --env "bootstrap.sh arg1 arg2"
+        local boot_file="${2%% *}"
+        local boot_args="${2#* }"
+        if [[ "$boot_args" != "$2" ]]; then
+          export BASHUNIT_BOOTSTRAP_ARGS="$boot_args"
+        fi
+        # shellcheck disable=SC1090,SC2086
+        source "$boot_file" ${BASHUNIT_BOOTSTRAP_ARGS:-}
         shift
         ;;
       -l|--log-junit)
@@ -139,8 +145,8 @@ function bashunit::main::cmd_test() {
   fi
 
   # Optional bootstrap
-  # shellcheck disable=SC1090
-  [[ -f "${BASHUNIT_BOOTSTRAP:-}" ]] && source "$BASHUNIT_BOOTSTRAP"
+  # shellcheck disable=SC1090,SC2086
+  [[ -f "${BASHUNIT_BOOTSTRAP:-}" ]] && source "$BASHUNIT_BOOTSTRAP" ${BASHUNIT_BOOTSTRAP_ARGS:-}
 
   if [[ "${BASHUNIT_NO_OUTPUT:-false}" == true ]]; then
     exec >/dev/null 2>&1
@@ -183,8 +189,14 @@ function bashunit::main::cmd_bench() {
         export BASHUNIT_SIMPLE_OUTPUT=false
         ;;
       -e|--env|--boot)
-        # shellcheck disable=SC1090
-        source "$2"
+        # Support: --env "bootstrap.sh arg1 arg2"
+        local boot_file="${2%% *}"
+        local boot_args="${2#* }"
+        if [[ "$boot_args" != "$2" ]]; then
+          export BASHUNIT_BOOTSTRAP_ARGS="$boot_args"
+        fi
+        # shellcheck disable=SC1090,SC2086
+        source "$boot_file" ${BASHUNIT_BOOTSTRAP_ARGS:-}
         shift
         ;;
       -vvv|--verbose)
@@ -211,8 +223,8 @@ function bashunit::main::cmd_bench() {
   fi
 
   # Optional bootstrap
-  # shellcheck disable=SC1090
-  [[ -f "${BASHUNIT_BOOTSTRAP:-}" ]] && source "$BASHUNIT_BOOTSTRAP"
+  # shellcheck disable=SC1090,SC2086
+  [[ -f "${BASHUNIT_BOOTSTRAP:-}" ]] && source "$BASHUNIT_BOOTSTRAP" ${BASHUNIT_BOOTSTRAP_ARGS:-}
 
   set +euo pipefail
 

tests/acceptance/bashunit_bootstrap_args_test.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+function set_up_before_script() {
+  TEST_ENV_FILE="tests/acceptance/fixtures/.env.default"
+}
+
+function test_bootstrap_receives_arguments_via_env_flag() {
+  local output
+  output=$(./bashunit --no-parallel --simple \
+    --env "tests/acceptance/fixtures/bootstrap_with_args.sh hello world" \
+    tests/acceptance/fixtures/test_bootstrap_args.sh 2>&1) || true
+
+  assert_contains "All tests passed" "$output"
+}
+
+function test_bootstrap_without_arguments_still_works() {
+  local output
+  output=$(./bashunit --no-parallel --simple --env "$TEST_ENV_FILE" \
+    tests/acceptance/fixtures/test_bashunit_when_a_test_passes.sh 2>&1) || true
+
+  assert_contains "All tests passed" "$output"
+}
+
+function test_bootstrap_args_via_env_variable() {
+  local output
+  # Use --env flag to set the bootstrap file (avoiding .env override),
+  # but use BASHUNIT_BOOTSTRAP_ARGS from environment
+  output=$(BASHUNIT_BOOTSTRAP_ARGS="hello world" \
+    ./bashunit --no-parallel --simple \
+    --env "tests/acceptance/fixtures/bootstrap_with_args.sh" \
+    tests/acceptance/fixtures/test_bootstrap_args.sh 2>&1) || true
+
+  assert_contains "All tests passed" "$output"
+}

tests/acceptance/fixtures/bootstrap_with_args.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Bootstrap file that receives arguments and exports them for tests
+export BOOTSTRAP_ARG1="${1:-}"
+export BOOTSTRAP_ARG2="${2:-}"
+export BOOTSTRAP_ALL_ARGS="$*"

tests/acceptance/fixtures/test_bootstrap_args.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+function test_bootstrap_arg1_is_available() {
+  assert_equals "hello" "$BOOTSTRAP_ARG1"
+}
+
+function test_bootstrap_arg2_is_available() {
+  assert_equals "world" "$BOOTSTRAP_ARG2"
+}
+
+function test_all_bootstrap_args_are_available() {
+  assert_equals "hello world" "$BOOTSTRAP_ALL_ARGS"
+}