[test] Upload per app screenshot as artifacts

Author: scopeInfinity

tests/app/cat_test.sh

@@ -2,6 +2,8 @@
 
 # Test is supposed to be sourced from shell_test.sh
 
+QEMU_SCREENSHOT_NAME="cat_test.ppm"
+
 python3 -m tests.qemu.monitor -p ${MONITOR_PORT:?} -sc run cat
 
 test_create_screen_dump

tests/app/ls_test.sh

@@ -2,6 +2,8 @@
 
 # Test is supposed to be sourced from shell_test.sh
 
+QEMU_SCREENSHOT_NAME="ls_test.ppm"
+
 python3 -m tests.qemu.monitor -p ${MONITOR_PORT:?} -sc run ls
 
 test_create_screen_dump

tests/app/tictactoe_test.sh

@@ -2,6 +2,8 @@
 
 # Test is supposed to be sourced from shell_test.sh
 
+QEMU_SCREENSHOT_NAME="tictactoe_test.ppm"
+
 python3 -m tests.qemu.monitor -p ${MONITOR_PORT:?} -sc run tictactoe
 
 test_create_screen_dump

tests/app_ttt_test.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+source tests/lib.sh
+
+TEST_INJECT_WORD="__TEST_INJECT_APP_TTT_ENTRY__"
+TEST_MAGIC_WANT="${MAGIC_WORD_SLEEP:?}"
+
+os_test_up "${TEST_MAGIC_WANT:?}" "${TEST_INJECT_WORD:?}" INIT_APPNAME="tictactoe" || exit -1
+
+# Test
+set -e
+test_screen_content $LINENO "TicTacToe"
+
+python -m tests.qemu.monitor --quit
+wait ${QEMU_PID:?}
+echo "$0 passed!!!"

tests/fuzzy_app_test.sh tests/fuzzy_shell_test.shtests/fuzzy_app_test.sh renamed to tests/fuzzy_shell_test.sh

@@ -6,8 +6,8 @@ SRC_DIR="src/"
 SRC_TEST_DIR="src_test/"
 BUILD_TEST_DIR="build_test"
 MONITOR_PORT=55555
-QEMU_SCREENSHOT="/tmp/$(basename $0 .sh).ppm"
-QEMU_SCREENSHOT_ARTIFACT="${QEMU_SCREENSHOT%.ppm}.png"
+QEMU_SCREENSHOT_BASEDIR="/tmp"
+QEMU_SCREENSHOT_NAME="$(basename $0 .sh).ppm"  # subtests are expected to override
 
 MAGIC_WORD_SLEEP="##SLEEP-10s##"
 MAGIC_WORD_NO_TEST_INJECT="TEST-INJECT-WORD-NOT-NEEDED"
@@ -25,7 +25,6 @@ function err() {
     exit -1
 }
 
-
 ##########################################
 # Resolves filename from build target.
 # Arguments:
@@ -69,21 +68,27 @@ function test_screen_content() {
 ##########################################
 # Test Helper: Create QEMU screen dump
 # Globals:
-#   QEMU_SCREENSHOT
-#   QEMU_SCREENSHOT_ARTIFACT
+#   QEMU_SCREENSHOT_NAME
+#   SCREEN_CONTENT
 # Output:
 #   raises error or screen dump in text.
 ##########################################
 function test_create_screen_dump() {
-    python -m tests.qemu.monitor -qc screendump ${QEMU_SCREENSHOT:?}
+    qemu_screenshot_fname="${QEMU_SCREENSHOT_BASEDIR:?}/${QEMU_SCREENSHOT_NAME:?}"
+    qemu_screenshot_png="${qemu_screenshot_fname%.ppm}.png"  # lazy compute
+
+    # Cleanup from any old screenshot
+    rm -f ${qemu_screenshot_fname:?}
 
-    if [ ! -f ${QEMU_SCREENSHOT:?} ]; then
+    python -m tests.qemu.monitor -qc screendump ${qemu_screenshot_fname:?}
+
+    if [ ! -f ${qemu_screenshot_fname:?} ]; then
         err -1 "[create_screen_dump] failed to create qemu screen dump"
     fi
 
-    convert ${QEMU_SCREENSHOT:?} ${QEMU_SCREENSHOT_ARTIFACT:?}
+    convert ${qemu_screenshot_fname:?} ${qemu_screenshot_png:?}
 
-    SCREEN_CONTENT="$(gocr -i ${QEMU_SCREENSHOT:?})"
+    SCREEN_CONTENT="$(gocr -i ${qemu_screenshot_fname:?})"
     echo "Screen Content: '${SCREEN_CONTENT:?}'"
 }
 
@@ -115,7 +120,7 @@ function sync_to_src_test() {
     rm -r "${SRC_TEST_DIR:?}"
     cp -r "${SRC_DIR:?}" "${SRC_TEST_DIR:?}"
 
-    if [[ "${1:?}" == "${MAGIC_WORD_NO_TEST_INJECT}" ]]; then
+    if [[ "${1:?}" == "${MAGIC_WORD_NO_TEST_INJECT:?}" ]]; then
         return
     fi
 
@@ -158,9 +163,6 @@ function os_test_up() {
     done
     echo "QEMU monitor is available."
 
-    # Cleanup from any previous execution
-    rm -f ${QEMU_SCREENSHOT:?}
-
     # Keep polling QEMU monitor until we get our magic word!
     COMMAND_OUTPUT=""
     echo "Sending commands to QEMU and polling for the magic word '${magic_word:?}' every second."

tests/lib.sh

@@ -59,6 +59,7 @@ def handle_qemu_quit(monitor, args):
         return
     logger.info("Handle: qemu quit")
     monitor.send_qemu_command("quit\n", wait_prompt=False)
+    time.sleep(1)
 
 def main():
     logging.basicConfig(level=logging.INFO)

tests/qemu/monitor.py

@@ -5,7 +5,7 @@ set -e
 timeout 2m bash tests/bootloader_stage1_test.sh &&
 timeout 2m bash tests/bootloader_stage2_test.sh &&
 timeout 2m bash tests/kernel_core_entry_test.sh &&
-timeout 2m bash tests/fuzzy_app_test.sh
+timeout 2m bash tests/fuzzy_shell_test.sh
 
 # Done
 echo "All tests passed!"