refactor(test): add new testing APIs and simple showcases

Author: rami3l

Cargo.lock

@@ -37,7 +37,7 @@ otel = [
 ]
 
 # Exports code dependent on private interfaces for the integration test suite
-test = ["dep:walkdir"]
+test = ["dep:snapbox", "dep:walkdir"]
 
 # Sorted by alphabetic order
 [dependencies]
@@ -77,6 +77,7 @@ semver = "1.0"
 serde = { version = "1.0", features = ["derive"] }
 sha2 = "0.10"
 sharded-slab = "0.1.1"
+snapbox = { version = "0.6.21", optional = true }
 strsim = "0.11"
 tar = "0.4.26"
 tempfile = "3.8"

Cargo.toml

@@ -18,6 +18,7 @@ use std::{
 };
 
 use enum_map::{Enum, EnumMap, enum_map};
+use snapbox::{IntoData, RedactedValue, Redactions, assert_data_eq};
 use tempfile::TempDir;
 use url::Url;
 
@@ -61,6 +62,60 @@ pub struct Config {
     pub test_root_dir: PathBuf,
 }
 
+#[derive(Clone)]
+pub struct Assert {
+    output: SanitizedOutput,
+    redactions: Redactions,
+}
+
+impl Assert {
+    /// Creates a new [`Assert`] object with the given command [`SanitizedOutput`].
+    pub fn new(output: SanitizedOutput) -> Self {
+        let mut redactions = Redactions::new();
+        redactions
+            .extend([("[HOST_TRIPLE]", this_host_triple())])
+            .expect("invalid redactions detected");
+        Self { output, redactions }
+    }
+
+    /// Extend the redaction rules used in the currrent assertion with new values.
+    pub fn extend_redactions(
+        &mut self,
+        vars: impl IntoIterator<Item = (&'static str, impl Into<RedactedValue>)>,
+    ) -> &mut Self {
+        self.redactions
+            .extend(vars)
+            .expect("invalid redactions detected");
+        self
+    }
+
+    /// Asserts that the command exited with an ok status.
+    pub fn is_ok(&self) -> &Self {
+        assert!(self.output.ok);
+        self
+    }
+
+    /// Asserts that the command exited with an error.
+    pub fn is_err(&self) -> &Self {
+        assert!(!self.output.ok);
+        self
+    }
+
+    /// Asserts that the command exited with the given `expected` stdout pattern.
+    pub fn with_stdout(&self, expected: impl IntoData) -> &Self {
+        let stdout = self.redactions.redact(&self.output.stdout);
+        assert_data_eq!(&stdout, expected);
+        self
+    }
+
+    /// Asserts that the command exited with the given `expected` stderr pattern.
+    pub fn with_stderr(&self, expected: impl IntoData) -> &Self {
+        let stderr = self.redactions.redact(&self.output.stderr);
+        assert_data_eq!(&stderr, expected);
+        self
+    }
+}
+
 impl Config {
     pub fn current_dir(&self) -> PathBuf {
         self.workdir.borrow().clone()
@@ -136,6 +191,26 @@ impl Config {
         }
     }
 
+    /// Returns an [`Assert`] object to check the output of running the command
+    /// specified by `args` under the default environment.
+    #[must_use]
+    pub async fn expect(&self, args: impl AsRef<[&str]>) -> Assert {
+        self.expect_with_env(args, &[]).await
+    }
+
+    /// Returns an [`Assert`] object to check the output of running the command
+    /// specified by `args` and under the environment specified by `env`.
+    #[must_use]
+    pub async fn expect_with_env(
+        &self,
+        args: impl AsRef<[&str]>,
+        env: impl AsRef<[(&str, &str)]>,
+    ) -> Assert {
+        let args = args.as_ref();
+        let output = self.run(args[0], &args[1..], env.as_ref()).await;
+        Assert::new(output)
+    }
+
     /// Expect an ok status
     pub async fn expect_ok(&mut self, args: &[&str]) {
         self.expect_ok_env(args, &[]).await
@@ -1035,7 +1110,7 @@ pub struct Output {
     pub stderr: Vec<u8>,
 }
 
-#[derive(Debug)]
+#[derive(Debug, Clone)]
 pub struct SanitizedOutput {
     pub ok: bool,
     pub stdout: String,

src/test/clitools.rs

@@ -6,6 +6,7 @@ use rustup::test::{
     CROSS_ARCH1, CROSS_ARCH2, CliTestContext, MULTI_ARCH1, Scenario, this_host_triple,
 };
 use rustup::utils::raw;
+use snapbox::str;
 
 #[tokio::test]
 async fn update_once() {
@@ -308,23 +309,21 @@ info: default toolchain set to 'nightly-{0}'
 
 #[tokio::test]
 async fn override_again() {
-    let mut cx = CliTestContext::new(Scenario::SimpleV2).await;
-    let cwd = cx.config.current_dir();
+    let cx = &CliTestContext::new(Scenario::SimpleV2).await;
     cx.config
-        .expect_ok(&["rustup", "override", "add", "nightly"])
-        .await;
+        .expect(["rustup", "override", "add", "nightly"])
+        .await
+        .is_ok();
     cx.config
-        .expect_ok_ex(
-            &["rustup", "override", "add", "nightly"],
-            "",
-            &format!(
-                r"info: override toolchain for '{}' set to 'nightly-{1}'
-",
-                cwd.display(),
-                &this_host_triple()
-            ),
-        )
-        .await;
+        .expect(["rustup", "override", "add", "nightly"])
+        .await
+        .extend_redactions([("[CWD]", cx.config.current_dir().display().to_string())])
+        .is_ok()
+        .with_stdout("")
+        .with_stderr(str![[r#"
+info: override toolchain for '[CWD]' set to 'nightly-[HOST_TRIPLE]'
+
+"#]]);
 }
 
 #[tokio::test]

tests/suite/cli_exact.rs

@@ -11,6 +11,7 @@ use rustup::test::{
 };
 use rustup::utils;
 use rustup::utils::raw::symlink_dir;
+use snapbox::str;
 
 #[tokio::test]
 async fn smoke_test() {
@@ -113,16 +114,15 @@ async fn custom_invalid_names_with_archive_dates() {
 async fn update_all_no_update_whitespace() {
     let cx = CliTestContext::new(Scenario::SimpleV2).await;
     cx.config
-        .expect_stdout_ok(
-            &["rustup", "update", "nightly"],
-            for_host!(
-                r"
-  nightly-{} installed - 1.3.0 (hash-nightly-2)
+        .expect(["rustup", "update", "nightly"])
+        .await
+        .is_ok()
+        .with_stdout(str![[r#"
 
-"
-            ),
-        )
-        .await;
+  nightly-[HOST_TRIPLE] installed - 1.3.0 (hash-nightly-2)
+
+
+"#]]);
 }
 
 // Issue #145

tests/suite/cli_misc.rs

@@ -20,6 +20,7 @@ use rustup::test::{
 use rustup::test::{RegistryGuard, RegistryValueId, USER_PATH};
 use rustup::utils::{self, raw};
 use rustup::{DUP_TOOLS, TOOLS, for_host};
+use snapbox::str;
 #[cfg(windows)]
 use windows_registry::Value;
 
@@ -387,26 +388,32 @@ info: downloading self-update
 
 #[tokio::test]
 async fn update_precise() {
-    let version = env!("CARGO_PKG_VERSION");
-    let expected_output = format!(
-        "info: checking for self-update
-info: `RUSTUP_VERSION` has been set to `{TEST_VERSION}`
-info: downloading self-update
-"
-    );
-
-    let mut cx = SelfUpdateTestContext::new(TEST_VERSION).await;
+    let cx = SelfUpdateTestContext::new(TEST_VERSION).await;
     cx.config
-        .expect_ok(&["rustup-init", "-y", "--no-modify-path"])
-        .await;
+        .expect(["rustup-init", "-y", "--no-modify-path"])
+        .await
+        .is_ok();
     cx.config
-        .expect_ok_ex_env(
-            &["rustup", "self", "update"],
-            &[("RUSTUP_VERSION", TEST_VERSION)],
-            &format!("  rustup updated - {version} (from {version})\n\n",),
-            &expected_output,
+        .expect_with_env(
+            ["rustup", "self", "update"],
+            [("RUSTUP_VERSION", TEST_VERSION)],
         )
-        .await;
+        .await
+        .extend_redactions([
+            ("[TEST_VERSION]", TEST_VERSION),
+            ("[VERSION]", env!("CARGO_PKG_VERSION")),
+        ])
+        .with_stdout(str![[r#"
+  rustup updated - [VERSION] (from [VERSION])
+
+
+"#]])
+        .with_stderr(str![[r#"
+info: checking for self-update
+info: `RUSTUP_VERSION` has been set to `[TEST_VERSION]`
+info: downloading self-update
+
+"#]]);
 }
 
 #[cfg(windows)]

tests/suite/cli_self_upd.rs

@@ -5,16 +5,20 @@ use std::fs;
 
 use rustup::for_host;
 use rustup::test::{CliTestContext, Scenario};
+use snapbox::str;
 
 #[tokio::test]
 async fn rustc_no_default_toolchain() {
     let cx = CliTestContext::new(Scenario::SimpleV1).await;
     cx.config
-        .expect_err(
-            &["rustc"],
-            "rustup could not choose a version of rustc to run",
-        )
-        .await;
+        .expect(["rustc"])
+        .await
+        .is_err()
+        .with_stderr(str![[r#"
+error: rustup could not choose a version of rustc to run, because one wasn't specified explicitly, and no default is configured.
+help: run 'rustup default stable' to download the latest stable release of Rust and set it as your default toolchain.
+
+"#]]);
 }
 
 #[tokio::test]