add tests

Author: Freax13

.github/workflows/build.yml

@@ -116,6 +116,10 @@ jobs:
       working-directory: example-kernels/runner-doctest
       name: 'Run `cargo test -Z doctest-xcompile` for "runner-doctest" kernel'
 
+    - run: cargo test
+      working-directory: example-kernels/runner-fail-reboot
+      name: 'Run `cargo test` for "runner-fail-reboot" kernel'
+
   check_formatting:
     name: "Check Formatting"
     runs-on: ubuntu-latest

example-kernels/Cargo.lock

@@ -3,5 +3,6 @@ members = [
     "basic",
     "runner",
     "runner-doctest",
+    "runner-fail-reboot",
     "runner-test",
 ]

example-kernels/Cargo.toml

@@ -0,0 +1,5 @@
+[build]
+target = "../x86_64-bootimage-example-kernels.json"
+
+[target.'cfg(target_os = "none")']
+runner = "bootimage runner"

example-kernels/runner-fail-reboot/.cargo/config

@@ -0,0 +1,2 @@
+/target/
+**/*.rs.bk

example-kernels/runner-fail-reboot/.gitignore

@@ -0,0 +1,14 @@
+[package]
+name = "runner-fail-reboot"
+version = "0.1.0"
+authors = ["Philipp Oppermann <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+bootloader = "0.9.7"
+x86_64 = "0.11.0"
+rlibc = "1.0.0"
+
+[package.metadata.bootimage]
+test-success-exit-code = 0 # this will test for the reboot
+test-args = ["-device", "isa-debug-exit,iobase=0xf4,iosize=0x04", "-display", "none"]

example-kernels/runner-fail-reboot/Cargo.toml

@@ -0,0 +1,71 @@
+#![no_std]
+#![cfg_attr(test, no_main)]
+#![feature(custom_test_frameworks)]
+#![test_runner(crate::test_runner)]
+#![reexport_test_harness_main = "test_main"]
+
+extern crate rlibc;
+
+pub fn test_runner(tests: &[&dyn Fn()]) {
+    for test in tests.iter() {
+        test();
+    }
+
+    unsafe {
+        exit_qemu(ExitCode::Success);
+    }
+}
+
+#[test_case]
+fn should_reboot() {
+    // this overflows the stack which leads to a triple fault
+    // the as-if rule might allow this to get optimized away on release builds
+    #[allow(unconditional_recursion)]
+    fn stack_overflow() {
+        stack_overflow()
+    }
+    stack_overflow()
+}
+
+pub enum ExitCode {
+    Success,
+    Failed,
+}
+
+impl ExitCode {
+    fn code(&self) -> u32 {
+        match self {
+            ExitCode::Success => 0x10,
+            ExitCode::Failed => 0x11,
+        }
+    }
+}
+
+/// exit QEMU (see https://os.phil-opp.com/integration-tests/#shutting-down-qemu)
+pub unsafe fn exit_qemu(exit_code: ExitCode) {
+    use x86_64::instructions::port::Port;
+
+    let mut port = Port::<u32>::new(0xf4);
+    port.write(exit_code.code());
+}
+
+#[cfg(test)]
+#[no_mangle]
+pub extern "C" fn _start() -> ! {
+    test_main();
+
+    unsafe {
+        exit_qemu(ExitCode::Failed);
+    }
+
+    loop {}
+}
+
+#[cfg(test)]
+#[panic_handler]
+fn panic(_info: &core::panic::PanicInfo) -> ! {
+    unsafe {
+        exit_qemu(ExitCode::Failed);
+    }
+    loop {}
+}