clippy_dev/src/bless.rs

   1 //! `bless` updates the reference files in the repo with changed output files
   2 //! from the last test run.
   3
   4 use std::env;
   5 use std::ffi::OsStr;
   6 use std::fs;
   7 use std::lazy::SyncLazy;
   8 use std::path::{Path, PathBuf};
   9 use walkdir::WalkDir;
  10
  11 use crate::clippy_project_root;
  12
  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") {
  15     Some(v) => v.into(),
  16     None => env::current_dir().unwrap().join("target"),
  17 });
  18
  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);
  22     path.push(profile);
  23     path.push("cargo-clippy");
  24     fs::metadata(path).ok()?.modified().ok()
  25 });
  26
  27 pub fn bless(ignore_timestamp: bool) {
  28     let test_suite_dirs = [
  29         clippy_project_root().join("tests").join("ui"),
  30         clippy_project_root().join("tests").join("ui-toml"),
  31         clippy_project_root().join("tests").join("ui-cargo"),
  32     ];
  33     for test_suite_dir in &test_suite_dirs {
  34         WalkDir::new(test_suite_dir)
  35             .into_iter()
  36             .filter_map(Result::ok)
  37             .filter(|f| f.path().extension() == Some(OsStr::new("rs")))
  38             .for_each(|f| {
  39                 let test_name = f.path().strip_prefix(test_suite_dir).unwrap();
  40                 for &ext in &["stdout", "stderr", "fixed"] {
  41                     update_reference_file(
  42                         f.path().with_extension(ext),
  43                         test_name.with_extension(ext),
  44                         ignore_timestamp,
  45                     );
  46                 }
  47             });
  48     }
  49 }
  50
  51 fn update_reference_file(reference_file_path: PathBuf, test_name: PathBuf, ignore_timestamp: bool) {
  52     let test_output_path = build_dir().join(test_name);
  53     let relative_reference_file_path = reference_file_path.strip_prefix(clippy_project_root()).unwrap();
  54
  55     // If compiletest did not write any changes during the test run,
  56     // we don't have to update anything
  57     if !test_output_path.exists() {
  58         return;
  59     }
  60
  61     // If the test output was not updated since the last clippy build, it may be outdated
  62     if !ignore_timestamp && !updated_since_clippy_build(&test_output_path).unwrap_or(true) {
  63         return;
  64     }
  65
  66     let test_output_file = fs::read(&test_output_path).expect("Unable to read test output file");
  67     let reference_file = fs::read(&reference_file_path).unwrap_or_default();
  68
  69     if test_output_file != reference_file {
  70         // If a test run caused an output file to change, update the reference file
  71         println!("updating {}", &relative_reference_file_path.display());
  72         fs::copy(test_output_path, &reference_file_path).expect("Could not update reference file");
  73
  74         // We need to re-read the file now because it was potentially updated from copying
  75         let reference_file = fs::read(&reference_file_path).unwrap_or_default();
  76
  77         if reference_file.is_empty() {
  78             // If we copied over an empty output file, we remove the now empty reference file
  79             println!("removing {}", &relative_reference_file_path.display());
  80             fs::remove_file(reference_file_path).expect("Could not remove reference file");
  81         }
  82     }
  83 }
  84
  85 fn updated_since_clippy_build(path: &Path) -> Option<bool> {
  86     let clippy_build_time = (*CLIPPY_BUILD_TIME)?;
  87     let modified = fs::metadata(path).ok()?.modified().ok()?;
  88     Some(modified >= clippy_build_time)
  89 }
  90
  91 fn build_dir() -> PathBuf {
  92     let profile = env::var("PROFILE").unwrap_or_else(|_| "debug".to_string());
  93     let mut path = PathBuf::new();
  94     path.push(CARGO_TARGET_DIR.clone());
  95     path.push(profile);
  96     path.push("test_build_base");
  97     path
  98 }