Merge pull request #549 from TypedDevs/feat/546-login-shell

Add new option for login shell

Author: Chemaclass

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Added
 - Add bootstrap argument passing support via `--env "file.sh arg1 arg2"` or `BASHUNIT_BOOTSTRAP_ARGS` (fixes #546)
 - Add `--preserve-env` flag to skip `.env` loading and use shell environment only (fixes #546)
+- Add `-l, --login` flag to run tests in login shell context (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)
@@ -283,7 +284,7 @@
 - Enable display execution time on macOS with `SHOW_EXECUTION_TIME`
 - Support for displaying the clock without `perl` (for non-macOS)
 - Enable strict mode
-- Add `-l|--log-junit <log.xml>` option
+- Add `--log-junit <log.xml>` option
 - Add `-r|--report-html <report.html>` option
 - Add `--debug` option
 - Add `dump` and `dd` functions for local debugging

bashunit

@@ -38,12 +38,16 @@ export BASHUNIT_ROOT_DIR
 declare -r BASHUNIT_WORKING_DIR="$PWD"
 export BASHUNIT_WORKING_DIR
 
-# Early scan for --preserve-env before loading env.sh
+# Early scan for flags that must be set before loading env.sh
 for arg in "$@"; do
-  if [[ "$arg" == "--preserve-env" ]]; then
-    export BASHUNIT_PRESERVE_ENV=true
-    break
-  fi
+  case "$arg" in
+    --preserve-env)
+      export BASHUNIT_PRESERVE_ENV=true
+      ;;
+    -l|--login)
+      export BASHUNIT_LOGIN_SHELL=true
+      ;;
+  esac
 done
 
 source "$BASHUNIT_ROOT_DIR/src/dev/debug.sh"

docs/command-line.md

@@ -48,7 +48,7 @@ bashunit test tests/ --parallel --simple
 | `-a, --assert <fn> <args>` | Run a standalone assert function |
 | `-e, --env, --boot <file>` | Load custom env/bootstrap file |
 | `-f, --filter <name>` | Only run tests matching name |
-| `-l, --log-junit <file>` | Write JUnit XML report |
+| `--log-junit <file>` | Write JUnit XML report |
 | `-p, --parallel` | Run tests in parallel (default) |
 | `--no-parallel` | Run tests sequentially |
 | `-r, --report-html <file>` | Write HTML report |
@@ -63,6 +63,7 @@ bashunit test tests/ --parallel --simple
 | `--no-output` | Suppress all output |
 | `--strict` | Enable strict shell mode |
 | `--preserve-env` | Skip `.env` loading, use shell environment only |
+| `-l, --login` | Run tests in login shell context |
 
 ### Standalone Assert
 
@@ -216,6 +217,29 @@ BASHUNIT_SIMPLE_OUTPUT=true ./bashunit test tests/ --preserve-env
 ```
 :::
 
+### Login Shell
+
+> `bashunit test -l|--login`
+
+Run tests in a login shell context by sourcing profile files.
+
+When enabled, bashunit sources the following files (if they exist) before each test:
+- `/etc/profile`
+- `~/.bash_profile`
+- `~/.bash_login`
+- `~/.profile`
+
+Use this when your tests depend on environment setup from login shell profiles, such as:
+- PATH modifications
+- Shell functions defined in `.bash_profile`
+- Environment variables set during login
+
+::: code-group
+```bash [Example]
+bashunit test tests/ --login
+```
+:::
+
 ## bench
 
 > `bashunit bench [path] [options]`
@@ -244,6 +268,8 @@ bashunit bench --filter "parse"
 | `-s, --simple` | Simple output |
 | `--detailed` | Detailed output (default) |
 | `-vvv, --verbose` | Show execution details |
+| `--preserve-env` | Skip `.env` loading, use shell environment only |
+| `-l, --login` | Run in login shell context |
 
 ## doc
 

docs/configuration.md

@@ -328,6 +328,28 @@ BASHUNIT_PRESERVE_ENV=true ./bashunit tests/
 ```
 :::
 
