FIX #18: bash_unit changes current working directory to current test file

Author: pgrange

README.md

@@ -61,6 +61,7 @@ Running test_assert_status_code_fails... SUCCESS
 Running test_assert_status_code_shows_stdout_stderr_on_failure... SUCCESS
 Running test_assert_status_code_succeeds... SUCCESS
 Running test_assert_succeeds... SUCCESS
+Running test_bash_unit_changes_cwd_to_current_test_file_directory... SUCCESS
 Running test_bash_unit_runs_teardown_even_in_case_of_failure... SUCCESS
 Running test_bash_unit_succeed_when_no_failure_even_if_no_teardown... SUCCESS
 Running test_display_usage_when_test_file_does_not_exist... SUCCESS
@@ -119,6 +120,8 @@ You may write a *teardown* function that will be exectuted after each test is ru
 
 If you need to set someting up only once for all tests, simply write your code outside any test function, this is a bash script.
 
+bash_unit changes the current working directory to the one of the running test file. If you need to access files from your test code, for instance the script under test, use path relative to the test file.
+
 You may need to change the behavior of some commands to create conditions for your code under test to behave as expected. The *fake* function may help you to do that, see bellow.
 
 # Test functions

bash_unit

@@ -202,7 +202,11 @@ failure=0
 for test_file in "$@"
 do
   echo "Running tests in $test_file"
-  (source "$test_file"; run_test_suite)
+  (
+    source "$test_file"
+    cd $(dirname "$test_file")
+    run_test_suite
+  )
   failure=$(( $? || $failure))
 done
 exit $failure

getting_started/tests/test_bonjour_monde

@@ -1,9 +1,3 @@
 test_should_print_bonjour_monde() {
-  assert_equals "Bonjour monde !" "$(./bonjour_monde)"
+  assert_equals "Bonjour monde !" "$(../bonjour_monde)"
 }
-
-# Change to directory where bash_unit so
-# that we can use our scripts under test
-# more easily
-
-cd $(dirname $0)

getting_started/tests/test_hello_world

@@ -1,9 +1,3 @@
 test_should_print_hello_world() {
-  assert_equals "Hello world!" "$(./hello_world)"
+  assert_equals "Hello world!" "$(../hello_world)"
 }
-
-# Change to directory where bash_unit so
-# that we can use our scripts under test
-# more easily
-
-cd $(dirname 0)

getting_started/tests/test_no_ablo_espanol

@@ -1,13 +1,7 @@
 test_no_ablo_espanol() {
-  assert_fail ./hola_mundo
+  assert_fail ../hola_mundo
 }
 
 test_should_tell_no_ablo_espanol() {
-  assert_equals "No ablo espanol" "$(./hola_mundo 2>&1)"
+  assert_equals "No ablo espanol" "$(../hola_mundo 2>&1)"
 }
-
-# Change to directory where bash_unit so
-# that we can use our scripts under test
-# more easily
-
-cd $(dirname $0)

tests/test_bash_unit.sh

