xtask: add option to override toolchain

Author: nicholasbishop

xtask/src/cargo.rs

@@ -89,7 +89,7 @@ pub enum CargoAction {
 pub struct Cargo {
     pub action: CargoAction,
     pub features: Vec<Feature>,
-    pub nightly: bool,
+    pub toolchain: Option<String>,
     pub packages: Vec<Package>,
     pub release: bool,
     pub target: Option<UefiArch>,
@@ -99,8 +99,9 @@ pub struct Cargo {
 impl Cargo {
     pub fn command(&self) -> Result<Command> {
         let mut cmd = Command::new("cargo");
-        if self.nightly {
-            cmd.arg("+nightly");
+
+        if let Some(toolchain) = &self.toolchain {
+            cmd.arg(&format!("+{}", toolchain));
         }
 
         let action;
@@ -187,7 +188,7 @@ mod tests {
         let cargo = Cargo {
             action: CargoAction::Doc { open: true },
             features: vec![Feature::Alloc],
-            nightly: true,
+            toolchain: Some("nightly".into()),
             packages: vec![Package::Uefi, Package::Xtask],
             release: false,
             target: None,

xtask/src/main.rs

@@ -12,11 +12,13 @@ use std::process::Command;
 use tempfile::TempDir;
 use util::{command_to_string, run_cmd};
 
+const NIGHTLY: &str = "nightly";
+
 fn build(opt: &BuildOpt) -> Result<()> {
     let cargo = Cargo {
         action: CargoAction::Build,
         features: Feature::more_code(),
-        nightly: true,
+        toolchain: opt.toolchain.or(NIGHTLY),
         packages: Package::all_except_xtask(),
         release: opt.build_mode.release,
         target: Some(*opt.target),
@@ -30,7 +32,7 @@ fn clippy(opt: &ClippyOpt) -> Result<()> {
     let cargo = Cargo {
         action: CargoAction::Clippy,
         features: Feature::more_code(),
-        nightly: true,
+        toolchain: opt.toolchain.or(NIGHTLY),
         packages: Package::all_except_xtask(),
         release: false,
         target: Some(*opt.target),
@@ -42,7 +44,7 @@ fn clippy(opt: &ClippyOpt) -> Result<()> {
     let cargo = Cargo {
         action: CargoAction::Clippy,
         features: Vec::new(),
-        nightly: false,
+        toolchain: None,
         packages: vec![Package::Xtask],
         release: false,
         target: None,
@@ -56,7 +58,7 @@ fn doc(opt: &DocOpt) -> Result<()> {
     let cargo = Cargo {
         action: CargoAction::Doc { open: opt.open },
         features: Feature::more_code(),
-        nightly: true,
+        toolchain: opt.toolchain.or(NIGHTLY),
         packages: Package::published(),
         release: false,
         target: None,
@@ -76,7 +78,7 @@ fn run_vm_tests(opt: &QemuOpt) -> Result<()> {
     let cargo = Cargo {
         action: CargoAction::Build,
         features,
-        nightly: true,
+        toolchain: opt.toolchain.or(NIGHTLY),
         packages: vec![Package::UefiTestRunner],
         release: opt.build_mode.release,
         target: Some(*opt.target),
@@ -94,7 +96,7 @@ fn run_host_tests() -> Result<()> {
     let cargo = Cargo {
         action: CargoAction::Test,
         features: vec![Feature::Exts],
-        nightly: true,
+        toolchain: Some(NIGHTLY.into()),
         // Don't test uefi-services (or the packages that depend on it)
         // as it has lang items that conflict with `std`.
         packages: vec![Package::Uefi, Package::UefiMacros, Package::Xtask],

xtask/src/opt.rs

@@ -21,6 +21,22 @@ impl Deref for TargetOpt {
     }
 }
 
+#[derive(Debug, Parser)]
+pub struct ToolchainOpt {
+    /// Rust toolchain to use, e.g. "nightly-2022-02-24".
+    #[clap(long)]
+    toolchain: Option<String>,
+}
+
+impl ToolchainOpt {
+    /// Get the toolchain arg if set, otherwise use `default_toolchain`.
+    pub fn or(&self, default_toolchain: &str) -> Option<String> {
+        self.toolchain
+            .clone()
+            .or_else(|| Some(default_toolchain.to_string()))
+    }
+}
+
 #[derive(Debug, Parser)]
 pub struct BuildModeOpt {
     /// Build in release mode.
@@ -58,6 +74,9 @@ pub struct BuildOpt {
     #[clap(flatten)]
     pub target: TargetOpt,
 
+    #[clap(flatten)]
+    pub toolchain: ToolchainOpt,
+
     #[clap(flatten)]
     pub build_mode: BuildModeOpt,
 }
@@ -68,13 +87,19 @@ pub struct ClippyOpt {
     #[clap(flatten)]
     pub target: TargetOpt,
 
+    #[clap(flatten)]
+    pub toolchain: ToolchainOpt,
+
     #[clap(flatten)]
     pub warning: WarningOpt,
 }
 
 /// Build the docs for the uefi packages.
 #[derive(Debug, Parser)]
 pub struct DocOpt {
+    #[clap(flatten)]
+    pub toolchain: ToolchainOpt,
+
     /// Open the docs in a browser.
     #[clap(long)]
     pub open: bool,
@@ -89,6 +114,9 @@ pub struct QemuOpt {
     #[clap(flatten)]
     pub target: TargetOpt,
 
+    #[clap(flatten)]
+    pub toolchain: ToolchainOpt,
+
     #[clap(flatten)]
     pub build_mode: BuildModeOpt,