Merge pull request #243 from apotterri/defined-order_20240115

fix: run test functions in defined order

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Add `--upgrade` option to `./bashunit`
 - Remove support to deprecated `setUp`, `tearDown`, `setUpBeforeScript` and `tearDownAfterScript` functions
 - Optimize test execution time
+- Test functions are now run in the order they're defined in a test file
 
 ## [0.10.1](https://github.com/TypedDevs/bashunit/compare/0.10.0...0.10.1) - 2023-11-13
 

src/runner.sh

@@ -34,16 +34,33 @@ function runner::load_test_files() {
   done
 }
 
+function runner::functions_for_script() {
+  local script="$1"
+  local all_function_names="$2"
+
+  # Filter the names down to the ones defined in the script, sort them by line
+  # number
+  shopt -s extdebug
+  for f in $all_function_names; do
+    declare -F "$f" | grep "$script"
+  done | sort -k2 -n | awk '{print $1}'
+  shopt -u extdebug
+}
+
 function runner::call_test_functions() {
   local script="$1"
   local filter="$2"
   local prefix="test"
   # Use declare -F to list all function names
-  local function_names
-  function_names=$(declare -F | awk '{print $3}')
+  local all_function_names
+  all_function_names=$(declare -F | awk '{print $3}')
+  local filtered_functions
+  # shellcheck disable=SC2207
+  filtered_functions=$(helper::get_functions_to_run "$prefix" "$filter" "$all_function_names")
+
   local functions_to_run
   # shellcheck disable=SC2207
-  functions_to_run=($(helper::get_functions_to_run "$prefix" "$filter" "$function_names"))
+  functions_to_run=($(runner::functions_for_script "$script" "$filtered_functions"))
 
   if [[ "${#functions_to_run[@]}" -gt 0 ]]; then
     if [[ "$SIMPLE_OUTPUT" == false ]]; then

tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_verbose_output_env.snapshot

@@ -1,11 +1,11 @@
 Running ./tests/acceptance/fixtures/test_bashunit_when_a_test_fail.sh
-✓ Passed: Assert contains
-✓ Passed: Assert empty
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 ✗ Failed: Assert failing
     Expected '1'
     but got '0'
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 
 Tests:      4 passed, 1 failed, 5 total
 Assertions: 6 passed, 1 failed, 7 total

tests/acceptance/snapshots/bashunit_fail_test_sh.test_bashunit_when_a_test_fail_verbose_output_option.snapshot

@@ -1,11 +1,11 @@
 Running ./tests/acceptance/fixtures/test_bashunit_when_a_test_fail.sh
-✓ Passed: Assert contains
-✓ Passed: Assert empty
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 ✗ Failed: Assert failing
     Expected '1'
     but got '0'
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 
 Tests:      4 passed, 1 failed, 5 total
 Assertions: 6 passed, 1 failed, 7 total

tests/acceptance/snapshots/bashunit_find_tests_command_line_test_sh.test_all_tests_files_with_wildcard.snapshot

@@ -1,9 +1,9 @@
 Running ./tests/acceptance/fixtures/tests_path/a_test.sh
-✓ Passed: Assert empty
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 Running ./tests/acceptance/fixtures/tests_path/other_test.sh
-✓ Passed: Assert contains
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 
 Tests:      4 passed, 4 total
 Assertions: 6 passed, 6 total

tests/acceptance/snapshots/bashunit_find_tests_command_line_test_sh.test_all_tests_files_within_a_directory.snapshot

@@ -1,9 +1,9 @@
 Running ./tests/acceptance/fixtures/tests_path/a_test.sh
-✓ Passed: Assert empty
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 Running ./tests/acceptance/fixtures/tests_path/other_test.sh
-✓ Passed: Assert contains
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 
 Tests:      4 passed, 4 total
 Assertions: 6 passed, 6 total

tests/acceptance/snapshots/bashunit_find_tests_command_line_test_sh.test_all_tests_files_within_a_file.snapshot

@@ -1,6 +1,6 @@
 Running ./tests/acceptance/fixtures/tests_path/a_test.sh
-✓ Passed: Assert empty
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 
 Tests:      2 passed, 2 total
 Assertions: 3 passed, 3 total

tests/acceptance/snapshots/bashunit_pass_test_sh.test_bashunit_when_a_test_passes_verbose_output_env.snapshot

@@ -1,8 +1,8 @@
 Running ./tests/acceptance/fixtures/test_bashunit_when_a_test_passes.sh
-✓ Passed: Assert contains
-✓ Passed: Assert empty
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 
 Tests:      4 passed, 4 total
 Assertions: 6 passed, 6 total

tests/acceptance/snapshots/bashunit_pass_test_sh.test_bashunit_when_a_test_passes_verbose_output_option.snapshot

@@ -1,8 +1,8 @@
 Running ./tests/acceptance/fixtures/test_bashunit_when_a_test_passes.sh
-✓ Passed: Assert contains
-✓ Passed: Assert empty
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 
 Tests:      4 passed, 4 total
 Assertions: 6 passed, 6 total

tests/acceptance/snapshots/bashunit_path_test_sh.test_bashunit_with_argument_path.snapshot

@@ -1,9 +1,9 @@
 Running tests/acceptance/fixtures/tests_path/a_test.sh
-✓ Passed: Assert empty
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 Running tests/acceptance/fixtures/tests_path/other_test.sh
-✓ Passed: Assert contains
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 
 Tests:      4 passed, 4 total
 Assertions: 6 passed, 6 total

tests/acceptance/snapshots/bashunit_path_test_sh.test_bashunit_with_env_default_path.snapshot

@@ -1,9 +1,9 @@
 Running tests/acceptance/fixtures/tests_path/a_test.sh
-✓ Passed: Assert empty
 ✓ Passed: Assert greater and less than
+✓ Passed: Assert empty
 Running tests/acceptance/fixtures/tests_path/other_test.sh
-✓ Passed: Assert contains
 ✓ Passed: Assert equals
+✓ Passed: Assert contains
 
 Tests:      4 passed, 4 total
 Assertions: 6 passed, 6 total