note() function

Changes

@@ -1,3 +1,12 @@
+* bash-tap 1.0.4 (2015-05-30-22:05)
+  * Updated skip() function and 'plan skip_all desc'
+  * Updated BAIL_OUT() function.  Test named bailout.t2 and an be 
+    run with 'prove -v t/bailout.t2'.  It will fail, as expected.
+  * Added t/ directory with example tests
+
+* bash-tap 1.0.3 (2015-05-29-23:30)
+  * Add note() function, similar in nature to diag()
+
 * bash-tap 1.0.2 (2013-05-19-00:59)
   * Make bash-tap-mock work with -e.
     Contributed by Daniel Nephin (@dnephin).

README.mkdn

@@ -45,6 +45,9 @@ total_rowsets=2
 
 plan tests $(((columns_per_row * max_rows_per_rowset * total_rowsets) + total_rowsets))
 
+note "This note will be seen with 'prove test.t'"
+diag "This diag will be seen with 'prove -v test.t'"
+
 #  Test data, resultset 1
 results1="artist Assemblage 23
 track Naked (God Module RMX)

bash-tap

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-bash_tap_version='1.0.2'
+bash_tap_version='1.0.5'
 
 # Our state.
 
@@ -111,6 +111,7 @@ function has_plan() {
 function skip_all() {
     local reason="${*:?}"
 
+    _bt_plan="skip all"
     _bt_output_plan 0 SKIP "$reason"
 }
 
@@ -237,11 +238,26 @@ function cmp_ok() {
 # Other helper functions
 
 function BAIL_OUT() {
-    echo TODO
+# Note: it is up to the calling shell script to stop testing after this function is called
+
+    local message="$1"
+    _bt_escaped_echo "Bail out! $message"
 }
 
 function skip() {
-    echo TODO
+    local message="$1"
+    local pattern="$2"
+    local name="$3"
+
+    _bt_current_test=$((_bt_current_test + 1))
+
+    if [ -n "$message" ]; then
+        if [ "$_bt_plan" == "skip all" ]; then
+            _bt_escaped_echo "#skip $name"
+        else
+            _bt_escaped_echo "ok # skip $name"
+        fi
+    fi
 }
 
 function todo_skip() {
@@ -266,6 +282,18 @@ function diag() {
     fi
 }
 
+function note() {
+    local message="$*"
+
+    if [ -n "$message" ]; then
+       local output=''
+       while IFS= read -r line; do
+          output="$output\n# $line"
+       done <<<"$message"
+       echo -e "# ${output:4}" >&2
+    fi
+}
+
 # Util functions for output capture within current shell
 
 function start_output_capture() {

bash-tap-bootstrap

@@ -7,7 +7,7 @@
 #    It takes care of finding bash-tap or outputing a usage message.
 #
 
-bash_tap_bootstrap_version='1.0.2'
+bash_tap_bootstrap_version='1.0.3'
 
 if [ "${BASH_SOURCE[0]}" = "$0" ]; then
     # Being run directly, probably by test harness running entire dir.
@@ -16,8 +16,22 @@ if [ "${BASH_SOURCE[0]}" = "$0" ]; then
 fi
 
 if [ -z "$BASH_TAP_ROOT" ]; then
-    #  TODO: search likely locations.
-    BASH_TAP_ROOT="$(dirname ${BASH_SOURCE[0]})/../../bash-tap"
+    BASH_TAP_ROOT="$(dirname ${BASH_SOURCE[0]})/../../"
+fi
+
+
+##### search likely locations.
+
+if [ -f "$HOME/bash-tap/bash-tap" ]; then
+    BASH_TAP_ROOT="$HOME/bash-tap/"
+fi
+
+if [ -f "$HOME/bash-tap" ]; then
+    BASH_TAP_ROOT="$HOME/"
+fi
+
+if [ -f "./bash-tap" ]; then
+    BASH_TAP_ROOT="./"
 fi
 
 if [ -f "$BASH_TAP_ROOT/bash-tap" ]; then

t/bailout.t2

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+. $(dirname $0)/bash-tap-bootstrap
+
+plan tests 3
+
+is "hello" "hello" "plan test 1"
+if [ 1 -eq 1 ]
+then
+  BAIL_OUT "Error, 1 equal 1!"
+  exit
+fi
+is "hello" "hello" "plan test 2"
+like "hello" "hell" "plan test 3"

t/bash-tap-bootstrap

@@ -0,0 +1,42 @@
+#!/bin/bash
+#
+#  Bash TAP Bootstrap:
+#    Copy this file into your project tests dir and source it
+#    from each test file with:
+#      . $(dirname $0)/bash-tap-bootstrap
+#    It takes care of finding bash-tap or outputing a usage message.
+#
+
+bash_tap_bootstrap_version='1.0.3'
+
+if [ "${BASH_SOURCE[0]}" = "$0" ]; then
+    # Being run directly, probably by test harness running entire dir.
+    echo "1..0 # SKIP bash-tap-bootstrap isn't a test file"
+    exit 0
+fi
+
+if [ -z "$BASH_TAP_ROOT" ]; then
+    BASH_TAP_ROOT="$(dirname ${BASH_SOURCE[0]})/../../"
+fi
+
+
+##### search likely locations.
+
+if [ -f "$HOME/bash-tap/bash-tap" ]; then
+    BASH_TAP_ROOT="$HOME/bash-tap/"
+fi
+
+if [ -f "$HOME/bash-tap" ]; then
+    BASH_TAP_ROOT="$HOME/"
+fi
+
+if [ -f "./bash-tap" ]; then
+    BASH_TAP_ROOT="./"
+fi
+
+if [ -f "$BASH_TAP_ROOT/bash-tap" ]; then
+    . "$BASH_TAP_ROOT/bash-tap"
+else
+    echo "Bail out!  Unable to find bash-tap.  Install from https://github.com/illusori/bash-tap or set \$BASH_TAP_ROOT if you have it installed somewhere unusual."
+    exit 255
+fi

t/no_plan.t

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+. $(dirname $0)/bash-tap-bootstrap
+
+plan no_plan
+
+is "hello" "hello" "no_plan test 1"
+is "hello" "hello" "no_plan test 2"
+like "hello" "hell" "no_plan test 3"
+
+done_testing

t/note_diag.t

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+. $(dirname $0)/bash-tap-bootstrap
+
+plan no_plan
+
+is "hello" "hello" "note_diag test 1"
+
+note "This note will be seen with 'prove test.t'"
+diag "This diag will be seen with 'prove -v test.t'"
+
+done_testing

t/ok.t

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+. $(dirname $0)/bash-tap-bootstrap
+
+plan tests 5
+
+ok "1" "plan test 1"
+ok "100" "plan test 2"
+ok "-1" "plan test 3"
+ok "" "plan test 4"
+ok "hello" "plan test 5"

t/plan.t

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+. $(dirname $0)/bash-tap-bootstrap
+
+plan tests 3
+
+is "hello" "hello" "plan test 1"
+is "hello" "hello" "plan test 2"
+like "hello" "hell" "plan test 3"

t/skip.t

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+. $(dirname $0)/bash-tap-bootstrap
+
+plan no_plan
+
+is "hello" "hello" "hello test 1"
+skip "hello" "hello" "hello test 2"
+like "hello" "hell" "hello test 3"
+
+done_testing

t/skip_all.t

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+. $(dirname $0)/bash-tap-bootstrap
+
+plan skip_all "skip_all testing.. for fun and profit"
+
+skip "hello" "hello" "skip_all test 1"
+skip "hello" "hello" "skip_all test 2"
+skip "hello" "hell" "skip_all test 3"
+