Skip to content

Commit 3751e68

Browse files
borsbors
committed
Auto merge of #4216 - durka:install-multi, r=alexcrichton
cargo install multiple crates rust-lang/rustup#986 for `cargo install` Revives #2601 @pwoolcoc, replaces #3075 @esclear, closes #2585 @kindlychung @cyplo Avoids the sticking point of the previous two PRs (multiple registry updates) by threading through a first-run boolean flag to decide whether `select_pkg` needs to call `source.update()`. There is still the issue that flags such as `--git` and `--vers` are "global" to the multiple packages you may be installing. The workaround is just to run `cargo install` separately. In the future we could add syntax like `cargo install foo=1.0 bar=2.5 quux=git://github.com/durka/quux#dev-branch` or something.
2 parents 76148e9 + ce2d69d commit 3751e68

File tree

4 files changed

+133
-27
lines changed

4 files changed

+133
-27
lines changed

‎src/bin/install.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pub struct Options {
2222
flag_frozen: bool,
2323
flag_locked: bool,
2424

25-
arg_crate: Option<String>,
25+
arg_crate: Vec<String>,
2626
flag_vers: Option<String>,
2727

2828
flag_git: Option<String>,
@@ -37,7 +37,7 @@ pub const USAGE: &'static str = "
3737
Install a Rust binary
3838
3939
Usage:
40-
cargo install [options] [<crate>]
40+
cargo install [options] [<crate>...]
4141
cargo install [options] --list
4242
4343
Specifying what crate to install:
@@ -139,20 +139,20 @@ pub fn execute(options: Options, config: &Config) -> CliResult {
139139
SourceId::for_git(&url, gitref)
140140
} else if let Some(path) = options.flag_path {
141141
SourceId::for_path(&config.cwd().join(path))?
142-
} else if options.arg_crate == None {
142+
} else if options.arg_crate.is_empty() {
143143
SourceId::for_path(&config.cwd())?
144144
} else {
145145
SourceId::crates_io(config)?
146146
};
147147

148-
let krate = options.arg_crate.as_ref().map(|s| &s[..]);
148+
let krates = options.arg_crate.iter().map(|s| &s[..]).collect::<Vec<_>>();
149149
let vers = options.flag_vers.as_ref().map(|s| &s[..]);
150150
let root = options.flag_root.as_ref().map(|s| &s[..]);
151151

152152
if options.flag_list {
153153
ops::install_list(root, config)?;
154154
} else {
155-
ops::install(root, krate, &source, vers, &compile_opts, options.flag_force)?;
155+
ops::install(root, krates, &source, vers, &compile_opts, options.flag_force)?;
156156
}
157157
Ok(())
158158
}

‎src/cargo/ops/cargo_install.rs

+84-22
Original file line numberDiff line numberDiff line change
@@ -55,37 +55,107 @@ impl Drop for Transaction {
5555
}
5656

