bake-test-rust 0.1.0

Reusable Rust test tasks for Bake
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

// Released under the MIT License.
// Copyright, 2026, by Samuel Williams.

//! Shared test tasks for Rust projects using Bake.
//!
//! The crate provides `test` and `test:external`. Both tasks call the optional
//! project task `test:before` before running Cargo tests.
mod cargo;
mod external;
mod manifest;
mod metadata;

/// Rust testing tasks register as `test` and `test:external`.
pub mod test {
    use bake::{Context, Error, Result};

    use crate::{cargo, external, manifest, metadata};

    fn run_before_test_hook(context: &mut Context) -> Result<()> {
        context.call_if_registered("test:before", &[])?;
        Ok(())
    }

    /// Run the current Cargo workspace tests with the lockfile enforced.
    #[bake::task(name = "test")]
    pub fn run(
        context: &mut Context,
        #[bake(named, default = false, help = "Also test examples and benchmarks.")]
        all_targets: bool,
    ) -> Result<String> {
        run_before_test_hook(context)?;

        let mut arguments = vec![
            "test".to_owned(),
            "--workspace".to_owned(),
            "--locked".to_owned(),
        ];
        if all_targets {
            arguments.push("--all-targets".to_owned());
        }

        cargo::run(context, &arguments)?;
        Ok("Cargo workspace tests passed".to_owned())
    }

    /// Test configured downstream repositories against this workspace's local packages.
    #[bake::task(name = "test:external")]
    pub fn external(
        context: &mut Context,
        #[bake(named, default = false, help = "Also test examples and benchmarks.")]
        all_targets: bool,
    ) -> Result<String> {
        let workspace = metadata::read_workspace(context)?;
        if workspace.external_repositories.is_empty() {
            return Ok("No downstream repositories are configured for external tests".to_owned());
        }
        if workspace.packages.is_empty() {
            return Err(Error::new(
                "the current workspace has no crates.io packages to patch into downstream tests",
            ));
        }

        let mut checkouts = Vec::with_capacity(workspace.external_repositories.len());
        for repository in &workspace.external_repositories {
            let checkout = external::checkout(context, repository)?;
            manifest::patch_checkout(&checkout, &workspace.packages)?;
            external::ensure_local_patches_are_selected(&checkout, &workspace.packages)?;
            checkouts.push(checkout);
        }

        run_before_test_hook(context)?;

        for checkout in &checkouts {
            let mut arguments = vec!["test".to_owned(), "--workspace".to_owned()];
            if all_targets {
                arguments.push("--all-targets".to_owned());
            }
            external::run_cargo(checkout, &arguments)?;
        }

        let repository_count = checkouts.len();
        let repository_label = if repository_count == 1 {
            "repository"
        } else {
            "repositories"
        };
        Ok(format!(
            "External tests passed for {repository_count} downstream {repository_label}"
        ))
    }
}