xtask/
main.rs

1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4//! HvLite repo-specific automation.
5//!
6//! If you're thinking of writing a bash script, write an xtask instead!
7//!
8//! Follows the xtask workflow/convention, as described at
9//! <https://github.com/matklad/cargo-xtask>
10
11use anyhow::Context;
12use clap::Parser;
13use clap::Subcommand;
14use std::path::Path;
15use std::path::PathBuf;
16
17mod completions;
18pub mod fs_helpers;
19pub mod tasks;
20
21/// Default location to maintain a `xtask-path` file
22///
23/// This file contains a fully-resolved path to the actual `xtask` binary,
24/// allowing other tooling (e.g: git hook) to invoke the xtask without having to
25/// go through `cargo`.
26pub const XTASK_PATH_FILE: &str = "./target/xtask-path";
27
28/// Common context passed into every Xtask
29#[derive(Clone)]
30pub struct XtaskCtx {
31    /// Project root directory
32    pub root: PathBuf,
33    /// xtask is running within a hook
34    pub in_git_hook: bool,
35    /// xtask was invoked as part of a "run on save" operation
36    pub in_run_on_save: bool,
37}
38
39/// Common trait implemented by all Xtask subcommands.
40pub trait Xtask: Parser {
41    /// Run the Xtask.
42    ///
43    /// For consistency and simplicity, `Xtask` implementations are allowed to
44    /// assume that they are being run from the root of the repo's filesystem.
45    /// Callers of `Xtask::run` should take care to ensure
46    /// [`std::env::set_current_dir`] was called prior to invoking `Xtask::run`.
47    fn run(self, ctx: XtaskCtx) -> anyhow::Result<()>;
48}
49
50#[derive(Parser)]
51#[clap(name = "xtask", about = "HvLite repo automation")]
52struct Cli {
53    #[clap(subcommand)]
54    command: Commands,
55
56    /// Specify a custom project root directory.
57    ///
58    /// Can be used to ensure consistent formatting between the OpenVMM base
59    /// repo, and any custom out-of-tree overlay repos.
60    #[clap(long)]
61    custom_root: Option<PathBuf>,
62
63    /// Signal that this `xtask` is being invoked as part of a "run on save"
64    /// operation.
65    ///
66    /// When set, certain tasks may choose to skip certain expensive checks in
67    /// order to execute as quickly as possible.
68    ///
69    /// e.g: instead of calling `cargo run` in order to execute a project-local
70    /// tool, `xtask` may instead attempt to find and use an existing pre-built
71    /// binary, if one is available. This will be faster, but may run the risk
72    /// of executing a slightly stale binary.
73    #[clap(long)]
74    run_on_save: bool,
75}
76
77#[derive(Subcommand)]
78enum Commands {
79    #[clap(hide = true)]
80    Hook(tasks::RunGitHook),
81    #[clap(hide = true)]
82    Complete(clap_dyn_complete::Complete),
83    Completions(completions::Completions),
84
85    Fmt(tasks::Fmt),
86    Fuzz(tasks::Fuzz),
87    GuestTest(tasks::GuestTest),
88    InstallGitHooks(tasks::InstallGitHooks),
89    VerifySize(tasks::VerifySize),
90}
91
92fn main() {
93    ci_logger::init("XTASK_LOG").unwrap();
94
95    if let Err(e) = try_main() {
96        log::error!("Error: {:#}", e);
97        std::process::exit(-1);
98    }
99}
100
101fn try_main() -> anyhow::Result<()> {
102    let cli = Cli::parse();
103
104    let orig_root = Path::new(&env!("CARGO_MANIFEST_DIR"))
105        .ancestors()
106        .nth(1)
107        .unwrap()
108        .to_path_buf();
109
110    let root = cli
111        .custom_root
112        .map(std::path::absolute)
113        .transpose()?
114        .unwrap_or(orig_root.clone());
115
116    // for consistency, always run xtasks as though they were run from the root
117    std::env::set_current_dir(&root)?;
118
119    // drop the path to the xtask binary in an easy-to-find place. this gets
120    // used by the pre-commit hook, as well as the fmt-on-save dev-flow to avoid
121    // rebuilding the xtask.
122    if let Ok(path) = std::env::current_exe() {
123        if let Err(e) = fs_err::write(orig_root.join(XTASK_PATH_FILE), path.display().to_string()) {
124            log::debug!("Unable to create XTASK_PATH_FILE: {:#}", e)
125        }
126    }
127
128    if !matches!(cli.command, Commands::Complete(..)) {
129        tasks::update_hooks(&root).context("failed to update git hooks")?;
130    }
131
132    let ctx = XtaskCtx {
133        root,
134        in_git_hook: matches!(cli.command, Commands::Hook(..)),
135        in_run_on_save: cli.run_on_save,
136    };
137
138    match cli.command {
139        Commands::Hook(task) => task.run(ctx),
140        Commands::Completions(task) => task.run(),
141        Commands::Complete(task) => {
142            futures::executor::block_on(task.println_to_stub_script::<Cli>(
143                Some("cargo"),
144                completions::XtaskCompleteFactory { ctx },
145            ));
146            Ok(())
147        }
148
149        Commands::Fmt(task) => task.run(ctx),
150        Commands::Fuzz(task) => task.run(ctx),
151        Commands::GuestTest(task) => task.run(ctx),
152        Commands::InstallGitHooks(task) => task.run(ctx),
153        Commands::VerifySize(task) => task.run(ctx),
154    }
155}
xtask/main.rs

xtask/
main.rs