+## Login shell
+
+> `BASHUNIT_LOGIN_SHELL=true|false`
+
+Run tests in a login shell context by sourcing profile files. `false` by default.
+
+When enabled, bashunit sources the following files (if they exist) before each test:
+- `/etc/profile`
+- `~/.bash_profile`
+- `~/.bash_login`
+- `~/.profile`
+
+Use this when your tests depend on environment setup from login shell profiles.
+
+Similar as using `-l|--login` option on the [command line](/command-line#login-shell).
+
+::: code-group
+```bash [Example]
+BASHUNIT_LOGIN_SHELL=true
+```
+:::
+
 <script setup>
 import pkg from '../package.json'
 </script>

src/console_header.sh

@@ -103,7 +103,7 @@ Options:
   -a, --assert <fn> <args>    Run a standalone assert function
   -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
+  --log-junit <file>          Write JUnit XML report
   -p, --parallel              Run tests in parallel (default)
   --no-parallel               Run tests sequentially
   -r, --report-html <file>    Write HTML report
@@ -116,6 +116,7 @@ Options:
   --no-output                 Suppress all output
   --strict                    Enable strict shell mode (set -euo pipefail)
   --preserve-env              Skip .env loading, use shell environment only
+  -l, --login                 Run tests in login shell context
   -h, --help                  Show this help message
 
 Examples:
@@ -142,6 +143,7 @@ Options:
   --detailed                  Detailed output (default)
   -vvv, --verbose             Show execution details
   --preserve-env              Skip .env loading, use shell environment only
+  -l, --login                 Run in login shell context
   -h, --help                  Show this help message
 
 Examples:

src/env.sh

@@ -39,6 +39,7 @@ _BASHUNIT_DEFAULT_SHOW_INCOMPLETE="false"
 _BASHUNIT_DEFAULT_STRICT_MODE="false"
 _BASHUNIT_DEFAULT_STOP_ON_ASSERTION_FAILURE="true"
 _BASHUNIT_DEFAULT_PRESERVE_ENV="false"
+_BASHUNIT_DEFAULT_LOGIN_SHELL="false"
 
 : "${BASHUNIT_PARALLEL_RUN:=${PARALLEL_RUN:=$_BASHUNIT_DEFAULT_PARALLEL_RUN}}"
 : "${BASHUNIT_SHOW_HEADER:=${SHOW_HEADER:=$_BASHUNIT_DEFAULT_SHOW_HEADER}}"
@@ -55,6 +56,7 @@ _BASHUNIT_DEFAULT_PRESERVE_ENV="false"
 : "${BASHUNIT_STRICT_MODE:=${STRICT_MODE:=$_BASHUNIT_DEFAULT_STRICT_MODE}}"
 : "${BASHUNIT_STOP_ON_ASSERTION_FAILURE:=${STOP_ON_ASSERTION_FAILURE:=$_BASHUNIT_DEFAULT_STOP_ON_ASSERTION_FAILURE}}"
 : "${BASHUNIT_PRESERVE_ENV:=${PRESERVE_ENV:=$_BASHUNIT_DEFAULT_PRESERVE_ENV}}"
+: "${BASHUNIT_LOGIN_SHELL:=${LOGIN_SHELL:=$_BASHUNIT_DEFAULT_LOGIN_SHELL}}"
 
 function bashunit::env::is_parallel_run_enabled() {
   [[ "$BASHUNIT_PARALLEL_RUN" == "true" ]]
@@ -120,6 +122,10 @@ function bashunit::env::is_preserve_env_enabled() {
   [[ "$BASHUNIT_PRESERVE_ENV" == "true" ]]
 }
 
+function bashunit::env::is_login_shell_enabled() {
+  [[ "$BASHUNIT_LOGIN_SHELL" == "true" ]]
+}
+
 function bashunit::env::active_internet_connection() {
   if [[ "${BASHUNIT_NO_NETWORK:-}" == "true" ]]; then
     return 1
@@ -172,6 +178,7 @@ function bashunit::env::print_verbose() {
     "BASHUNIT_STRICT_MODE"
     "BASHUNIT_STOP_ON_ASSERTION_FAILURE"
     "BASHUNIT_PRESERVE_ENV"
+    "BASHUNIT_LOGIN_SHELL"
   )
 
   local max_length=0

src/main.sh

@@ -54,7 +54,7 @@ function bashunit::main::cmd_test() {
         source "$boot_file" ${BASHUNIT_BOOTSTRAP_ARGS:-}
         shift
         ;;
-      -l|--log-junit)
+      --log-junit)
         export BASHUNIT_LOG_JUNIT="$2"
         shift
         ;;
@@ -87,6 +87,9 @@ function bashunit::main::cmd_test() {
       --preserve-env)
         export BASHUNIT_PRESERVE_ENV=true
         ;;
+      -l|--login)
+        export BASHUNIT_LOGIN_SHELL=true
+        ;;
       *)
         raw_args+=("$1")
         ;;
