ci/xtask: add test-latest-release

Add an xtask action and corresponding CI job to test that the template app builds against the released versions of the uefi-rs libraries. Since nightly compiler changes can break the released versions at any time, it's nice to have an automatic alert. Fixes #343

Author: nicholasbishop

.github/workflows/rust.yml

@@ -98,3 +98,27 @@ jobs:
 
  - name: Run cargo doc
  run: cargo xtask doc --warnings-as-errors
+
+ # This job tests that the template app builds successfully with the
+ # released versions of the libraries on crates.io.
+ #
+ # Since a nightly toolchain is currently required to build uefi-rs,
+ # the released versions can suddenly stop building when a new nightly
+ # compiler with a breaking change is released. This job provides an
+ # alert when this situation occurs.
+ test_latest_release:
+ name: Build the template against the released version of uefi-rs
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout sources
+ uses: actions/checkout@v2
+
+ - name: Install latest nightly
+ uses: actions-rs/toolchain@v1
+ with:
+ toolchain: nightly
+ override: true
+ components: rust-src
+
+ - name: Build
+ run: cargo xtask test-latest-release

xtask/src/main.rs

@@ -8,7 +8,9 @@ use anyhow::Result;
 use cargo::{Cargo, CargoAction, Feature, Package};
 use clap::Parser;
 use opt::{Action, BuildOpt, ClippyOpt, DocOpt, Opt, QemuOpt};
-use util::run_cmd;
+use std::process::Command;
+use tempfile::TempDir;
+use util::{command_to_string, run_cmd};
 
 fn build(opt: &BuildOpt) -> Result<()> {
  let cargo = Cargo {
@@ -105,6 +107,45 @@ fn run_host_tests() -> Result<()> {
  run_cmd(cargo.command()?)
 }
 
+/// Test that the template app builds successfully with the released
+/// versions of the libraries on crates.io.
+///
+/// The `build` action also builds the template app, but due to the
+/// `patch.crates-io` of the top-level Cargo.toml the app is built using
+/// the current versions of the libraries in this repo. To give warning
+/// when the latest crates.io releases of the libraries are broken (due
+/// to changes in the nightly toolchain), this action copies the
+/// template to a temporary directory and builds it in isolation.
+///
+/// The build command is also checked against the contents of
+/// `BUILDING.md` to ensure that the doc correctly describes how to
+/// build an app.
+fn test_latest_release() -> Result<()> {
+ // Recursively copy the template app to a temporary directory. This
+ // isolates the app from the full git repo so that the
+ // `patch.crates-io` section of the root Cargo.toml doesn't apply.
+ let tmp_dir = TempDir::new()?;
+ let tmp_dir = tmp_dir.path();
+ let mut cp_cmd = Command::new("cp");
+ cp_cmd
+ .args(&["--recursive", "--verbose", "template"])
+ .arg(tmp_dir);
+ run_cmd(cp_cmd)?;
+
+ // Create cargo build command, not using the `cargo` module to make
+ // it explicit that it matches the command in `BUILDING.md`.
+ let mut build_cmd = Command::new("cargo");
+ build_cmd
+ .args(&["+nightly", "build", "--target", "x86_64-unknown-uefi"])
+ .current_dir(tmp_dir.join("template"));
+
+ // Check that the command is indeed in BUILDING.md, then verify the
+ // build succeeds.
+ let building_md = include_str!("../../BUILDING.md");
+ assert!(building_md.contains(&command_to_string(&build_cmd)));
+ run_cmd(build_cmd)
+}
+
 fn main() -> Result<()> {
  let opt = Opt::parse();
 
@@ -114,5 +155,6 @@ fn main() -> Result<()> {
  Action::Doc(doc_opt) => doc(doc_opt),
  Action::Run(qemu_opt) => run_vm_tests(qemu_opt),
  Action::Test(_) => run_host_tests(),
+ Action::TestLatestRelease(_) => test_latest_release(),
  }
 }

xtask/src/opt.rs

@@ -49,6 +49,7 @@ pub enum Action {
  Doc(DocOpt),
  Run(QemuOpt),
  Test(TestOpt),
+ TestLatestRelease(TestLatestReleaseOpt),
 }
 
 /// Build all the uefi packages.
@@ -111,3 +112,7 @@ pub struct QemuOpt {
 /// Build uefi-test-runner and run it in QEMU.
 #[derive(Debug, Parser)]
 pub struct TestOpt;
+
+/// Build the template against the crates.io packages.
+#[derive(Debug, Parser)]
+pub struct TestLatestReleaseOpt;