Skip to content

Commit 33d2c1b

Browse files
borsbors
committed
Auto merge of #5877 - ehuss:ws-run, r=alexcrichton
Allow `cargo run` in workspaces. Closes #3713
2 parents ebaf212 + fa54a79 commit 33d2c1b

File tree

4 files changed

+123
-51
lines changed

4 files changed

+123
-51
lines changed

‎src/bin/cargo/commands/run.rs

+13-5
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,18 @@ run. If you're passing arguments to both Cargo and the binary, the ones after
3838
pub fn exec(config: &mut Config, args: &ArgMatches) -> CliResult {
3939
let ws = args.workspace(config)?;
4040

41-
let mut compile_opts = args.compile_options_for_single_package(config, CompileMode::Build)?;
41+
let mut compile_opts = args.compile_options(config, CompileMode::Build)?;
4242
if !args.is_present("example") && !args.is_present("bin") {
43-
if let Some(default_run) = compile_opts.get_package(&ws)?
44-
.and_then(|pkg| pkg.manifest().default_run())
45-
{
43+
let default_runs: Vec<_> = compile_opts
44+
.spec
45+
.get_packages(&ws)?
46+
.iter()
47+
.filter_map(|pkg| pkg.manifest().default_run())
48+
.collect();
49+
if default_runs.len() == 1 {
4650
compile_opts.filter = CompileFilter::new(
4751
false,
48-
vec![default_run.to_owned()],
52+
vec![default_runs[0].to_owned()],
4953
false,
5054
vec![],
5155
false,
@@ -56,7 +60,11 @@ pub fn exec(config: &mut Config, args: &ArgMatches) -> CliResult {
5660
false,
5761
);
5862
} else {
63+
// ops::run will take care of errors if len pkgs != 1.
5964
compile_opts.filter = CompileFilter::Default {
65+
// Force this to false because the code in ops::run is not
66+
// able to pre-check features before compilation starts to
67+
// enforce that only 1 binary is built.
6068
required_features_filterable: false,
6169
};
6270
}

‎src/cargo/ops/cargo_compile.rs

+21-18
Original file line numberDiff line numberDiff line change
@@ -83,24 +83,6 @@ impl<'a> CompileOptions<'a> {
8383
export_dir: None,
8484
})
8585
}
86-
87-
// Returns the unique specified package, or None
88-
pub fn get_package<'b>(&self, ws: &'b Workspace) -> CargoResult<Option<&'b Package>> {
89-
Ok(match self.spec {
90-
Packages::All | Packages::Default | Packages::OptOut(_) => {
91-
None
92-
}
93-
Packages::Packages(ref xs) => match xs.len() {
94-
0 => Some(ws.current()?),
95-
1 => Some(ws.members()
96-
.find(|pkg| *pkg.name() == xs[0])
97-
.ok_or_else(|| {
98-
format_err!("package `{}` is not a member of the workspace", xs[0])
99-
})?),
100-
_ => None,
101-
},
102-
})
103-
}
10486
}
10587

10688
#[derive(Clone, PartialEq, Eq, Debug)]
@@ -157,6 +139,27 @@ impl Packages {
157139
}
158140
Ok(specs)
159141
}
142+
143+
pub fn get_packages<'ws>(&self, ws: &'ws Workspace) -> CargoResult<Vec<&'ws Package>> {
144+
let packages: Vec<_> = match self {
145+
Packages::Default => ws.default_members().collect(),
146+
Packages::All => ws.members().collect(),
147+
Packages::OptOut(ref opt_out) => ws
148+
.members()
149+
.filter(|pkg| !opt_out.iter().any(|name| pkg.name().as_str() == name))
150+
.collect(),
151+
Packages::Packages(ref pkgs) => pkgs
152+
.iter()
153+
.map(|name| {
154+
ws.members()
155+
.find(|pkg| pkg.name().as_str() == name)
156+
.ok_or_else(|| {
157+
format_err!("package `{}` is not a member of the workspace", name)
158+
})
159+
}).collect::<CargoResult<Vec<_>>>()?,
160+
};
161+
Ok(packages)
162+
}
160163
}
161164

162165
#[derive(Debug)]

‎src/cargo/ops/cargo_run.rs

+30-28
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
use std::iter;
12
use std::path::Path;
23

