refactor(coverage): improve coverage inside lifecycle hooks (#574)

Co-authored-by: Omar Gallo <omar.gallo@mercedes-benz-com>
Co-authored-by: Chemaclass <chemaclass@outlook.es>

Author: 3 people

.github/workflows/tests-bash-3.0.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Build Bash 3.0 Docker image
         run: |
           docker build -t bashunit-bash3 -f - . <<'EOF'
-          FROM debian:bullseye-slim
+          FROM debian:bookworm-slim
 
           RUN apt-get update && apt-get install -y \
               build-essential \

.github/workflows/tests.yml

@@ -71,6 +71,7 @@ jobs:
   alpine:
     name: "On alpine-latest"
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -89,6 +90,7 @@ jobs:
   simple-output:
     name: "Simple output"
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -102,6 +104,7 @@ jobs:
   simple-output-parallel:
     name: "Simple output in parallel"
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -115,6 +118,7 @@ jobs:
   extended-output-parallel:
     name: "Extended output in parallel"
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -128,6 +132,7 @@ jobs:
   strict-mode:
     name: "Strict mode"
     runs-on: ubuntu-latest
+    timeout-minutes: 10
     steps:
       - name: Checkout
         uses: actions/checkout@v4

src/assert_dates.sh

@@ -34,8 +34,8 @@ function bashunit::date::to_epoch() {
     echo "$epoch"
     return 0
   }
-  # Try BSD date with date-only format
-  epoch=$(date -j -f "%Y-%m-%d" "$input" +%s 2>/dev/null) && {
+  # Try BSD date with date-only format (append midnight for deterministic results)
+  epoch=$(date -j -f "%Y-%m-%d %H:%M:%S" "$input 00:00:00" +%s 2>/dev/null) && {
     echo "$epoch"
     return 0
   }

src/coverage.sh

@@ -99,7 +99,7 @@ function bashunit::coverage::enable_trap() {
   # Set DEBUG trap to record line execution
   # Use ${VAR:-} to handle unset variables when set -u is active (in subshells)
   # shellcheck disable=SC2154
-  trap 'bashunit::coverage::record_line "${BASH_SOURCE:-}" "${LINENO:-}"' DEBUG
+  trap 'bashunit::coverage::record_line "${BASH_SOURCE[0]:-}" "${LINENO:-}"' DEBUG
 }
 
 function bashunit::coverage::disable_trap() {

src/runner.sh

@@ -28,6 +28,10 @@ function bashunit::runner::load_test_files() {
     # Auto-discover coverage paths if not explicitly set
     if [[ -z "$BASHUNIT_COVERAGE_PATHS" ]]; then
       BASHUNIT_COVERAGE_PATHS=$(bashunit::coverage::auto_discover_paths "${files[@]}")
+      # Fallback: if auto-discovery yields no paths, track the src/ folder
+      if [[ -z "$BASHUNIT_COVERAGE_PATHS" ]]; then
+        BASHUNIT_COVERAGE_PATHS="src/"
+      fi
     fi
     bashunit::coverage::init
   fi
@@ -564,6 +568,11 @@ function bashunit::runner::run_test() {
       [[ -f ~/.profile ]] && source ~/.profile 2>/dev/null || true
     fi
 
+    # Enable coverage tracking early to include set_up/tear_down hooks
+    if bashunit::env::is_coverage_enabled; then
+      bashunit::coverage::enable_trap
+    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"
@@ -579,11 +588,6 @@ function bashunit::runner::run_test() {
       set +euo pipefail
     fi
 
-    # Enable coverage tracking if enabled
-    if bashunit::env::is_coverage_enabled; then
-      bashunit::coverage::enable_trap
-    fi
-
     # 2>&1: Redirects the std-error (FD 2) to the std-output (FD 1).
     # points to the original std-output.
     "$fn_name" "$@" 2>&1
@@ -1037,10 +1041,20 @@ function bashunit::runner::run_set_up_before_script() {
   local start_time
   start_time=$(bashunit::clock::now)
 
+  # Enable coverage trap to attribute lines executed during set_up_before_script
+  if bashunit::env::is_coverage_enabled; then
+    bashunit::coverage::enable_trap
+  fi
+
   # Execute the hook (render_header=false since header is already rendered)
   bashunit::runner::execute_file_hook 'set_up_before_script' "$test_file" false
   local status=$?
 
+  # Disable coverage trap after hook execution
+  if bashunit::env::is_coverage_enabled; then
+    bashunit::coverage::disable_trap
+  fi
+
   local end_time
   end_time=$(bashunit::clock::now)
   local duration_ns=$((end_time - start_time))
@@ -1162,10 +1176,20 @@ function bashunit::runner::run_tear_down_after_script() {
   local start_time
   start_time=$(bashunit::clock::now)
 
+  # Enable coverage trap to attribute lines executed during tear_down_after_script
+  if bashunit::env::is_coverage_enabled; then
+    bashunit::coverage::enable_trap
+  fi
+
   # Execute the hook
   bashunit::runner::execute_file_hook 'tear_down_after_script' "$test_file"
   local status=$?
 
+  # Disable coverage trap after hook execution
+  if bashunit::env::is_coverage_enabled; then
+    bashunit::coverage::disable_trap
+  fi
+
   local end_time
   end_time=$(bashunit::clock::now)
   local duration_ns=$((end_time - start_time))

tests/acceptance/coverage_hooks_test.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+# shellcheck disable=SC2034
+
+LCOV_FILE=""
+
+function set_up_before_script() {
+  LCOV_FILE="$(bashunit::temp_file "lcov-hooks")"
+}
+
+function test_coverage_tracks_src_lines_executed_in_hooks() {
+  local output
+  output=$(BASHUNIT_PARALLEL_RUN=false ./bashunit \
+    --coverage \
+    --no-coverage-report \
+    --coverage-paths "src/globals.sh" \
+    --coverage-report "$LCOV_FILE" \
+    tests/acceptance/fixtures/test_coverage_hooks.sh 2>&1)
+
+  assert_successful_code
+
+  local lcov
+  lcov="$(cat "$LCOV_FILE" 2>/dev/null)"
+
+  assert_not_empty "$lcov"
+  assert_contains "SF:" "$lcov"
+  assert_contains "DA:" "$lcov"
+}

tests/acceptance/fixtures/test_coverage_hooks.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+# This fixture exercises coverage attribution inside lifecycle hooks.
+# The set_up hook calls src/ functions; coverage should track those lines.
+
+function set_up() {
+  local f
+  f="$(bashunit::temp_file "cov-hooks")"
+  if [ -n "${f:-}" ]; then
+    echo "tmp created" > /dev/null
+  fi
+}
+
+function test_noop() {
+  # No-op test; coverage should still attribute lines from set_up
+  assert_true true
+}

tests/unit/assert_dates_test.sh

@@ -120,7 +120,7 @@ function test_successful_assert_date_within_range_with_iso_dates() {
 function test_successful_assert_date_equals_with_mixed_formats() {
   local epoch
   epoch=$(date -d "2023-06-15" +%s 2>/dev/null) \
-    || epoch=$(date -j -f "%Y-%m-%d" "2023-06-15" +%s 2>/dev/null)
+    || epoch=$(date -j -f "%Y-%m-%d %H:%M:%S" "2023-06-15 00:00:00" +%s 2>/dev/null)
 
   assert_empty "$(assert_date_equals "$epoch" "2023-06-15")"
 }