Added Bootloader Stage 1 Test

Author: scopeInfinity

.gitignore

@@ -1,4 +1,5 @@
 *.vmdk
 *.o
 local_notes/
-build/
+build/
+src_test/

Makefile

@@ -1,15 +1,18 @@
 BUILD_DIR = build
-
-SRC_BOOTLOADER = src/bootloader
-SRC_KERNEL = src/kernel
-SRC_DRIVERS = src/drivers
-SRC_LIB_DS = src/lib/ds
-SRC_LIB_SYSCALL = src/lib/syscall
-SRC_LIB_UTILS = src/lib/utils
-SRC_LIB = src/lib
-SRC_MEMMGR = src/memmgr
-SRC_APP = src/app
-SRC_REALMODE = src/real_mode
+SRC_DIR = src
+QEMU_SHUT_FLAGS= -no-shutdown -no-reboot
+QEMU_EXTRA_FLAGS=
+
+SRC_BOOTLOADER = $(SRC_DIR)/bootloader
+SRC_KERNEL = $(SRC_DIR)/kernel
+SRC_DRIVERS = $(SRC_DIR)/drivers
+SRC_LIB_DS = $(SRC_DIR)/lib/ds
+SRC_LIB_SYSCALL = $(SRC_DIR)/lib/syscall
+SRC_LIB_UTILS = $(SRC_DIR)/lib/utils
+SRC_LIB = $(SRC_DIR)/lib
+SRC_MEMMGR = $(SRC_DIR)/memmgr
+SRC_APP = $(SRC_DIR)/app
+SRC_REALMODE = $(SRC_DIR)/real_mode
 
 BUILD_BOOTLOADER = build/bootloader
 BUILD_KERNEL = build/kernel
@@ -127,13 +130,13 @@ debug_kernel: $(kernel_core)
 	xxd $<
 
 qemu: $(image_vmdk)
-	cpulimit -f -l 100 -- qemu-system-x86_64 -smp 1 -m 128M -hda $< -no-shutdown -no-reboot
+	cpulimit -f -l 100 -- qemu-system-x86_64 -smp 1 -m 128M -hda $< $(QEMU_SHUT_FLAGS) $(QEMU_EXTRA_FLAGS)
 
 qemu_debug: $(image_vmdk)
-	qemu-system-x86_64 -smp 1 -m 128M -hda $< -no-shutdown -no-reboot -d  cpu,exec,in_asm
+	qemu-system-x86_64 -smp 1 -m 128M -hda $< $(QEMU_SHUT_FLAGS) -d  cpu,exec,in_asm
 
 qemu_xdebug: $(image_vmdk)
-	qemu-system-x86_64 -S -gdb tcp::9000 -smp 1 -m 128M -hda $< -no-shutdown -no-reboot -d  cpu,exec,in_asm
+	qemu-system-x86_64 -S -gdb tcp::9000 -smp 1 -m 128M -hda $< $(QEMU_SHUT_FLAGS) -d  cpu,exec,in_asm
 
 clean:
 	rm -r $(BUILD_DIR)/ || echo "Build directory is clean."

src/bootloader/stage1.asm

@@ -33,6 +33,8 @@
 label_bts2_loaded:
         move_xy 06, 07, 00
         print_hex_string_ext 0x8000, 10, C_WHITE, 0
+        ; __TEST_INJECT__: mov eax, 0x9A11C824
+        ; __TEST_INJECT__: HLT
         JMP 0x8000
         JMP label_exit
 

tests/lib.sh

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+SRC_DIR="src/"
+SRC_TEST_DIR="src_test/"
+MONITOR_PORT=55555
+QEMU_SCREENSHOT="/tmp/qemu.ppm"
+
+###################################################
+# Turn up OS in QEMU and wait for $TEST_MAGIC_WANT.
+# Globals:
+#   TEST_MAGIC_WANT
+#   COMMAND_OUTPUT
+#   SCREEN_CONTENT
+#   QEMU_PID
+# Outputs:
+#   Logs
+# Returns:
+#   0 on success, non-zero on error.
+###################################################
+function os_up() {
+    # Turn up QEMU in background
+    make qemu "SRC_DIR=${SRC_TEST_DIR:?}" QEMU_SHUT_FLAGS="" QEMU_EXTRA_FLAGS=" -monitor telnet:127.0.0.1:${MONITOR_PORT:?},server,nowait" &
+    QEMU_PID=$!
+
+    while ! nc -z localhost ${MONITOR_PORT:?}; do
+        echo "Waiting QEMU monitor to be available..."
+        sleep 1s
+    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=""
+    while true; do
+        echo "Sending commands to QEMU."
+        COMMAND_OUTPUT="$(echo -e 'screendump '${QEMU_SCREENSHOT:?}'\nprint $eax\nquit' | nc 127.0.0.1 ${MONITOR_PORT:?})"
+        echo "$COMMAND_OUTPUT" | grep -i "$TEST_MAGIC_WANT" && echo "Magic Word Found! Continuing the test..." && break
+        echo "Magic word not found! Got: $COMMAND_OUTPUT"
+    done
+
+    if [ ! -f ${QEMU_SCREENSHOT:?} ]; then
+        echo "Magic word found but no screenshot found! :( " >&2
+        return -1
+    fi
+
+    SCREEN_CONTENT="$(gocr -i ${QEMU_SCREENSHOT:?})"
+    echo "Screen Content: '${SCREEN_CONTENT:?}'"
+
+    echo "os_up done."
+    return 0
+}

tests/preprocess.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+set -e
+
+source tests/lib.sh
+
+##########################################
+# Activate Code for testing within source.
+# Arguments:
+#   Filename
+##########################################
+function inject_test_code() {
+    echo "Injecting Test Code in $1 (if any)"
+    sed -i 's/;\s*__TEST_INJECT__:\s*//g' "$1"
+}
+export -f inject_test_code
+
+# Prepare source code directory for tests.
+rsync -r "${SRC_DIR:?}" "${SRC_TEST_DIR:?}"
+
+find "${SRC_TEST_DIR:?}" -iname '*.asm' -exec bash -c 'inject_test_code "$0"' {} \;
+

tests/run.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -e
+
+# Preprocess
+bash tests/preprocess.sh
+
+# Execute Tests
+bash tests/stage1_test.sh
+
+# Done
+echo "All tests passed!"

tests/stage1_test.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+TEST_MAGIC_WANT="9A11C824"
+
+source tests/lib.sh
+
+os_up || exit -1
+
+# Test
+set -e
+echo "${SCREEN_CONTENT:?}" | grep "Bootloader: Stage 1" || ( echo "Test Failed!" && exit -1 )
+wait ${QEMU_PID:?}
+echo "$0 passed!!!"