Use upstream repo and nested workdir layout for tfkit

.gitignore

@@ -1,3 +1,5 @@
 .autoclean
 saturnin-*.tar.gz
 tfkit-artifacts
+tfkit
+bin/tfkit_init

Makefile

@@ -2,6 +2,7 @@
 # See LICENSE file for copyright and license details.
 
 include config.mk
+include tfkit.mk
 
 all: options build
 
@@ -35,9 +36,6 @@ release_y:
 release_z:
 	@mkit/make release_z
 
-test:
-	@tfkit/runtests
-
 uninstall:
 	@mkit/make uninstall
 

tfkit.mk

@@ -0,0 +1,53 @@
+# Makefile module to deploy tfkit
+#
+# Will add bin/tfkit_init utility, and use it to guess URI to tfkit.git,
+# and clone tfkit to current directory.
+#
+# Adds targets: test to run tfkit tests, tfkit to deploy tfkit, tfkit_update to
+# pull tfkit updates, and tfkit_delete to remove the tfkit code.
+
+
+test: tfkit
+	@tfkit/runtests
+
+tfkit: bin/tfkit_init
+	@bin/tfkit_init
+
+tfkit_delete:
+	@rm -rf tfkit
+	@rm -f bin/tfkit_init
+	@rmdir bin 2>/dev/null || true
+
+bin/tfkit_init:
+	@mkdir -p bin
+	@echo '#!/bin/sh' >bin/tfkit_init
+	@echo '' >>bin/tfkit_init
+	@echo 'die() {' >>bin/tfkit_init
+	@echo '    echo "$$1" >&2' >>bin/tfkit_init
+	@echo '    exit 3' >>bin/tfkit_init
+	@echo '}' >>bin/tfkit_init
+	@echo '' >>bin/tfkit_init
+	@echo 'if test -d tfkit/.git;' >>bin/tfkit_init
+	@echo 'then' >>bin/tfkit_init
+	@echo '    exit 0' >>bin/tfkit_init
+	@echo 'else' >>bin/tfkit_init
+	@echo '' >>bin/tfkit_init
+	@echo '    origin=""' >>bin/tfkit_init
+	@echo '    git remote | grep -q origin && origin=origin' >>bin/tfkit_init
+	@echo '    test $$(git remote | wc -l) -eq 1 && origin=$$(git remote)' >>bin/tfkit_init
+	@echo '    test -n "$$origin" || die "could not guess remote name"' >>bin/tfkit_init
+	@echo '' >>bin/tfkit_init
+	@echo '' >>bin/tfkit_init
+	@echo '    uri=$$(git remote -v | grep "^$$origin.*(fetch)" | tr $$"\t" " " | cut -d\  -f2)' >>bin/tfkit_init
+	@echo '    tfkit_uri=$$(dirname $$uri)/tfkit.git' >>bin/tfkit_init
+	@echo '' >>bin/tfkit_init
+	@echo '    git clone $$tfkit_uri || die "failed to clone tfkit"' >>bin/tfkit_init
+	@echo '' >>bin/tfkit_init
+	@echo 'fi' >>bin/tfkit_init
+	@chmod +x bin/tfkit_init
+
+tfkit_update: tfkit
+	@cd tfkit
+	@git --git-dir tfkit/.git pull
+
+.PHONY: test

tfkit/README.md

@@ -1,15 +0,0 @@
-TFKIT
-=====
-
-A simple portable (or rather "movable") test framework.
-
- 1. Copy (or `git submodule`) *test* sub-folder to your place
-    where you want to run tests.
-
- 2. Run your framework by `./tfkit/runtests`.
-
- 3. Don't be surprised--you haven't added any tests yet :)
-
- 4. Read tfkit/README.testing.md
-
- 5. Start adding tests to `tests` folder

tfkit/README.testing.md

@@ -1,360 +0,0 @@
-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" chapter 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 chapters.  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_name2cmd` to translate each name an actual
-command that would perform it and return with the the correct exit status.
-
-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_name2cmd() {
-        case $1 in
-            test1)  echo myprog foo ;;
-            test2)  echo myprog bar ;;
-        esac
-    }
-
-    tf_do_subtests
-
-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,
- *  run TF_CLEANUP, if such file is found,
- *  and report "worst" exit status encountered.
-
-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.
-
-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 defaiult.
-
-
-### 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 the previous chapters.
-
-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`.
-
- *  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`.
-
- *  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.
-
- *  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 be 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_*)   |
-                  '------------------------------------'

tfkit/doc/templates/grep_engine/TF_RUN

@@ -1,26 +0,0 @@
-#!/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

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

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

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

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

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

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

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

@@ -1,6 +0,0 @@
-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.

tfkit/include/common.sh

