Introduce a skip test option

One can now decide to not run some tests if they match a given
pattern using the `-s` command line option.

Author: pgrange

README.adoc

@@ -12,7 +12,7 @@ bash_unit - bash unit testing enterprise edition framework for professionals!
 
 == Synopsis
 
-*bash_unit* [-f tap] [-p <pattern>] [-r] [test_file]
+*bash_unit* [-f tap] [-p <pattern>] [-s <pattern>] [-r] [test_file]
 
 == Description
 
@@ -36,6 +36,12 @@ _(by the way, the documentation you are reading is itself tested with bash-unit)
   You can specify several patterns by repeating this option
   for each pattern.
 
+*-s* _pattern_::
+  skip tests which name matches the given pattern.
+  You can specify several patterns by repeating this option
+  for each pattern.
+  Tests will appear in *bash_unit* output as _pending_.
+
 *-r*::
   executes test cases in random order.
   Only affects the order within a test file (files are always
@@ -199,6 +205,39 @@ Running tests in tests/test_core.sh
 Overall result: SUCCESS
 ```
 
+You can combine the _-p_ option with _-s_ to skip some of the tests. This option accepts a pattern
+as parameter and mark as pending any test function which matches this pattern.
+
+```test
+./bash_unit -p fail_fails -p assert -s no -s status tests/test_core.sh
+```
+
+```output
+Running tests in tests/test_core.sh
+	Running test_assert_equals_fails_when_not_equal ... PENDING
+	Running test_assert_matches_fails_when_not_matching ... PENDING
+	Running test_assert_no_diff_fails_when_diff ... PENDING
+	Running test_assert_no_diff_succeeds_when_no_diff ... PENDING
+	Running test_assert_not_equals_fails_when_equal ... PENDING
+	Running test_assert_not_equals_succeeds_when_not_equal ... PENDING
+	Running test_assert_not_matches_fails_when_matching ... PENDING
+	Running test_assert_not_matches_succeed_when_not_matching ... PENDING
+	Running test_assert_status_code_fails ... PENDING
+	Running test_assert_status_code_succeeds ... PENDING
+	Running test_assert_equals_succeed_when_equal ... SUCCESS
+	Running test_assert_fails ... SUCCESS
+	Running test_assert_fails_fails ... SUCCESS
+	Running test_assert_fails_succeeds ... SUCCESS
+	Running test_assert_matches_succeed_when_matching ... SUCCESS
+	Running test_assert_shows_stderr_on_failure ... SUCCESS
+	Running test_assert_shows_stdout_on_failure ... SUCCESS
+	Running test_assert_succeeds ... SUCCESS
+	Running test_assert_within_delta_fails ... SUCCESS
+	Running test_assert_within_delta_succeeds ... SUCCESS
+	Running test_fail_fails ... SUCCESS
+Overall result: SUCCESS
+```
+
 *bash_unit* supports the http://testanything.org/[Test Anything Protocol] so you can ask for a tap formatted
 output with the _-f_ option.
 

bash_unit

@@ -240,8 +240,19 @@ run_tests() {
     notify_test_pending "$pending_test"
   done
 
+  if [[ -n "$skip_pattern" ]]
+  then
+    for skipped_test in $(set | "$GREP"  -E '^test.* \(\)' | "$GREP" -E "$test_pattern" | "$GREP" -E "$skip_pattern" | "$SED" -e 's: .*::')
+    do
+      notify_test_starting "$skipped_test"
+      notify_test_pending "$skipped_test"
+    done
+    local tests_to_run="$(set | "$GREP"  -E '^test.* \(\)' | "$GREP" -E "$test_pattern" | "$GREP" -v -E "$skip_pattern" | "$SED" -e 's: .*::' | maybe_shuffle)"
+  else
+    local tests_to_run="$(set | "$GREP"  -E '^test.* \(\)' | "$GREP" -E "$test_pattern" |  "$SED" -e 's: .*::' | maybe_shuffle)"
+  fi
 
-  for test in $(set | "$GREP"  -E '^test.* \(\)' | "$GREP" -E "$test_pattern" | "$SED" -e 's: .*::' | maybe_shuffle)
+  for test in $tests_to_run
   do
     (
       local status=0
@@ -270,9 +281,10 @@ run_teardown_suite() {
 
 usage() {
   echo "$1" >&2
-  echo "$0 [-f <output format>] [-p <pattern1>] [-p <pattern2>] [-r] ... <test_file1> <test_file2> ..." >&2
+  echo "$0 [-f <output format>] [-p <pattern1>] [-p <pattern2>] [-s <skip_pattern1>] [-s <skip_pattern2>] [-r] ... <test_file1> <test_file2> ..." >&2
   echo >&2
   echo "Runs tests in test files that match <pattern>s" >&2
+  echo "Test that match the skip patterns are skipped and displayed as PENDING" >&2
   echo "<output format> is optional only supported value is tap" >&2
   echo "-r to execute test cases in random order" >&2
   echo "-v to get current version information" >&2
@@ -427,14 +439,20 @@ tap_format() {
 
 output_format=text
 test_pattern=""
-separator=""
-randomize=0
-while getopts "vp:f:r" option
+test_pattern_separator=""
+skip_pattern=""
+skip_pattern_separator=""
+randomise=0
+while getopts "vp:s:f:r" option
 do
   case "$option" in
     p)
-      test_pattern="${test_pattern}${separator}${OPTARG}"
-      separator="|"
+      test_pattern="${test_pattern}${test_pattern_separator}${OPTARG}"
+      test_pattern_separator="|"
+      ;;
+    s)
+      skip_pattern="${skip_pattern}${skip_pattern_separator}${OPTARG}"
+      skip_pattern_separator="|"
       ;;
     f)
       output_format="${OPTARG}"

tests/test_cli.sh

@@ -85,6 +85,28 @@ Overall result: SUCCESS" \
   "$bash_unit_output"
 }
 
+test_do_not_run_skipped_tests() {
+  assert "$BASH_UNIT -s two \
+    <(echo 'test_one() { echo -n ; }
+            test_two() { fail ; }') \
+  "
+}
+
+test_skipped_tests_appear_in_output() {
+  bash_unit_output=$($BASH_UNIT -s two \
+    <(echo 'test_one() { echo -n ; }
+            test_two() { fail ; }') \
+    | "$SED" -e 's:/dev/fd/[0-9]*:test_file:' \
+  )
+
+  assert_equals "\
+Running tests in test_file
+	Running test_two ... PENDING
+	Running test_one ... SUCCESS
+Overall result: SUCCESS" \
+  "$bash_unit_output"
+}
+
 test_fails_when_test_file_does_not_exist() {
   assert_fails "$BASH_UNIT /not_exist/not_exist"
 }