Merge pull request #129 from rust-osdev/integration-test

Add Integration Test

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,37 @@ jobs:
       do-style-check: true
       do-test: false
       features: builder,unstable
+
+  integrationtest:
+    name: 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
+        with:
+          # This channel is only required to invoke "nix-shell".
+          # Everything inside that nix-shell will use a pinned version of
+          # nixpkgs.
+          nix_path: nixpkgs=channel:nixos-23.05
+      - name: Set up cargo cache
+        uses: actions/cache@v3
+        continue-on-error: false
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            integration-test/bins/target/
+          # Hash over Cargo.toml and Cargo.lock, as this might be copied to
+          # projects that do not have a Cargo.lock in their repository tree!
+          key: ${{ runner.os }}-${{ github.job }}-${{ hashFiles('integration-test/**/Cargo.toml', 'integration-test/**/Cargo.lock', 'integration-test/bins/rust-toolchain.toml') }}
+      # Have all the "copying into Nix store" messages in a dedicated step for
+      # better log visibility.
+      - run: cd integration-test && nix-shell --run "echo OK" && cd ..
+      # Now, run the actual test.
+      - run: cd integration-test && nix-shell --run ./run.sh && cd ..

.typos.toml

@@ -7,6 +7,7 @@ extend-exclude = [
 
 [default.extend-words]
 Rela = "Rela"
+grup = "grup"
 
 [default.extend-identifiers]
 # FOOBAR = "FOOBAR"

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,23 @@
+# 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:
+- `$ nix-shell --run ./run.sh` to execute the integration tests with Nix (recommended)
+- `$ ./run.sh` to execute the integration tests (you have to install dependencies manually)
+
+## Prerequisites
+The tests are executed best when using [`nix`](https://nixos.org/)/`nix-shell`
+to get the relevant tools. Otherwise, please make sure the following packages
+are available:
+- grub helper tools
+- rustup
+- QEMU
+- xorriso

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