Update TFKit to v0.0.16

utils/tfkit/doc/README.md

@@ -1,12 +1,22 @@
-Tests
+TFKit
 =====
 
-Running tests is handled by tfkit/runtests:
 
-    $ tfkit/runtest [filter]
+Installation
+------------
 
-*filter* is a regular expression to be applied to sub-test name, running
-only the matching ones.  See below for details.
+The easiest way is to embed TFKit within your repo, ie. clone TFKit and
+install it using:
+
+    make install DESTDIR=/path/to/your/repo
+
+Now you can run your test suite using *runtests* binary:
+
+    $ cd /path/to/your/repo
+    $ utils/tfkit/runtest
+
+Note that the above probably won't return any useful results as you still
+don't have any tests.
 
 
 Writing tests
@@ -49,7 +59,7 @@ along with *TF_RUN*.
 
 Note that before running, the whole test directory is automatically
 copied to a temporary location (one per test), and should the test fail,
-copied back as a debugging artifact.  For this reason, *do not store
+copied back as a debugging relic.  For this reason, *do not store
 huge amounts of data here*.  If you really need huge data, consider
 obtaining it (and throwing it away) within runtime of *TF_RUN*.
 

utils/tfkit/doc/templates/simple/TF_RUN

@@ -0,0 +1,37 @@
+#!/bin/bash
+#shellcheck disable=SC1090
+
+. "$TF_DIR/include/subtest.sh"
+. "$TF_DIR/include/tools.sh"
+
+tf_enum_subtests() {
+    echo one
+    echo two
+    echo three
+}
+
+my_sut() {
+    local word=$1
+    declare -A map
+    map[one]=1
+    map[two]=2
+    map[three]=33
+    echo "${map[$word]}"
+}
+
+mkoracle() {
+    mkdir -p oracle
+    case $subtest in
+        one)    echo 1 ;;
+        two)    echo 2 ;;
+        three)  echo 3 ;;
+    esac > "oracle/$subtest.stdout"
+}
+
+tf_do_subtest() {
+    local subtest=$1
+    mkoracle
+    tf_testflt -n "$subtest" -O "oracle/$subtest.stdout" "my_sut $subtest"
+}
+
+tf_do_subtests

utils/tfkit/include/common.sh

@@ -29,6 +29,16 @@ TF_COLOR_LWHITE="\033[1;37m"
 TF_COLOR_NONE="\033[1;0m"
 
 
