comprehensive-rust/xtask/src/main.rs

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! This binary allows us to execute tasks within the project by running
//! `cargo xtask <task>`. It can thus be used as a task automation tool.
//! For example instead of repeatedly running `cargo install` from the CLI
//! to install all the necessary tools for the project we can just run
//! `cargo xtask install-tools` and the logic defined here will install
//! the tools.

use anyhow::{anyhow, Ok, Result};
use clap::Parser;
use std::path::Path;
use std::{env, process::Command};

fn main() -> Result<()> {
    if let Err(e) = execute_task() {
        eprintln!("{e}");
        std::process::exit(-1);
    }
    Ok(())
}

#[derive(Parser, Debug)]
#[command(
    about = "Binary for executing tasks within the Comprehensive Rust project"
)]
struct Args {
    #[arg(required = true, help = "The task to execute")]
    task: String,
}

fn execute_task() -> Result<()> {
    let task = Args::parse().task;
    match task.as_str() {
        "install-tools" => install_tools()?,
        "web-tests" => run_web_tests()?,
        _ => {
            return Err(anyhow!(unrecognized_task_string(task.as_str())));
        }
    }
    Ok(())
}

fn install_tools() -> Result<()> {
    println!("Installing project tools...");

    let path_to_mdbook_exerciser =
        Path::new(env!("CARGO_WORKSPACE_DIR")).join("mdbook-exerciser");
    let path_to_mdbook_course =
        Path::new(env!("CARGO_WORKSPACE_DIR")).join("mdbook-course");

    let install_args = vec![
        // The --locked flag is important for reproducible builds. It also
        // avoids breakage due to skews between mdbook and mdbook-svgbob.
        vec!["mdbook", "--locked", "--version", "0.4.44"],
        vec!["mdbook-svgbob", "--locked", "--version", "0.2.1"],
        vec!["mdbook-pandoc", "--locked", "--version", "0.9.3"],
        vec!["mdbook-i18n-helpers", "--locked", "--version", "0.3.5"],
        vec!["i18n-report", "--locked", "--version", "0.2.0"],
        // Mdbook-exerciser and mdbook-course are located in this repository.
        // To make it possible to install them from any directory we need to
        // specify their path from the workspace root.
        vec!["--path", path_to_mdbook_exerciser.to_str().unwrap(), "--locked"],
        vec!["--path", path_to_mdbook_course.to_str().unwrap(), "--locked"],
    ];

    for args in &install_args {
        let status = Command::new(env!("CARGO"))
            .arg("install")
            .args(args)
            .status()
            .expect("Failed to execute cargo install");

        if !status.success() {
            let error_message = format!(
                "Command 'cargo install {}' exited with status code: {}",
                args.join(" "),
                status.code().unwrap()
            );
            return Err(anyhow!(error_message));
        }
    }

    Ok(())
}

fn run_web_tests() -> Result<()> {
    println!("Running web tests...");

    let path_to_tests_dir = Path::new(env!("CARGO_WORKSPACE_DIR")).join("tests");

    let status = Command::new("npm")
        .current_dir(path_to_tests_dir.to_str().unwrap())
        .arg("test")
        .status()
        .expect("Failed to execute npm test");

    if !status.success() {
        let error_message = format!(
            "Command 'cargo web-tests' exited with status code: {}",
            status.code().unwrap()
        );
        return Err(anyhow!(error_message));
    }

    Ok(())
}

// TODO - https://github.com/google/comprehensive-rust/issues/2741: Replace this with Clap
fn unrecognized_task_string(task: &str) -> String {
    format!(
        "Unrecognized task '{task}'. Available tasks:

install-tools            Installs the tools the project depends on.
web-tests                Runs the web driver tests in the tests directory."
    )
}