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
use regex::bytes::Regex;
use crate::{dependencies::build_dependencies, CommandBuilder, Filter, Match, Mode};
pub use color_eyre;
use color_eyre::eyre::Result;
use std::{
ffi::OsString,
num::NonZeroUsize,
path::{Path, PathBuf},
};
mod args;
pub use args::Args;
#[derive(Debug, Clone)]
/// Central datastructure containing all information to run the tests.
pub struct Config {
/// Host triple; usually will be auto-detected.
pub host: Option<String>,
/// `None` to run on the host, otherwise a target triple
pub target: Option<String>,
/// Filters applied to stderr output before processing it.
/// By default contains a filter for replacing backslashes in paths with
/// regular slashes.
/// On windows, contains a filter to remove `\r`.
pub stderr_filters: Filter,
/// Filters applied to stdout output before processing it.
/// On windows, contains a filter to remove `\r`.
pub stdout_filters: Filter,
/// The folder in which to start searching for .rs files
pub root_dir: PathBuf,
/// The mode in which to run the tests.
pub mode: Mode,
/// Run [`rustfix`] on tests that produce machine applicable (or any
/// with [`Mode::Yolo`]) suggestions
pub rustfix: bool,
/// The binary to actually execute.
pub program: CommandBuilder,
/// The command to run to obtain the cfgs that the output is supposed to
pub cfgs: CommandBuilder,
/// What to do in case the stdout/stderr output differs from the expected one.
/// By default, errors in case of conflict, but emits a message informing the user
/// that running `cargo test -- -- --bless` will automatically overwrite the
/// `.stdout` and `.stderr` files with the latest output.
pub output_conflict_handling: OutputConflictHandling,
/// Path to a `Cargo.toml` that describes which dependencies the tests can access.
pub dependencies_crate_manifest_path: Option<PathBuf>,
/// The command to run can be changed from `cargo` to any custom command to build the
/// dependencies in `dependencies_crate_manifest_path`
pub dependency_builder: CommandBuilder,
/// How many threads to use for running tests. Defaults to number of cores
pub num_test_threads: NonZeroUsize,
/// Where to dump files like the binaries compiled from tests.
/// Defaults to `target/ui` in the current directory.
pub out_dir: PathBuf,
/// The default edition to use on all tests
pub edition: Option<String>,
}
impl Config {
/// Create a configuration for testing the output of running
/// `rustc` on the test files.
pub fn rustc(root_dir: impl Into<PathBuf>) -> Self {
Self {
host: None,
target: None,
stderr_filters: vec![
(Match::PathBackslash, b"/"),
#[cfg(windows)]
(Match::Exact(vec![b'\r']), b""),
],
stdout_filters: vec![
#[cfg(windows)]
(Match::Exact(vec![b'\r']), b""),
],
root_dir: root_dir.into(),
mode: Mode::Fail {
require_patterns: true,
},
rustfix: true,
program: CommandBuilder::rustc(),
cfgs: CommandBuilder::cfgs(),
output_conflict_handling: OutputConflictHandling::Error(format!(
"{} --bless",
std::env::args()
.map(|s| format!("{s:?}"))
.collect::<Vec<_>>()
.join(" ")
)),
dependencies_crate_manifest_path: None,
dependency_builder: CommandBuilder::cargo(),
num_test_threads: std::thread::available_parallelism().unwrap(),
out_dir: std::env::var_os("CARGO_TARGET_DIR")
.map(PathBuf::from)
.unwrap_or_else(|| std::env::current_dir().unwrap().join("target"))
.join("ui"),
edition: Some("2021".into()),
}
}
/// Create a configuration for testing the output of running
/// `cargo` on the test `Cargo.toml` files.
pub fn cargo(root_dir: impl Into<PathBuf>) -> Self {
Self {
program: CommandBuilder::cargo(),
edition: None,
rustfix: false,
..Self::rustc(root_dir)
}
}
/// Replace all occurrences of a path in stderr with a byte string.
pub fn path_stderr_filter(
&mut self,
path: &Path,
replacement: &'static (impl AsRef<[u8]> + ?Sized),
) {
let pattern = path.canonicalize().unwrap();
self.stderr_filters
.push((pattern.parent().unwrap().into(), replacement.as_ref()));
}
/// Replace all occurrences of a regex pattern in stderr with a byte string.
pub fn stderr_filter(
&mut self,
pattern: &str,
replacement: &'static (impl AsRef<[u8]> + ?Sized),
) {
self.stderr_filters
.push((Regex::new(pattern).unwrap().into(), replacement.as_ref()));
}
/// Replace all occurrences of a regex pattern in stdout with a byte string.
pub fn stdout_filter(
&mut self,
pattern: &str,
replacement: &'static (impl AsRef<[u8]> + ?Sized),
) {
self.stdout_filters
.push((Regex::new(pattern).unwrap().into(), replacement.as_ref()));
}
/// Compile dependencies and make sure `Config::program` contains the right flags
/// to find the dependencies.
pub fn build_dependencies_and_link_them(&mut self) -> Result<()> {
let dependencies = build_dependencies(self)?;
for (name, artifacts) in dependencies.dependencies {
for dependency in artifacts {
self.program.args.push("--extern".into());
let mut dep = OsString::from(&name);
dep.push("=");
dep.push(dependency);
self.program.args.push(dep);
}
}
for import_path in dependencies.import_paths {
self.program.args.push("-L".into());
self.program.args.push(import_path.into());
}
Ok(())
}
/// Make sure we have the host and target triples.
pub fn fill_host_and_target(&mut self) -> Result<()> {
if self.host.is_none() {
self.host = Some(
rustc_version::VersionMeta::for_command(std::process::Command::new(
&self.program.program,
))
.map_err(|err| {
color_eyre::eyre::Report::new(err).wrap_err(format!(
"failed to parse rustc version info: {}",
self.program.display()
))
})?
.host,
);
}
if self.target.is_none() {
self.target = Some(self.host.clone().unwrap());
}
Ok(())
}
pub(crate) fn has_asm_support(&self) -> bool {
static ASM_SUPPORTED_ARCHS: &[&str] = &[
"x86", "x86_64", "arm", "aarch64", "riscv32",
"riscv64",
// These targets require an additional asm_experimental_arch feature.
// "nvptx64", "hexagon", "mips", "mips64", "spirv", "wasm32",
];
ASM_SUPPORTED_ARCHS
.iter()
.any(|arch| self.target.as_ref().unwrap().contains(arch))
}
}
#[derive(Debug, Clone)]
/// The different options for what to do when stdout/stderr files differ from the actual output.
pub enum OutputConflictHandling {
/// The default: emit a diff of the expected/actual output.
///
/// The string should be a command that can be executed to bless all tests.
Error(String),
/// Ignore mismatches in the stderr/stdout files.
Ignore,
/// Instead of erroring if the stderr/stdout differs from the expected
/// automatically replace it with the found output (after applying filters).
Bless,
}