1 #![feature(test)] // compiletest_rs requires this attribute
2 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
3 #![warn(rust_2018_idioms, unused_lifetimes)]
5 use compiletest_rs as compiletest;
6 use compiletest_rs::common::Mode as TestMode;
8 use std::collections::HashMap;
9 use std::env::{self, remove_var, set_var, var_os};
10 use std::ffi::{OsStr, OsString};
13 use std::path::{Path, PathBuf};
17 // whether to run internal tests or not
18 const RUN_INTERNAL_TESTS: bool = cfg!(feature = "internal");
20 /// All crates used in UI tests are listed here
21 static TEST_DEPENDENCIES: &[&str] = &[
36 // Test dependencies may need an `extern crate` here to ensure that they show up
37 // in the depinfo file (otherwise cargo thinks they are unused)
38 #[allow(unused_extern_crates)]
39 extern crate clippy_utils;
40 #[allow(unused_extern_crates)]
41 extern crate derive_new;
42 #[allow(unused_extern_crates)]
44 #[allow(unused_extern_crates)]
45 extern crate if_chain;
46 #[allow(unused_extern_crates)]
47 extern crate itertools;
48 #[allow(unused_extern_crates)]
49 extern crate parking_lot;
50 #[allow(unused_extern_crates)]
52 #[allow(unused_extern_crates)]
54 #[allow(unused_extern_crates)]
57 /// Produces a string with an `--extern` flag for all UI test crate
60 /// The dependency files are located by parsing the depinfo file for this test
61 /// module. This assumes the `-Z binary-dep-depinfo` flag is enabled. All test
62 /// dependencies must be added to Cargo.toml at the project root. Test
63 /// dependencies that are not *directly* used by this test module require an
64 /// `extern crate` declaration.
65 fn extern_flags() -> String {
66 let current_exe_depinfo = {
67 let mut path = env::current_exe().unwrap();
68 path.set_extension("d");
69 std::fs::read_to_string(path).unwrap()
71 let mut crates: HashMap<&str, &str> = HashMap::with_capacity(TEST_DEPENDENCIES.len());
72 for line in current_exe_depinfo.lines() {
73 // each dependency is expected to have a Makefile rule like `/path/to/crate-hash.rlib:`
74 let parse_name_path = || {
75 if line.starts_with(char::is_whitespace) {
78 let path_str = line.strip_suffix(':')?;
79 let path = Path::new(path_str);
80 if !matches!(path.extension()?.to_str()?, "rlib" | "so" | "dylib" | "dll") {
83 let (name, _hash) = path.file_stem()?.to_str()?.rsplit_once('-')?;
84 // the "lib" prefix is not present for dll files
85 let name = name.strip_prefix("lib").unwrap_or(name);
86 Some((name, path_str))
88 if let Some((name, path)) = parse_name_path() {
89 if TEST_DEPENDENCIES.contains(&name) {
90 // A dependency may be listed twice if it is available in sysroot,
91 // and the sysroot dependencies are listed first. As of the writing,
92 // this only seems to apply to if_chain.
93 crates.insert(name, path);
97 let not_found: Vec<&str> = TEST_DEPENDENCIES
100 .filter(|n| !crates.contains_key(n))
103 not_found.is_empty(),
104 "dependencies not found in depinfo: {:?}\n\
105 help: Make sure the `-Z binary-dep-depinfo` rust flag is enabled\n\
106 help: Try adding to dev-dependencies in Cargo.toml",
111 .map(|(name, path)| format!(" --extern {}={}", name, path))
115 fn default_config() -> compiletest::Config {
116 let mut config = compiletest::Config {
117 edition: Some("2021".into()),
118 ..compiletest::Config::default()
121 if let Ok(filters) = env::var("TESTNAME") {
122 config.filters = filters.split(',').map(std::string::ToString::to_string).collect();
125 if let Some(path) = option_env!("RUSTC_LIB_PATH") {
126 let path = PathBuf::from(path);
127 config.run_lib_path = path.clone();
128 config.compile_lib_path = path;
130 let current_exe_path = std::env::current_exe().unwrap();
131 let deps_path = current_exe_path.parent().unwrap();
132 let profile_path = deps_path.parent().unwrap();
134 // Using `-L dependency={}` enforces that external dependencies are added with `--extern`.
135 // This is valuable because a) it allows us to monitor what external dependencies are used
136 // and b) it ensures that conflicting rlibs are resolved properly.
137 let host_libs = option_env!("HOST_LIBS")
138 .map(|p| format!(" -L dependency={}", Path::new(p).join("deps").display()))
139 .unwrap_or_default();
140 config.target_rustcflags = Some(format!(
141 "--emit=metadata -Dwarnings -Zui-testing -L dependency={}{}{}",
147 config.build_base = profile_path.join("test");
148 config.rustc_path = profile_path.join(if cfg!(windows) {
156 fn run_ui(cfg: &mut compiletest::Config) {
157 cfg.mode = TestMode::Ui;
158 cfg.src_base = Path::new("tests").join("ui");
159 // use tests/clippy.toml
160 let _g = VarGuard::set("CARGO_MANIFEST_DIR", std::fs::canonicalize("tests").unwrap());
161 compiletest::run_tests(cfg);
164 fn run_ui_test(cfg: &mut compiletest::Config) {
165 cfg.mode = TestMode::Ui;
166 cfg.src_base = Path::new("tests").join("ui_test");
167 let _g = VarGuard::set("CARGO_MANIFEST_DIR", std::fs::canonicalize("tests").unwrap());
168 let rustcflags = cfg.target_rustcflags.get_or_insert_with(Default::default);
169 let len = rustcflags.len();
170 rustcflags.push_str(" --test");
171 compiletest::run_tests(cfg);
172 if let Some(ref mut flags) = &mut cfg.target_rustcflags {
177 fn run_internal_tests(cfg: &mut compiletest::Config) {
178 // only run internal tests with the internal-tests feature
179 if !RUN_INTERNAL_TESTS {
182 cfg.mode = TestMode::Ui;
183 cfg.src_base = Path::new("tests").join("ui-internal");
184 compiletest::run_tests(cfg);
187 fn run_ui_toml(config: &mut compiletest::Config) {
188 fn run_tests(config: &compiletest::Config, mut tests: Vec<tester::TestDescAndFn>) -> Result<bool, io::Error> {
189 let mut result = true;
190 let opts = compiletest::test_opts(config);
191 for dir in fs::read_dir(&config.src_base)? {
193 if !dir.file_type()?.is_dir() {
196 let dir_path = dir.path();
197 let _g = VarGuard::set("CARGO_MANIFEST_DIR", &dir_path);
198 for file in fs::read_dir(&dir_path)? {
200 let file_path = file.path();
201 if file.file_type()?.is_dir() {
204 if file_path.extension() != Some(OsStr::new("rs")) {
207 let paths = compiletest::common::TestPaths {
209 base: config.src_base.clone(),
210 relative_dir: dir_path.file_name().unwrap().into(),
212 let test_name = compiletest::make_test_name(config, &paths);
215 .position(|test| test.desc.name == test_name)
216 .expect("The test should be in there");
217 result &= tester::run_tests_console(&opts, vec![tests.swap_remove(index)])?;
223 config.mode = TestMode::Ui;
224 config.src_base = Path::new("tests").join("ui-toml").canonicalize().unwrap();
226 let tests = compiletest::make_tests(config);
228 let res = run_tests(config, tests);
231 Ok(false) => panic!("Some tests failed"),
233 panic!("I/O failure during tests: {:?}", e);
238 fn run_ui_cargo(config: &mut compiletest::Config) {
240 config: &compiletest::Config,
242 mut tests: Vec<tester::TestDescAndFn>,
243 ) -> Result<bool, io::Error> {
244 let mut result = true;
245 let opts = compiletest::test_opts(config);
247 for dir in fs::read_dir(&config.src_base)? {
249 if !dir.file_type()?.is_dir() {
253 // Use the filter if provided
254 let dir_path = dir.path();
255 for filter in filters {
256 if !dir_path.ends_with(filter) {
261 for case in fs::read_dir(&dir_path)? {
263 if !case.file_type()?.is_dir() {
267 let src_path = case.path().join("src");
269 // When switching between branches, if the previous branch had a test
270 // that the current branch does not have, the directory is not removed
271 // because an ignored Cargo.lock file exists.
272 if !src_path.exists() {
276 env::set_current_dir(&src_path)?;
277 for file in fs::read_dir(&src_path)? {
279 if file.file_type()?.is_dir() {
283 // Search for the main file to avoid running a test for each file in the project
284 let file_path = file.path();
285 match file_path.file_name().and_then(OsStr::to_str) {
286 Some("main.rs") => {},
289 let _g = VarGuard::set("CLIPPY_CONF_DIR", case.path());
290 let paths = compiletest::common::TestPaths {
292 base: config.src_base.clone(),
293 relative_dir: src_path.strip_prefix(&config.src_base).unwrap().into(),
295 let test_name = compiletest::make_test_name(config, &paths);
298 .position(|test| test.desc.name == test_name)
299 .expect("The test should be in there");
300 result &= tester::run_tests_console(&opts, vec![tests.swap_remove(index)])?;
307 if cargo::is_rustc_test_suite() {
311 config.mode = TestMode::Ui;
312 config.src_base = Path::new("tests").join("ui-cargo").canonicalize().unwrap();
314 let tests = compiletest::make_tests(config);
316 let current_dir = env::current_dir().unwrap();
317 let res = run_tests(config, &config.filters, tests);
318 env::set_current_dir(current_dir).unwrap();
322 Ok(false) => panic!("Some tests failed"),
324 panic!("I/O failure during tests: {:?}", e);
330 set_var("CLIPPY_DISABLE_DOCS_LINKS", "true");
331 set_var("__CLIPPY_INTERNAL_TESTS", "true");
332 //set_var("RUST_BACKTRACE", "0");
338 let mut config = default_config();
340 run_ui_test(&mut config);
341 run_ui_toml(&mut config);
342 run_ui_cargo(&mut config);
343 run_internal_tests(&mut config);
346 /// Restores an env var on drop
350 value: Option<OsString>,
354 fn set(key: &'static str, val: impl AsRef<OsStr>) -> Self {
355 let value = var_os(key);
361 impl Drop for VarGuard {
363 match self.value.as_deref() {
364 None => remove_var(self.key),
365 Some(value) => set_var(self.key, value),