test: add integration test for multiboot2-lib

Author: phip1611

.editorconfig

@@ -11,5 +11,5 @@ indent_size = 4
 trim_trailing_whitespace = true
 max_line_length = 80
 
-[*.yml]
+[{*.nix, *.yml}]
 indent_size = 2

.github/workflows/rust.yml

@@ -127,3 +127,15 @@ jobs:
       do-style-check: true
       do-test: false
       features: builder,unstable
+
+  multiboot2_integrationtest:
+    name: multiboot2 integrationtest
+    needs:
+      - build_nightly
+      - build_nostd_nightly
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/checkout@v3
+      - uses: cachix/install-nix-action@v19
+      - run: integration-test/run_multiboot2_integrationtest.sh

Cargo.toml

@@ -4,6 +4,9 @@ members = [
     "multiboot2",
     "multiboot2-header",
 ]
+exclude = [
+    "integration-test"
+]
 
 [workspace.dependencies]
 bitflags = "2"

integration-test/.envrc

@@ -0,0 +1 @@
+use nix

integration-test/README.md

@@ -0,0 +1,17 @@
+# Integrationtests
+
+The `multiboot2`-directory contains an integration test that boots GRUB via legacy
+boot in a QEMU VM, which chainloads a multiboot2 integration test binary written
+in Rust.
+
+The `multiboot2-header`-directory contains an integration test that boots a
+bootloader using the `multiboot2-header` crate via multiboot1 which generates a
+multiboot information structure and chainloads the integrationtest from the
+`multiboot2`-directory.
+
+Both tests write output to the QEMU debugcon device and the output is matched
+against an expected test file.
+
+The easiest way to set up the necessary toolchain is to install Nix and
+execute:
+- `$ nix-shell --pure --run "./run.sh""`

integration-test/bins/.cargo/config.toml

@@ -0,0 +1,11 @@
+[unstable]
+build-std = ["core", "compiler_builtins", "alloc"]
+build-std-features = ["compiler-builtins-mem"]
+
+[build]
+target = "x86-unknown-none.json"
+rustflags = [
+    "-C", "code-model=kernel",
+    # "-C", "link-arg=-Tlink.ld",
+    "-C", "relocation-model=static",
+]

integration-test/bins/Cargo.lock

@@ -0,0 +1,14 @@
+[workspace]
+resolver = "2"
+members = [
+    "multiboot2_chainloader",
+    "multiboot2_payload",
+    "util"
+]
+
+[profile.release]
+codegen-units = 1
+lto = true
+
+[patch.crates-io]
+multiboot2 = { path = "../../multiboot2" }

integration-test/bins/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "multiboot2_chainloader"
+description = "Multiboot chainloader that loads a Multiboot2 payload"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+anyhow = { version = "1.0.69", default-features = false }
+elf_rs = "0.3.0"
+log = { version = "0.4.17", default-features = false }
+good_memory_allocator = "0.1.7"
+multiboot = "0.8.0"
+util = { path = "../util" }
+multiboot2 = { path = "../../../multiboot2" }
+multiboot2-header = { path = "../../../multiboot2-header" }

integration-test/bins/multiboot2_chainloader/Cargo.toml

@@ -0,0 +1,5 @@
+fn main() {
+    let linker_script = "multiboot2_chainloader/link.ld";
+    println!("cargo:rerun-if-changed={linker_script}");
+    println!("cargo:rustc-link-arg=-T{linker_script}");
+}