xtasks 0.0.2

Essential tools and tasks for Rust projects using the xtask pattern, simplifying common build and development workflows.
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

// Copyright © 2023 xtasks. All rights reserved.
// SPDX-License-Identifier: Apache-2.0 OR MIT

use anyhow::{Context, Result as AnyResult};
use derive_builder::Builder;
use serde::{Deserialize, Serialize};

/// Represents the configuration for generating a powerset of features for cargo build runs.
///
/// A powerset in this context refers to all possible combinations of features that can be enabled
/// or disabled for a cargo build.
#[derive(
    Builder,
    Debug,
    Default,
    PartialEq,
    Eq,
    Hash,
    Clone,
    Serialize,
    Deserialize,
)]
#[builder(setter(into))]
pub struct Powerset {
    /// Specifies the depth of the powerset.
    ///
    /// The depth determines how many features will be considered for each combination in the powerset.
    /// For example, a depth of 2 would consider all combinations of 2 features at a time.
    ///
    /// Valid values are integers greater than or equal to 1.
    ///
    /// By default, this is set to 2.
    #[builder(default = "2")]
    pub depth: i32,

    /// Determines whether to exclude build runs with no default features enabled.
    ///
    /// Setting this to `true` means that build runs where no default features are enabled will be excluded
    /// from the powerset. This can be useful if you know that your project requires at least one feature to be
    /// enabled for successful compilation.
    ///
    /// By default, this is set to `false`.
    #[builder(default = "false")]
    pub exclude_no_default_features: bool,
}

impl PowersetBuilder {
    /// Builds and runs a powerset test.
    ///
    /// This function will execute `cargo hack clippy`, `cargo hack test`, and `cargo hack test --doc`
    /// with various feature combinations based on the powerset configuration.
    ///
    /// # Errors
    ///
    /// This function will return an error if any of the `cargo` commands fail to execute.
    pub fn run(&self) -> AnyResult<()> {
        let t = self
            .build()
            .context("Failed to build Powerset configuration")?;
        let depth = t.depth.to_string();
        let mut common_args =
            vec![
                "--workspace",
                "--exclude",
                "xtask",
                "--feature-powerset",
                "--depth",
                &depth,
            ];
        if t.exclude_no_default_features {
            common_args.push("--exclude-no-default-features");
        }

        let mut clippy_args = common_args.clone();
        clippy_args.extend(["--", "-D", "warnings"]);
        std::process::Command::new("cargo")
            .args(["hack", "clippy"])
            .args(&clippy_args)
            .status()
            .context("Failed to execute 'cargo hack clippy'")?;

        let mut test_args = common_args.clone();
        test_args.push("test");
        std::process::Command::new("cargo")
            .args(["hack"])
            .args(&test_args)
            .status()
            .context("Failed to execute 'cargo hack test'")?;

        let mut doc_test_args = common_args;
        doc_test_args.extend(["test", "--doc"]);
        std::process::Command::new("cargo")
            .args(["hack"])
            .args(&doc_test_args)
            .status()
            .context("Failed to execute 'cargo hack test --doc'")?;

        Ok(())
    }

    /// Creates a new `PowersetBuilder` instance with a specified depth.
    ///
    /// # Arguments
    ///
    /// * `depth` - The depth of the powerset.
    ///
    /// # Examples
    ///
    /// ```
    /// # use xtasks::tasks::powerset::PowersetBuilder;
    /// let builder = PowersetBuilder::new(3);
    /// ```
    pub fn new(depth: i32) -> Self {
        let mut builder = Self::default();
        builder.depth(depth);
        builder
    }
}

///
/// Perform a CI build with powerset of features
///
/// # Errors
/// Errors if one of the commands failed
///
pub fn powerset() -> AnyResult<()> {
    PowersetBuilder::default().run()
}