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

tracel_xtask/
lib.rs