@@ -148,7 +148,7 @@ EOF
 }
 
 test_run_all_tests_even_in_case_of_failure() {
-  bash_unit_output=$($0 <(cat << EOF
+  bash_unit_output=$($BASH_UNIT <(cat << EOF
 function test_succeed() { assert true ; }
 function test_fails()   { assert false ; }
 EOF
@@ -162,15 +162,15 @@ Running test_succeed... SUCCESS" "$bash_unit_output"
 }
 
 test_exit_code_not_0_in_case_of_failure() {
-  assert_fail "$0 <(cat << EOF
+  assert_fail "$BASH_UNIT <(cat << EOF
 function test_succeed() { assert true ; }
 function test_fails()   { assert false ; }
 EOF
 )"
 }
 
 test_run_all_file_parameters() {
-  bash_unit_output=$($0 \
+  bash_unit_output=$($BASH_UNIT \
     <(echo "test_one() { echo -n ; }") \
     <(echo "test_two() { echo -n ; }") \
     | sed -e 's:/dev/fd/[0-9]*:test_file:' \
@@ -184,7 +184,7 @@ Running test_two... SUCCESS" "$bash_unit_output"
 }
 
 test_run_only_tests_that_match_pattern() {
-  bash_unit_output=$($0 -p one \
+  bash_unit_output=$($BASH_UNIT -p one \
     <(echo "test_one() { echo -n ; }") \
     <(echo "test_two() { echo -n ; }") \
     | sed -e 's:/dev/fd/[0-9]*:test_file:' \
@@ -197,35 +197,42 @@ Running tests in test_file" "$bash_unit_output"
 }
 
 test_fails_when_test_file_does_not_exist() {
-  assert_fail "$0 /not_exist/not_exist"
+  assert_fail "$BASH_UNIT /not_exist/not_exist"
 }
 
 test_display_usage_when_test_file_does_not_exist() {
-  bash_unit_output=$($0 /not_exist/not_exist 2>&1 >/dev/null | line 1)
+  bash_unit_output=$($BASH_UNIT /not_exist/not_exist 2>&1 >/dev/null | line 1)
 
   assert_equals "file does not exist: /not_exist/not_exist"\
                 "$bash_unit_output" 
 }
 
 test_bash_unit_succeed_when_no_failure_even_if_no_teardown() {
   #FIX https://github.com/pgrange/bash_unit/issues/8
-  assert "$0 <(echo 'test_success() { echo -n ; }')"
+  assert "$BASH_UNIT <(echo 'test_success() { echo -n ; }')"
 }
 
 test_bash_unit_runs_teardown_even_in_case_of_failure() {
   #FIX https://github.com/pgrange/bash_unit/issues/10
   assert_equals "ran teardown" \
-    "$($0 <(echo 'test_fail() { fail ; } ; teardown() { echo "ran teardown" >&2 ; }') 2>&1 >/dev/null)"
+    "$($BASH_UNIT <(echo 'test_fail() { fail ; } ; teardown() { echo "ran teardown" >&2 ; }') 2>&1 >/dev/null)"
 }
 
 test_one_test_should_stop_after_first_assertion_failure() {
   #FIX https://github.com/pgrange/bash_unit/issues/10
   assert_equals "before failure" \
-    "$($0 <(echo 'test_fail() { echo "before failure" >&2 ; fail ; echo "after failure" >&2 ; }') 2>&1 >/dev/null)"
+    "$($BASH_UNIT <(echo 'test_fail() { echo "before failure" >&2 ; fail ; echo "after failure" >&2 ; }') 2>&1 >/dev/null)"
 
 }
 
+test_bash_unit_changes_cwd_to_current_test_file_directory() {
+  assert "ls ../tests/$(basename $BASH_SOURCE)" \
+    "bash_unit should change current working directory to match the directory of the currenlty running test"
+}
+
 line() {
   line_nb=$1
   tail -n +$line_nb | head -1
 }
+
+BASH_UNIT=../bash_unit

tests/test_doc.sh

@@ -4,7 +4,7 @@ TEST_PATTERN='```bash|```test'
 OUTPUT_PATTERN='```output'
 LANG=C
 
-cd $(dirname $0)
+BASH_UNIT=./bash_unit
 
 prepare_tests() {
   mkdir /tmp/$$
@@ -29,7 +29,7 @@ prepare_tests() {
 function run_doc_test() {
   local remaining="$1"
   local swap="$2"
-  $0 <(
+  $BASH_UNIT <(
     cat "$remaining" | _next_code "$swap"
   ) | tail -n +2 | sed -e 's:/dev/fd/[0-9]*:doc:g' 
   cat "$swap" > "$remaining"
@@ -62,4 +62,5 @@ function _next_quote_section() {
   '
 }
 
+cd $(dirname $0)
 prepare_tests