tracel_xtask/
lib.rs

1pub mod commands;
2pub mod context;
3pub mod environment;
4pub mod logging;
5pub mod utils;
6mod versions;
7
8// re-exports
9pub mod prelude {
10    pub use anyhow;
11    pub use clap;
12    pub use derive_more;
13    pub use env_logger;
14    pub use rand;
15    pub use serde_json;
16    pub use tracing_subscriber;
17
18    pub mod macros {
19        pub use tracel_xtask_macros::base_commands;
20        pub use tracel_xtask_macros::declare_command_args;
21        pub use tracel_xtask_macros::extend_command_args;
22        pub use tracel_xtask_macros::extend_subcommands;
23        pub use tracel_xtask_macros::extend_targets;
24    }
25
26    pub use crate::commands as base_commands;
27    pub use crate::commands::build::BuildCmdArgs;
28    pub use crate::commands::bump::BumpCmdArgs;
29    pub use crate::commands::bump::BumpSubCommand;
30    pub use crate::commands::check::CheckCmdArgs;
31    pub use crate::commands::check::CheckSubCommand;
32    pub use crate::commands::compile::CompileCmdArgs;
33    pub use crate::commands::container::ContainerCmdArgs;
34    pub use crate::commands::container::ContainerSubCommand;
35    pub use crate::commands::coverage::CoverageCmdArgs;
36    pub use crate::commands::dependencies::DependenciesCmdArgs;
37    pub use crate::commands::dependencies::DependenciesSubCommand;
38    pub use crate::commands::doc::DocCmdArgs;
39    pub use crate::commands::doc::DocSubCommand;
40    pub use crate::commands::docker_compose::DockerComposeCmdArgs;
41    pub use crate::commands::docker_compose::DockerComposeSubCommand;
42    pub use crate::commands::fix::FixCmdArgs;
43    pub use crate::commands::fix::FixSubCommand;
44    pub use crate::commands::publish::PublishCmdArgs;
45    pub use crate::commands::secrets::SecretsCmdArgs;
46    pub use crate::commands::secrets::SecretsSubCommand;
47    pub use crate::commands::test::TestCmdArgs;
48    pub use crate::commands::test::TestSubCommand;
49    pub use crate::commands::validate::ValidateCmdArgs;
50    pub use crate::commands::vulnerabilities::VulnerabilitiesCmdArgs;
51    pub use crate::commands::vulnerabilities::VulnerabilitiesSubCommand;
52    pub use crate::commands::Target;
53    pub use crate::context::Context;
54    pub use crate::endgroup;
55    pub use crate::environment::Environment;
56    pub use crate::environment::EnvironmentIndex;
57    pub use crate::environment::EnvironmentName;
58    pub use crate::environment::ExplicitIndex;
59    pub use crate::group;
60    pub use crate::group_info;
61    pub use crate::handle_cleanup;
62    pub use crate::init_xtask;
63    pub use crate::parse_args;
64    pub use crate::register_cleanup;
65    pub use crate::utils::aws;
66    pub use crate::utils::cargo::ensure_cargo_crate_is_installed;
67    pub use crate::utils::cleanup::CLEANUP_HANDLER;
68    pub use crate::utils::git;
69    pub use crate::utils::helpers;
70    pub use crate::utils::process::random_port;
71    pub use crate::utils::process::run_process;
72    pub use crate::utils::process::run_process_for_package;
73    pub use crate::utils::process::run_process_for_workspace;
74    pub use crate::utils::prompt::ask_once;
75    pub use crate::utils::rustup::is_current_toolchain_nightly;
76    pub use crate::utils::rustup::rustup_add_component;
77    pub use crate::utils::rustup::rustup_add_target;
78    pub use crate::utils::rustup::rustup_get_installed_targets;
79    pub use crate::utils::time::format_duration;
80    pub use crate::XtaskArgs;
81    // does not re-export strum has it is incompatible with strum macros expansions
82}
83
84use environment::EnvironmentName;
85use prelude::Environment;
86
87use crate::context::Context;
88use crate::logging::init_logger;
89
90#[macro_use]
91extern crate log;
92
93#[derive(clap::Parser)]
94#[command(author, version, about, long_about = None)]
95pub struct XtaskArgs<C: clap::Subcommand> {
96    /// Enable code coverage for Rust code if available (see coverage command for more info).
97    #[arg(long)]
98    pub enable_coverage: bool,
99    /// Set environment.
100    #[arg(short = 'e', long = "env_name", default_value_t = EnvironmentName::default())]
101    pub environment_name: EnvironmentName,
102    /// Set environment index, must be between 1 and 255 inclusive
103    #[arg(short = 'i', long = "env_index", default_value_t = 1, value_parser = clap::value_parser!(u8).range(1..=255))]
104    pub environment_index: u8,
105    /// Set context.
106    #[arg(short = 'c', long, default_value_t = Context::default())]
107    pub context: Context,
108    #[command(subcommand)]
109    pub command: C,
110}
111
112pub fn parse_args<C: clap::Subcommand>() -> anyhow::Result<(XtaskArgs<C>, Environment)> {
113    // init logs early
114    init_logger().init();
115    let args = <XtaskArgs<C> as clap::Parser>::parse();
116    let env = Environment::new(args.environment_name.clone(), args.environment_index);
117    Ok((args, env))
118}
119
120pub fn init_xtask<C: clap::Subcommand>(
121    config: (XtaskArgs<C>, Environment),
122) -> anyhow::Result<(XtaskArgs<C>, Environment)> {
123    let args = config.0;
124    let env = config.1;
125    group_info!("Environment: {}", env.long());
126    env.load(None)?;
127    group_info!("Context: {}", args.context);
128    // code coverage
129    if args.enable_coverage {
130        group_info!("Enabling coverage support...");
131        setup_coverage()?;
132    }
133    Ok((args, env))
134}
135
136fn setup_coverage() -> anyhow::Result<()> {
137    unsafe {
138        std::env::set_var("RUSTFLAGS", "-Cinstrument-coverage");
139        std::env::set_var("LLVM_PROFILE_FILE", "burn-%p-%m.profraw");
140    }
141    Ok(())
142}
tracel_xtask/lib.rs

tracel_xtask/
lib.rs
