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::test::TestCmdArgs;
46    pub use crate::commands::test::TestSubCommand;
47    pub use crate::commands::validate::ValidateCmdArgs;
48    pub use crate::commands::vulnerabilities::VulnerabilitiesCmdArgs;
49    pub use crate::commands::vulnerabilities::VulnerabilitiesSubCommand;
50    pub use crate::commands::Target;
51    pub use crate::context::Context;
52    pub use crate::endgroup;
53    pub use crate::environment::Environment;
54    pub use crate::group;
55    pub use crate::group_info;
56    pub use crate::handle_cleanup;
57    pub use crate::init_xtask;
58    pub use crate::parse_args;
59    pub use crate::register_cleanup;
60    pub use crate::utils::cargo::ensure_cargo_crate_is_installed;
61    pub use crate::utils::cleanup::CLEANUP_HANDLER;
62    pub use crate::utils::helpers;
63    pub use crate::utils::aws_cli::ecr_get_manifest;
64    pub use crate::utils::aws_cli::ecr_image_digest;
65    pub use crate::utils::aws_cli::ecr_image_url;
66    pub use crate::utils::git::git_current_commit_hash;
67    pub use crate::utils::git::git_is_repo_dirty;
68    pub use crate::utils::git::git_repo_root_or_cwd;
69    pub use crate::utils::process::random_port;
70    pub use crate::utils::process::run_process;
71    pub use crate::utils::process::run_process_for_package;
72    pub use crate::utils::process::run_process_for_workspace;
73    pub use crate::utils::prompt::ask_once;
74    pub use crate::utils::rustup::is_current_toolchain_nightly;
75    pub use crate::utils::rustup::rustup_add_component;
76    pub use crate::utils::rustup::rustup_add_target;
77    pub use crate::utils::rustup::rustup_get_installed_targets;
78    pub use crate::utils::time::format_duration;
79    pub use crate::XtaskArgs;
80    // does not re-export strum has it is incompatible with strum macros expansions
81}
82
83use crate::context::Context;
84use crate::environment::Environment;
85use crate::logging::init_logger;
86
87#[macro_use]
88extern crate log;
89
90#[derive(clap::Parser)]
91#[command(author, version, about, long_about = None)]
92pub struct XtaskArgs<C: clap::Subcommand> {
93    /// Enable code coverage for Rust code if available (see coverage command for more info).
94    #[arg(long)]
95    pub enable_coverage: bool,
96    /// Set environment (for commands that support it).
97    #[arg(short = 'e', long, default_value_t = Environment::default())]
98    pub environment: Environment,
99    /// Set context (for commands that support it).
100    #[arg(short = 'c', long, default_value_t = Context::default())]
101    pub context: Context,
102    #[command(subcommand)]
103    pub command: C,
104}
105
106pub fn parse_args<C: clap::Subcommand>() -> anyhow::Result<XtaskArgs<C>> {
107    // init logs early
108    init_logger().init();
109    let args = <XtaskArgs<C> as clap::Parser>::parse();
110    Ok(args)
111}
112
113pub fn init_xtask<C: clap::Subcommand>(args: XtaskArgs<C>) -> anyhow::Result<XtaskArgs<C>> {
114    // environment
115    group_info!("Environment: {}", args.environment);
116    args.environment.load(None)?;
117    group_info!("Context: {}", args.context);
118    // code coverage
119    if args.enable_coverage {
120        group_info!("Enabling coverage support...");
121        setup_coverage()?;
122    }
123    Ok(args)
124}
125
126fn setup_coverage() -> anyhow::Result<()> {
127    unsafe {
128        std::env::set_var("RUSTFLAGS", "-Cinstrument-coverage");
129        std::env::set_var("LLVM_PROFILE_FILE", "burn-%p-%m.profraw");
130    }
131    Ok(())
132}
tracel_xtask/lib.rs

tracel_xtask/
lib.rs
