test: add integration test for multiboot2 and multiboot2-header

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
+
+  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@v20
+      - run: integration-test/run.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/.run.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+
+# http://redsymbol.net/articles/unofficial-bash-strict-mode/
+set -euo pipefail
+IFS=$'\n\t'
+
+DIR=$(dirname "$(realpath "$0")")
+cd "$DIR" || exit
+
+function fn_main() {
+    fn_build_rust_bins
+    fn_multiboot2_integrationtest
+    fn_multiboot2_header_integrationtest
+}
+
+function fn_build_rust_bins() {
+    cd "bins"
+    cargo build --release
+    cd "$DIR"
+}
+
+function fn_multiboot2_integrationtest() {
+    cd tests/multiboot2
+    ./build_img.sh
+    ./run_qemu.sh
+    cd "$DIR"
+}
+
+function fn_multiboot2_header_integrationtest() {
+    cd tests/multiboot2-header
+    ./run_qemu.sh
+    cd "$DIR"
+}
+
+fn_main

integration-test/README.md

@@ -0,0 +1,17 @@
+# Integrationtests
+
+This directory contains integration tests for the `multiboot2` and the
+`multiboot2-header` crate. The integration tests start a QEMU VM and do certain
+checks at runtime. If something fails, they instruct QEMU to exit with an error
+code. All output of the VM is printed to the screen. If
+
+The `bins` directory contains binaries that **are** the tests. The `tests`
+directory contains test definitions, run scripts, and other relevant files. The
+main entry to run all tests is `./run.sh` in this directory.
+
+## TL;DR:
+- `$ ./run.sh` to execute the integration tests
+
+## Prerequisites
+The tests rely on [`nix`](https://nixos.org/) being installed / `nix-shell`
+being available to get the relevant tools.

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",
+]