ref(test): Introduce assert_cmd test manager

This should reduce boilerplate when writing `assert_cmd` tests.

Author: szokeasaurusrex

tests/integration/debug_files/upload.rs

@@ -2,10 +2,9 @@ use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::LazyLock;
 use std::{fs, str};
 
-use assert_cmd::Command;
 use regex::bytes::Regex;
 
-use crate::integration::{test_utils::env, MockEndpointBuilder, TestManager};
+use crate::integration::{AssertCommand, MockEndpointBuilder, TestManager};
 
 /// This regex is used to extract the boundary from the content-type header.
 /// We need to match the boundary, since it changes with each request.
@@ -165,7 +164,7 @@ fn command_debug_files_upload_no_upload() {
 /// The mock assemble endpoint returns a 200 response simulating the case where all chunks
 /// are already uploaded.
 fn ensure_correct_assemble_call() {
-    let manager = TestManager::new()
+    TestManager::new()
         .mock_endpoint(
             MockEndpointBuilder::new("GET", "/api/0/organizations/wat-org/chunk-upload/")
                 .with_response_file("debug_files/get-chunk-upload.json"),
@@ -184,26 +183,13 @@ fn ensure_correct_assemble_call() {
                 }
             }"#,
             ),
-        );
-
-    let mut command = Command::cargo_bin("sentry-cli").expect("sentry-cli should be available");
-
-    command.args(
-        "debug-files upload --include-sources tests/integration/_fixtures/SrcGenSampleApp.pdb"
-            .split(' '),
-    );
-
-    env::set_all(manager.server_info(), |k, v| {
-        command.env(k, v.as_ref());
-    });
-
-    let command_result = command.assert();
-
-    // First assert the mock was called as expected, then that the command was successful.
-    // This is because failure with the mock assertion can cause the command to fail, and
-    // the mock assertion failure is likely more interesting in this case.
-    manager.assert_mock_endpoints();
-    command_result.success();
+        )
+        .assert_cmd(
+            "debug-files upload --include-sources tests/integration/_fixtures/SrcGenSampleApp.pdb"
+                .split(' '),
+        )
+        .with_default_token()
+        .run_and_assert(AssertCommand::Success);
 }
 
 #[test]
@@ -217,7 +203,7 @@ fn ensure_correct_chunk_upload() {
         fs::read("tests/integration/_expected_requests/debug_files/upload/chunk_upload.bin")
             .expect("expected chunk body file should be present");
 
-    let manager = TestManager::new()
+    TestManager::new()
         .mock_endpoint(
             MockEndpointBuilder::new("GET", "/api/0/organizations/wat-org/chunk-upload/")
                 .with_response_file("debug_files/get-chunk-upload.json"),
@@ -291,24 +277,11 @@ fn ensure_correct_chunk_upload() {
                 .into()
             })
             .expect(2),
-        );
-
-    let mut command = Command::cargo_bin("sentry-cli").expect("sentry-cli should be available");
-
-    command.args(
-        "debug-files upload --include-sources tests/integration/_fixtures/SrcGenSampleApp.pdb"
-            .split(' '),
-    );
-
-    env::set_all(manager.server_info(), |k, v| {
-        command.env(k, v.as_ref());
-    });
-
-    let command_result = command.assert();
-
-    // First assert the mock was called as expected, then that the command was successful.
-    // This is because failure with the mock assertion can cause the command to fail, and
-    // the mock assertion failure is likely more interesting in this case.
-    manager.assert_mock_endpoints();
-    command_result.success();
+        )
+        .assert_cmd(
+            "debug-files upload --include-sources tests/integration/_fixtures/SrcGenSampleApp.pdb"
+                .split(' '),
+        )
+        .with_default_token()
+        .run_and_assert(AssertCommand::Success);
 }

tests/integration/mod.rs

@@ -31,7 +31,7 @@ use std::io;
 use std::path::Path;
 
 use test_utils::MockEndpointBuilder;
