feat(runner): show source context in failure summary

Chemaclass · Chemaclass · commit 1d7a4ce8c4d3 · 2026-03-06T03:52:22.000+01:00
When a test fails, the failure summary now shows the assertion
lines from the test function, making it easier to identify which
assertion caused the failure without opening the source file.
diff --git a/src/runner.sh b/src/runner.sh
@@ -936,7 +936,43 @@ function bashunit::runner::write_failure_result_output() {
     output_section="\n    Output:\n$raw_output"
   fi
 
-  echo -e "$test_nr) $test_file:$line_number\n$error_msg$output_section" >>"$FAILURES_OUTPUT_PATH"
+  local source_context=""
+  if [[ -n "$line_number" && -f "$test_file" ]]; then
+    source_context=$(bashunit::runner::get_failure_source_context \
+      "$test_file" "$line_number")
+  fi
+
+  echo -e "$test_nr) $test_file:$line_number\n$error_msg$output_section$source_context" \
+    >>"$FAILURES_OUTPUT_PATH"
+}
+
+function bashunit::runner::get_failure_source_context() {
+  local file=$1
+  local fn_line=$2
+
+  local end_line start_line
+  end_line=$(wc -l <"$file")
+  start_line=$((fn_line + 1))
+
+  local line_text line_num assert_lines=""
+  line_num=$start_line
+  while [[ $line_num -le $end_line ]]; do
+    line_text=$(sed -n "${line_num}p" "$file")
+    # Stop at the closing brace of the function
+    if [[ "$line_text" =~ ^[[:space:]]*\}[[:space:]]*$ ]]; then
+      break
+    fi
+    # Collect lines containing assert calls
+    if [[ "$line_text" == *assert_* ]] || [[ "$line_text" == *assert\ * ]]; then
+      local trimmed="${line_text#"${line_text%%[![:space:]]*}"}"
+      assert_lines="${assert_lines}\n    ${_BASHUNIT_COLOR_FAINT}${line_num}:${_BASHUNIT_COLOR_DEFAULT} ${trimmed}"
+    fi
+    line_num=$((line_num + 1))
+  done
+
+  if [[ -n "$assert_lines" ]]; then
+    echo -e "\n    ${_BASHUNIT_COLOR_FAINT}Source:${_BASHUNIT_COLOR_DEFAULT}${assert_lines}"
+  fi
 }
 
 function bashunit::runner::write_skipped_result_output() {
diff --git a/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_simple_output_env.snapshot b/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_simple_output_env.snapshot
@@ -6,6 +6,8 @@
 |[31m✗ Failed[0m: Assert failing
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'0'[0m
+|    [2mSource:[0m
+|    [2m13:[0m assert_same 1 0
 
 
 
diff --git a/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_simple_output_option.snapshot b/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_simple_output_option.snapshot
@@ -6,6 +6,8 @@
 |[31m✗ Failed[0m: Assert failing
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'0'[0m
+|    [2mSource:[0m
+|    [2m13:[0m assert_same 1 0
 
 
 
diff --git a/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_verbose_output_env.snapshot b/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_verbose_output_env.snapshot
@@ -13,6 +13,8 @@
 |[31m✗ Failed[0m: Assert failing
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'0'[0m
+|    [2mSource:[0m
+|    [2m13:[0m assert_same 1 0
 
 [2mTests:     [0m [32m4 passed[0m, [31m1 failed[0m, 5 total
 [2mAssertions:[0m [32m6 passed[0m, [31m1 failed[0m, 7 total
diff --git a/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_verbose_output_option.snapshot b/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_verbose_output_option.snapshot
@@ -13,6 +13,8 @@
 |[31m✗ Failed[0m: Assert failing
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'0'[0m
+|    [2mSource:[0m
+|    [2m13:[0m assert_same 1 0
 
 [2mTests:     [0m [32m4 passed[0m, [31m1 failed[0m, 5 total
 [2mAssertions:[0m [32m6 passed[0m, [31m1 failed[0m, 7 total
diff --git a/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_with_multiple_failing_tests.snapshot b/tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_with_multiple_failing_tests.snapshot
@@ -14,6 +14,9 @@
 |[31m✗ Failed[0m: Assert failing
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'2'[0m
+|    [2mSource:[0m
+|    [2m8:[0m assert_same 1 2
+|    [2m9:[0m assert_same 3 4
 
 [2mTests:     [0m [32m1 passed[0m, [33m0 skipped[0m, [36m2 incomplete[0m, [31m1 failed[0m, 4 total
 [2mAssertions:[0m [32m1 passed[0m, [33m2 skipped[0m, [36m2 incomplete[0m, [31m1 failed[0m, 6 total
diff --git a/tests/acceptance/snapshots/bashunit_log_junit_test_sh.test_bashunit_when_log_junit_env.snapshot b/tests/acceptance/snapshots/bashunit_log_junit_test_sh.test_bashunit_when_log_junit_env.snapshot
@@ -10,6 +10,8 @@
 |[31m✗ Failed[0m: Failure
 |    [2mExpected[0m [1m'2'[0m
 |    [2mbut got [0m [1m'3'[0m
+|    [2mSource:[0m
+|    [2m8:[0m assert_same 2 3
 
 [2mTests:     [0m [32m1 passed[0m, [31m1 failed[0m, 2 total
 [2mAssertions:[0m [32m1 passed[0m, [31m1 failed[0m, 2 total
diff --git a/tests/acceptance/snapshots/bashunit_log_junit_test_sh.test_bashunit_when_log_junit_option.snapshot b/tests/acceptance/snapshots/bashunit_log_junit_test_sh.test_bashunit_when_log_junit_option.snapshot
@@ -10,6 +10,8 @@
 |[31m✗ Failed[0m: Failure
 |    [2mExpected[0m [1m'2'[0m
 |    [2mbut got [0m [1m'3'[0m
+|    [2mSource:[0m
+|    [2m8:[0m assert_same 2 3
 
 [2mTests:     [0m [32m1 passed[0m, [31m1 failed[0m, 2 total
 [2mAssertions:[0m [32m1 passed[0m, [31m1 failed[0m, 2 total
diff --git a/tests/acceptance/snapshots/bashunit_report_html_test_sh.test_bashunit_when_report_html_env.snapshot b/tests/acceptance/snapshots/bashunit_report_html_test_sh.test_bashunit_when_report_html_env.snapshot
@@ -12,6 +12,8 @@
 |[31m✗ Failed[0m: Fail
 |    [2mExpected[0m [1m'to be empty'[0m
 |    [2mbut got [0m [1m'non empty'[0m
+|    [2mSource:[0m
+|    [2m8:[0m assert_empty "non empty"
 
 [2mTests:     [0m [32m1 passed[0m, [33m1 skipped[0m, [36m1 incomplete[0m, [31m1 failed[0m, 4 total
 [2mAssertions:[0m [32m1 passed[0m, [33m1 skipped[0m, [36m1 incomplete[0m, [31m1 failed[0m, 4 total
diff --git a/tests/acceptance/snapshots/bashunit_report_html_test_sh.test_bashunit_when_report_html_option.snapshot b/tests/acceptance/snapshots/bashunit_report_html_test_sh.test_bashunit_when_report_html_option.snapshot
@@ -12,6 +12,8 @@
 |[31m✗ Failed[0m: Fail
 |    [2mExpected[0m [1m'to be empty'[0m
 |    [2mbut got [0m [1m'non empty'[0m
+|    [2mSource:[0m
+|    [2m8:[0m assert_empty "non empty"
 
 [2mTests:     [0m [32m1 passed[0m, [33m1 skipped[0m, [36m1 incomplete[0m, [31m1 failed[0m, 4 total
 [2mAssertions:[0m [32m1 passed[0m, [33m1 skipped[0m, [36m1 incomplete[0m, [31m1 failed[0m, 4 total
diff --git a/tests/acceptance/snapshots/bashunit_stop_on_failure_test_sh.test_bashunit_when_stop_on_failure_env.snapshot b/tests/acceptance/snapshots/bashunit_stop_on_failure_test_sh.test_bashunit_when_stop_on_failure_env.snapshot
@@ -11,6 +11,10 @@
 |[31m✗ Failed[0m: B error
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'2'[0m
+|    [2mSource:[0m
+|    [2m7:[0m assert_same 1 1
+|    [2m8:[0m assert_same 1 2 # error
+|    [2m9:[0m assert_same 2 2
 
 [2mTests:     [0m [32m1 passed[0m, [31m1 failed[0m, 2 total
 [2mAssertions:[0m [32m2 passed[0m, [31m1 failed[0m, 3 total
diff --git a/tests/acceptance/snapshots/bashunit_stop_on_failure_test_sh.test_bashunit_when_stop_on_failure_env_simple_output.snapshot b/tests/acceptance/snapshots/bashunit_stop_on_failure_test_sh.test_bashunit_when_stop_on_failure_env_simple_output.snapshot
@@ -8,6 +8,10 @@
 |[31m✗ Failed[0m: B error
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'2'[0m
+|    [2mSource:[0m
+|    [2m7:[0m assert_same 1 1
+|    [2m8:[0m assert_same 1 2 # error
+|    [2m9:[0m assert_same 2 2
 
 
 
diff --git a/tests/acceptance/snapshots/bashunit_stop_on_failure_test_sh.test_bashunit_when_stop_on_failure_option.snapshot b/tests/acceptance/snapshots/bashunit_stop_on_failure_test_sh.test_bashunit_when_stop_on_failure_option.snapshot
@@ -11,6 +11,10 @@
 |[31m✗ Failed[0m: B error
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'2'[0m
+|    [2mSource:[0m
+|    [2m7:[0m assert_same 1 1
+|    [2m8:[0m assert_same 1 2 # error
+|    [2m9:[0m assert_same 2 2
 
 [2mTests:     [0m [32m1 passed[0m, [31m1 failed[0m, 2 total
 [2mAssertions:[0m [32m2 passed[0m, [31m1 failed[0m, 3 total

-Original file line number
+Diff line change
 |[31m✗ Failed[0m: Assert failing
 |    [2mExpected[0m [1m'1'[0m
 |    [2mbut got [0m [1m'0'[0m
 +|    [2mSource:[0m
 +|    [2m13:[0m assert_same 1 0
-Original file line number
+Diff line change
 |[31m✗ Failed[0m: Failure
 |    [2mExpected[0m [1m'2'[0m
 |    [2mbut got [0m [1m'3'[0m
 +|    [2mSource:[0m
 +|    [2m8:[0m assert_same 2 3
 [2mTests:     [0m [32m1 passed[0m, [31m1 failed[0m, 2 total
 [2mAssertions:[0m [32m1 passed[0m, [31m1 failed[0m, 2 total
-Original file line number
+Diff line change
 |[31m✗ Failed[0m: Fail
 |    [2mExpected[0m [1m'to be empty'[0m
 |    [2mbut got [0m [1m'non empty'[0m
 +|    [2mSource:[0m
 +|    [2m8:[0m assert_empty "non empty"
 [2mTests:     [0m [32m1 passed[0m, [33m1 skipped[0m, [36m1 incomplete[0m, [31m1 failed[0m, 4 total
 [2mAssertions:[0m [32m1 passed[0m, [33m1 skipped[0m, [36m1 incomplete[0m, [31m1 failed[0m, 4 total