+_tf__is_word() {
+    #
+    # Check if $1 contains only alphanumeric chars or _
+    #
+    local tainted=$1    # "dirty" version
+    local clean         # clean version
+    clean=$(tr -c -d '_[:alnum:]' <<< "$tainted")
+    test "$tainted" = "$clean"
+}
+
 tf_exit_ok() {
     #
     # Exit with OK status
@@ -82,6 +92,28 @@ tf_debug() {
     done
 }
 
+tf_debugv() {
+    #
+    # Emit debug message showing value of each named variable
+    #
+    local varname
+    local declare_str
+    for varname in "$@";
+    do
+        if ! _tf__is_word "$varname";
+        then
+            tf_warn "tf_debugv: unsafe value skipped: $varname";
+            continue
+        fi
+        if declare_str=$(declare -p "$varname" 2>/dev/null);
+        then
+            tf_debug "${declare_str#declare ?? }"
+        else
+            tf_debug "$varname #Unset"
+        fi
+    done
+}
+
 tf_think() {
     #
     # Emit status/progress message

utils/tfkit/include/harness.sh

@@ -7,9 +7,9 @@
 
 __tf_collect_if_needed() {
     #
-    # Collect artifact if exit status suggests it
+    # Collect relic if exit status suggests it
     #
-    # Use test exit status $1 to help decide if artifacts are
+    # Use test exit status $1 to help decide if relics are
     # needed, and collect them if so.
     #
     # If TF_COLLECT is set to "always", collect regardless of
@@ -18,7 +18,7 @@ __tf_collect_if_needed() {
     # or 1 (pass or bailout); in that case do nothing.
     #
     local tes=$1    # test exit status
-    local will      # should we collect artifacts?
+    local will      # should we collect relics?
     case "$TF_COLLECT:$tes" in
         always:*)   will=true ;;
         never:*)    will=false ;;
@@ -28,8 +28,8 @@ __tf_collect_if_needed() {
         *)          tf_exit_bailout "bad value of TF_COLLECT: $TF_COLLECT" ;;
     esac
     $will || return 0
-    mkdir -p "$artifact_dir/$stamp"
-    cp -r "$tmpdir"/* "$artifact_dir/$stamp"
+    mkdir -p "$relic_dir/$stamp"
+    cp -r "$tmpdir"/* "$relic_dir/$stamp"
 }
 
 __tf_header() {
@@ -90,23 +90,24 @@ tf_run_tests() {
     local tmpdir=""     # test temporary dir
     local tname=""      # test name
     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  # where to keep artifacts
-    artifact_dir="$(readlink -f "$TF_ARTIFACTS")"
+    local stamp=""      # test stamp to use as relic name
+    local tf_dir        # to keep absolute path for TF_RUN
+    local relic_dir     # where to keep relics
+    relic_dir="$(readlink -f "$TF_RELICS")"
     __tf_header
     tf_debug "TF_VERSION='$TF_VERSION'"
     tf_dir="$(readlink -f "$TF_DIR")"
-    tf_suite="$(readlink -f "$TF_SUITE")"
     es=0
     for tname in $(tf_enum_tests | grep -e "$TF_FILTER_TEST");
     do
         tf_think "... $tname"
         tmpdir=$(mktemp -d)
-        stamp=$(date "+artifacts-$tname-%Y%m%d-%H%M%S")
+        stamp=$(date "+relics-$tname-%Y%m%d-%H%M%S")
         cp -r "$TF_SUITE/$tname/"* "$tmpdir"
         pushd "$tmpdir" >/dev/null
-            TF_DIR="$tf_dir" TF_SUITE=$tf_suite TF_TNAME="$tname" \
+            TF_DEBUG=$TF_DEBUG TF_VERBOSE=$TF_VERBOSE \
+            TF_DIR="$tf_dir" TF_TEST="$tname" \
+            TF_FILTER_SUBTEST=$TF_FILTER_SUBTEST \
                 ./TF_RUN
             tes=$?
             __tf_collect_if_needed $tes

utils/tfkit/include/subtest.sh

@@ -73,12 +73,11 @@ tf_do_subtests() {
 
     for subtname in $(<$fltrd);
     do
-        export TF_SUBTNAME=$subtname
-        tf_think "::: $TF_TNAME::$TF_SUBTNAME"
-        _tf_do_subtest "$TF_SUBTNAME";
+        tf_think "::: $TF_TEST::$subtname"
+        TF_SUBTEST=$subtname _tf_do_subtest "$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_OK"      && tf_warn "!!! $TF_TEST::$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.14"
+TF_VERSION="0.0.16"
 
 die() {
     echo "$@" && exit 9
@@ -18,15 +18,13 @@ version() {
     exit 0
 }
 
-LC_ALL=C
-
 #
-# Artifact directory path
+# Relic directory path
 #
-TF_ARTIFACTS="${TF_ARTIFACTS:-artifacts}"
+TF_RELICS="${TF_RELICS:-relics}"
 
 #
-# Artifact collection mode
+# Relic collection mode
 #
 # 'always' to always collect, 'never` to never collect and 'auto'
 # to collect only on failed tests.
@@ -68,28 +66,27 @@ TF_SUITE="${TF_SUITE:-tests}"
 #
 TF_VERBOSE=${TF_VERBOSE:-true}
 
-while true; do case "$1" in
-    -c|--collect)           TF_COLLECT=always;          shift ;;
-    -C|--no-collect)        TF_COLLECT=never;           shift ;;
-    -d|--debug)             TF_DEBUG=true;              shift ;;
-    -p|--prefix)            export PATH="$(readlink -f "$2")/bin:$PATH"
-                                                        shift 2 || usage ;;
-    -s|--filter-subtest)    TF_FILTER_SUBTEST="$2";     shift 2 || usage ;;
-    -t|--filter-test)       TF_FILTER_TEST="$2";        shift 2 || usage ;;
-    -v|--verbose)           TF_VERBOSE=true;            shift ;;
-    --version-semver)       echo "$TF_VERSION"; exit 0 ;;
-    --version)              version ;;
-    "") break ;;
-    *)  usage ;;
-esac done
-
-export LC_ALL
-export TF_DIR TF_SUITE TF_ARTIFACTS
-export TF_COLLECT TF_FILTER_SUBTEST TF_FILTER_TEST
-export TF_DEBUG TF_VERBOSE
-export TF_VERSION
 
 . "$TF_DIR/include/harness.sh" \
  || die "cannot import harness; is TF_DIR set properly?: $TF_DIR"
 
-time tf_run_tests
+main() {
+    while true; do case "$1" in
+        -c|--collect)           TF_COLLECT=always;          shift ;;
+        -C|--no-collect)        TF_COLLECT=never;           shift ;;
+        -d|--debug)             TF_DEBUG=true;              shift ;;
+        -p|--prefix)            export PATH="$(readlink -f "$2")/bin:$PATH"
+                                                            shift 2 || usage ;;
+        -s|--filter-subtest)    TF_FILTER_SUBTEST="$2";     shift 2 || usage ;;
+        -t|--filter-test)       TF_FILTER_TEST="$2";        shift 2 || usage ;;
+        -v|--verbose)           TF_VERBOSE=true;            shift ;;
+        --version-semver)       echo "$TF_VERSION"; exit 0 ;;
+        --version)              version ;;
+        "") break ;;
+        *)  usage ;;
+    esac done
+    export LC_ALL=C
+    time tf_run_tests
+}
+
+main "$@"