@@ -208,6 +211,9 @@ function bashunit::main::cmd_bench() {
       --preserve-env)
         export BASHUNIT_PRESERVE_ENV=true
         ;;
+      -l|--login)
+        export BASHUNIT_LOGIN_SHELL=true
+        ;;
       -h|--help)
         bashunit::console_header::print_bench_help
         exit 0

src/runner.sh

@@ -397,6 +397,18 @@ function bashunit::runner::run_test() {
     trap 'exit_code=$?; bashunit::runner::cleanup_on_exit "$test_file" "$exit_code"' EXIT
     bashunit::state::initialize_assertions_count
 
+    # Source login shell profiles if enabled
+    if bashunit::env::is_login_shell_enabled; then
+      # shellcheck disable=SC1091
+      [[ -f /etc/profile ]] && source /etc/profile 2>/dev/null || true
+      # shellcheck disable=SC1090
+      [[ -f ~/.bash_profile ]] && source ~/.bash_profile 2>/dev/null || true
+      # shellcheck disable=SC1090
+      [[ -f ~/.bash_login ]] && source ~/.bash_login 2>/dev/null || true
+      # shellcheck disable=SC1090
+      [[ -f ~/.profile ]] && source ~/.profile 2>/dev/null || true
+    fi
+
     # Run set_up and capture exit code without || to preserve errexit behavior
     local setup_exit_code=0
     bashunit::runner::run_set_up "$test_file"

tests/acceptance/bashunit_init_test.sh

@@ -3,10 +3,10 @@
 
 set -euo pipefail
 
-TMP_DIR="tmp/init"
+BASHUNIT_PATH="$PWD/bashunit"
+
 function set_up() {
-  rm -rf "$TMP_DIR"
-  mkdir -p "$TMP_DIR"
+  TMP_DIR=$(mktemp -d)
 }
 
 function tear_down() {
@@ -17,7 +17,7 @@ function test_bashunit_init_creates_structure() {
   # switch into a clean temporary directory
   pushd "$TMP_DIR" >/dev/null
   # generate test scaffolding
-  ../../bashunit init > /tmp/init.log
+  "$BASHUNIT_PATH" init > /tmp/init.log
   # perform the assertions
   assert_file_exists "tests/example_test.sh"
   assert_file_exists "tests/bootstrap.sh"
@@ -27,7 +27,7 @@ function test_bashunit_init_creates_structure() {
 
 function test_bashunit_init_custom_directory() {
   pushd "$TMP_DIR" >/dev/null
-  ../../bashunit init custom > /tmp/init.log
+  "$BASHUNIT_PATH" init custom > /tmp/init.log
   assert_file_exists "custom/example_test.sh"
   assert_file_exists "custom/bootstrap.sh"
   popd >/dev/null
@@ -38,7 +38,7 @@ function test_bashunit_init_updates_env() {
 
   pushd "$TMP_DIR" >/dev/null
   echo "BASHUNIT_BOOTSTRAP=old/bootstrap.sh" > .env
-  ../../bashunit init custom > /tmp/init.log
+  "$BASHUNIT_PATH" init custom > /tmp/init.log
   assert_file_exists "custom/example_test.sh"
   assert_file_exists "custom/bootstrap.sh"
   assert_file_contains .env "#BASHUNIT_BOOTSTRAP=old/bootstrap.sh"

tests/acceptance/bashunit_login_shell_test.sh

@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+function test_login_flag_works_without_errors() {
+  local output
+  output=$(./bashunit --no-parallel --simple --login \
+    tests/acceptance/fixtures/test_bashunit_when_a_test_passes.sh 2>&1) || true
+
+  assert_contains "All tests passed" "$output"
+}
+
+function test_login_flag_short_form_works() {
+  local output
+  output=$(./bashunit --no-parallel --simple -l \
+    tests/acceptance/fixtures/test_bashunit_when_a_test_passes.sh 2>&1) || true
+
+  assert_contains "All tests passed" "$output"
+}
+
+function test_login_via_env_var() {
+  local output
+  output=$(BASHUNIT_LOGIN_SHELL=true \
+    ./bashunit --no-parallel --simple \
+    tests/acceptance/fixtures/test_bashunit_when_a_test_passes.sh 2>&1) || true
+
+  assert_contains "All tests passed" "$output"
+}