Merge pull request #36 from rust-osdev/updates

New features for `bootimage runner`

Author: phil-opp

Changelog.md

@@ -1,3 +1,14 @@
+
+- New features for `bootimage runner`
+    - Pass additional arguments to the run command (e.g. QEMU)
+    - Consider all binaries in the `target/deps` folder as test executables
+    - Apply `test-timeout` config key when running tests in `bootimage runner`
+    - Don't apply `run-args` for test executables
+    - Add a new `test-args` config key for test arguments
+    - Add a new `test-success-exit-code` config key for interpreting an exit code as success
+        - This is useful when the `isa-debug-exit` QEMU device is used.
+    - Improve printing of the run command (print string instead of array, print non-canonicalized executable path, respect `--quiet`)
+
 # 0.7.1
 
 - Fix for backwards compatibility: Ignore `test-` executables for `bootimage run`.

Readme.md

@@ -67,15 +67,23 @@ Configuration is done through a through a `[package.metadata.bootimage]` table i
     # This target is used if no `--target` is passed
     default-target = ""
 
-    # The command invoked on `bootimage run` or `bootimage runner`
-    # (the "{}" will be replaced with the path to the bootable disk image)
+    # The command invoked with the created bootimage (the "{}" will be replaced
+    # with the path to the bootable disk image)
+    # Applies to `bootimage run` and `bootimage runner`
     run-command = ["qemu-system-x86_64", "-drive", "format=raw,file={}"]
 
-    # Additional arguments passed to the runner on `bootimage run` or `bootimage runner`
-    # (this is useful when you want to add some arguments to the default QEMU command)
+    # Additional arguments passed to the run command for non-test executables
+    # Applies to `bootimage run` and `bootimage runner`
     run-args = []
 
-    # The timeout for running an integration test through `bootimage test` in seconds
+    # Additional arguments passed to the run command for test executables
+    # Applies to `bootimage runner`
+    test-args = []
+
+    # An exit code that should be considered as success for test executables
+    test-success-exit-code = {integer}
+
+    # The timeout for running a test through `bootimage test` or `bootimage runner` (in seconds)
     test-timeout = 300
 ```
 

azure-pipelines.yml

@@ -198,3 +198,52 @@ jobs:
       if [ $? -eq 109 ]; then (exit 0); else (exit 1); fi
     workingDirectory: example-kernels/runner
     displayName: 'Run `cargo xrun` for "runner" kernel'
+
+  - script: cargo xtest
+    workingDirectory: example-kernels/runner-test
+    displayName: 'Run `cargo xtest` for "runner-test" kernel'
+
+- job: formatting
+  displayName: Check Formatting
+
+  strategy:
+    matrix:
+      linux:
+        image_name: 'ubuntu-16.04'
+        rustup_toolchain: stable
+
+  pool:
+    vmImage: $(image_name)
+
+  steps:
+  - bash: |
+      echo "Hello world from $AGENT_NAME running on $AGENT_OS"
+      echo "Reason: $BUILD_REASON"
+      case "$BUILD_REASON" in
+              "Manual") echo "$BUILD_REQUESTEDFOR manually queued the build." ;;
+              "PullRequest") echo "This is a CI build for a pull request on $BUILD_REQUESTEDFOR." ;;
+              "IndividualCI") echo "This is a CI build for $BUILD_REQUESTEDFOR." ;;
+              "BatchedCI") echo "This is a batched CI build for $BUILD_REQUESTEDFOR." ;;
+          *) "$BUILD_REASON" ;;
+      esac
+    displayName: 'Build Info'
+    continueOnError: true
+
+  - script: |
+      set -euxo pipefail
+      curl https://sh.rustup.rs -sSf | sh -s -- -y --default-toolchain $RUSTUP_TOOLCHAIN
+      echo "##vso[task.setvariable variable=PATH;]$PATH:$HOME/.cargo/bin"
+    condition: or(eq( variables['Agent.OS'], 'Linux' ),  eq( variables['Agent.OS'], 'Darwin' ))
+    displayName: 'Install Rust'
+
+  - script: |
+      rustc -Vv
+      cargo -V
+    displayName: 'Print Rust Version'
+    continueOnError: true
+
+  - script: rustup component add rustfmt
+    displayName: 'Install Rustfmt'
+
+  - script: cargo fmt -- --check
+    displayName: 'Check Formatting'

example-kernels/Cargo.lock

@@ -4,6 +4,7 @@ members = [
     "default-target-bootimage",
     "default-target-cargo",
     "runner",
+    "runner-test",
     "testing-qemu-exit-code",
     "testing-serial-result",
 ]

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-test/.cargo/config

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

example-kernels/runner-test/.gitignore

@@ -0,0 +1,17 @@
+[package]
+name = "runner-test"
+version = "0.1.0"
+authors = ["Philipp Oppermann <[email protected]>"]
+edition = "2018"
+
+[[test]]
+name = "no-harness"
+harness = false
+
+[dependencies]
+bootloader = "0.5.1"
+x86_64 = "0.5.3"
+
+[package.metadata.bootimage]
+test-success-exit-code = 33 # (0x10 << 1) | 1
+test-args = ["-device", "isa-debug-exit,iobase=0xf4,iosize=0x04", "-display", "none"]

example-kernels/runner-test/Cargo.toml

@@ -0,0 +1,63 @@
+#![no_std]
+#![cfg_attr(test, no_main)]
+
+#![feature(custom_test_frameworks)]
+#![test_runner(crate::test_runner)]
+#![reexport_test_harness_main = "test_main"]
+
+pub fn test_runner(tests: &[&dyn Fn()]) {
+    for test in tests.iter() {
+        test();
+    }
+
+    unsafe { exit_qemu(ExitCode::Success); }
+}
+
+#[test_case]
+fn test1() {
+    assert_eq!(0, 0);
+}
+
+#[test_case]
+fn test2() {
+    assert_eq!(1, 1);
+}
+
+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 {}
+}

example-kernels/runner-test/src/lib.rs

@@ -0,0 +1,30 @@
+#![no_std]
+#![no_main]
+
+#![feature(custom_test_frameworks)]
+#![test_runner(runner_test::test_runner)]
+#![reexport_test_harness_main = "test_main"]
+
+use core::panic::PanicInfo;
+use runner_test::{exit_qemu, ExitCode};
+
+#[no_mangle]
+pub extern "C" fn _start() -> ! {
+    #[cfg(test)]
+    test_main();
+
+    unsafe { exit_qemu(ExitCode::Failed); }
+
+    loop {}
+}
+
+#[test_case]
+fn test1() {
+    assert_eq!(0, 0);
+}
+
+#[panic_handler]
+fn panic(_info: &PanicInfo) -> ! {
+    unsafe { exit_qemu(ExitCode::Failed); }
+    loop {}
+}