34
use ops;
@@ -11,23 +12,20 @@ pub fn run(
1112
) -> CargoResult<Option<ProcessError>> {
1213
let config = ws.config();
1314

14-
let pkg = options.get_package(ws)?
15-
.unwrap_or_else(|| unreachable!("cargo run supports single package only"));
16-
17-
// We compute the `bins` here *just for diagnosis*. The actual set of packages to be run
18-
// is determined by the `ops::compile` call below.
19-
let bins: Vec<_> = pkg.manifest()
20-
.targets()
21-
.iter()
22-
.filter(|a| {
23-
!a.is_lib() && !a.is_custom_build() && if !options.filter.is_specific() {
24-
a.is_bin()
25-
} else {
26-
options.filter.target_run(a)
27-
}
28-
})
29-
.map(|bin| (bin.name(), bin.kind()))
30-
.collect();
15+
// We compute the `bins` here *just for diagnosis*. The actual set of
16+
// packages to be run is determined by the `ops::compile` call below.
17+
let packages = options.spec.get_packages(ws)?;
18+
let bins: Vec<_> = packages
19+
.into_iter()
20+
.flat_map(|pkg| {
21+
iter::repeat(pkg).zip(pkg.manifest().targets().iter().filter(|target| {
22+
!target.is_lib() && !target.is_custom_build() && if !options.filter.is_specific() {
23+
target.is_bin()
24+
} else {
25+
options.filter.target_run(target)
26+
}
27+
}))
28+
}).collect();
3129

3230
if bins.is_empty() {
3331
if !options.filter.is_specific() {
@@ -38,31 +36,34 @@ pub fn run(
3836
}
3937

4038
if bins.len() == 1 {
41-
let &(name, kind) = bins.first().unwrap();
42-
if let TargetKind::ExampleLib(..) = kind {
39+
let target = bins[0].1;
40+
if let TargetKind::ExampleLib(..) = target.kind() {
4341
bail!(
44-
"example target `{}` is a library and cannot be executed",
45-
name
46-
)
42+
"example target `{}` is a library and cannot be executed",
43+
target.name()
44+
)
4745
}
4846
}
4947

5048
if bins.len() > 1 {
5149
if !options.filter.is_specific() {
52-
let names: Vec<&str> = bins.into_iter().map(|bin| bin.0).collect();
50+
let names: Vec<&str> = bins
51+
.into_iter()
52+
.map(|(_pkg, target)| target.name())
53+
.collect();
5354
if nightly_features_allowed() {
5455
bail!(
5556
"`cargo run` could not determine which binary to run. \
56-
Use the `--bin` option to specify a binary, \
57-
or (on nightly) the `default-run` manifest key.\n\
58-
available binaries: {}",
57+
Use the `--bin` option to specify a binary, \
58+
or (on nightly) the `default-run` manifest key.\n\
59+
available binaries: {}",
5960
names.join(", ")
6061
)
6162
} else {
6263
bail!(
6364
"`cargo run` requires that a project only have one \
64-
executable; use the `--bin` option to specify which one \
65-
to run\navailable binaries: {}",
65+
executable; use the `--bin` option to specify which one \
66+
to run\navailable binaries: {}",
6667
names.join(", ")
6768
)
6869
}
@@ -84,6 +85,7 @@ pub fn run(
8485
Some(path) => path.to_path_buf(),
8586
None => exe.to_path_buf(),
8687
};
88+
let pkg = bins[0].0;
8789
let mut process = compile.target_process(exe, pkg)?;
8890
process.args(args).cwd(config.cwd());
8991

‎tests/testsuite/run.rs

+59
Original file line numberDiff line numberDiff line change
@@ -1098,3 +1098,62 @@ fn explicit_bin_with_args() {
10981098

10991099
assert_that(p.cargo("run --bin foo hello world"), execs());
11001100
}
1101+
1102+
#[test]
1103+
fn run_workspace() {
1104+
let p = project()
1105+
.file(
1106+
"Cargo.toml",
1107+
r#"
1108+
[workspace]
1109+
members = ["a", "b"]
1110+
"#,
1111+
).file("a/Cargo.toml", &basic_bin_manifest("a"))
1112+
.file("a/src/main.rs", r#"fn main() {println!("run-a");}"#)
1113+
.file("b/Cargo.toml", &basic_bin_manifest("b"))
1114+
.file("b/src/main.rs", r#"fn main() {println!("run-b");}"#)
1115+
.build();
1116+
1117+
assert_that(
1118+
p.cargo("run"),
1119+
execs().with_status(101).with_stderr(
1120+
"\
1121+
[ERROR] `cargo run` requires that a project only have one executable[..]
1122+
available binaries: a, b",
1123+
),
1124+
);
1125+
assert_that(
1126+
p.cargo("run --bin a"),
1127+
execs().with_status(0).with_stdout("run-a"),
1128+
);
1129+
}
1130+
1131+
#[test]
1132+
fn default_run_workspace() {
1133+
let p = project()
1134+
.file(
1135+
"Cargo.toml",
1136+
r#"
1137+
[workspace]
1138+
members = ["a", "b"]
1139+
"#,
1140+
).file(
1141+
"a/Cargo.toml",
1142+
r#"
1143+
cargo-features = ["default-run"]
1144+
1145+
[project]
1146+
name = "a"
1147+
version = "0.0.1"
1148+
default-run = "a"
1149+
"#,
1150+
).file("a/src/main.rs", r#"fn main() {println!("run-a");}"#)
1151+
.file("b/Cargo.toml", &basic_bin_manifest("b"))
1152+
.file("b/src/main.rs", r#"fn main() {println!("run-b");}"#)
1153+
.build();
1154+
1155+
assert_that(
1156+
p.cargo("run").masquerade_as_nightly_cargo(),
1157+
execs().with_status(0).with_stdout("run-a"),
1158+
);
1159+
}

0 commit comments

Comments
 (0)