5757
pub fn install(root: Option<&str>,
58-
krate: Option<&str>,
58+
krates: Vec<&str>,
5959
source_id: &SourceId,
6060
vers: Option<&str>,
6161
opts: &ops::CompileOptions,
6262
force: bool) -> CargoResult<()> {
63+
let root = resolve_root(root, opts.config)?;
64+
let map = SourceConfigMap::new(opts.config)?;
65+
66+
let (installed_anything, scheduled_error) = if krates.len() <= 1 {
67+
install_one(root.clone(), map, krates.into_iter().next(), source_id, vers, opts,
68+
force, true)?;
69+
(true, false)
70+
} else {
71+
let mut succeeded = vec![];
72+
let mut failed = vec![];
73+
let mut first = true;
74+
for krate in krates {
75+
let root = root.clone();
76+
let map = map.clone();
77+
match install_one(root, map, Some(krate), source_id, vers, opts, force, first) {
78+
Ok(()) => succeeded.push(krate),
79+
Err(e) => {
80+
::handle_error(e, &mut opts.config.shell());
81+
failed.push(krate)
82+
}
83+
}
84+
first = false;
85+
}
86+
87+
let mut summary = vec![];
88+
if !succeeded.is_empty() {
89+
summary.push(format!("Successfully installed {}!", succeeded.join(", ")));
90+
}
91+
if !failed.is_empty() {
92+
summary.push(format!("Failed to install {} (see error(s) above).", failed.join(", ")));
93+
}
94+
if !succeeded.is_empty() || !failed.is_empty() {
95+
opts.config.shell().status("\nSummary:", summary.join(" "))?;
96+
}
97+
98+
(!succeeded.is_empty(), !failed.is_empty())
99+
};
100+
101+
if installed_anything {
102+
// Print a warning that if this directory isn't in PATH that they won't be
103+
// able to run these commands.
104+
let dst = metadata(opts.config, &root)?.parent().join("bin");
105+
let path = env::var_os("PATH").unwrap_or(OsString::new());
106+
for path in env::split_paths(&path) {
107+
if path == dst {
108+
return Ok(())
109+
}
110+
}
111+
112+
opts.config.shell().warn(&format!("be sure to add `{}` to your PATH to be \
113+
able to run the installed binaries",
114+
dst.display()))?;
115+
}
116+
117+
if scheduled_error {
118+
bail!("some crates failed to install");
119+
}
120+
121+
Ok(())
122+
}
123+
124+
fn install_one(root: Filesystem,
125+
map: SourceConfigMap,
126+
krate: Option<&str>,
127+
source_id: &SourceId,
128+
vers: Option<&str>,
129+
opts: &ops::CompileOptions,
130+
force: bool,
131+
is_first_install: bool) -> CargoResult<()> {
132+
63133
let config = opts.config;
64-
let root = resolve_root(root, config)?;
65-
let map = SourceConfigMap::new(config)?;
134+
66135
let (pkg, source) = if source_id.is_git() {
67136
select_pkg(GitSource::new(source_id, config),
68-
krate, vers, config, &mut |git| git.read_packages())?
137+
krate, vers, config, is_first_install,
138+
&mut |git| git.read_packages())?
69139
} else if source_id.is_path() {
70-
let path = source_id.url().to_file_path().ok()
71-
.expect("path sources must have a valid path");
140+
let path = source_id.url().to_file_path()
141+
.map_err(|()| CargoError::from("path sources must have a valid path"))?;
72142
let mut src = PathSource::new(&path, source_id, config);
73143
src.update().chain_err(|| {
74144
format!("`{}` is not a crate root; specify a crate to \
75145
install from crates.io, or use --path or --git to \
76146
specify an alternate source", path.display())
77147
})?;
78148
select_pkg(PathSource::new(&path, source_id, config),
79-
krate, vers, config, &mut |path| path.read_packages())?
149+
krate, vers, config, is_first_install,
150+
&mut |path| path.read_packages())?
80151
} else {
81152
select_pkg(map.load(source_id)?,
82-
krate, vers, config,
153+
krate, vers, config, is_first_install,
83154
&mut |_| Err("must specify a crate to install from \
84155
crates.io, or use --path or --git to \
85156
specify alternate source".into()))?
86157
};
87158

88-
89159
let mut td_opt = None;
90160
let overidden_target_dir = if source_id.is_path() {
91161
None
@@ -248,30 +318,22 @@ pub fn install(root: Option<&str>,
248318
fs::remove_dir_all(&target_dir)?;
249319
}
250320

251-
// Print a warning that if this directory isn't in PATH that they won't be
252-
// able to run these commands.
253-
let path = env::var_os("PATH").unwrap_or(OsString::new());
254-
for path in env::split_paths(&path) {
255-
if path == dst {
256-
return Ok(())
257-
}
258-
}
259-
260-
config.shell().warn(&format!("be sure to add `{}` to your PATH to be \
261-
able to run the installed binaries",
262-
dst.display()))?;
263321
Ok(())
264322
}
265323

266324
fn select_pkg<'a, T>(mut source: T,
267325
name: Option<&str>,
268326
vers: Option<&str>,
269327
config: &Config,
328+
needs_update: bool,
270329
list_all: &mut FnMut(&mut T) -> CargoResult<Vec<Package>>)
271330
-> CargoResult<(Package, Box<Source + 'a>)>
272331
where T: Source + 'a
273332
{
274-
source.update()?;
333+
if needs_update {
334+
source.update()?;
335+
}
336+
275337
match name {
276338
Some(name) => {
277339
let vers = match vers {

‎src/cargo/sources/config.rs

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ use util::{Config, ToUrl};
1515
use util::config::ConfigValue;
1616
use util::errors::{CargoError, CargoResult, CargoResultExt};
1717

18+
#[derive(Clone)]
1819
pub struct SourceConfigMap<'cfg> {
1920
cfgs: HashMap<String, SourceConfig>,
2021
id2name: HashMap<SourceId, String>,
@@ -28,6 +29,7 @@ pub struct SourceConfigMap<'cfg> {
2829
/// registry = 'https://github.com/rust-lang/crates.io-index'
2930
/// replace-with = 'foo' # optional
3031
/// ```
32+
#[derive(Clone)]
3133
struct SourceConfig {
3234
// id this source corresponds to, inferred from the various defined keys in
3335
// the configuration

‎tests/install.rs

+42
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,48 @@ warning: be sure to add `[..]` to your PATH to be able to run the installed bina
5454
assert_that(cargo_home(), is_not(has_installed_exe("foo")));
5555
}
5656

57+
#[test]
58+
fn multiple_pkgs() {
59+
pkg("foo", "0.0.1");
60+
pkg("bar", "0.0.2");
61+
62+
assert_that(cargo_process("install").args(&["foo", "bar", "baz"]),
63+
execs().with_status(101).with_stderr(&format!("\
64+
[UPDATING] registry `[..]`
65+
[DOWNLOADING] foo v0.0.1 (registry file://[..])
66+
[INSTALLING] foo v0.0.1
67+
[COMPILING] foo v0.0.1
68+
[FINISHED] release [optimized] target(s) in [..]
69+
[INSTALLING] {home}[..]bin[..]foo[..]
70+
[DOWNLOADING] bar v0.0.2 (registry file://[..])
71+
[INSTALLING] bar v0.0.2
72+
[COMPILING] bar v0.0.2
73+
[FINISHED] release [optimized] target(s) in [..]
74+
[INSTALLING] {home}[..]bin[..]bar[..]
75+
error: could not find `baz` in `registry [..]`
76+
77+
Summary: Successfully installed foo, bar! Failed to install baz (see error(s) above).
78+
warning: be sure to add `[..]` to your PATH to be able to run the installed binaries
79+
error: some crates failed to install
80+
",
81+
home = cargo_home().display())));
82+
assert_that(cargo_home(), has_installed_exe("foo"));
83+
assert_that(cargo_home(), has_installed_exe("bar"));
84+
85+
assert_that(cargo_process("uninstall").arg("foo"),
86+
execs().with_status(0).with_stderr(&format!("\
87+
[REMOVING] {home}[..]bin[..]foo[..]
88+
",
89+
home = cargo_home().display())));
90+
assert_that(cargo_process("uninstall").arg("bar"),
91+
execs().with_status(0).with_stderr(&format!("\
92+
[REMOVING] {home}[..]bin[..]bar[..]
93+
",
94+
home = cargo_home().display())));
95+
assert_that(cargo_home(), is_not(has_installed_exe("foo")));
96+
assert_that(cargo_home(), is_not(has_installed_exe("bar")));
97+
}
98+
5799
#[test]
58100
fn pick_max_version() {
59101
pkg("foo", "0.0.1");

0 commit comments

Comments
 (0)