@@ -1,135 +0,0 @@
-#
-# 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
-
-#
-# 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
-#
-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_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 "||| $1" >&2;
-        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
-    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$1$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 "$1" >&2;
-        $TF_COLOR && echo -ne "$TF_COLOR_NONE" >&2
-    done
-}

tfkit/include/harness.sh

@@ -1,113 +0,0 @@
-#!/bin/bash
-# ffoo test harness
-# See LICENSE file for copyright and license details.
-
-. $TF_DIR/include/common.sh
-
-#
-# Default path to header generator
-#
-__TF_HDRCMD="$TF_SUITE/TF_HEADER"
-
-
-__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.  Otherwise, collect 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 ;;
-        *:0)        will=false ;;
-        *:2)        will=false ;;
-        *)          will=true ;;
-    esac
-    $will || return 0
-    mkdir -p "$artifact_dir/$stamp"
-    cp -r $tmpdir/* "$artifact_dir/$stamp"
-}
-
-__tf_default_header() {
-    #
-    # Create default header
-    #
-    echo "(add $__TF_HDRCMD executable for own header)"
-}
-
-__tf_header() {
-    #
-    # create header to add to output before test
-    #
-    local field
-    local hdrcmd="$__TF_HDRCMD"
-    test -x "$hdrcmd" || hdrcmd="__tf_default_header"
-    $hdrcmd \
-      | while read field;
-        do
-            test -n "$field" || break
-            tf_think "# $field"
-        done
-    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 artifact_dir="$PWD/tfkit-artifacts"
-    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
-    __tf_header
-    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_TNAME="$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
-}

tfkit/include/subtest.sh

@@ -1,73 +0,0 @@
-#!/bin/bash
-
-. $TF_DIR/include/common.sh
-
-tf_enum_subtests() {
-    #
-    # Stub: enumerate subtests
-    #
-    tf_warn "implement tf_enum_subtests()!"
-    return $TF_ES_ERROR
-}
-
-tf_name2cmd() {
-    #
-    # Stub: expand test name to test command
-    #
-    tf_warn "implement tf_name2cmd()!"
-    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 tcmd=""           # test command
-    local setup=true        # setup function
-    local cleanup=true      # cleanup command
-    test -f TF_SETUP   && setup=". TF_SETUP"
-    test -f TF_CLEANUP && cleanup=". TF_CLEANUP"
-    if $setup;
-    then
-        tcmd="$(tf_name2cmd $subtname)"
-        tf_debug "tcmd='$tcmd'"
-        $tcmd; 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
-        export TF_SUBTNAME=$subtname
-        tf_think "::: $TF_TNAME::$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
-    done
-    return $es
-}

tfkit/include/tools.sh

@@ -1,78 +0,0 @@
-#!/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 ffoo.stdout] [-E ffoo.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
-
-    # get args
-    #
-    while true; do case "$1" in
-        -i) t_in="$2";          shift 2 ;;
-        -n) t_name="$2";        shift 2 ;;
-        -O) o_out="$2";         shift 2 ;;
-        -E) o_err="$2";         shift 2 ;;
-        -S) o_es="$2";          shift 2 ;;
-        --)                     shift; break ;;
-        "")                            break ;;
-        -*) tf_warn "wrong testcli arg: $1"; return $TF_ES_BAILOUT ;;
-        *)                             break ;;
-    esac done
-    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; }
-
-    # 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
-}

tfkit/runtests

@@ -1,33 +0,0 @@
-#!/bin/bash
-# ffoo test framework
-# See LICENSE file for copyright and license details.
-
-
-die() {
-    echo "$@" && exit 9
-}
-
-export LC_ALL=C
-export TF_DIR=${TF_DIR:-tfkit}
-export TF_SUITE="${TF_SUITE:-tests}"
-
-. $TF_DIR/include/harness.sh || die "this must be run from project root"
-
-
-usage() {
-    echo "usage: $(basename $0) [-c] [-t tests_re] [-s subtest_re] [-p binpath] [-v] [-d]" >&2
-    exit 2
-}
-
-while true; do case "$1" in
-    -c|--collect)           export TF_COLLECT=always; shift ;;
-    -t|--filter-test)       export TF_FILTER_TEST="$2"; shift 2 ;;
-    -s|--filter-subtest)    export TF_FILTER_SUBTEST="$2"; shift 2 ;;
-    -p|--prefix)            export PATH="$(readlink -f "$2")/bin:$PATH"; shift 2 ;;
-    -d|--debug)             export TF_DEBUG=true; shift ;;
-    -v|--verbose)           export TF_VERBOSE=true; shift ;;
-    "") break ;;
-    *)  usage ;;
-esac done
-
-time tf_run_tests