Update test framework to rewrite

Author: phil-opp

.cargo/config.toml

@@ -1,2 +1,2 @@
-[target.x86_64-unknown-uefi]
-runner = "cargo run -p runner"
+[unstable]
+bindeps = true

Cargo.lock

@@ -1,3 +1,5 @@
+cargo-features = ["profile-rustflags"]
+
 [package]
 name = "bootloader"
 version = "0.11.0-alpha.0"
@@ -31,6 +33,13 @@ raw-cpuid = { version = "10.2.0", optional = true }
 rand = { version = "0.8.4", optional = true, default-features = false }
 rand_chacha = { version = "0.3.1", optional = true, default-features = false }
 
+[dev-dependencies]
+bootloader_test_runner = { path = "tests/runner" }
+test_kernel_default_settings = { path = "tests/test_kernels/default_settings", artifact = "bin", target = "x86_64-unknown-none" }
+test_kernel_higher_half = { path = "tests/test_kernels/higher_half", artifact = "bin", target = "x86_64-unknown-none" }
+test_kernel_map_phys_mem = { path = "tests/test_kernels/map_phys_mem", artifact = "bin", target = "x86_64-unknown-none" }
+test_kernel_pie = { path = "tests/test_kernels/pie", artifact = "bin", target = "x86_64-unknown-none" }
+
 # [dependencies.bootloader-x86_64-uefi]
 # version = "0.1.0"
 # path = "uefi"
@@ -55,6 +64,15 @@ codegen-units = 1
 debug = false
 overflow-checks = false
 
+[profile.test.package.test_kernel_higher_half]
+rustflags = [
+    "-C",
+    "link-args=--image-base 0xFFFF800000000000",
+    "-C",
+    "relocation-model=static",                   # pic in higher half not supported yet
+    "-C",
+    "code-model=large",
+]
 
 [package.metadata.docs.rs]
 default-target = "x86_64-unknown-linux-gnu"

Cargo.toml

@@ -1,3 +1,4 @@
 [toolchain]
 channel = "nightly"
 components = ["rustfmt", "clippy", "rust-src", "llvm-tools-preview"]
+targets = ["x86_64-unknown-none"]

rust-toolchain.toml

@@ -67,14 +67,13 @@ for all possible configuration options.
 
 #![warn(missing_docs)]
 
+use anyhow::Context;
 use std::{
     fs::{self, File},
     io::{self, Seek},
     path::Path,
 };
 
