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
use std::{
collections::{hash_map::Entry, HashMap},
ffi::OsString,
io::{BufReader, ErrorKind},
path::{Path, PathBuf},
process::Stdio,
};
use cargo_metadata::{
diagnostic::{Diagnostic, DiagnosticLevel},
BuildFinished, Edition, Message, MetadataCommand,
};
#[derive(thiserror::Error, Debug)]
pub enum Error {
#[error("Missing environment variable: {0}. Expected to be run by cargo.")]
MissingEnvVar(&'static str),
#[error("Failed to get cargo metadata: {0}")]
CargoMetadata(#[from] cargo_metadata::Error),
#[error("Failed to find package: {0}")]
NoPackage(std::io::Error),
#[error("Failed to get path to test's executable: {0}")]
NoCurrentExe(std::io::Error),
#[error("Failed create cargo package for test binary: {0}")]
CreatingCargoPackage(std::io::Error),
#[error("Failed to run cargo build for test binary: {0}")]
CargoBuildCommand(std::io::Error),
#[error("Failed to build test binary.")]
BuildError(HashMap<DiagnosticLevel, Vec<Diagnostic>>),
}
type Result<T, E = Error> = std::result::Result<T, E>;
#[derive(Debug)]
pub struct DetectedEnvironment {
target: String,
package_name: String,
package_manifest: PathBuf,
test_name: String,
edition: Edition,
target_directory: PathBuf,
}
#[derive(Debug)]
pub struct Program {
path: PathBuf,
name: String,
source: String,
dependencies: Vec<String>,
detected: DetectedEnvironment,
}
impl Program {
pub fn new(name: String, source: String) -> Result<Self> {
let package_name = package_name()?;
let (base_dir, edition) = base_dir_and_edition(&package_name)?;
let target = target();
let package_manifest = package_manifest()?;
let test_name = test_name()?;
let path = base_dir.join(&package_name).join(&test_name).join(&name);
let path_dependency = format!(
"{} = {{ path = \"{}\"}}",
package_name,
package_manifest.to_string_lossy()
);
Ok(Program {
path,
name,
source,
dependencies: vec![path_dependency],
detected: DetectedEnvironment {
target: target.to_owned(),
package_name,
package_manifest,
test_name,
edition,
target_directory: base_dir
.parent()
.expect("base dir should have parent")
.to_path_buf(),
},
})
}
pub fn add_dependency(&mut self, value: String) {
self.dependencies.push(value);
}
pub fn compile(self) -> Result<Binary> {
let cargo_path = cargo_path()?;
std::fs::create_dir_all(&self.path)
.map_err(Error::CreatingCargoPackage)?;
std::fs::write(self.path.join("Cargo.toml"), format!(r#"
[package]
name = "{name}"
version = "0.1.0"
edition = "{edition}"
publish = false
[[bin]]
name = "{name}"
path = "main.rs"
[dependencies]
{dependencies}
[package.metadata.treadmill]
notice = "This package was automatically generated by the `treadmill` crate for use with tests."
"#,
name = &self.name,
dependencies = self.dependencies.join("\n"),
edition = self.detected.edition.as_str(),
)).map_err(Error::CreatingCargoPackage)?;
std::fs::write(self.path.join("main.rs"), self.source)
.map_err(Error::CreatingCargoPackage)?;
let mut command = std::process::Command::new(cargo_path);
command
.args(["build", "--message-format=json", "-q", "--manifest-path"])
.arg(self.path.join("Cargo.toml"))
.arg("--bin")
.arg(&self.name)
.arg("--target")
.arg(&self.detected.target)
.arg("--target-dir")
.arg(&self.detected.target_directory)
.stdout(Stdio::piped());
let mut spawned = command.spawn().map_err(Error::CargoBuildCommand)?;
let reader = BufReader::new(
spawned
.stdout
.take()
.expect("spawned should have stdout buffer"),
);
let messages = Message::parse_stream(reader);
let mut executable_path = None;
let mut diagnostics: HashMap<DiagnosticLevel, Vec<Diagnostic>> =
HashMap::new();
let mut build_finished = false;
for message in messages {
match message {
Ok(Message::CompilerArtifact(artifact))
if artifact.target.name == self.name =>
{
if let Some(path) = artifact.executable {
executable_path = Some(path);
}
}
Ok(Message::CompilerMessage(msg))
if msg.target.name == self.name =>
{
match diagnostics.entry(msg.message.level) {
Entry::Occupied(occupied) => {
occupied.into_mut().push(msg.message)
}
Entry::Vacant(vacant) => {
vacant.insert(vec![msg.message]);
}
}
}
Ok(Message::BuildFinished(BuildFinished {
success: true,
..
})) => build_finished = true,
_ => {}
}
}
if build_finished {
if let Some(path) = executable_path {
Ok(Binary {
path: path.into_std_path_buf(),
})
} else {
Err(Error::CargoBuildCommand(std::io::Error::new(
ErrorKind::Other,
"No executable was generated.",
)))
}
} else {
Err(Error::BuildError(diagnostics))
}
}
}
fn environment_var(name: &'static str) -> Result<OsString> {
std::env::var_os(name).ok_or(Error::MissingEnvVar(name))
}
fn base_dir_and_edition(package_name: &str) -> Result<(PathBuf, Edition)> {
let manifest_path = package_manifest()?.join("Cargo.toml");
let metadata =
MetadataCommand::new().manifest_path(manifest_path).exec()?;
let package = metadata
.packages
.iter()
.find(|package| package.name == package_name)
.ok_or_else(|| {
Error::NoPackage(std::io::Error::new(ErrorKind::Other, ""))
})?;
let edition = package.edition.clone();
Ok((
metadata.target_directory.join("ttp").into_std_path_buf(),
edition,
))
}
fn cargo_path() -> Result<PathBuf> {
environment_var("CARGO").map(PathBuf::from)
}
fn target() -> &'static str {
env!("TREADMILL_TARGET")
}
fn package_manifest() -> Result<PathBuf> {
environment_var("CARGO_MANIFEST_DIR").map(PathBuf::from)
}
fn package_name() -> Result<String> {
environment_var("CARGO_PKG_NAME")
.map(|name| name.to_string_lossy().into_owned())
}
fn test_name() -> Result<String> {
let current_exe = std::env::current_exe().map_err(Error::NoCurrentExe)?;
let name = current_exe
.file_name()
.ok_or_else(|| {
Error::NoCurrentExe(std::io::Error::new(
ErrorKind::Other,
"File doesn't have a file name.",
))
})?
.to_string_lossy()
.into_owned();
if let Some((test_name, _)) = name.rsplit_once('-') {
Ok(test_name.to_owned())
} else {
Ok(name)
}
}
pub struct Binary {
path: PathBuf,
}
impl Binary {
pub fn command(&self) -> std::process::Command {
std::process::Command::new(&self.path)
}
}