Move tests runner to uefi-test-runner

This is in anticipation for support for running
tests from the `tests` directory.

Author: GabrielMajeri

Cargo.toml

@@ -10,7 +10,7 @@ bitflags = "1"
 
 [workspace]
 members = [
-    "tests",
+    "uefi-test-runner",
     "uefi-logger",
     "uefi-alloc",
     "uefi-services",

README.md

@@ -23,20 +23,34 @@ This project contains multiple sub-crates:
 - `uefi-utils`: building on top of `uefi-services`, this crate provides a higher-level access to UEFI functions.
   Provides utility functions for common API usage.
 
-- `tests`: a sample UEFI applications that runs unit tests.
+- `uefi-test-runner` a UEFI application that runs unit / integration tests.
+
+- `examples`: example UEFI apps.
+
+- `tests`: unit and integration tests.
 
 ## Documentation
 
 This crate's documentation is fairly minimal, and you are encouraged to refer to
 the [UEFI specification][spec] for detailed information.
 
-You can find some example code in the `tests` directory,
-as well as use the `build.py` script to generate the documentation.
+[spec]: http://www.uefi.org/specifications
 
-This repo also contains a `x86_64-uefi.json` file, which is
-a custom Rust target for 64-bit UEFI applications.
+### rustdoc
 
-[spec]: http://www.uefi.org/specifications
+Use the `build.py` script in the `uefi-test-runner` directory to generate the documentation:
+
+```sh
+./build.py doc
+```
+
+### Sample code
+
+Some example UEFI apps are in the `examples` directory.
+
+The unit / integration tests are in the `tests` directory.
+
+This repo also contains a `x86_64-uefi.json` file, which is a custom Rust target for 64-bit UEFI applications.
 
 ## Building UEFI programs
 
@@ -69,6 +83,7 @@ You can use the `tests` directory as sample code for building a simple UEFI app.
 
 ## License
 
-The code in this repository is licensed under the Mozilla Public License 2. This license allows you to use the crate in proprietary programs, but any modifications to the files must be open-sourced.
+The code in this repository is licensed under the Mozilla Public License 2.
+This license allows you to use the crate in proprietary programs, but any modifications to the files must be open-sourced.
 
 The full text of the license is available in the `LICENSE` file.

tests/.gitignore renamed to uefi-test-runner/.gitignore

@@ -1,5 +1,5 @@
 [package]
-name = "tests"
+name = "uefi-test-runner"
 version = "0.1.0"
 authors = ["Gabriel Majeri <[email protected]>"]
 publish = false

tests/Cargo.toml renamed to uefi-test-runner/Cargo.toml

@@ -25,25 +25,22 @@
 
 # Path to directory containing `OVMF_{CODE/VARS}.fd`.
 # TODO: use installed OVMF, if available.
-OVMF_DIR = WORKSPACE_DIR / 'tests'
+OVMF_DIR = WORKSPACE_DIR / 'uefi-test-runner'
 
 BUILD_DIR = WORKSPACE_DIR / 'target' / TARGET / CONFIG
 ESP_DIR = BUILD_DIR / 'esp'
 
-# File with test output.
-LOG_FILE = BUILD_DIR / 'tests.log'
-
 def run_xargo(verb, *flags):
     'Runs Xargo with certain arguments.'
     sp.run([XARGO, verb, '--target', TARGET, *flags]).check_returncode()
 
 def build():
     'Builds the tests package.'
 
-    run_xargo('build', '--package', 'tests')
+    run_xargo('build', '--package', 'uefi-test-runner')
 
     # Copy the built file to the right directory for running tests.
-    built_file = BUILD_DIR / 'tests.efi'
+    built_file = BUILD_DIR / 'uefi-test-runner.efi'
 
     boot_dir = ESP_DIR / 'EFI' / 'Boot'
     boot_dir.mkdir(parents=True, exist_ok=True)
@@ -84,8 +81,6 @@ def run_qemu():
         # Mount a local directory as a FAT partition.
         '-drive', f'if=none,format=raw,file=fat:rw:{ESP_DIR},id=esp',
         '-device', 'ide-drive,bus=ahci.0,drive=esp',
-        # Enable the debug connection to allow retrieving test data from the test runner.
-        '-debugcon', f'file:{LOG_FILE}', '-global', 'isa-debugcon.iobase=0xE9',
         # Only enable when debugging UEFI boot:
         #'-debugcon', 'file:debug.log', '-global', 'isa-debugcon.iobase=0x402',
     ]
@@ -99,7 +94,7 @@ def main(args) -> int:
     os.environ['RUSTFLAGS'] = ''
 
     # Temporary solution for https://github.com/rust-lang/cargo/issues/4905
-    os.environ['RUST_TARGET_PATH'] = str(WORKSPACE_DIR / 'tests')
+    os.environ['RUST_TARGET_PATH'] = str(WORKSPACE_DIR / 'uefi-test-runner')
 
     print(os.environ['RUST_TARGET_PATH'])