-use anyhow::Context;
-
 pub fn create_uefi_disk_image(
     kernel_binary: &Path,
     out_fat_path: &Path,
@@ -200,8 +199,3 @@ fn create_gpt_disk(fat_image: &Path, out_gpt_path: &Path) {
     disk.seek(io::SeekFrom::Start(start_offset)).unwrap();
     io::copy(&mut File::open(&fat_image).unwrap(), &mut disk).unwrap();
 }
-
-// Provides a function to turn a bootloader executable into a disk image.
-//
-// Used by the `builder` binary. Only available when the `builder` feature is enabled.
-// pub mod disk_image;

src/lib.rs

@@ -1,27 +1,22 @@
-use std::process::Command;
+use bootloader_test_runner::run_test_kernel;
 
 #[test]
 fn basic_boot() {
-    run_test_binary("basic_boot");
+    run_test_kernel(env!(
+        "CARGO_BIN_FILE_TEST_KERNEL_DEFAULT_SETTINGS_basic_boot"
+    ));
 }
 
 #[test]
 fn should_panic() {
-    run_test_binary("should_panic");
+    run_test_kernel(env!(
+        "CARGO_BIN_FILE_TEST_KERNEL_DEFAULT_SETTINGS_should_panic"
+    ));
 }
 
 #[test]
 fn check_boot_info() {
-    run_test_binary("check_boot_info");
-}
-
-fn run_test_binary(bin_name: &str) {
-    let mut cmd = Command::new(env!("CARGO"));
-    cmd.current_dir("tests/test_kernels/default_settings");
-    cmd.arg("run");
-    cmd.arg("--bin").arg(bin_name);
-    cmd.arg("--target").arg("x86_64-default_settings.json");
-    cmd.arg("-Zbuild-std=core");
-    cmd.arg("-Zbuild-std-features=compiler-builtins-mem");
-    assert!(cmd.status().unwrap().success());
+    run_test_kernel(env!(
+        "CARGO_BIN_FILE_TEST_KERNEL_DEFAULT_SETTINGS_check_boot_info"
+    ));
 }

tests/default_settings.rs

@@ -1,32 +1,25 @@
-use std::process::Command;
+use bootloader_test_runner::run_test_kernel;
 
 #[test]
 fn basic_boot() {
-    run_test_binary("basic_boot");
+    run_test_kernel(env!("CARGO_BIN_FILE_TEST_KERNEL_HIGHER_HALF_basic_boot"));
 }
 
 #[test]
 fn should_panic() {
-    run_test_binary("should_panic");
+    run_test_kernel(env!("CARGO_BIN_FILE_TEST_KERNEL_HIGHER_HALF_should_panic"));
 }
 
 #[test]
 fn check_boot_info() {
-    run_test_binary("check_boot_info");
+    run_test_kernel(env!(
+        "CARGO_BIN_FILE_TEST_KERNEL_HIGHER_HALF_check_boot_info"
+    ));
 }
 
 #[test]
 fn verify_higher_half() {
-    run_test_binary("verify_higher_half");
-}
-
-fn run_test_binary(bin_name: &str) {
-    let mut cmd = Command::new(env!("CARGO"));
-    cmd.current_dir("tests/test_kernels/higher_half");
-    cmd.arg("run");
-    cmd.arg("--bin").arg(bin_name);
-    cmd.arg("--target").arg("x86_64-higher_half.json");
-    cmd.arg("-Zbuild-std=core");
-    cmd.arg("-Zbuild-std-features=compiler-builtins-mem");
-    assert!(cmd.status().unwrap().success());
+    run_test_kernel(env!(
+        "CARGO_BIN_FILE_TEST_KERNEL_HIGHER_HALF_verify_higher_half"
+    ));
 }

tests/higher_half.rs

@@ -1,22 +1,15 @@
-use std::process::Command;
+use bootloader_test_runner::run_test_kernel;
 
 #[test]
 fn check_boot_info() {
-    run_test_binary("check_boot_info");
+    run_test_kernel(env!(
+        "CARGO_BIN_FILE_TEST_KERNEL_MAP_PHYS_MEM_check_boot_info"
+    ));
 }
 
 #[test]
 fn access_phys_mem() {
-    run_test_binary("access_phys_mem");
-}
-
-fn run_test_binary(bin_name: &str) {
-    let mut cmd = Command::new(env!("CARGO"));
-    cmd.current_dir("tests/test_kernels/map_phys_mem");
-    cmd.arg("run");
-    cmd.arg("--bin").arg(bin_name);
-    cmd.arg("--target").arg("x86_64-map_phys_mem.json");
-    cmd.arg("-Zbuild-std=core");
-    cmd.arg("-Zbuild-std-features=compiler-builtins-mem");
-    assert!(cmd.status().unwrap().success());
+    run_test_kernel(env!(
+        "CARGO_BIN_FILE_TEST_KERNEL_MAP_PHYS_MEM_access_phys_mem"
+    ));
 }

tests/map_phys_mem.rs

@@ -1,32 +1,21 @@
-use std::process::Command;
+use bootloader_test_runner::run_test_kernel;
 
 #[test]
 fn basic_boot() {
-    run_test_binary("basic_boot");
+    run_test_kernel(env!("CARGO_BIN_FILE_TEST_KERNEL_PIE_basic_boot"));
 }
 
 #[test]
 fn should_panic() {
-    run_test_binary("should_panic");
+    run_test_kernel(env!("CARGO_BIN_FILE_TEST_KERNEL_PIE_should_panic"));
 }
 
 #[test]
 fn check_boot_info() {
-    run_test_binary("check_boot_info");
+    run_test_kernel(env!("CARGO_BIN_FILE_TEST_KERNEL_PIE_check_boot_info"));
 }
 
 #[test]
 fn global_variable() {
-    run_test_binary("global_variable");
-}
-
-fn run_test_binary(bin_name: &str) {
-    let mut cmd = Command::new(env!("CARGO"));
-    cmd.current_dir("tests/test_kernels/pie");
-    cmd.arg("run");
-    cmd.arg("--bin").arg(bin_name);
-    cmd.arg("--target").arg("x86_64-pie.json");
-    cmd.arg("-Zbuild-std=core");
-    cmd.arg("-Zbuild-std-features=compiler-builtins-mem");
-    assert!(cmd.status().unwrap().success());
+    run_test_kernel(env!("CARGO_BIN_FILE_TEST_KERNEL_PIE_global_variable"));
 }

tests/pie.rs

@@ -1,11 +1,11 @@
 [package]
-name = "runner"
+name = "bootloader_test_runner"
 version = "0.1.0"
 authors = ["Philipp Oppermann <dev@phil-opp.com>"]
 edition = "2018"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-bootloader-locator = "0.0.4"
-locate-cargo-manifest = "0.2.1"
+bootloader = { path = "../.." }
+strip-ansi-escapes = "0.1.1"