1 #![feature(test)] // compiletest_rs requires this attribute
4 use compiletest_rs as compiletest;
5 use compiletest_rs::common::Mode as TestMode;
7 use std::env::{self, remove_var, set_var, var_os};
8 use std::ffi::{OsStr, OsString};
11 use std::path::{Path, PathBuf};
15 // whether to run internal tests or not
16 const RUN_INTERNAL_TESTS: bool = cfg!(feature = "internal-lints");
18 fn host_lib() -> PathBuf {
19 option_env!("HOST_LIBS").map_or(cargo::CARGO_TARGET_DIR.join(env!("PROFILE")), PathBuf::from)
22 fn clippy_driver_path() -> PathBuf {
23 option_env!("CLIPPY_DRIVER_PATH").map_or(cargo::TARGET_LIB.join("clippy-driver"), PathBuf::from)
26 // When we'll want to use `extern crate ..` for a dependency that is used
27 // both by the crate and the compiler itself, we can't simply pass -L flags
28 // as we'll get a duplicate matching versions. Instead, disambiguate with
29 // `--extern dep=path`.
30 // See https://github.com/rust-lang/rust-clippy/issues/4015.
32 // FIXME: We cannot use `cargo build --message-format=json` to resolve to dependency files.
33 // Because it would force-rebuild if the options passed to `build` command is not the same
34 // as what we manually pass to `cargo` invocation
35 fn third_party_crates() -> String {
36 use std::collections::HashMap;
37 static CRATES: &[&str] = &["serde", "serde_derive", "regex", "clippy_lints", "syn", "quote"];
38 let dep_dir = cargo::TARGET_LIB.join("deps");
39 let mut crates: HashMap<&str, PathBuf> = HashMap::with_capacity(CRATES.len());
40 for entry in fs::read_dir(dep_dir).unwrap() {
41 let path = match entry {
42 Ok(entry) => entry.path(),
45 if let Some(name) = path.file_name().and_then(OsStr::to_str) {
47 if name.starts_with(&format!("lib{}-", dep))
48 && name.rsplit('.').next().map(|ext| ext.eq_ignore_ascii_case("rlib")) == Some(true)
50 if let Some(old) = crates.insert(dep, path.clone()) {
51 // Check which action should be done in order to remove compiled deps.
52 // If pre-installed version of compiler is used, `cargo clean` will do.
53 // Otherwise (for bootstrapped compiler), the dependencies directory
54 // must be removed manually.
55 let suggested_action = if std::env::var_os("RUSTC_BOOTSTRAP").is_some() {
56 "remove the stageN-tools directory"
62 "\n---------------------------------------------------\n\n \
63 Found multiple rlibs for crate `{}`: `{:?}` and `{:?}`.\n \
64 Probably, you need to {} before running tests again.\n \
65 \nFor details on that error see https://github.com/rust-lang/rust-clippy/issues/7343 \
66 \n---------------------------------------------------\n",
67 dep, old, path, suggested_action
76 let v: Vec<_> = crates
78 .map(|(dep, path)| format!("--extern {}={}", dep, path.display()))
83 fn default_config() -> compiletest::Config {
84 let mut config = compiletest::Config::default();
86 if let Ok(filters) = env::var("TESTNAME") {
87 config.filters = filters.split(',').map(std::string::ToString::to_string).collect();
90 if let Some(path) = option_env!("RUSTC_LIB_PATH") {
91 let path = PathBuf::from(path);
92 config.run_lib_path = path.clone();
93 config.compile_lib_path = path;
96 config.target_rustcflags = Some(format!(
97 "--emit=metadata -L {0} -L {1} -Dwarnings -Zui-testing {2}",
98 host_lib().join("deps").display(),
99 cargo::TARGET_LIB.join("deps").display(),
100 third_party_crates(),
103 config.build_base = host_lib().join("test_build_base");
104 config.rustc_path = clippy_driver_path();
108 fn run_ui(cfg: &mut compiletest::Config) {
109 cfg.mode = TestMode::Ui;
110 cfg.src_base = Path::new("tests").join("ui");
111 // use tests/clippy.toml
112 let _g = VarGuard::set("CARGO_MANIFEST_DIR", std::fs::canonicalize("tests").unwrap());
113 compiletest::run_tests(cfg);
116 fn run_internal_tests(cfg: &mut compiletest::Config) {
117 // only run internal tests with the internal-tests feature
118 if !RUN_INTERNAL_TESTS {
121 cfg.mode = TestMode::Ui;
122 cfg.src_base = Path::new("tests").join("ui-internal");
123 compiletest::run_tests(cfg);
126 fn run_ui_toml(config: &mut compiletest::Config) {
127 fn run_tests(config: &compiletest::Config, mut tests: Vec<tester::TestDescAndFn>) -> Result<bool, io::Error> {
128 let mut result = true;
129 let opts = compiletest::test_opts(config);
130 for dir in fs::read_dir(&config.src_base)? {
132 if !dir.file_type()?.is_dir() {
135 let dir_path = dir.path();
136 let _g = VarGuard::set("CARGO_MANIFEST_DIR", &dir_path);
137 for file in fs::read_dir(&dir_path)? {
139 let file_path = file.path();
140 if file.file_type()?.is_dir() {
143 if file_path.extension() != Some(OsStr::new("rs")) {
146 let paths = compiletest::common::TestPaths {
148 base: config.src_base.clone(),
149 relative_dir: dir_path.file_name().unwrap().into(),
151 let test_name = compiletest::make_test_name(config, &paths);
154 .position(|test| test.desc.name == test_name)
155 .expect("The test should be in there");
156 result &= tester::run_tests_console(&opts, vec![tests.swap_remove(index)])?;
162 config.mode = TestMode::Ui;
163 config.src_base = Path::new("tests").join("ui-toml").canonicalize().unwrap();
165 let tests = compiletest::make_tests(config);
167 let res = run_tests(config, tests);
170 Ok(false) => panic!("Some tests failed"),
172 panic!("I/O failure during tests: {:?}", e);
177 fn run_ui_cargo(config: &mut compiletest::Config) {
179 config: &compiletest::Config,
181 mut tests: Vec<tester::TestDescAndFn>,
182 ) -> Result<bool, io::Error> {
183 let mut result = true;
184 let opts = compiletest::test_opts(config);
186 for dir in fs::read_dir(&config.src_base)? {
188 if !dir.file_type()?.is_dir() {
192 // Use the filter if provided
193 let dir_path = dir.path();
194 for filter in filters {
195 if !dir_path.ends_with(filter) {
200 for case in fs::read_dir(&dir_path)? {
202 if !case.file_type()?.is_dir() {
206 let src_path = case.path().join("src");
208 // When switching between branches, if the previous branch had a test
209 // that the current branch does not have, the directory is not removed
210 // because an ignored Cargo.lock file exists.
211 if !src_path.exists() {
215 env::set_current_dir(&src_path)?;
216 for file in fs::read_dir(&src_path)? {
218 if file.file_type()?.is_dir() {
222 // Search for the main file to avoid running a test for each file in the project
223 let file_path = file.path();
224 match file_path.file_name().and_then(OsStr::to_str) {
225 Some("main.rs") => {},
228 let _g = VarGuard::set("CLIPPY_CONF_DIR", case.path());
229 let paths = compiletest::common::TestPaths {
231 base: config.src_base.clone(),
232 relative_dir: src_path.strip_prefix(&config.src_base).unwrap().into(),
234 let test_name = compiletest::make_test_name(config, &paths);
237 .position(|test| test.desc.name == test_name)
238 .expect("The test should be in there");
239 result &= tester::run_tests_console(&opts, vec![tests.swap_remove(index)])?;
246 if cargo::is_rustc_test_suite() {
250 config.mode = TestMode::Ui;
251 config.src_base = Path::new("tests").join("ui-cargo").canonicalize().unwrap();
253 let tests = compiletest::make_tests(config);
255 let current_dir = env::current_dir().unwrap();
256 let res = run_tests(config, &config.filters, tests);
257 env::set_current_dir(current_dir).unwrap();
261 Ok(false) => panic!("Some tests failed"),
263 panic!("I/O failure during tests: {:?}", e);
269 set_var("CLIPPY_DISABLE_DOCS_LINKS", "true");
270 set_var("__CLIPPY_INTERNAL_TESTS", "true");
271 //set_var("RUST_BACKTRACE", "0");
277 let mut config = default_config();
279 run_ui_toml(&mut config);
280 run_ui_cargo(&mut config);
281 run_internal_tests(&mut config);
284 /// Restores an env var on drop
288 value: Option<OsString>,
292 fn set(key: &'static str, val: impl AsRef<OsStr>) -> Self {
293 let value = var_os(key);
299 impl Drop for VarGuard {
301 match self.value.as_deref() {
302 None => remove_var(self.key),
303 Some(value) => set_var(self.key, value),