1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
//! This crate provides convenient access to the [`compiletest_rs`] package for testing [Dylint]
//! libraries.
//!
//! **Note: If your test has dependencies, you must use `ui_test_example` or `ui_test_examples`.**
//! See the [`question_mark_in_expression`] example in this repository.
//!
//! This crate provides the following three functions:
//!
//! - [`ui_test`] - test a library on all source files in a directory
//! - [`ui_test_example`] - test a library on one example target
//! - [`ui_test_examples`] - test a library on all example targets
//!
//! For most situations, you can add the following to your library's `lib.rs` file:
//!
//! ```rust,ignore
//! #[test]
//! fn ui() {
//! dylint_testing::ui_test(
//! env!("CARGO_PKG_NAME"),
//! &std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("ui"),
//! );
//! }
//! ```
//!
//! And include one or more `.rs` and `.stderr` files in a `ui` directory alongside your library's
//! `src` directory. See the [examples] in this repository.
//!
//! # Test builder
//!
//! In addition to the above three functions, [`ui::Test`] is a test "builder." Currently, the main
//! advantage of using `Test` over the above functions is that `Test` allows flags to be passed to
//! `rustc`. For an example of its use, see [`non_thread_safe_call_in_test`] in this repository.
//!
//! `Test` has three constructors, which correspond to the above three functions as follows:
//!
//! - [`ui::Test::src_base`] <-> [`ui_test`]
//! - [`ui::Test::example`] <-> [`ui_test_example`]
//! - [`ui::Test::examples`] <-> [`ui_test_examples`]
//!
//! In each case, the constructor's arguments are exactly those of the corresponding function.
//!
//! A `Test` instance has the following methods:
//!
//! - `dylint_toml` - set the `dylint.toml` file's contents (for testing [configurable libraries])
//! - `rustc_flags` - pass flags to the compiler when running the test
//! - `run` - run the test
//!
//! # Updating `.stderr` files
//!
//! If the standard error that results from running your `.rs` file differs from the contents of
//! your `.stderr` file, `compiletest_rs` will produce a report like the following:
//!
//! ```text
//! diff of stderr:
//!
//! error: calling `std::env::set_var` in a test could affect the outcome of other tests
//! --> $DIR/main.rs:8:5
//! |
//! LL | std::env::set_var("KEY", "VALUE");
//! | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
//! |
//! = note: `-D non-thread-safe-call-in-test` implied by `-D warnings`
//!
//! -error: aborting due to previous error
//! +error: calling `std::env::set_var` in a test could affect the outcome of other tests
//! + --> $DIR/main.rs:23:9
//! + |
//! +LL | std::env::set_var("KEY", "VALUE");
//! + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
//! +
//! +error: aborting due to 2 previous errors
//!
//!
//!
//! The actual stderr differed from the expected stderr.
//! Actual stderr saved to ...
//! ```
//!
//! The meaning of each line is as follows:
//!
//! - A line beginning with a plus (`+`) is in the actual standard error, but not in your `.stderr`
//! file.
//! - A line beginning with a minus (`-`) is in your `.stderr` file, but not in the actual standard
//! error.
//! - A line beginning with a space (` `) is in both the actual standard error and your `.stderr`
//! file, and is provided for context.
//! - All other lines (e.g., `diff of stderr:`) contain `compiletest_rs` messages.
//!
//! **Note:** In the actual standard error, a blank line usually follows the `error: aborting due to
//! N previous errors` line. So a correct `.stderr` file will typically contain one blank line at
//! the end.
//!
//! In general, it is not too hard to update a `.stderr` file by hand. However, the `compiletest_rs`
//! report should contain a line of the form `Actual stderr saved to PATH`. Copying `PATH` to your
//! `.stderr` file should update it completely.
//!
//! Additional documentation on `compiletest_rs` can be found in [its repository].
//!
//! [Dylint]: https://github.com/trailofbits/dylint/tree/master
//! [`compiletest_rs`]: https://github.com/Manishearth/compiletest-rs
//! [`non_thread_safe_call_in_test`]: https://github.com/trailofbits/dylint/tree/master/examples/general/non_thread_safe_call_in_test/src/lib.rs
//! [`question_mark_in_expression`]: https://github.com/trailofbits/dylint/tree/master/examples/restriction/question_mark_in_expression/Cargo.toml
//! [`ui::Test::example`]: https://docs.rs/dylint_testing/latest/dylint_testing/ui/struct.Test.html#method.example
//! [`ui::Test::examples`]: https://docs.rs/dylint_testing/latest/dylint_testing/ui/struct.Test.html#method.examples
//! [`ui::Test::src_base`]: https://docs.rs/dylint_testing/latest/dylint_testing/ui/struct.Test.html#method.src_base
//! [`ui::Test`]: https://docs.rs/dylint_testing/latest/dylint_testing/ui/struct.Test.html
//! [`ui_test_example`]: https://docs.rs/dylint_testing/latest/dylint_testing/fn.ui_test_example.html
//! [`ui_test_examples`]: https://docs.rs/dylint_testing/latest/dylint_testing/fn.ui_test_examples.html
//! [`ui_test`]: https://docs.rs/dylint_testing/latest/dylint_testing/fn.ui_test.html
//! [configurable libraries]: https://github.com/trailofbits/dylint/tree/master#configurable-libraries
//! [docs.rs documentation]: https://docs.rs/dylint_testing/latest/dylint_testing/
//! [examples]: https://github.com/trailofbits/dylint/tree/master/examples
//! [its repository]: https://github.com/Manishearth/compiletest-rs
use anyhow::{anyhow, ensure, Context, Result};
use cargo_metadata::{Metadata, Package, Target};
use compiletest_rs as compiletest;
use dylint_internal::{env, library_filename, rustup::is_rustc, CommandExt};
use once_cell::sync::{Lazy, OnceCell};
use regex::Regex;
use std::{
env::{consts, remove_var, set_var, var_os},
ffi::{OsStr, OsString},
fs::{copy, read_dir, remove_file},
io::BufRead,
path::{Path, PathBuf},
sync::Mutex,
};
pub mod ui;
static DRIVER: OnceCell<PathBuf> = OnceCell::new();
static LINKING_FLAGS: OnceCell<Vec<String>> = OnceCell::new();
/// Test a library on all source files in a directory.
///
/// - `name` is the name of a Dylint library to be tested. (Often, this is the same as the package
/// name.)
/// - `src_base` is a directory containing:
/// - source files on which to test the library (`.rs` files), and
/// - the output those files should produce (`.stderr` files).
pub fn ui_test(name: &str, src_base: &Path) {
ui::Test::src_base(name, src_base).run();
}
/// Test a library on one example target.
///
/// - `name` is the name of a Dylint library to be tested.
/// - `example` is an example target on which to test the library.
pub fn ui_test_example(name: &str, example: &str) {
ui::Test::example(name, example).run();
}
/// Test a library on all example targets.
///
/// - `name` is the name of a Dylint library to be tested.
pub fn ui_test_examples(name: &str) {
ui::Test::examples(name).run();
}
fn initialize(name: &str) -> Result<&Path> {
DRIVER
.get_or_try_init(|| {
let _ = env_logger::try_init();
// smoelius: Try to order failures by how informative they are: failure to build the
// library, failure to find the library, failure to build/find the driver.
dylint_internal::cargo::build(&format!("library `{name}`"))
.build()
.success()?;
// smoelius: `DYLINT_LIBRARY_PATH` must be set before `dylint_libs` is called.
// smoelius: This was true when `dylint_libs` called `name_toolchain_map`, but that is
// no longer the case. I am leaving the comment here for now in case removal
// of the `name_toolchain_map` call causes a regression.
let metadata = dylint_internal::cargo::current_metadata().unwrap();
let dylint_library_path = metadata.target_directory.join("debug");
set_var(env::DYLINT_LIBRARY_PATH, dylint_library_path);
let dylint_libs = dylint_libs(name)?;
let driver = dylint::driver_builder::get(
&dylint::opts::Dylint::default(),
env!("RUSTUP_TOOLCHAIN"),
)?;
set_var(env::CLIPPY_DISABLE_DOCS_LINKS, "true");
set_var(env::DYLINT_LIBS, dylint_libs);
Ok(driver)
})
.map(PathBuf::as_path)
}
#[doc(hidden)]
pub fn dylint_libs(name: &str) -> Result<String> {
let metadata = dylint_internal::cargo::current_metadata().unwrap();
let rustup_toolchain = env::var(env::RUSTUP_TOOLCHAIN)?;
let filename = library_filename(name, &rustup_toolchain);
let path = metadata.target_directory.join("debug").join(filename);
let paths = vec![path];
serde_json::to_string(&paths).map_err(Into::into)
}
fn example_target(package: &Package, example: &str) -> Result<Target> {
package
.targets
.iter()
.find(|target| target.kind == ["example"] && target.name == example)
.cloned()
.ok_or_else(|| anyhow!("Could not find example `{}`", example))
}
#[allow(clippy::unnecessary_wraps)]
fn example_targets(package: &Package) -> Result<Vec<Target>> {
Ok(package
.targets
.iter()
.filter(|target| target.kind == ["example"])
.cloned()
.collect())
}
fn run_example_test(
driver: &Path,
metadata: &Metadata,
package: &Package,
target: &Target,
config: &ui::Config,
) -> Result<()> {
let linking_flags = linking_flags(metadata, package, target)?;
let file_name = target
.src_path
.file_name()
.ok_or_else(|| anyhow!("Could not get file name"))?;
let tempdir = tempfile::tempdir().with_context(|| "`tempdir` failed")?;
let src_base = tempdir.path();
let to = src_base.join(file_name);
copy(&target.src_path, &to).with_context(|| {
format!(
"Could not copy `{}` to `{}`",
target.src_path,
to.to_string_lossy()
)
})?;
["fixed", "stderr", "stdout"]
.map(|extension| copy_with_extension(&target.src_path, &to, extension).unwrap_or_default());
let mut config = config.clone();
config.rustc_flags.extend(linking_flags.iter().cloned());
run_tests(driver, src_base, &config);
Ok(())
}
fn linking_flags(
metadata: &Metadata,
package: &Package,
target: &Target,
) -> Result<&'static [String]> {
LINKING_FLAGS
.get_or_try_init(|| {
let rustc_flags = rustc_flags(metadata, package, target)?;
let mut linking_flags = Vec::new();
let mut iter = rustc_flags.into_iter();
while let Some(flag) = iter.next() {
if flag.starts_with("--edition=") {
linking_flags.push(flag);
} else if flag == "--extern" || flag == "-L" {
let arg = next(&flag, &mut iter)?;
linking_flags.extend([flag, arg.trim_matches('\'').to_owned()]);
}
}
Ok(linking_flags)
})
.map(Vec::as_slice)
}
// smoelius: We need to recover the `rustc` flags used to build a target. I can see four options:
//
// * Use `cargo build --build-plan`
// - Pros: Easily parsable JSON output
// - Cons: Unstable and likely to be removed: https://github.com/rust-lang/cargo/issues/7614
// * Parse the output of `cargo build --verbose`
// - Pros: ?
// - Cons: Not as easily parsable, requires synchronization (see below)
// * Use a custom executor like Siderophile does: https://github.com/trailofbits/siderophile/blob/26c067306f6c2f66d9530dacef6b17dbf59cdf8c/src/trawl_source/mod.rs#L399
// - Pros: Ground truth
// - Cons: Seems a bit of a heavy lift (Note: I think Siderophile's approach was inspired by
// `cargo-geiger`.)
// * Set `RUSTC_WORKSPACE_WRAPPER` to something that logs `rustc` invocations
// - Pros: Ground truth
// - Cons: Requires a separate executable/script, portability could be an issue
//
// I am going with the second option for now, because it seems to be the least of all evils. This
// decision may need to be revisited.
static RE: Lazy<Regex> = Lazy::new(|| Regex::new(r"^\s*Running\s*`(.*)`$").unwrap());
fn rustc_flags(metadata: &Metadata, package: &Package, target: &Target) -> Result<Vec<String>> {
// smoelius: The following comments are old and retained for posterity. The linking flags are
// now initialized using a `OnceCell`, which makes the mutex unnecessary.
// smoelius: Force rebuilding of the example by removing it. This is kind of messy. The
// example is a shared resource that may be needed by multiple tests. For now, I lock a mutex
// while the example is removed and put back.
// smoelius: Should we use a temporary target directory here?
let output = {
remove_example(metadata, package, target)?;
// smoelius: Because of lazy initialization, `cargo build` is run only once. Seeing
// "Building example `target`" for one example but not for others is confusing. So instead
// say "Building `package` examples".
dylint_internal::cargo::build(&format!("`{}` examples", package.name))
.build()
.envs([(env::CARGO_TERM_COLOR, "never")])
.args([
"--manifest-path",
package.manifest_path.as_ref(),
"--example",
&target.name,
"--verbose",
])
.logged_output(true)?
};
let matches = output
.stderr
.lines()
.map(|line| {
let line =
line.with_context(|| format!("Could not read from `{}`", package.manifest_path))?;
Ok((*RE).captures(&line).and_then(|captures| {
let args = captures[1]
.split(' ')
.map(ToOwned::to_owned)
.collect::<Vec<_>>();
if args.first().map_or(false, is_rustc)
&& args
.as_slice()
.windows(2)
.any(|window| window == ["--crate-name", &snake_case(&target.name)])
{
Some(args)
} else {
None
}
}))
})
.collect::<Result<Vec<Option<Vec<_>>>>>()?;
let mut matches = matches.into_iter().flatten().collect::<Vec<Vec<_>>>();
ensure!(
matches.len() <= 1,
"Found multiple `rustc` invocations for `{}`",
target.name
);
matches
.pop()
.ok_or_else(|| anyhow!("Found no `rustc` invocations for `{}`", target.name))
}
fn remove_example(metadata: &Metadata, _package: &Package, target: &Target) -> Result<()> {
let examples = metadata.target_directory.join("debug/examples");
for entry in
read_dir(&examples).with_context(|| format!("`read_dir` failed for `{examples}`"))?
{
let entry = entry.with_context(|| format!("`read_dir` failed for `{examples}`"))?;
let path = entry.path();
if let Some(file_name) = path.file_name() {
let s = file_name.to_string_lossy();
let target_name = snake_case(&target.name);
if s == target_name.clone() + consts::EXE_SUFFIX
|| s.starts_with(&(target_name.clone() + "-"))
{
remove_file(&path).with_context(|| {
format!("`remove_file` failed for `{}`", path.to_string_lossy())
})?;
}
}
}
Ok(())
}
fn next<I, T>(flag: &str, iter: &mut I) -> Result<T>
where
I: Iterator<Item = T>,
{
iter.next()
.ok_or_else(|| anyhow!("Missing argument for `{}`", flag))
}
fn copy_with_extension<P: AsRef<Path>, Q: AsRef<Path>>(
from: P,
to: Q,
extension: &str,
) -> Result<u64> {
let from = from.as_ref().with_extension(extension);
let to = to.as_ref().with_extension(extension);
copy(from, to).map_err(Into::into)
}
static MUTEX: Mutex<()> = Mutex::new(());
fn run_tests(driver: &Path, src_base: &Path, config: &ui::Config) {
let _lock = MUTEX.lock().unwrap();
// smoelius: There doesn't seem to be a way to set environment variables using `compiletest`'s
// [`Config`](https://docs.rs/compiletest_rs/0.7.1/compiletest_rs/common/struct.Config.html)
// struct. For comparison, where Clippy uses `compiletest`, it sets environment variables
// directly (see: https://github.com/rust-lang/rust-clippy/blob/master/tests/compile-test.rs).
//
// Of course, even if `compiletest` had such support, it would need to be incorporated into
// `dylint_testing`.
let _var = config
.dylint_toml
.as_ref()
.map(|value| VarGuard::set(env::DYLINT_TOML, value));
let config = compiletest::Config {
mode: compiletest::common::Mode::Ui,
rustc_path: driver.to_path_buf(),
src_base: src_base.to_path_buf(),
target_rustcflags: Some(
config.rustc_flags.clone().join(" ")
+ " --emit=metadata"
+ if cfg!(feature = "deny_warnings") {
" -Dwarnings"
} else {
""
}
+ " -Zui-testing",
),
..compiletest::Config::default()
};
compiletest::run_tests(&config);
}
// smoelius: `VarGuard` was copied from:
// https://github.com/rust-lang/rust-clippy/blob/9cc8da222b3893bc13bc13c8827e93f8ea246854/tests/compile-test.rs
/// Restores an env var on drop
#[must_use]
struct VarGuard {
key: &'static str,
value: Option<OsString>,
}
impl VarGuard {
fn set(key: &'static str, val: impl AsRef<OsStr>) -> Self {
let value = var_os(key);
set_var(key, val);
Self { key, value }
}
}
impl Drop for VarGuard {
fn drop(&mut self) {
match self.value.as_deref() {
None => remove_var(self.key),
Some(value) => set_var(self.key, value),
}
}
}
fn snake_case(name: &str) -> String {
name.replace('-', "_")
}