1 //! `bless` updates the reference files in the repo with changed output files
2 //! from the last test run.
7 use std::lazy::SyncLazy;
8 use std::path::{Path, PathBuf};
11 use crate::clippy_project_root;
13 // NOTE: this is duplicated with tests/cargo/mod.rs What to do?
14 pub static CARGO_TARGET_DIR: SyncLazy<PathBuf> = SyncLazy::new(|| match env::var_os("CARGO_TARGET_DIR") {
16 None => env::current_dir().unwrap().join("target"),
19 static CLIPPY_BUILD_TIME: SyncLazy<Option<std::time::SystemTime>> = SyncLazy::new(|| {
20 let profile = env::var("PROFILE").unwrap_or_else(|_| "debug".to_string());
21 let mut path = PathBuf::from(&**CARGO_TARGET_DIR);
23 path.push("cargo-clippy");
24 fs::metadata(path).ok()?.modified().ok()
29 /// Panics if the path to a test file is broken
30 pub fn bless(ignore_timestamp: bool) {
31 let test_suite_dirs = [
32 clippy_project_root().join("tests").join("ui"),
33 clippy_project_root().join("tests").join("ui-internal"),
34 clippy_project_root().join("tests").join("ui-toml"),
35 clippy_project_root().join("tests").join("ui-cargo"),
37 for test_suite_dir in &test_suite_dirs {
38 WalkDir::new(test_suite_dir)
40 .filter_map(Result::ok)
41 .filter(|f| f.path().extension() == Some(OsStr::new("rs")))
43 let test_name = f.path().strip_prefix(test_suite_dir).unwrap();
44 for &ext in &["stdout", "stderr", "fixed"] {
45 update_reference_file(
46 f.path().with_extension(ext),
47 test_name.with_extension(ext),
55 fn update_reference_file(reference_file_path: PathBuf, test_name: PathBuf, ignore_timestamp: bool) {
56 let test_output_path = build_dir().join(test_name);
57 let relative_reference_file_path = reference_file_path.strip_prefix(clippy_project_root()).unwrap();
59 // If compiletest did not write any changes during the test run,
60 // we don't have to update anything
61 if !test_output_path.exists() {
65 // If the test output was not updated since the last clippy build, it may be outdated
66 if !ignore_timestamp && !updated_since_clippy_build(&test_output_path).unwrap_or(true) {
70 let test_output_file = fs::read(&test_output_path).expect("Unable to read test output file");
71 let reference_file = fs::read(&reference_file_path).unwrap_or_default();
73 if test_output_file != reference_file {
74 // If a test run caused an output file to change, update the reference file
75 println!("updating {}", &relative_reference_file_path.display());
76 fs::copy(test_output_path, &reference_file_path).expect("Could not update reference file");
78 // We need to re-read the file now because it was potentially updated from copying
79 let reference_file = fs::read(&reference_file_path).unwrap_or_default();
81 if reference_file.is_empty() {
82 // If we copied over an empty output file, we remove the now empty reference file
83 println!("removing {}", &relative_reference_file_path.display());
84 fs::remove_file(reference_file_path).expect("Could not remove reference file");
89 fn updated_since_clippy_build(path: &Path) -> Option<bool> {
90 let clippy_build_time = (*CLIPPY_BUILD_TIME)?;
91 let modified = fs::metadata(path).ok()?.modified().ok()?;
92 Some(modified >= clippy_build_time)
95 fn build_dir() -> PathBuf {
96 let profile = env::var("PROFILE").unwrap_or_else(|_| "debug".to_string());
97 let mut path = PathBuf::new();
98 path.push(CARGO_TARGET_DIR.clone());
100 path.push("test_build_base");