|
| 1 | +use std::collections::{BTreeSet, HashSet}; |
| 2 | +use std::fs; |
| 3 | +use std::path::{Path, PathBuf}; |
| 4 | +use std::sync::{Arc, Mutex}; |
| 5 | + |
| 6 | +use crate::Build; |
| 7 | +use crate::core::builder::cli_paths::match_paths_to_steps_and_run; |
| 8 | +use crate::core::builder::{Builder, StepDescription}; |
| 9 | +use crate::utils::tests::TestCtx; |
| 10 | + |
| 11 | +fn render_steps_for_cli_args(args_str: &str) -> String { |
| 12 | + // Split a single string into a step kind and subsequent arguments. |
| 13 | + // E.g. "test ui" => ("test", &["ui"]) |
| 14 | + let args = args_str.split_ascii_whitespace().collect::<Vec<_>>(); |
| 15 | + let (kind, args) = args.split_first().unwrap(); |
| 16 | + |
| 17 | + // Arbitrary tuple to represent the host system. |
| 18 | + let hosts = &["x86_64-unknown-linux-gnu"]; |
| 19 | + // Arbitrary tuple to represent the target system, which might not be the host. |
| 20 | + let targets = &["aarch64-unknown-linux-gnu"]; |
| 21 | + |
| 22 | + let config = TestCtx::new() |
| 23 | + .config(kind) |
| 24 | + // `test::Bootstrap` is only run by default in CI, causing inconsistency. |
| 25 | + .arg("--ci=false") |
| 26 | + .args(args) |
| 27 | + .hosts(hosts) |
| 28 | + .targets(targets) |
| 29 | + .create_config(); |
| 30 | + let mut build = Build::new(config); |
| 31 | + // Some rustdoc test steps are only run by default if nodejs is |
| 32 | + // configured/discovered, causing inconsistency. |
| 33 | + build.config.nodejs = Some(PathBuf::from("node")); |
| 34 | + let mut builder = Builder::new(&build); |
| 35 | + |
| 36 | + // Tell the builder to log steps that it would run, instead of running them. |
| 37 | + let mut buf = Arc::new(Mutex::new(String::new())); |
| 38 | + let buf2 = Arc::clone(&buf); |
| 39 | + builder.log_cli_step_for_tests = Some(Box::new(move |step_desc, pathsets, targets| { |
| 40 | + use std::fmt::Write; |
| 41 | + let mut buf = buf2.lock().unwrap(); |
| 42 | + |
| 43 | + let StepDescription { name, kind, .. } = step_desc; |
| 44 | + // Strip boilerplate to make step names easier to read. |
| 45 | + let name = name.strip_prefix("bootstrap::core::build_steps::").unwrap_or(name); |
| 46 | + |
| 47 | + writeln!(buf, "[{kind:?}] {name}").unwrap(); |
| 48 | + writeln!(buf, " targets: {targets:?}").unwrap(); |
| 49 | + for pathset in pathsets { |
| 50 | + // Normalize backslashes in paths, to avoid snapshot differences on Windows. |
| 51 | + // FIXME(Zalathar): Doing a string-replace on <PathSet as Debug> |
| 52 | + // is a bit unprincipled, but it's good enough for now. |
| 53 | + let pathset_str = format!("{pathset:?}").replace('\\', "/"); |
| 54 | + writeln!(buf, " - {pathset_str}").unwrap(); |
| 55 | + } |
| 56 | + })); |
| 57 | + |
| 58 | + builder.execute_cli(); |
| 59 | + |
| 60 | + String::clone(&buf.lock().unwrap()) |
| 61 | +} |
| 62 | + |
| 63 | +fn snapshot_test_inner(name: &str, args_str: &str) { |
| 64 | + let mut settings = insta::Settings::clone_current(); |
| 65 | + // Use the test name as the snapshot filename, not its whole fully-qualified name. |
| 66 | + settings.set_prepend_module_to_snapshot(false); |
| 67 | + settings.bind(|| { |
| 68 | + insta::assert_snapshot!(name, render_steps_for_cli_args(args_str), args_str); |
| 69 | + }); |
| 70 | +} |
| 71 | + |
| 72 | +/// Keep the snapshots directory tidy by forbidding `.snap` files that don't |
| 73 | +/// correspond to a test name. |
| 74 | +fn no_unused_snapshots_inner(known_test_names: &[&str]) { |
| 75 | + let known_test_names = known_test_names.iter().copied().collect::<HashSet<&str>>(); |
| 76 | + |
| 77 | + let mut unexpected_file_names = BTreeSet::new(); |
| 78 | + |
| 79 | + // FIXME(Zalathar): Is there a better way to locate the snapshots dir? |
| 80 | + for entry in walkdir::WalkDir::new("src/core/builder/cli_paths/snapshots") |
| 81 | + .into_iter() |
| 82 | + .map(Result::unwrap) |
| 83 | + { |
| 84 | + let meta = entry.metadata().unwrap(); |
| 85 | + if !meta.is_file() { |
| 86 | + continue; |
| 87 | + } |
| 88 | + |
| 89 | + let name = entry.file_name().to_str().unwrap(); |
| 90 | + if let Some(name_stub) = name.strip_suffix(".snap") |
| 91 | + && !known_test_names.contains(name_stub) |
| 92 | + { |
| 93 | + unexpected_file_names.insert(name.to_owned()); |
| 94 | + } |
| 95 | + } |
| 96 | + |
| 97 | + assert!( |
| 98 | + unexpected_file_names.is_empty(), |
| 99 | + "Found snapshot files that don't correspond to a test name: {unexpected_file_names:#?}", |
| 100 | + ); |
| 101 | +} |
| 102 | + |
| 103 | +macro_rules! declare_tests { |
| 104 | + ( |
| 105 | + $( ($name:ident, $args:literal) ),* $(,)? |
| 106 | + ) => { |
| 107 | + $( |
| 108 | + #[test] |
| 109 | + fn $name() { |
| 110 | + snapshot_test_inner(stringify!($name), $args); |
| 111 | + } |
| 112 | + )* |
| 113 | + |
| 114 | + #[test] |
| 115 | + fn no_unused_snapshots() { |
| 116 | + let known_test_names = &[ $( stringify!($name), )* ]; |
| 117 | + no_unused_snapshots_inner(known_test_names); |
| 118 | + } |
| 119 | + }; |
| 120 | +} |
| 121 | + |
| 122 | +// Snapshot tests for bootstrap's command-line path-to-step handling. |
| 123 | +// |
| 124 | +// To bless these tests as necessary, choose one: |
| 125 | +// - Run `INSTA_UPDATE=always ./x test bootstrap` |
| 126 | +// - Run `./x test bootstrap --bless` |
| 127 | +// - Follow the instructions for `cargo-insta` in bootstrap's README.md |
| 128 | +// |
| 129 | +// These snapshot tests capture _current_ behavior, to prevent unintended |
| 130 | +// changes or regressions. If the current behavior is wrong or undersirable, |
| 131 | +// then any fix will necessarily have to re-bless the affected tests! |
| 132 | +declare_tests!( |
| 133 | + // tidy-alphabetical-start |
| 134 | + (x_build, "build"), |
| 135 | + // tidy-alphabetical-end |
| 136 | +); |
0 commit comments