Replace build.py with the xtask pattern

This is a rewrite of the Python build.py code in Rust. See
https://github.com/matklad/cargo-xtask for details of the xtask
pattern. Essentially it's a pattern for extending cargo with
project-specific commands. Using Rust gives all the usual benefits of
checking stuff at compile time, thorough error handling, ease of
testing, etc. It is more verbose though, so the LOC goes up a bit.

* Removed `build-std` settings from `.cargo/config` because we want to
  run `xtask` with the default compiler config. The various `cargo
  xtask` commands handle adding the build-std args where needed. This
  has the side effect of obsoleting the
  `uefi-macros/tests/cargo_wrapper` hack.

* The build subcommand now builds the whole workspace (except for xtask,
  since that implicitly has already been built). So no separate CI step
  to test that the `tmplate` package builds is needed.

* Dropped the `--verbose` option, just always print the commands being
  run since it's helpful info.

* Looked like there was some vestigial timeout code for the VM test but
  no timeout was set that I could see; added a timeout to the github
  workflow yaml instead.

Author: nicholasbishop

.cargo/config

@@ -1,3 +1,2 @@
-[unstable]
-build-std = ["core", "compiler_builtins", "alloc"]
-build-std-features = ["compiler-builtins-mem"]
+[alias]
+xtask = "run --package xtask --"

.github/workflows/rust.yml

@@ -25,7 +25,7 @@ jobs:
       # TODO: cache Rust binaries
 
     - name: Build
-      run: ./build.py build --target aarch64
+      run: cargo xtask build --target aarch64
 
   build_and_test:
     name: Build and run tests on x86_64
@@ -47,17 +47,12 @@ jobs:
           components: rust-src
       # TODO: cache Rust binaries
 
-    - name: Build template
-      uses: actions-rs/cargo@v1
-      with:
-          command: build
-          args: --target x86_64-unknown-uefi --manifest-path template/Cargo.toml
-
     - name: Build
-      run: ./build.py build
+      run: cargo xtask build --target x86_64
 
     - name: Run VM tests
-      run: ./build.py run --headless --ci
+      run: cargo xtask run --target x86_64 --headless --ci
+      timeout-minutes: 2
 
   test:
     name: Run tests and documentation tests
@@ -75,7 +70,7 @@ jobs:
             override: true
 
       - name: Run cargo test
-        run: ./build.py test
+        run: cargo xtask test
 
   lints:
     name: Lints
@@ -99,12 +94,7 @@ jobs:
           args: --all -- --check
 
       - name: Run clippy
-        run: ./build.py clippy
+        run: cargo xtask clippy --warnings-as-errors
 
       - name: Run cargo doc
-        uses: actions-rs/cargo@v1
-        env:
-          RUSTDOCFLAGS: -Dwarnings
-        with:
-          command: doc
-          args: --target x86_64-unknown-uefi --all-features
+        run: cargo xtask doc --warnings-as-errors

BUILDING.md

@@ -42,7 +42,7 @@ targets.
 
 - To run this in QEMU:
   - You will need a recent version of QEMU as well as OVMF to provide UEFI support
-  - Check the [`build.py`](uefi-test-runner/build.py) script for an idea of
+  - Check the [`qemu.rs`](xtask/src/qemu.rs) module for an idea of
     what arguments to pass to QEMU.
 
     In principle, you need to replicate the file structure described above for an USB drive,

CONTRIBUTING.md

@@ -5,7 +5,7 @@ Pull requests, issues and suggestions are welcome!
 The UEFI spec is huge, so there might be some omissions or some missing features.
 You should follow the existing project structure when adding new items.
 
-See the top-level [README](../README.md) for details of using `./build.py` to
+See the top-level [README](../README.md) for details of using `cargo xtask` to
 build and test the project.
 
 Make some changes in your favourite editor / IDE:
@@ -14,7 +14,7 @@ I use [VS Code][code] with the [RLS][rls] extension.
 Test your changes:
 
 ```shell
-./build.py run
+cargo xtask run
 ```
 
 The line above will open a QEMU window where the test harness will run some tests.
@@ -23,7 +23,7 @@ Any contributions are also expected to pass [Clippy][clippy]'s static analysis,
 which you can run as follows:
 
 ```shell
-./build.py clippy
+cargo xtask clippy
 ```
 
 [clippy]: https://github.com/rust-lang-nursery/rust-clippy

Cargo.toml

@@ -10,6 +10,7 @@ exclude = [
     "uefi-macros/**",
     "uefi-services/**",
     "uefi-test-runner/**",
+    "xtask/**",
 ]
 description = "Safe and easy-to-use wrapper for building UEFI apps"
 repository = "https://github.com/rust-osdev/uefi-rs"
@@ -43,6 +44,7 @@ members = [
     "uefi-macros",
     "uefi-services",
     "uefi-test-runner",
+    "xtask",
 ]
 
 [patch.crates-io]

README.md

@@ -71,28 +71,34 @@ rustup toolchain install nightly
 rustup component add --toolchain nightly rust-src
 ```
 
-Use the `./build.py` script to build and test the crate.
+Use the `cargo xtask` command to build and test the crate.
 
 Available commands:
-- `build`: build `uefi-test-runner`
-- `clippy`: run clippy on the whole workspace
-- `doc`: build the docs for the library packages
+- `build`: build all the UEFI packages
+  - `--release`: build in release mode
+  - `--target {x86_64,aarch64}`: choose target UEFI arch
+- `clippy`: run clippy on all the packages
+  - `--target {x86_64,aarch64}`: choose target UEFI arch
+  - `--warnings-as-errors`: treat warnings as errors
+- `doc`: build the docs for the UEFI packages
+  - `--open`: open the docs in a browser
+  - `--warnings-as-errors`: treat warnings as errors
 - `run`: build `uefi-test-runner` and run it in QEMU
+  - `--ci`: disable some tests that don't work in the CI
+  - `--disable-kvm`: disable hardware accelerated virtualization support in QEMU.
+                     Especially useful if you want to run the tests under
+                     [WSL](https://docs.microsoft.com/en-us/windows/wsl) on Windows.
+  - `--headless`: run QEMU without a GUI
+  - `--ovmf-dir <PATH>`: directory in which to look for OVMF files
+  - `--release`: build in release mode
+  - `--target {x86_64,aarch64}`: choose target UEFI arch
 - `test`: run unit tests and doctests on the host
 
-Available options:
-- `--target {x86_64,aarch64}`: choose which architecture to build/run the tests
-- `--verbose`: enables verbose mode, prints commands before running them
-- `--headless`: enables headless mode, which runs QEMU without a GUI
-- `--release`: builds the code with optimizations enabled
-- `--disable-kvm`: disable [KVM](https://www.linux-kvm.org/page/Main_Page) hardware acceleration
-  when running the tests in QEMU (especially useful if you want to run the tests under
-  [WSL](https://docs.microsoft.com/en-us/windows/wsl) on Windows.
-
 The `uefi-test-runner` directory contains a sample UEFI app which exercises
 most of the library's functionality.
 
-Check out the testing project's [`README.md`](uefi-test-runner/README.md) for instructions on how to run the tests.
+Check out the testing project's [`README.md`](uefi-test-runner/README.md) for
+prerequisites for running the tests.
 
 ## Building UEFI programs