ADD pending and/or todo keywords

Fix #38

Author: pgrange

README.adoc

@@ -188,6 +188,9 @@ 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.
 
+If you want to keep an eye on a test not yet implemented, prefix the name of the function by *todo* instead of test.
+Test to do are not executed and do not impact the global status of your test suite but are displayed in *bash_unit* output.
+
 *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.

bash_unit

@@ -132,6 +132,14 @@ stacktrace() {
 
 run_test_suite() {
   local failure=0
+
+  for pending_test in $(set | grep  -E '^(pending|todo).* \(\)' | grep -E "$test_pattern" | sed -e 's: .*::')
+  do
+    notify_test_starting "$pending_test"
+    notify_test_pending "$pending_test"
+  done
+
+
   for test in $(set | grep  -E '^test.* \(\)' | grep -E "$test_pattern" | sed -e 's: .*::')
   do
     (
@@ -169,6 +177,10 @@ pretty_success() {
   pretty_format "$GREEN" "\u2713" "$1"
 }
 
+pretty_warning() {
+  pretty_format "$YELLOW" "\u2717" "$1"
+}
+
 pretty_failure() {
   pretty_format "$RED" "\u2717" "$1"
 }
@@ -225,6 +237,11 @@ text_format() {
     local test="$1"
     echo -n "Running $test... " | color "$BLUE"
   }
+  notify_test_pending() {
+    echo -n "PENDING" | pretty_warning
+    echo
+  }
+
   notify_test_succeeded() {
     echo -n "SUCCESS" | pretty_success
     echo
@@ -254,6 +271,12 @@ tap_format() {
   notify_test_starting() {
     echo -n
   }
+  notify_test_pending() {
+    local test="$1"
+    echo -n "ok" | pretty_warning -
+    echo -n "$test" | color "$BLUE"
+    echo " # skip test to be written" | color "$YELLOW"
+  }
   notify_test_succeeded() {
     local test="$1"
     echo -n "ok" | pretty_success -

tests/test_cli.sh

@@ -49,6 +49,27 @@ Running test_one... SUCCESS
 Running tests in test_file" "$bash_unit_output" 
 }
 
+test_do_not_run_pending_tests() {
+  assert "$BASH_UNIT \
+    <(echo 'pending_should_not_run() { fail ; }
+            todo_should_not_run() { fail ; }') \
+  "
+}
+
+test_pending_tests_appear_in_output() {
+  bash_unit_output=$($BASH_UNIT \
+    <(echo 'pending_should_not_run() { fail ; }
+            todo_should_not_run() { fail ; }') \
+    | sed -e 's:/dev/fd/[0-9]*:test_file:' \
+  )
+
+  assert_equals "\
+Running tests in test_file
+Running pending_should_not_run... PENDING
+Running todo_should_not_run... PENDING" \
+  "$bash_unit_output"
+}
+
 test_fails_when_test_file_does_not_exist() {
   assert_fail "$BASH_UNIT /not_exist/not_exist"
 }

tests/test_tap_format

@@ -37,6 +37,20 @@ EOF
 )"
 }
 
+test_tap_format_for_one_pending_test() {
+   assert_equals \
+"\
+# Running tests in code
+ok - pending_not_yet_implemented # skip test to be written\
+" \
+"$(bash_unit_out_for_code <<EOF
+  pending_not_yet_implemented() {
+    assert false
+  }
+EOF
+)"
+}
+
 test_tap_format_for_failing_test_with_stdout_stderr_outputs() {
    assert_equals \
 "\