-use test_utils::{env, ChunkOptions, ServerBehavior, TestManager};
+use test_utils::{env, AssertCommand, ChunkOptions, ServerBehavior, TestManager};
 
 pub const UTC_DATE_FORMAT: &str = r"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6,9}Z";
 const VERSION: &str = env!("CARGO_PKG_VERSION");

tests/integration/test_utils/env.rs

@@ -42,10 +42,3 @@ pub fn set_auth_token(setter: impl FnOnce(&'static str, Cow<'static, str>)) {
         "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef".into(),
     );
 }
-
-/// Set all environment variables, including the auth token and the environments
-/// set by `set`.
-pub fn set_all(server_info: MockServerInfo, mut setter: impl FnMut(&str, Cow<str>)) {
-    set(server_info, &mut setter);
-    set_auth_token(setter);
-}

tests/integration/test_utils/mod.rs

@@ -8,6 +8,6 @@ mod test_manager;
 
 pub use mock_common_endpoints::{ChunkOptions, ServerBehavior};
 pub use mock_endpoint_builder::MockEndpointBuilder;
-pub use test_manager::TestManager;
+pub use test_manager::{AssertCommand, TestManager};
 
 use env::MockServerInfo;

tests/integration/test_utils/test_manager.rs

@@ -1,5 +1,7 @@
+use std::ffi::OsStr;
 use std::fmt::Display;
 
+use assert_cmd::Command;
 use mockito::{Mock, Server, ServerGuard};
 use thiserror::Error;
 use trycmd::TestCases;
@@ -67,6 +69,19 @@ impl TestManager {
         TrycmdTestManager::new(self, path)
     }
 
+    /// Define an assert_cmd test.
+    /// The args contain the command line arguments which will be passed to `sentry-cli`.
+    /// The test is run when the appropriate function is called on the returned
+    /// `AssertCmdTestManager`.
+    /// The test manager handles setting the environment variables for the test.
+    pub fn assert_cmd<I, S>(self, args: I) -> AssertCmdTestManager
+    where
+        I: IntoIterator<Item = S>,
+        S: AsRef<OsStr>,
+    {
+        AssertCmdTestManager::new(self, args)
+    }
+
     /// Get the URL of the mock server.
     pub fn server_url(&self) -> String {
         self.server().url()
@@ -158,3 +173,61 @@ impl TrycmdTestManager {
         self.manager.server()
     }
 }
+
+pub struct AssertCmdTestManager {
+    manager: TestManager,
+    command: Command,
+}
+
+/// The type of assertion to perform on the command result.
+// Currently we only assert success, but we may add other assertions
+// (e.g. failure or skip) in the future.
+pub enum AssertCommand {
+    /// Assert that the command succeeds (i.e. returns a `0` exit code).
+    Success,
+}
+
+impl AssertCmdTestManager {
+    /// Set the auth token environment variable to a fake value.
+    /// This may be needed when running a Sentry CLI command that checks that
+    /// an auth token is set. No token is set by default.
+    pub fn with_default_token(mut self) -> Self {
+        env::set_auth_token(|k, v| {
+            self.command.env(k, v.as_ref());
+        });
+
+        self
+    }
+
+    /// Run the command and perform assertions.
+    ///
+    /// This function asserts both the mocks and the command result.
+    /// The mocks are asserted first, since a failure in the mocks
+    /// could cause the command to fail. The function consumes the
+    /// `AssertCmdTestManager`, as it should not be used after this call.
+    ///
+    /// Panics if any assertions fail.
+    pub fn run_and_assert(mut self, assert: AssertCommand) {
+        let command_result = self.command.assert();
+        self.manager.assert_mock_endpoints();
+
+        match assert {
+            AssertCommand::Success => command_result.success(),
+        };
+    }
+
+    fn new<I, S>(manager: TestManager, args: I) -> Self
+    where
+        I: IntoIterator<Item = S>,
+        S: AsRef<OsStr>,
+    {
+        let mut command = Command::cargo_bin("sentry-cli").expect("sentry-cli should be available");
+        command.args(args);
+
+        env::set(manager.server_info(), |k, v| {
+            command.env(k, v.as_ref());
+        });
+
+        Self { manager, command }
+    }
+}