]> git.lizzy.rs Git - rust.git/blob - tests/compile-test.rs
18099c45fee3ccac23293ac5e44069d74d4a6c5b
[rust.git] / tests / compile-test.rs
1 #![feature(test)] // compiletest_rs requires this attribute
2 #![feature(once_cell)]
3 #![cfg_attr(feature = "deny-warnings", deny(warnings))]
4 #![warn(rust_2018_idioms, unused_lifetimes)]
5
6 use compiletest_rs as compiletest;
7 use compiletest_rs::common::Mode as TestMode;
8
9 use std::collections::HashMap;
10 use std::env::{self, remove_var, set_var, var_os};
11 use std::ffi::{OsStr, OsString};
12 use std::fs;
13 use std::io;
14 use std::lazy::SyncLazy;
15 use std::path::{Path, PathBuf};
16 use test_utils::IS_RUSTC_TEST_SUITE;
17
18 mod test_utils;
19
20 // whether to run internal tests or not
21 const RUN_INTERNAL_TESTS: bool = cfg!(feature = "internal");
22
23 /// All crates used in UI tests are listed here
24 static TEST_DEPENDENCIES: &[&str] = &[
25     "clap",
26     "clippy_utils",
27     "derive_new",
28     "futures",
29     "if_chain",
30     "itertools",
31     "quote",
32     "regex",
33     "serde",
34     "serde_derive",
35     "syn",
36     "tokio",
37     "parking_lot",
38     "rustc_semver",
39 ];
40
41 // Test dependencies may need an `extern crate` here to ensure that they show up
42 // in the depinfo file (otherwise cargo thinks they are unused)
43 #[allow(unused_extern_crates)]
44 extern crate clap;
45 #[allow(unused_extern_crates)]
46 extern crate clippy_utils;
47 #[allow(unused_extern_crates)]
48 extern crate derive_new;
49 #[allow(unused_extern_crates)]
50 extern crate futures;
51 #[allow(unused_extern_crates)]
52 extern crate if_chain;
53 #[allow(unused_extern_crates)]
54 extern crate itertools;
55 #[allow(unused_extern_crates)]
56 extern crate parking_lot;
57 #[allow(unused_extern_crates)]
58 extern crate quote;
59 #[allow(unused_extern_crates)]
60 extern crate rustc_semver;
61 #[allow(unused_extern_crates)]
62 extern crate syn;
63 #[allow(unused_extern_crates)]
64 extern crate tokio;
65
66 /// Produces a string with an `--extern` flag for all UI test crate
67 /// dependencies.
68 ///
69 /// The dependency files are located by parsing the depinfo file for this test
70 /// module. This assumes the `-Z binary-dep-depinfo` flag is enabled. All test
71 /// dependencies must be added to Cargo.toml at the project root. Test
72 /// dependencies that are not *directly* used by this test module require an
73 /// `extern crate` declaration.
74 static EXTERN_FLAGS: SyncLazy<String> = SyncLazy::new(|| {
75     let current_exe_depinfo = {
76         let mut path = env::current_exe().unwrap();
77         path.set_extension("d");
78         fs::read_to_string(path).unwrap()
79     };
80     let mut crates: HashMap<&str, &str> = HashMap::with_capacity(TEST_DEPENDENCIES.len());
81     for line in current_exe_depinfo.lines() {
82         // each dependency is expected to have a Makefile rule like `/path/to/crate-hash.rlib:`
83         let parse_name_path = || {
84             if line.starts_with(char::is_whitespace) {
85                 return None;
86             }
87             let path_str = line.strip_suffix(':')?;
88             let path = Path::new(path_str);
89             if !matches!(path.extension()?.to_str()?, "rlib" | "so" | "dylib" | "dll") {
90                 return None;
91             }
92             let (name, _hash) = path.file_stem()?.to_str()?.rsplit_once('-')?;
93             // the "lib" prefix is not present for dll files
94             let name = name.strip_prefix("lib").unwrap_or(name);
95             Some((name, path_str))
96         };
97         if let Some((name, path)) = parse_name_path() {
98             if TEST_DEPENDENCIES.contains(&name) {
99                 // A dependency may be listed twice if it is available in sysroot,
100                 // and the sysroot dependencies are listed first. As of the writing,
101                 // this only seems to apply to if_chain.
102                 crates.insert(name, path);
103             }
104         }
105     }
106     let not_found: Vec<&str> = TEST_DEPENDENCIES
107         .iter()
108         .copied()
109         .filter(|n| !crates.contains_key(n))
110         .collect();
111     assert!(
112         not_found.is_empty(),
113         "dependencies not found in depinfo: {:?}\n\
114         help: Make sure the `-Z binary-dep-depinfo` rust flag is enabled\n\
115         help: Try adding to dev-dependencies in Cargo.toml\n\
116         help: Be sure to also add `extern crate ...;` to tests/compile-test.rs",
117         not_found,
118     );
119     crates
120         .into_iter()
121         .map(|(name, path)| format!(" --extern {}={}", name, path))
122         .collect()
123 });
124
125 fn base_config(test_dir: &str) -> compiletest::Config {
126     let mut config = compiletest::Config {
127         edition: Some("2021".into()),
128         mode: TestMode::Ui,
129         ..compiletest::Config::default()
130     };
131
132     if let Ok(filters) = env::var("TESTNAME") {
133         config.filters = filters.split(',').map(ToString::to_string).collect();
134     }
135
136     if let Some(path) = option_env!("RUSTC_LIB_PATH") {
137         let path = PathBuf::from(path);
138         config.run_lib_path = path.clone();
139         config.compile_lib_path = path;
140     }
141     let current_exe_path = env::current_exe().unwrap();
142     let deps_path = current_exe_path.parent().unwrap();
143     let profile_path = deps_path.parent().unwrap();
144
145     // Using `-L dependency={}` enforces that external dependencies are added with `--extern`.
146     // This is valuable because a) it allows us to monitor what external dependencies are used
147     // and b) it ensures that conflicting rlibs are resolved properly.
148     let host_libs = option_env!("HOST_LIBS")
149         .map(|p| format!(" -L dependency={}", Path::new(p).join("deps").display()))
150         .unwrap_or_default();
151     config.target_rustcflags = Some(format!(
152         "--emit=metadata -Dwarnings -Zui-testing -L dependency={}{}{}",
153         deps_path.display(),
154         host_libs,
155         &*EXTERN_FLAGS,
156     ));
157
158     config.src_base = Path::new("tests").join(test_dir);
159     config.build_base = profile_path.join("test").join(test_dir);
160     config.rustc_path = profile_path.join(if cfg!(windows) {
161         "clippy-driver.exe"
162     } else {
163         "clippy-driver"
164     });
165     config
166 }
167
168 fn run_ui() {
169     let config = base_config("ui");
170     // use tests/clippy.toml
171     let _g = VarGuard::set("CARGO_MANIFEST_DIR", fs::canonicalize("tests").unwrap());
172     let _threads = VarGuard::set(
173         "RUST_TEST_THREADS",
174         // if RUST_TEST_THREADS is set, adhere to it, otherwise override it
175         env::var("RUST_TEST_THREADS").unwrap_or_else(|_| {
176             std::thread::available_parallelism()
177                 .map_or(1, std::num::NonZeroUsize::get)
178                 .to_string()
179         }),
180     );
181     compiletest::run_tests(&config);
182 }
183
184 fn run_internal_tests() {
185     // only run internal tests with the internal-tests feature
186     if !RUN_INTERNAL_TESTS {
187         return;
188     }
189     let config = base_config("ui-internal");
190     compiletest::run_tests(&config);
191 }
192
193 fn run_ui_toml() {
194     fn run_tests(config: &compiletest::Config, mut tests: Vec<tester::TestDescAndFn>) -> Result<bool, io::Error> {
195         let mut result = true;
196         let opts = compiletest::test_opts(config);
197         for dir in fs::read_dir(&config.src_base)? {
198             let dir = dir?;
199             if !dir.file_type()?.is_dir() {
200                 continue;
201             }
202             let dir_path = dir.path();
203             let _g = VarGuard::set("CARGO_MANIFEST_DIR", &dir_path);
204             for file in fs::read_dir(&dir_path)? {
205                 let file = file?;
206                 let file_path = file.path();
207                 if file.file_type()?.is_dir() {
208                     continue;
209                 }
210                 if file_path.extension() != Some(OsStr::new("rs")) {
211                     continue;
212                 }
213                 let paths = compiletest::common::TestPaths {
214                     file: file_path,
215                     base: config.src_base.clone(),
216                     relative_dir: dir_path.file_name().unwrap().into(),
217                 };
218                 let test_name = compiletest::make_test_name(config, &paths);
219                 let index = tests
220                     .iter()
221                     .position(|test| test.desc.name == test_name)
222                     .expect("The test should be in there");
223                 result &= tester::run_tests_console(&opts, vec![tests.swap_remove(index)])?;
224             }
225         }
226         Ok(result)
227     }
228
229     let mut config = base_config("ui-toml");
230     config.src_base = config.src_base.canonicalize().unwrap();
231
232     let tests = compiletest::make_tests(&config);
233
234     let res = run_tests(&config, tests);
235     match res {
236         Ok(true) => {},
237         Ok(false) => panic!("Some tests failed"),
238         Err(e) => {
239             panic!("I/O failure during tests: {:?}", e);
240         },
241     }
242 }
243
244 fn run_ui_cargo() {
245     fn run_tests(
246         config: &compiletest::Config,
247         filters: &[String],
248         mut tests: Vec<tester::TestDescAndFn>,
249     ) -> Result<bool, io::Error> {
250         let mut result = true;
251         let opts = compiletest::test_opts(config);
252
253         for dir in fs::read_dir(&config.src_base)? {
254             let dir = dir?;
255             if !dir.file_type()?.is_dir() {
256                 continue;
257             }
258
259             // Use the filter if provided
260             let dir_path = dir.path();
261             for filter in filters {
262                 if !dir_path.ends_with(filter) {
263                     continue;
264                 }
265             }
266
267             for case in fs::read_dir(&dir_path)? {
268                 let case = case?;
269                 if !case.file_type()?.is_dir() {
270                     continue;
271                 }
272
273                 let src_path = case.path().join("src");
274
275                 // When switching between branches, if the previous branch had a test
276                 // that the current branch does not have, the directory is not removed
277                 // because an ignored Cargo.lock file exists.
278                 if !src_path.exists() {
279                     continue;
280                 }
281
282                 env::set_current_dir(&src_path)?;
283                 for file in fs::read_dir(&src_path)? {
284                     let file = file?;
285                     if file.file_type()?.is_dir() {
286                         continue;
287                     }
288
289                     // Search for the main file to avoid running a test for each file in the project
290                     let file_path = file.path();
291                     match file_path.file_name().and_then(OsStr::to_str) {
292                         Some("main.rs") => {},
293                         _ => continue,
294                     }
295                     let _g = VarGuard::set("CLIPPY_CONF_DIR", case.path());
296                     let paths = compiletest::common::TestPaths {
297                         file: file_path,
298                         base: config.src_base.clone(),
299                         relative_dir: src_path.strip_prefix(&config.src_base).unwrap().into(),
300                     };
301                     let test_name = compiletest::make_test_name(config, &paths);
302                     let index = tests
303                         .iter()
304                         .position(|test| test.desc.name == test_name)
305                         .expect("The test should be in there");
306                     result &= tester::run_tests_console(&opts, vec![tests.swap_remove(index)])?;
307                 }
308             }
309         }
310         Ok(result)
311     }
312
313     if IS_RUSTC_TEST_SUITE {
314         return;
315     }
316
317     let mut config = base_config("ui-cargo");
318     config.src_base = config.src_base.canonicalize().unwrap();
319
320     let tests = compiletest::make_tests(&config);
321
322     let current_dir = env::current_dir().unwrap();
323     let res = run_tests(&config, &config.filters, tests);
324     env::set_current_dir(current_dir).unwrap();
325
326     match res {
327         Ok(true) => {},
328         Ok(false) => panic!("Some tests failed"),
329         Err(e) => {
330             panic!("I/O failure during tests: {:?}", e);
331         },
332     }
333 }
334
335 #[test]
336 fn compile_test() {
337     set_var("CLIPPY_DISABLE_DOCS_LINKS", "true");
338     run_ui();
339     run_ui_toml();
340     run_ui_cargo();
341     run_internal_tests();
342 }
343
344 /// Restores an env var on drop
345 #[must_use]
346 struct VarGuard {
347     key: &'static str,
348     value: Option<OsString>,
349 }
350
351 impl VarGuard {
352     fn set(key: &'static str, val: impl AsRef<OsStr>) -> Self {
353         let value = var_os(key);
354         set_var(key, val);
355         Self { key, value }
356     }
357 }
358
359 impl Drop for VarGuard {
360     fn drop(&mut self) {
361         match self.value.as_deref() {
362             None => remove_var(self.key),
363             Some(value) => set_var(self.key, value),
364         }
365     }
366 }