Add TFKit v0.0.15

utils/tfkit/doc/README.md

@@ -0,0 +1,389 @@
+Tests
+=====
+
+Running tests is handled by tfkit/runtests:
+
+    $ tfkit/runtest [filter]
+
+*filter* is a regular expression to be applied to sub-test name, running
+only the matching ones.  See below for details.
+
+
+Writing tests
+-------------
+
+Tests can be written in any scripting language, although the built-in
+framework, written in Bash, provides some useful features for writing
+certain kind of relatively simple tests.
+
+The harness, though, assumes that:
+
+ *  Any direct sub-directory of `$TF_SUITE` directory ("tests" by default)
+    that contains at least *TF_RUN* executable becomes a test,
+
+ *  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" section below.
+
+
+Naming
+------
+
+Test name should start with name of the module that is tested and
+underscore.  If module name contains dots, they should be replaced with
+underscores as well.
+
+    core_sanity
+    mod_submod_function
+    ini_iniread
+
+are valid test names.
+
+
+Data
+----
+
+Should the test need any data, just leave it around in the test directory
+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
+huge amounts of data here*.  If you really need huge data, consider
+obtaining it (and throwing it away) within runtime of *TF_RUN*.
+
+
+Exit status
+-----------
+
+We try hard to follow this semantic:
+
+ *  *Zero* means *OK* -- test has been run and passed.
+
+ *  *One* means *Failure* -- test has been run but failed (e.g. found
+     a bug).
+
+ *  *Two* means *Bailout* --  test has decided not to run at all.
+
+ *  *Three* means *Error* -- there was error detected during execution,
+     but script was able to clean up properly.
+
+ *  *Four* means *Panic* -- there was other error but script *was not*
+     able to clean up properly.
+
+ *  Anything else should indicate other uncaught errors, including those
+    outside control of the program such as segfaults in the test code
+    or test being SIGKILLed.
+
+Notice that the higher the value is, the worse situation it indicates.
+Thus, if a test is composed of several sub-tests, you need to make sure
+to always **exit with the highest value** (subtest.sh does take care
+of this).
+
+See *common.sh* for functions and variables to help with handling exit
+statuses with this semantic.
+
+Also see Notes section for more details on exit statuses, including
+cheat sheet and dscussuion.
+
+
+Framework
+---------
+
+
+### harness.sh ###
+
+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 sections.  Feel free to poke around, of course.
+
+
+### subtest.sh ###
+
+As name suggests, this file defines few functions to handle subtests
+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_do_subtest` with actual test
+implementation.
+
+The minimal *TF_RUN* with two subtests could look like this:
+
+    #!/bin/bash
+
+    . $TF_DIR/include/subtest.sh
+
+    tf_enum_subtests() {
+        echo test1
+        echo test2
+        something && echo test3
+    }
+
+    tf_do_subtest() {
+        case $1 in
+            test1)  myprog foo ;;
+            test2)  myprog bar ;;
+            test3)  myprog baz ;;
+        esac
+    }
+
+    tf_do_subtests
+
+At the end, `tf_do_subtests` acts as a launcher of the actual test.
+In short, it will
+
+ 1. run `tf_enum_subtests`, taking each line as name of a subtest;
+    for each subtest:
+
+     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_]`).
+
+
+### tools.sh ###
+
+This file contains various tools and utilities to help with testing.
+
+Curently there is only one function, `tf_testflt` designed to help write
+tests for simple unix filters.
+
+
+#### tf_testflt ####
+
+The idea is that tester specifies
+
+ *  test name,
+ *  command to launch the system under test,
+ *  a data stream to use as STDIN,
+ *  and expected STDOUT, STDERR, and exit status.
+
+and tf_testflt launches the command, collects tha data and evaluates
+and reports the result using unified diff.
+
+In its simplest form:
+
+    tf_testflt -n foo my_command arg
+
+the function will run `my_command arg` (not piping anything to it),
+and will expect it to finish with exit status 0 and empty both STDERR
+and STDOUT.
+
+Example of full form,
+
+    tf_testflt -n foo -i foo.in -O foo.stdout -E foo.stderr -S 2 myprog
+
+will pipe foo.in into `myprog`, expecting exit status of 2, and STDOUT and
+STDERR as above.  Notice that parameters specifying expected values are
+uppercase, and those specifying input values are lowercase.
+
+Specifying name is mandatory, because it's used in reporting messages,
+and as a basis for naming temporary result files: these are saved in
+*results* subdirectory and kept for further reference.
+
+
+### common.sh ###
+
+This includes simple functions and variables shared between both mentioned
+libraries.
+
+First group is designed to help support the exit status semantic:
+
+ *  The functions are `tf_exit_pass`, `tf_exit_fail`, `tf_exit_bailout`,
+    `tf_exit_error` and `tf_exit_panic` and each take any number of
+    parameters that are printed on stderr.
+
+ *  The variables are `TF_ES_OK`, `TF_ES_FAIL`, `TF_ES_BAILOUT`,
+    `TF_ES_ERROR` and `TF_ES_PANIC` and are supposed to be used with
+    `return` builtin, e.g. to return from `tf_exit_error`.
+
+Second group is useful to better control output:  functions `tf_warn`,
+`tf_debug` and `tf_think` are used to print stuff on STDERR.  Use of
+`tf_warn` is apparent, just as `tf_debug`, the latter being muted if
+`TF_DEBUG` is set to `false` (set it to `true` to turn on debugging).
+
+`tf_think` is used for progress info, and is muted unless `TF_VERBOSE`
+is set to `true`, which is by default.
+
+
+### Setup and cleanup ###
+
+Special files *TF_SETUP* and *TF_CLEANUP* (one of them or both) can be
+added along with *TF_RUN*.  These will be sourced before (*TF_SETUP*)
+and after every subtest (*TF_CLEANUP*).
+
+First, if any of these files are missing, it is considered as if the
+respective phase succeeded.  Second, if setup phase fails, test will
+be skipped and subtest exit status will be *TF_ES_BAILOUT*.   Last,
+if cleanup fails (no matter result of setup), subtests aborts with
+*TF_ES_PANIC* returned.  Be aware that in this case the actual test
+status, albeit useful, is lost.
+
+When coming from other test frameworks, this may feel harsh, but note
+that this has been designed with the idea that if a cleanup fails,
+it may render all further tests are automatically unsafe, because the
+environment is not as expected.
+
+To cope with this behavior, try to bear in mind following advice:
+
+ 1. Make sure you write setup/cleanup procedures with extreme care and
+    test them well.
+
+ 2. Do not do complicated and risky things in the setup/cleanup phases.
+
+ 3. If you need to do such things, consider doing them in the *TF_RUN*
+    instead of doing them for all subtests.
+
+ 4. You don't need to clean up everything, the contents of the testing dir
+    will be moved out from the test system.
+
+ 5. If there are scenarios you can safely fix or ignore, handle them in
+    a robust manner.
+
+
+Notes
+-----
+
+
+### bailout vs. `tf_enum_subtests` ###
+
+One more note to claify relation of bailout and `tf_enum_subtests`.
+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 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
+saying that you actually **did not even want** to run the test in the
+first place.  By using `TF_ES_BAILOUT`, you are saying that you **wanted**
+to run the test but could not.
+
+A few common cases if that helps you:
+
+ *  If during the test you find out that for some reason it can't be
+    carried out (e.g. an external resource is not available, or
+    something outside the SUT is broken), use `TF_ES_BAILOUT`.
+
+        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) 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`.
+
+
+### On exit statuses: three and above ###
+
+The difference in *error*, *panic* and higher values is subtle but
+important.  Follow me as I try to explain:
+
+ 1. If script has changed something on the system outside the working
+    directory, it is apparently expected to revert that change.
+
+ 2. Now if an error occurs, but the code responsible for cleaning up is
+    safely run, you can say there was *error but we have recovered*.
+
+ 3. But if the change can't be reverted safely, we know that we have
+    broken something and latter code may lead to weird results (including
+    masking bugs(!)), it's time to *panic* (in the code, not in real
+    life ;))
+
+ 4. And then there are corner cases like a bug in the script, OOM kill
+    or timeout when the status will be different and not really controlled
+    by the script.  Such cases will have to be treated the same way as
+    the "panic" case, but...
+
+ 5. the use of *panic* adds hint that the status has been set consciously
+    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
+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.
+
+Possibilities like "test has passed but then something blew up" exist,
+but conveying this information is responsibility of the test output.
+
+Following table can be used as a cheat-sheet:
+
+    .---------------------------------------------------------------.
+    | e |    state of         |                                     |
+    | s |---------------------| script says                         |
+    |   | SUT   | environment |                                     |
+    |---|-------|-------------|-------------------------------------|
+    | 0 | OK    | safe        | test passed, everything worked fine |
+    | 1 | buggy | safe        | test failed, everything worked fine |
+    | 2 | ???   | safe        | I decided not to run the test       |
+    | 3 | ???   | safe        | Something blew up but I managed to  |
+    |   |       |             | clean up (I promise!)               |
+    | 4 | ???   | broken      | Something blew up and I rushed out  |
+    |   |       |             | in panic                            |
+    | * | ???   | broken      | ...nothing (is dead)                |
+    '---------------------------------------------------------------'
+
+As you can see, following this semantic allows us to see both the state
+of the system under test (SUT) *and* the environment.
+
+Following table illustrates how different statuses map to different
+scenarios with regard to test result as well as state of the environment:
+
+    .--------------------------------------------------.
+    | environment |  test result   |  test result      |
+    |             | pass fail unkn | pass fail unkn    |
+    |-------------|----------------|-------------------|
+    | clean(ed)   |  0    1    3   |  OK  FAIL ERROR   |
+    | untouched   |  ~    ~    2   |  ~    ~   BAILOUT |
+    | mess        |  ~    ~    4   |  ~    ~   PANIC   |
+    | ?! (trap)   |  ~    ~    5   |  ~    ~   ~       |
+    | ?! (sig 9)  |  ~    ~    137 |  ~    ~   ~       |
+    | ?! (aliens) |  ~    ~    ?   |  ~    ~   ~       |
+    '-------------|----------------|-------------------|
+                  |  exit status   |  human-readable   |
+                  |                |  name (TF_ES_*)   |
+                  '------------------------------------'

utils/tfkit/doc/templates/grep_engine/TF_RUN

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+. "$TF_DIR/include/subtest.sh"
+. "$TF_DIR/include/tools.sh"
+
+tf_enum_subtests() {
+    echo fixed
+    echo basic
+    echo extended
+#   echo perl       # TODO: write test
+}
+
+tf_name2cmd() {
+    local name=$1
+    local t_in="test/ALL.stdin"
+    local o_out="oracle/$name.stdout"
+    local args
+    case $name in
+        fixed)       args="-F 'The mask *.* matches all.'" ;;
+        basic)       args="-G 'he.*'" ;;
+        extended)    args="-P '.*og?g'" ;;
+    esac
+    echo "tf_testflt -n $name -i $t_in -O $o_out grep $args"
+}
+
+tf_do_subtests

utils/tfkit/doc/templates/grep_engine/oracle/basic.stdout

@@ -0,0 +1,3 @@
+Linda and Nina work together.
+The mask *.* matches all.
+The mask *.docx matches Word documents.

utils/tfkit/doc/templates/grep_engine/oracle/extended.stdout

@@ -0,0 +1,3 @@
+Alice uses Google.
+Bob wears goggles.
+Linda and Nina work together.

utils/tfkit/doc/templates/grep_engine/oracle/fixed.stdout

@@ -0,0 +1 @@
+The mask *.* matches all.

utils/tfkit/doc/templates/grep_engine/test/ALL.stdin

@@ -0,0 +1,6 @@
+Alice uses Google.
+Bob wears goggles.
+Joe and John are friends.
+Linda and Nina work together.
+The mask *.* matches all.
+The mask *.docx matches Word documents.

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

@@ -0,0 +1,142 @@
+#
+# Variables to hold exit status semantic
+#
+TF_ES_OK=0
+TF_ES_FAIL=1
+TF_ES_BAILOUT=2
+TF_ES_ERROR=3
+TF_ES_PANIC=4
+
+#
+# Color definition variables
+#
+TF_COLOR_BLACK="\033[0;30m"
+TF_COLOR_RED="\033[0;31m"
+TF_COLOR_GREEN="\033[0;32m"
+TF_COLOR_YELLOW="\033[0;33m"
+TF_COLOR_BLUE="\033[0;34m"
+TF_COLOR_MAGENTA="\033[0;35m"
+TF_COLOR_CYAN="\033[0;36m"
+TF_COLOR_WHITE="\033[0;37m"
+TF_COLOR_LBLACK="\033[1;30m"
+TF_COLOR_LRED="\033[1;31m"
+TF_COLOR_LGREEN="\033[1;32m"
+TF_COLOR_LYELLOW="\033[1;33m"
+TF_COLOR_LBLUE="\033[1;34m"
+TF_COLOR_LMAGENTA="\033[1;35m"
+TF_COLOR_LCYAN="\033[1;36m"
+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
+    #
+    exit $TF_ES_OK
+}
+
+tf_exit_fail() {
+    #
+    # Warn $1 and exit with status FAIL
+    #
+    tf_warn "$@"
+    exit $TF_ES_FAIL
+}
+
+tf_exit_bailout() {
+    #
+    # Warn $1 and exit with status FAIL
+    #
+    tf_warn "$@"
+    exit $TF_ES_BAILOUT
+}
+
+tf_exit_error() {
+    #
+    # Warn $1 and exit with status FAIL
+    #
+    tf_warn "$@"
+    exit $TF_ES_ERROR
+}
+
+tf_exit_panic() {
+    #
+    # Warn $1 and exit with status FAIL
+    #
+    tf_warn "$@"
+    exit $TF_ES_PANIC
+}
+
+tf_debug() {
+    #
+    # Emit debug message
+    #
+    $TF_DEBUG || return 0
+    local msg
+    for msg in "$@";
+    do
+        $TF_COLOR && echo -ne "$TF_COLOR_CYAN" >&2
+        echo "||| $msg" >&2;
+        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
+    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
+    #
+    $TF_VERBOSE || return 0
+    local msg
+    for msg in "$@";
+    do
+        $TF_COLOR && echo -ne "$TF_COLOR_LBLACK" >&2
+        echo "$pfx$msg$sfx" >&2;
+        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
+    done
+}
+
+tf_warn() {
+    #
+    # Emit warning
+    #
+    local msg
+    for msg in "$@";
+    do
+        $TF_COLOR && echo -ne "$TF_COLOR_LRED" >&2
+        echo "$msg" >&2;
+        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
+    done
+}

utils/tfkit/include/harness.sh

@@ -0,0 +1,124 @@
+#!/bin/bash
+# tfkit - Shellfu's movable test framework
+# See LICENSE file for copyright and license details.
+
+. "$TF_DIR/include/common.sh"
+
+
+__tf_collect_if_needed() {
+    #
+    # Collect artifact if exit status suggests it
+    #
+    # Use test exit status $1 to help decide if artifacts are
+    # needed, and collect them if so.
+    #
+    # If TF_COLLECT is set to "always", collect regardless of
+    # the status.  If set to "never", do not collect anything.
+    # The default setting, "auto" collects unless status is 0
+    # or 1 (pass or bailout); in that case do nothing.
+    #
+    local tes=$1    # test exit status
+    local will      # should we collect artifacts?
+    case "$TF_COLLECT:$tes" in
+        always:*)   will=true ;;
+        never:*)    will=false ;;
+        auto:0)     will=false ;;
+        auto:2)     will=false ;;
+        auto:*)     will=true ;;
+        *)          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"
+}
+
+__tf_header() {
+    #
+    # create header to add to output before test
+    #
+    local hdrline                       # each line from generator
+    local hdrgen="$TF_SUITE/TF_HEADER"  # header generator script
+    tf_think "#"
+    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 ""
+}
+
+tf_enum_tests() {
+    #
+    # List what looks like test; relative to $TF_SUITE
+    #
+    tf_debug "TF_SUITE='$TF_SUITE'"
+    test -d "$TF_SUITE" || return 0
+    find -L \
+        "$TF_SUITE" \
+        -mindepth 2 \
+        -maxdepth 2 \
+        -type f \
+        -perm /111 \
+        -name TF_RUN \
+      | cut -d/ -f2
+}
+
+tf_run_tests() {
+    #
+    # Discover and run tests
+    #
+    local es=0          # overall exit status
+    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")"
+    __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")
+        cp -r "$TF_SUITE/$tname/"* "$tmpdir"
+        pushd "$tmpdir" >/dev/null
+            TF_DIR="$tf_dir" TF_SUITE=$tf_suite TF_TEST="$tname" \
+                ./TF_RUN
+            tes=$?
+            __tf_collect_if_needed $tes
+            test $tes -gt $es && es=$tes
+        popd >/dev/null
+        rm -rf "$tmpdir"
+        if test $tes -eq 0;
+        then
+            tf_think "''' $tname ($tes)"
+        else
+            tf_warn "??? $tname ($tes)"
+        fi
+    done
+    return $es
+}

utils/tfkit/include/subtest.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+. "$TF_DIR/include/common.sh"
+
+tf_enum_subtests() {
+    #
+    # Stub: enumerate subtests
+    #
+    tf_warn "implement tf_enum_subtests()!"
+    return "$TF_ES_ERROR"
+}
+
+tf_do_subtest() {
+    #
+    # Stub: perform test named $1
+    #
+    tf_warn "implement tf_do_subtest()!"
+    return "$TF_ES_ERROR"
+}
+
+_tf_do_subtest() {
+    #
+    # Run single subtest inc. setup/cleanup if present
+    #
+    local subtname="$1"     # this subtest name
+    local ses=0             # subtest exit status
+    local setup=true        # setup command
+    local cleanup=true      # cleanup command
+    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
+        tf_do_subtest "$subtname"; ses=$?
+    else
+        tf_warn "setup phase failed, skipping: $subtname"
+        ses=$TF_ES_ERROR
+    fi
+    if ! $cleanup;
+    then
+        tf_warn "cleanup phase failed: $subtname"
+        ses=$TF_ES_PANIC
+    fi
+    return "$ses"
+}
+
+tf_do_subtests() {
+    #
+    # Run all subtests and return highest status
+    #
+    local es=0              # final exit status ("worst" of subtests)
+    local subtname=""       # one subtest name
+    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"; }
+    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
+        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_TEST::$subtname ($tes)"
+        test $tes -gt "$TF_ES_BAILOUT" && break
+    done
+    return $es
+}

utils/tfkit/include/tools.sh

@@ -0,0 +1,86 @@
+#!/bin/bash
+
+. "$TF_DIR/include/common.sh"
+
+# 1. exec: [test] -> [result]
+# 2. eval:           [result] == [oracle]
+
+tf_testflt() {
+    #
+    # Run a simple test for a unix filter
+    #
+    #     tf_testflt -n foo [-i foo.stdin] \
+    #                [-O foo.stdout] [-E foo.stderr] [-S 3] \
+    #                cmd arg...
+    #
+    # Will drop *result/NAME.stdout* and *result/NAME.stderr* (intentionally
+    # not cleaning up).
+    #
+
+    # defaults
+    #
+    local t_in="/dev/null"      # test: stdin
+    local t_name=""             # test: name
+                                # command is "$@" after arg parsing
+    local t_es="0"              # final test exit status
+    local o_out="/dev/null"     # oracle: stdout
+    local o_err="/dev/null"     # oracle: stderr
+    local o_es="0"              # oralce: exit status
+    local r_out r_err r_es      # result: ^ ^ ^ those 3
+
+    local diff=diff
+    type colordiff >/dev/null 2>/dev/null && diff=colordiff
+
+    # get args
+    #
+    local orig_args="$0 $*"
+    tf_debug "orig_args=$orig_args"
+    local arg_err=false
+    while true; do case "$1" in
+        -i) t_in="$2";          shift 2 || { arg_err=true; break; } ;;
+        -n) t_name="$2";        shift 2 || { arg_err=true; break; } ;;
+        -O) o_out="$2";         shift 2 || { arg_err=true; break; } ;;
+        -E) o_err="$2";         shift 2 || { arg_err=true; break; } ;;
+        -S) o_es="$2";          shift 2 || { arg_err=true; break; } ;;
+        --)                     shift; break ;;
+        "")                            break ;;
+        -*) tf_warn "wrong testcli arg: $1"; return $TF_ES_BAILOUT ;;
+        *)                             break ;;
+    esac done
+    $arg_err && { tf_warn "error parsing arguments: $orig_args"; return $TF_ES_BAILOUT; }
+    tf_debug "t_in='$t_in'"
+    tf_debug "t_name='$t_name'"
+    tf_debug "o_out='$o_out'"
+    tf_debug "o_err='$o_err'"
+    tf_debug "o_es='$o_es'"
+    tf_debug "test command: $*"
+    test "$t_in" = "-" && t_in=/dev/stdin   # works better for check below
+    test -z "$t_name"  && { tf_warn "missing test name"             ; return $TF_ES_BAILOUT; }
+    test -z "$1"       && { tf_warn "missing test command"          ; return $TF_ES_BAILOUT; }
+    test -r "$t_in"    || { tf_warn "missing input file: $t_in"     ; return $TF_ES_BAILOUT; }
+    test -e "$o_out"   || { tf_warn "missing oracle stdout: $o_out" ; return $TF_ES_BAILOUT; }
+    test -e "$o_err"   || { tf_warn "missing oracle stderr: $o_err" ; return $TF_ES_BAILOUT; }
+    test "$o_es" -ge 0 || { tf_warn "invalid oracle status: $o_es"  ; return $TF_ES_BAILOUT; }
+
+    # prepare
+    #
+    mkdir -p result
+    r_out="result/$t_name.stdout"
+    r_err="result/$t_name.stderr"
+    tf_debug "r_out='$r_out'"
+    tf_debug "r_err='$r_err'"
+    touch "$r_out" || { tf_warn "cannot create tmp file: $r_out" ; return $TF_ES_BAILOUT; }
+    touch "$r_err" || { tf_warn "cannot create tmp file: $r_err" ; return $TF_ES_PANIC; }
+
+    # run
+    #
+    ( <"$t_in" eval "$@" >"$r_out" 2>"$r_err" ); r_es=$?
+    tf_debug "r_es='$r_es'"
+
+    # eval/report/exit
+    #
+    test $r_es = $o_es || { tf_warn "bad exit status: $r_es (need $o_es)" ; t_es=$TF_ES_FAIL; }
+    $diff -u "$o_err" "$r_err" || t_es=$TF_ES_FAIL
+    $diff -u "$o_out" "$r_out" || t_es=$TF_ES_FAIL
+    return $t_es
+}

utils/tfkit/runtests

@@ -0,0 +1,95 @@
+#!/bin/bash
+# tfkit - Shellfu's movable test framework
+# See LICENSE file for copyright and license details.
+
+TF_VERSION="0.0.15"
+
+die() {
+    echo "$@" && exit 9
+}
+
+usage() {
+    echo "usage: $(basename "$0") [-c|-C] [-t tests_re] [-s subtest_re] [-p binpath] [-v] [-d]" >&2
+    exit 2
+}
+
+version() {
+    echo "TFKit (A trivial test kit) $TF_VERSION"
+    exit 0
+}
+
+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")}
+
+#
+# Regex (BRE) to filter subtests based on name
+#
+TF_FILTER_SUBTEST=${TF_FILTER_SUBTEST:-}
+
+#
+# Regex (BRE) to filter tests based on name
+#
+TF_FILTER_TEST=${TF_FILTER_TEST:-}
+
+#
+# Location of test suite
+#
+TF_SUITE="${TF_SUITE:-tests}"
+
+#
+# Turn on verbosity?
+#
+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

utils/tfkit/tfkit.mk

@@ -0,0 +1,18 @@
+# tfkit - Shellfu's movable test framework
+# See LICENSE file for copyright and license details.
+#
+# To use, set TF_DIR (make macro) in your Makefile and
+# include this file.
+#
+# Adds `test` target.
+#
+# Note that running "runtests" directly should have the same
+# effect but you will need to set TF_DIR and/or TF_SUITE properly
+# unless they are default (see README)
+
+export TF_DIR
+
+test:
+	@$(TF_DIR)/runtests
+
+.PHONY: test