use crate::{ commands, prepare::{Flag, Prepare, PreparedCommand}, }; use argh::FromArgs; /// The CI command line tool for Bevy. #[derive(FromArgs)] pub struct CI { #[argh(subcommand)] command: Option, /// continue running commands even if one fails #[argh(switch)] keep_going: bool, } impl CI { /// Runs the specified commands or all commands if none are specified. /// /// When run locally, results may differ from actual CI runs triggered by `.github/workflows/ci.yml`. /// This is usually related to differing toolchains and configuration. pub fn run(self) { let sh = xshell::Shell::new().unwrap(); let prepared_commands = self.prepare(&sh); let mut failures = vec![]; for command in prepared_commands { // If the CI test is to be executed in a subdirectory, we move there before running the command. // This will automatically move back to the original directory once dropped. let _subdir_hook = command.subdir.map(|path| sh.push_dir(path)); // Execute each command, checking if it returned an error. if command.command.envs(command.env_vars).run().is_err() { let name = command.name; let message = command.failure_message; if self.keep_going { // We use bullet points here because there can be more than one error. failures.push(format!("- {name}: {message}")); } else { failures.push(format!("{name}: {message}")); break; } } } // Log errors at the very end. if !failures.is_empty() { let failures = failures.join("\n"); panic!( "One or more CI commands failed:\n\ {failures}" ); } } fn prepare<'a>(&self, sh: &'a xshell::Shell) -> Vec> { let mut flags = Flag::empty(); if self.keep_going { flags |= Flag::KEEP_GOING; } match &self.command { Some(command) => command.prepare(sh, flags), None => { // Note that we are running the subcommands directly rather than using any aliases let mut cmds = vec![]; cmds.append(&mut commands::FormatCommand::default().prepare(sh, flags)); cmds.append(&mut commands::ClippyCommand::default().prepare(sh, flags)); cmds.append(&mut commands::TestCommand::default().prepare(sh, flags)); cmds.append(&mut commands::TestCheckCommand::default().prepare(sh, flags)); cmds.append(&mut commands::DocCheckCommand::default().prepare(sh, flags)); cmds.append(&mut commands::DocTestCommand::default().prepare(sh, flags)); cmds.append(&mut commands::CompileCheckCommand::default().prepare(sh, flags)); cmds.append(&mut commands::CompileFailCommand::default().prepare(sh, flags)); cmds.append(&mut commands::BenchCheckCommand::default().prepare(sh, flags)); cmds.append(&mut commands::ExampleCheckCommand::default().prepare(sh, flags)); cmds } } } } /// The subcommands that can be run by the CI script. #[derive(FromArgs)] #[argh(subcommand)] enum Commands { // Aliases (subcommands that run other subcommands) Lints(commands::LintsCommand), Doc(commands::DocCommand), Compile(commands::CompileCommand), // Actual subcommands Format(commands::FormatCommand), Clippy(commands::ClippyCommand), Test(commands::TestCommand), TestCheck(commands::TestCheckCommand), DocCheck(commands::DocCheckCommand), DocTest(commands::DocTestCommand), CompileCheck(commands::CompileCheckCommand), CompileFail(commands::CompileFailCommand), BenchCheck(commands::BenchCheckCommand), ExampleCheck(commands::ExampleCheckCommand), } impl Prepare for Commands { fn prepare<'a>(&self, sh: &'a xshell::Shell, flags: Flag) -> Vec> { match self { Commands::Lints(subcommand) => subcommand.prepare(sh, flags), Commands::Doc(subcommand) => subcommand.prepare(sh, flags), Commands::Compile(subcommand) => subcommand.prepare(sh, flags), Commands::Format(subcommand) => subcommand.prepare(sh, flags), Commands::Clippy(subcommand) => subcommand.prepare(sh, flags), Commands::Test(subcommand) => subcommand.prepare(sh, flags), Commands::TestCheck(subcommand) => subcommand.prepare(sh, flags), Commands::DocCheck(subcommand) => subcommand.prepare(sh, flags), Commands::DocTest(subcommand) => subcommand.prepare(sh, flags), Commands::CompileCheck(subcommand) => subcommand.prepare(sh, flags), Commands::CompileFail(subcommand) => subcommand.prepare(sh, flags), Commands::BenchCheck(subcommand) => subcommand.prepare(sh, flags), Commands::ExampleCheck(subcommand) => subcommand.prepare(sh, flags), } } }