Update TFKit to v0.0.14

utils/tfkit/doc/README.md

@@ -24,7 +24,7 @@ The harness, though, assumes that:
  *  basename of this directory becomes the name of the test,
 
  *  and return code from running the executable is reported
-    as result of the test, according to "Exit status" chapter below.
+    as result of the test, according to "Exit status" section below.
 
 
 Naming
@@ -96,7 +96,7 @@ Framework
 
 This part is not intended to be used in tests, but rather contains
 functions that help govern test discovery, preparation and execution as
-is described in previous chapters.  Feel free to poke around, of course.
+is described in previous sections.  Feel free to poke around, of course.
 
 
 ### subtest.sh ###
@@ -125,6 +125,7 @@ The minimal *TF_RUN* with two subtests could look like this:
         case $1 in
             test1)  myprog foo ;;
             test2)  myprog bar ;;
+            test3)  myprog baz ;;
         esac
     }
 
@@ -257,7 +258,7 @@ As you may have noticed, there are two ways how to skip a test:
 return prematurely with `TF_ES_BAILOUT`, or suppress enumeration in
 `tf_enum_subtests`.  The problem is that the latter does not do anything
 to inform upper in the stack that a test has been skipped, which seems to
-break the principle described in the previous chapters.
+break the principle described in previous sections.
 
 Don't confuse these mechanisms, though. Each is supposed to be used
 for distinct purpose.  Compare: by using the `tf_enum_subtests` you are
@@ -271,19 +272,47 @@ A few common cases if that helps you:
     carried out (e.g. an external resource is not available, or
     something outside the SUT is broken), use `TF_ES_BAILOUT`.
 
- *  If you want to disable the test because for some long-term condition,
-    e.g. a known bug outside SUT but preventing execution of the test
-    is not fixed, use `tf_enum_subtests`.
-
- *  If you want to filter out some sub-tests to only for some platforms,
-    e.g. 64-bit architecture, (IOW, you can safely check that a
-    sub-test would be totally pointless if run on this box), use
-    `tf_enum_subtests`.
+        tf_enum_subtests() {
+            echo test1
+            echo test2
+            echo test3
+        }
+
+        tf_do_subtest() {
+            case $1 in
+                test1) do_stuff  ;;
+                test2) do_other_stuff ;;
+                test3) curl -s http://www.example.com/ >file \
+                        || return $TF_ES_BAILOUT
+                       do_stuff_with file ;;
+            esac
+        }
+
+ *  If you want to filter out some sub-tests for some platforms, e.g. a
+    test for only 64-bit architectures, or a test only for Mac OS (IOW,
+    you can safely say that running this sub-test would be totally
+    pointless on this box), use `tf_enum_subtests`--just omit this test
+    from enumeration.
+
+        tf_enum_subtests() {
+            echo test1
+            echo test2
+            if this_is_macos_x; then
+                echo test3
+            fi
+        }
 
  *  If you want to disable (comment out test) that you might not have
     implemented yet or is broken (and for some reason you still want
-    it to haunt the test code), use `tf_enum_subtests` and properly
-    comment the reasons in code.
+    it to haunt the test code) or something else outside SUT is broken
+    and prevents you from running the test, use `tf_enum_subtests` and
+    properly comment the reasons in code.
+
+        tf_enum_subtests() {
+            echo test1
+            echo test2
+        #   echo test3      #FIXME: implement after bz1234
+        }
 
  *  If in doubt, use `TF_ES_BAILOUT`.
 
@@ -313,7 +342,7 @@ important.  Follow me as I try to explain:
     by the script, albeit exiting "in a hurry"--without proper clean up.
 
 Unfortunately there will be cases like above but with the error code less
-than four.   Example is a bash script syntax error, which returns 2, or
+than four.   Example is a Bash script syntax error, which returns 2, or
 Python exception which returns 1.  Yes, in such cases the information
 conveyed by the exit status is wrong and you should do everything to
 avoid it.

utils/tfkit/include/common.sh

@@ -7,31 +7,6 @@ TF_ES_BAILOUT=2
 TF_ES_ERROR=3
 TF_ES_PANIC=4
 
-#
-# Option to turn on/off verbosity
-#
-TF_VERBOSE=${TF_VERBOSE:-true}
-
-#
-# Option to turn on/off debug mode
-#
-TF_DEBUG=${TF_DEBUG:-false}
-
-#
-# Regex to filter test names to run
-#
-TF_FILTER_TEST="${TF_FILTER_TEST:-.*}"
-
-#
-# Regex to filter subtest names to run
-#
-TF_FILTER_SUBTEST="${TF_FILTER_SUBTEST:-.*}"
-
-#
-# Enable color?
-#
-TF_COLOR=${TF_COLOR:-true}
-
 #
 # Color definition variables
 #

utils/tfkit/include/harness.sh

@@ -4,11 +4,6 @@
 
 . "$TF_DIR/include/common.sh"
 
