Skip to content

Commit 3fa09c2

Browse files
borsbors
committed
Auto merge of #3954 - RReverser:run-with, r=alexcrichton
Add support for custom target-specific runners When `target.$triple.runner` is specified, it will be used for any execution commands by cargo including `cargo run`, `cargo test` and `cargo bench`. The original file is passed to the runner executable as a first argument. This allows to run tests when cross-comping Rust projects. This is not a complete solution and might be extended in future for better ergonomics to support passing extra arguments to the runner itself or overriding runner from the command line, but it should already unlock major existing use cases. Fixes #1411 Resolves #3626
2 parents 13d92c6 + 0f1c687 commit 3fa09c2

File tree

5 files changed

+106
-19
lines changed

5 files changed

+106
-19
lines changed

‎src/cargo/ops/cargo_compile.rs

+5-2
Original file line numberDiff line numberDiff line change
@@ -662,8 +662,11 @@ fn scrape_target_config(config: &Config, triple: &str)
662662
None => return Ok(ret),
663663
};
664664
for (lib_name, value) in table {
665-
if lib_name == "ar" || lib_name == "linker" || lib_name == "rustflags" {
666-
continue
665+
match lib_name.as_str() {
666+
"ar" | "linker" | "runner" | "rustflags" => {
667+
continue
668+
},
669+
_ => {}
667670
}
668671

669672
let mut output = BuildOutput {

‎src/cargo/ops/cargo_rustc/compilation.rs

+20-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use std::path::PathBuf;
44
use semver::Version;
55

66
use core::{PackageId, Package, Target, TargetKind};
7-
use util::{self, CargoResult, Config, ProcessBuilder, process, join_paths};
7+
use util::{self, CargoResult, Config, LazyCell, ProcessBuilder, process, join_paths};
88

99
/// A structure returning the result of a compilation.
1010
pub struct Compilation<'cfg> {
@@ -53,6 +53,8 @@ pub struct Compilation<'cfg> {
5353
pub target: String,
5454

5555
config: &'cfg Config,
56+
57+
target_runner: LazyCell<Option<(PathBuf, Vec<String>)>>,
5658
}
5759

5860
impl<'cfg> Compilation<'cfg> {
@@ -72,6 +74,7 @@ impl<'cfg> Compilation<'cfg> {
7274
cfgs: HashMap::new(),
7375
config: config,
7476
target: String::new(),
77+
target_runner: LazyCell::new(),
7578
}
7679
}
7780

@@ -91,10 +94,25 @@ impl<'cfg> Compilation<'cfg> {
9194
self.fill_env(process(cmd), pkg, true)
9295
}
9396

97+
fn target_runner(&self) -> CargoResult<&Option<(PathBuf, Vec<String>)>> {
98+
self.target_runner.get_or_try_init(|| {
99+
let key = format!("target.{}.runner", self.target);
100+
Ok(self.config.get_path_and_args(&key)?.map(|v| v.val))
101+
})
102+
}
103+
94104
/// See `process`.
95105
pub fn target_process<T: AsRef<OsStr>>(&self, cmd: T, pkg: &Package)
96106
-> CargoResult<ProcessBuilder> {
97-
self.fill_env(process(cmd), pkg, false)
107+
let builder = if let &Some((ref runner, ref args)) = self.target_runner()? {
108+
let mut builder = process(runner);
109+
builder.args(args);
110+
builder.arg(cmd);
111+
builder
112+
} else {
113+
process(cmd)
114+
};
115+
self.fill_env(builder, pkg, false)
98116
}
99117

100118
/// Prepares a new process with an appropriate environment to run against

‎src/cargo/util/config.rs

+26-10
Original file line numberDiff line numberDiff line change
@@ -215,25 +215,41 @@ impl Config {
215215
}
216216
}
217217

218+
fn string_to_path(&self, value: String, definition: &Definition) -> PathBuf {
219+
let is_path = value.contains('/') ||
220+
(cfg!(windows) && value.contains('\\'));
221+
if is_path {
222+
definition.root(self).join(value)
223+
} else {
224+
// A pathless name
225+
PathBuf::from(value)
226+
}
227+
}
228+
218229
pub fn get_path(&self, key: &str) -> CargoResult<Option<Value<PathBuf>>> {
219230
if let Some(val) = self.get_string(key)? {
220-
let is_path = val.val.contains('/') ||
221-
(cfg!(windows) && val.val.contains('\\'));
222-
let path = if is_path {
223-
val.definition.root(self).join(val.val)
224-
} else {
225-
// A pathless name
226-
PathBuf::from(val.val)
227-
};
228231
Ok(Some(Value {
229-
val: path,
230-
definition: val.definition,
232+
val: self.string_to_path(val.val, &val.definition),
233+
definition: val.definition
231234
}))
232235
} else {
233236
Ok(None)
234237
}
235238
}
236239

240+
pub fn get_path_and_args(&self, key: &str)
241+
-> CargoResult<Option<Value<(PathBuf, Vec<String>)>>> {
242+
if let Some(mut val) = self.get_list_or_split_string(key)? {
243+
if !val.val.is_empty() {
244+
return Ok(Some(Value {
245+
val: (self.string_to_path(val.val.remove(0), &val.definition), val.val),
246+
definition: val.definition
247+
}));
248+
}
249+
}
250+
Ok(None)
251+
}
252+
237253
pub fn get_list(&self, key: &str)
238254
-> CargoResult<Option<Value<Vec<(String, PathBuf)>>>> {
239255
match self.get(key)? {

‎src/doc/config.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,20 @@ email = "..."
5757
vcs = "none"
5858

5959
# For the following sections, $triple refers to any valid target triple, not the
60-
# literal string "$triple", and it will apply whenever that target triple is
60+
# literal string "$triple", and it will apply whenever that target triple is
6161
# being compiled to. 'cfg(...)' refers to the Rust-like `#[cfg]` syntax for
6262
# conditional compilation.
63-
[target.$triple]
64-
# This is the linker which is passed to rustc (via `-C linker=`) when the `$triple`
63+
[target.$triple]
64+
# This is the linker which is passed to rustc (via `-C linker=`) when the `$triple`
6565
# is being compiled for. By default this flag is not passed to the compiler.
66-
linker = ".."
67-
# Same but for the library archiver which is passed to rustc via `-C ar=`.
66+
linker = ".."
67+
# Same but for the library archiver which is passed to rustc via `-C ar=`.
6868
ar = ".."
69+
# If a runner is provided, compiled targets for the `$triple` will be executed
70+
# by invoking the specified runner executable with actual target as first argument.
71+
# This applies to `cargo run`, `cargo test` and `cargo bench` commands.
72+
# By default compiled targets are executed directly.
73+
runner = ".."
6974
# custom flags to pass to all compiler invocations that target $triple
7075
# this value overrides build.rustflags when both are present
7176
rustflags = ["..", ".."]

‎tests/tool-paths.rs

+45
Original file line numberDiff line numberDiff line change
@@ -124,3 +124,48 @@ fn relative_tools() {
124124
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
125125
", url = foo_url, ar = output.0, linker = output.1)))
126126
}
127+
128+
#[test]
129+
fn custom_runner() {
130+
let target = rustc_host();
131+
132+
let foo = project("foo")
133+
.file("Cargo.toml", r#"
134+
[package]
135+
name = "foo"
136+
version = "0.0.1"
137+
"#)
138+
.file("src/main.rs", "fn main() {}")
139+
.file("tests/test.rs", "")
140+
.file("benches/bench.rs", "")
141+
.file(".cargo/config", &format!(r#"
142+
[target.{}]
143+
runner = "nonexistent-runner -r"
144+
"#, target));
145+
146+
foo.build();
147+
148+
assert_that(foo.cargo("run").args(&["--", "--param"]),
149+
execs().with_stderr_contains(&format!("\
150+
[COMPILING] foo v0.0.1 ({url})
151+
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
152+
[RUNNING] `nonexistent-runner -r target[/]debug[/]foo[EXE] --param`
153+
", url = foo.url())));
154+
155+
assert_that(foo.cargo("test").args(&["--test", "test", "--verbose", "--", "--param"]),
156+
execs().with_stderr_contains(&format!("\
157+
[COMPILING] foo v0.0.1 ({url})
158+
[RUNNING] `rustc [..]`
159+
[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]
160+
[RUNNING] `nonexistent-runner -r [..][/]target[/]debug[/]deps[/]test-[..][EXE] --param`
161+
", url = foo.url())));
162+
163+
assert_that(foo.cargo("bench").args(&["--bench", "bench", "--verbose", "--", "--param"]),
164+
execs().with_stderr_contains(&format!("\
165+
[COMPILING] foo v0.0.1 ({url})
166+
[RUNNING] `rustc [..]`
167+
[RUNNING] `rustc [..]`
168+
[FINISHED] release [optimized] target(s) in [..]
169+
[RUNNING] `nonexistent-runner -r [..][/]target[/]release[/]deps[/]bench-[..][EXE] --param --bench`
170+
", url = foo.url())));
171+
}

0 commit comments

Comments
 (0)