overhaul run-test.sh

- require bash and use subroutines
- write intermediate output to stderr instead of stdout
- strip ANSI escape sequences from the logs
- add option to run tests via ZMK shell commands

app/run-test.sh

@@ -1,47 +1,112 @@
-#!/bin/sh
+#!/bin/bash
 
 # Copyright (c) 2020 The ZMK Contributors
 # SPDX-License-Identifier: MIT
 
-if [ -z "$1" ]; then
+function main() {
-    echo "Usage: ./run-test.sh <path to testcase>"
+    if [ -z "$1" ] || [ "$1" = "all" ]; then
-    exit 1
+        path="tests"
-fi
+    else
+        path="$1"
+    fi
 
-path="$1"
+    >&2 echo "Running all tests in ./$path"
-if [ $path = "all" ]; then
-    path="tests"
-fi
 
-testcases=$(find $path -name native_posix_64.keymap -exec dirname \{\} \;)
+    testcases=$(find $path -name native_posix_64.keymap -exec dirname \{\} \;)
-num_cases=$(echo "$testcases" | wc -l)
+
-if [ $num_cases -gt 1 ] || [ "$testcases" != "$path" ]; then
+    :>./build/tests/pass-fail.log
-    echo "" > ./build/tests/pass-fail.log
+    echo "$testcases" | xargs -n 1 -P ${J:-4} bash -c 'run_test "$@"' _
-    echo "$testcases" | xargs -L 1 -P ${J:-4} ./run-test.sh
     err=$?
+    >&2 echo
+    >&2 echo "=== Test results ==="
     sort -k2 ./build/tests/pass-fail.log
     exit $err
-fi
+}
 
-testcase="$path"
+function run_test() {
-echo "Running $testcase:"
+    path="$1"
 
-west build -d build/$testcase -b native_posix_64 -- -DZMK_CONFIG="$(pwd)/$testcase" > /dev/null 2>&1
+    build_dir="build/$path"
-if [ $? -gt 0 ]; then
+    build_log="$build_dir/build.log"
-    echo "FAILED: $testcase did not build" | tee -a ./build/tests/pass-fail.log
-    exit 1
-fi
 
-./build/$testcase/zephyr/zmk.exe | sed -e "s/.*> //" | tee build/$testcase/keycode_events_full.log | sed -n -f $testcase/events.patterns > build/$testcase/keycode_events.log
+    # Look for a file named "inputs.txt" in some subdirectory of the test.
-diff -auZ $testcase/keycode_events.snapshot build/$testcase/keycode_events.log
+    #
-if [ $? -gt 0 ]; then
+    # If none exists, assume it uses the old approach of hardcoding events in the kscan-mock driver.
-    if [ -f $testcase/pending ]; then
+    inputs=$(find $path -mindepth 1 -name inputs.txt -exec dirname \{\} \;)
-        echo "PENDING: $testcase" | tee -a ./build/tests/pass-fail.log
+
-        exit 0
+    extra_config=""
+    if [ -n "$inputs" ]; then
+        # replace with DEXTRA_CONFIG_FILE for Zephyr 3.4
+        extra_config+="-DOVERLAY_CONFIG=boards/native_posix_shell_test_extra.conf"
     fi
-    echo "FAILED: $testcase" | tee -a ./build/tests/pass-fail.log
-    exit 1
-fi
 
-echo "PASS: $testcase" | tee -a ./build/tests/pass-fail.log
+    mkdir -p $build_dir
-exit 0
+    >&2 echo "Building $path:"
+    west build -d $build_dir -b native_posix_64 -- -DZMK_CONFIG="$(pwd)/$path" $extra_config >"$build_log" 2>&1
+    if [ $? -gt 0 ]; then
+        echo "FAILED: $path did not build"
+        >&2 printf "\t%s\n" "for details see ./$build_log"
+        return 1
+    fi
+
+
+    function check_test_results() {
+        testdir="$1"
+        outdir="$2"
+        tee $outdir/keycode_events_full.log | \
+            sed -e "s/.*> //" | \
+            sed -e "s/\x1B\[[0-9;]*[a-zA-Z]//g" | \
+            sed -n -f $testdir/events.patterns > $outdir/keycode_events.log
+
+        >&2 diff -auZ $testdir/keycode_events.snapshot $outdir/keycode_events.log
+
+        if [ $? -gt 0 ]; then
+            if [ -f $testdir/pending ]; then
+                echo "PENDING: $testdir"
+                return 0
+            fi
+            echo "FAILED: $testdir"
+            return 1
+        else
+            echo "PASS: $testdir"
+            return 0
+        fi | tee -a ./build/tests/pass-fail.log
+    }
+
+    if [ -z "$inputs" ]; then
+        >&2 echo "Running $path using kscan-mock:"
+        ./build/$path/zephyr/zmk.exe | check_test_results $path build/$path
+        return $?
+    fi
+
+    # Add waits between each command to better simulate typing.
+    #
+    # FIXME(ecstaticmore): make this configurable
+    function augment_commands() {
+       awk '{print; print "wait 10"}' "$1/inputs.txt"
+       echo "exit"
+    }
+
+    # This convoluted invocation is needed to work around some quirks in
+    # Zephyr's serial shell driver:
+    #
+    # - When stdin is closed while CONFIG_NATIVE_UART_0_ON_STDINOUT is enabled,
+    #   reading from the UART driver returns the same byte over and over
+    #   (instead of blocking).
+    # - The shell driver reads from the UART driver greedily until it blocks
+    #   (instead of stopping on newlines or when the ring buffer is full).
+    #
+    # To work around this, we sleep inside a process substitution to keep
+    # the pipe open until the Zephyr executable exits.
+    ret=0
+    for input in $inputs; do
+        >&2 echo "Running $path/native_posix_64.keymap with $input/inputs.txt:"
+        mkdir -p build/$input
+        ./build/$path/zephyr/zmk.exe < <(augment_commands $input; sleep 999) \
+            | check_test_results $input build/$input || ret=1
+    done
+    return $ret
+}
+
+export -f run_test
+main "$@"