Update TFKit to version 0.0.10

utils/tfkit/doc/README.md

@@ -106,8 +106,8 @@ in *TF_RUN*.
 
 In order to make use of the subtests functionality, you will need to
 define two functions yourself:  `tf_enum_subtests` to enumerate names of
-tests you want to run, and `tf_name2cmd` to translate each name an actual
-command that would perform it and return with the the correct exit status.
+tests you want to run, and `tf_do_subtest` with actual test
+implementation.
 
 The minimal *TF_RUN* with two subtests could look like this:
 
@@ -121,10 +121,10 @@ The minimal *TF_RUN* with two subtests could look like this:
         something && echo test3
     }
 
-    tf_name2cmd() {
+    tf_do_subtest() {
         case $1 in
-            test1)  echo myprog foo ;;
-            test2)  echo myprog bar ;;
+            test1)  myprog foo ;;
+            test2)  myprog bar ;;
         esac
     }
 
@@ -133,15 +133,15 @@ The minimal *TF_RUN* with two subtests could look like this:
 At the end, `tf_do_subtests` acts as a launcher of the actual test.
 In short, it will
 
- *  take each enumerated subtest from `tf_enum_subtests`,
- *  source *TF_SETUP*, if such file is found,
- *  translate te subtest name to a command,
- *  launch the command,
- *  source *TF_CLEANUP*, if such file is found,
- *  and report "worst" exit status encountered.
+ 1. run `tf_enum_subtests`, taking each line as name of a subtest;
+    for each subtest:
 
-All but the first and last step is done by `tf_do_subtest`, so in some
-cases you may want to re-define this one as well.
+     1. source *TF_SETUP*, if such file is found,
+     2. launch the `tf_do_subtest()` function with subtest name as
+        the only argument,
+     3. source *TF_CLEANUP*, if such file is found,
+
+ 2. and finally, report "worst" exit status encountered.
 
 Note that subtest names need to be single words (`[a-zA-Z0-9_]`).
 

utils/tfkit/include/subtest.sh

@@ -7,33 +7,44 @@ tf_enum_subtests() {
     # Stub: enumerate subtests
     #
     tf_warn "implement tf_enum_subtests()!"
-    return $TF_ES_ERROR
+    return "$TF_ES_ERROR"
 }
 
-tf_name2cmd() {
+tf_do_subtest() {
     #
-    # Stub: expand test name to test command
+    # Stub: perform test named $1
     #
-    tf_warn "implement tf_name2cmd()!"
-    return $TF_ES_ERROR
+    tf_warn "implement tf_do_subtest()!"
+    return "$TF_ES_ERROR"
 }
 
-tf_do_subtest() {
+_tf_do_subtest() {
     #
     # Run single subtest inc. setup/cleanup if present
     #
     local subtname="$1"     # this subtest name
     local ses=0             # subtest exit status
-    local tcmd=""           # test command
     local setup=true        # setup command
     local cleanup=true      # cleanup command
-    test -f TF_SETUP   && setup=". TF_SETUP"
-    test -f TF_CLEANUP && cleanup=". TF_CLEANUP"
+    if test -f TF_SETUP;
+    then
+        setup=". TF_SETUP"
+        bash -n TF_SETUP || {
+            tf_warn "synax errors in TF_SETUP, skipping"
+            return "$TF_ES_ERROR"
+        }
+    fi
+    if test -f TF_CLEANUP;
+    then
+        setup=". TF_CLEANUP"
+        bash -n TF_CLEANUP || {
+            tf_warn "synax errors in TF_CLEANUP, skipping"
+            return "$TF_ES_ERROR"
+        }
+    fi
     if $setup;
     then
-        tcmd="$(tf_name2cmd "$subtname")"
-        tf_debug "tcmd='$tcmd'"
-        $tcmd; ses=$?
+        tf_do_subtest "$subtname"; ses=$?
     else
         tf_warn "setup phase failed, skipping: $subtname"
         ses=$TF_ES_ERROR
@@ -43,7 +54,7 @@ tf_do_subtest() {
         tf_warn "cleanup phase failed: $subtname"
         ses=$TF_ES_PANIC
     fi
-    return $ses
+    return "$ses"
 }
 
 tf_do_subtests() {
@@ -55,19 +66,20 @@ tf_do_subtests() {
     local tes=""            # one subtest exit status
     local enumd=TF_ENUMERATED_SUBTESTS
     local fltrd=TF_FILTERED_SUBTESTS
-    tf_enum_subtests >$enumd    || { tf_warn "error enumerating subtests"; return $TF_ES_BAILOUT; }
-    test -s $enumd              || { tf_warn "no subtests enumerated";     return $TF_ES_BAILOUT; }
+    tf_enum_subtests >$enumd    || { tf_warn "error enumerating subtests"; return "$TF_ES_BAILOUT"; }
+    test -s $enumd              || { tf_warn "no subtests enumerated";     return "$TF_ES_BAILOUT"; }
     grep -e "$TF_FILTER_SUBTEST" $enumd > $fltrd
     test -s $fltrd  || tf_debug "TF_FILTER_SUBTEST ate everything: $TF_FILTER_SUBTEST"
+
     for subtname in $(<$fltrd);
     do
         export TF_SUBTNAME=$subtname
         tf_think "::: $TF_TNAME::$TF_SUBTNAME"
-        tf_do_subtest "$TF_SUBTNAME";
+        _tf_do_subtest "$TF_SUBTNAME";
         tes=$?
-        test $tes -gt $es            && es=$tes
-        test $tes -gt $TF_ES_OK      && tf_warn "!!! $TF_TNAME::$TF_SUBTNAME ($tes)"
-        test $tes -gt $TF_ES_BAILOUT && break
+        test $tes -gt $es              && es=$tes
+        test $tes -gt "$TF_ES_OK"      && tf_warn "!!! $TF_TNAME::$TF_SUBTNAME ($tes)"
+        test $tes -gt "$TF_ES_BAILOUT" && break
     done
     return $es
 }

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.8"
+TF_VERSION="0.0.10"
 
 die() {
     echo "$@" && exit 9
@@ -19,9 +19,28 @@ version() {
 }
 
 LC_ALL=C
+
+#
+# Location of own directory
+#
 TF_DIR=${TF_DIR:-$(dirname "$0")}
+
+#
+# Location of test suite
+#
 TF_SUITE="${TF_SUITE:-tests}"
-TF_ARTIFACTS="${TF_ARTIFACTS:-tfkit-artifacts}"
+
+#
+# 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}"
 
 while true; do case "$1" in