forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Small CI tool improvements (#12841)

Browse Source 
# Objective

- The CI tool is slowly getting more difficult to maintain and could use
a bit of refactoring.

## Solution

- Do a first pass of small improvements.

## For Reviewers

This PR is best reviewed commit-by-commit, because I separate it into a
collection of small changes. :)
This commit is contained in:
BD103 2024-04-10 10:29:05 -04:00 committed by GitHub
parent 11817f4ba4
commit 78c922509b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 34 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
tools/ci/src/main.rs
View File

@ -1,31 +1,31 @@
//! CI script used for Bevy. //! CI script used for Bevy.
use bitflags::bitflags; use bitflags::bitflags;
use core::panic;
use std::collections::BTreeMap; use std::collections::BTreeMap;
use xshell::{cmd, Cmd, Shell}; use xshell::{cmd, Cmd, Shell};
bitflags! { bitflags! {
/// A collection of individual checks that can be run in CI.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)] #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
struct Check: u32 { struct Check: u32 {
const FORMAT = 0b00000001; const FORMAT = 1 << 0;
const CLIPPY = 0b00000010; const CLIPPY = 1 << 1;
const COMPILE_FAIL = 0b00000100; const COMPILE_FAIL = 1 << 2;
const TEST = 0b00001000; const TEST = 1 << 3;
const DOC_TEST = 0b00010000; const DOC_TEST = 1 << 4;
const DOC_CHECK = 0b00100000; const DOC_CHECK = 1 << 5;
const BENCH_CHECK = 0b01000000; const BENCH_CHECK = 1 << 6;
const EXAMPLE_CHECK = 0b10000000; const EXAMPLE_CHECK = 1 << 7;
const COMPILE_CHECK = 0b100000000; const COMPILE_CHECK = 1 << 8;
const CFG_CHECK = 0b1000000000; const CFG_CHECK = 1 << 9;
const TEST_CHECK = 0b10000000000; const TEST_CHECK = 1 << 10;
} }
}
bitflags! { /// A collection of flags that can modify how checks are run.
#[derive(Clone, Copy, Debug, PartialEq, Eq)] #[derive(Clone, Copy, Debug, PartialEq, Eq)]
struct Flag: u32 { struct Flag: u32 {
const KEEP_GOING = 0b00000001; /// Forces certain checks to continue running even if they hit an error.
const KEEP_GOING = 1 << 0;
} }
} }
@ -80,27 +80,30 @@ fn main() {
// the executable, so it is ignored. Any parameter may either be a flag or the name of a battery of tests // the executable, so it is ignored. Any parameter may either be a flag or the name of a battery of tests
// to include. // to include.
let (mut checks, mut flags) = (Check::empty(), Flag::empty()); let (mut checks, mut flags) = (Check::empty(), Flag::empty());
// Skip first argument, which is usually the path of the executable.
for arg in std::env::args().skip(1) { for arg in std::env::args().skip(1) {
if let Some((_, flag)) = flag_arguments.iter().find(|(flag_arg, _)| *flag_arg == arg) {
flags.insert(*flag);
continue;
}
if let Some((_, check)) = arguments.iter().find(|(check_arg, _)| *check_arg == arg) { if let Some((_, check)) = arguments.iter().find(|(check_arg, _)| *check_arg == arg) {
// Note that this actually adds all of the constituent checks to the test suite. // Note that this actually adds all of the constituent checks to the test suite.
checks.insert(*check); checks.insert(*check);
continue; } else if let Some((_, flag)) = flag_arguments.iter().find(|(flag_arg, _)| *flag_arg == arg)
{
flags.insert(*flag);
} else {
// We encountered an invalid parameter:
eprintln!(
"Invalid argument: {arg:?}.\n\
Valid parameters: {}.",
// Skip first argument so it can be added in fold(), when displaying as a comma separated list.
arguments[1..]
.iter()
.map(|(s, _)| s)
.chain(flag_arguments.iter().map(|(s, _)| s))
.fold(arguments[0].0.to_owned(), |c, v| c + ", " + v)
);
return;
} }
// We encountered an invalid parameter:
println!(
"Invalid argument: {arg:?}.\n\
Valid parameters: {}.",
arguments[1..]
.iter()
.map(|(s, _)| s)
.chain(flag_arguments.iter().map(|(s, _)| s))
.fold(arguments[0].0.to_owned(), |c, v| c + ", " + v)
);
return;
} }
// If no checks are specified, we run every check // If no checks are specified, we run every check