-#
-# Default path to header generator
-#
-__TF_HDRCMD="$TF_SUITE/TF_HEADER"
-
 
 __tf_collect_if_needed() {
     #
@@ -37,39 +32,36 @@ __tf_collect_if_needed() {
     cp -r "$tmpdir"/* "$artifact_dir/$stamp"
 }
 
-__tf_default_header() {
-    #
-    # Create default header
-    #
-    echo "hint = Add $__TF_HDRCMD executable for own header."
-    echo "hint = It should output 'key = value' pairs about"
-    echo "hint = your SUT ('version' at least')."
-}
-
 __tf_header() {
     #
     # create header to add to output before test
     #
-    local field
-    local hdrcmd="$__TF_HDRCMD"
-    test -x "$hdrcmd" || hdrcmd="__tf_default_header"
-    tf_think "#"
-    tf_think "# [tfkit.sut]"
-    tf_think "#"
-    $hdrcmd \
-      | while read field;
-        do
-            test -n "$field" || break
-            tf_think "#     $field"
-        done
-    tf_think "#"
-    tf_think "# [tfkit.run]"
+    local hdrline                       # each line from generator
+    local hdrgen="$TF_SUITE/TF_HEADER"  # header generator script
     tf_think "#"
-    tf_think "#     start_time = $(date -Iseconds)"
-    test "$TF_FILTER_TEST" = '.*' \
-     || tf_think "#     TF_FILTER_TEST = $TF_FILTER_TEST"
-    test "$TF_FILTER_SUBTEST" = '.*' \
-     || tf_think "#     TF_FILTER_SUBTEST = $TF_FILTER_SUBTEST"
+    tf_think "# ---"
+    tf_think "# tfkit:"
+    if test -x "$hdrgen";
+    then
+        tf_think "#     sut:"
+        $hdrgen \
+          | while IFS= read -r hdrline;
+            do
+                test -n "$hdrline" || break
+                tf_think "#         $hdrline"
+            done
+    else
+        tf_think "#     hint: >"
+        tf_think "#         Add $hdrgen executable for own header."
+        tf_think "#         It should output YAML (\"key: value\" pairs) about"
+        tf_think "#         your SUT ('version' at least')."
+    fi
+    tf_think "#     run:"
+    tf_think "#         start_time: $(date -Iseconds)"
+    test -n "$TF_FILTER_TEST" \
+     && tf_think "#         TF_FILTER_TEST: $TF_FILTER_TEST"
+    test -n "$TF_FILTER_SUBTEST" \
+     && tf_think "#         TF_FILTER_SUBTEST: $TF_FILTER_SUBTEST"
     tf_think "#"
     tf_think ""
 }
@@ -100,7 +92,8 @@ tf_run_tests() {
     local tes=0         # test result
     local stamp=""      # test stamp to use as artifact name
     local tf_dir tf_suite   # to keep absolute paths for TF_RUN
-    local artifact_dir="$(readlink -f "$TF_ARTIFACTS")"
+    local artifact_dir  # where to keep artifacts
+    artifact_dir="$(readlink -f "$TF_ARTIFACTS")"
     __tf_header
     tf_debug "TF_VERSION='$TF_VERSION'"
     tf_dir="$(readlink -f "$TF_DIR")"

utils/tfkit/runtests

@@ -2,7 +2,7 @@
 # tfkit - Shellfu's movable test framework
 # See LICENSE file for copyright and license details.
 
-TF_VERSION="0.0.11"
+TF_VERSION="0.0.14"
 
 die() {
     echo "$@" && exit 9
@@ -20,28 +20,53 @@ version() {
 
 LC_ALL=C
 
+#
+# Artifact directory path
+#
+TF_ARTIFACTS="${TF_ARTIFACTS:-artifacts}"
+
+#
+# Artifact collection mode
+#
+# 'always' to always collect, 'never` to never collect and 'auto'
+# to collect only on failed tests.
+#
+TF_COLLECT="${TF_COLLECT:-auto}"
+
+#
+# Enable color?
+#
+TF_COLOR=${TF_COLOR:-true}
+
+#
+# Turn on debug mode?
+#
+TF_DEBUG="${TF_DEBUG:-false}"
+
 #
 # Location of own directory
 #
 TF_DIR=${TF_DIR:-$(dirname "$0")}
 
 #
-# Location of test suite
+# Regex (BRE) to filter subtests based on name
 #
-TF_SUITE="${TF_SUITE:-tests}"
+TF_FILTER_SUBTEST=${TF_FILTER_SUBTEST:-}
 
 #
-# Artifact directory path
+# Regex (BRE) to filter tests based on name
 #
-TF_ARTIFACTS="${TF_ARTIFACTS:-artifacts}"
+TF_FILTER_TEST=${TF_FILTER_TEST:-}
 
 #
-# Artifact collection mode
+# Location of test suite
 #
-# 'always' to always collect, 'never` to never collect and 'auto'
-# to collect only on failed tests.
+TF_SUITE="${TF_SUITE:-tests}"
+
 #
-TF_COLLECT="${TF_COLLECT:-auto}"
+# Turn on verbosity?
+#
+TF_VERBOSE=${TF_VERBOSE:-true}
 
 while true; do case "$1" in
     -c|--collect)           TF_COLLECT=always;          shift ;;