Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "--workspace" to update command #8725

Merged
merged 7 commits into from
Dec 2, 2020
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/bin/cargo/commands/update.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ pub fn cli() -> App {
subcommand("update")
.about("Update dependencies as recorded in the local lock file")
.arg(opt("quiet", "No output printed to stdout").short("q"))
.arg(opt("workspace", "Only update the workspace pakcages").short("w"))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.arg(opt("workspace", "Only update the workspace pakcages").short("w"))
.arg(opt("workspace", "Only update the workspace packages").short("w"))

.arg_package_spec_simple("Package to update")
.arg(opt(
"aggressive",
Expand All @@ -30,6 +31,7 @@ pub fn exec(config: &mut Config, args: &ArgMatches<'_>) -> CliResult {
precise: args.value_of("precise"),
to_update: values(args, "package"),
dry_run: args.is_present("dry-run"),
workspace: args.is_present("workspace"),
config,
};
ops::update_lockfile(&ws, &update_opts)?;
Expand Down
14 changes: 14 additions & 0 deletions src/cargo/ops/cargo_generate_lockfile.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ pub struct UpdateOptions<'a> {
pub precise: Option<&'a str>,
pub aggressive: bool,
pub dry_run: bool,
pub workspace: bool,
}

pub fn generate_lockfile(ws: &Workspace<'_>) -> CargoResult<()> {
Expand All @@ -35,6 +36,19 @@ pub fn generate_lockfile(ws: &Workspace<'_>) -> CargoResult<()> {
}

pub fn update_lockfile(ws: &Workspace<'_>, opts: &UpdateOptions<'_>) -> CargoResult<()> {
if opts.workspace {
if opts.aggressive {
anyhow::bail!("cannot specify aggressive for workspace updates");
}
if opts.precise.is_some() {
anyhow::bail!("cannot specify precise for workspace updates");
}

ws.emit_warnings()?;
let (_packages, _resolve) = ops::resolve_ws(ws)?;
return Ok(());
}

if opts.aggressive && opts.precise.is_some() {
anyhow::bail!("cannot specify both aggressive and precise simultaneously")
}
Expand Down
8 changes: 8 additions & 0 deletions src/doc/man/cargo-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ the package to. If the package comes from a git repository, this can be a git
revision (such as a SHA hash or tag).
{{/option}}

{{#option "`-w`" "`--workspace`" }}
Attempt to update only packages defined in the workspace. Other packages
are updated only if they don't already exist in the lockfile. This
option is useful for updating `Cargo.lock` after you've changed version
numbers in `Cargo.toml`.
Cannot be used with `--precise` or `--aggressive`.
{{/option}}

{{#option "`--dry-run`" }}
Displays what would be updated, but doesn't actually write the lockfile.
{{/option}}
Expand Down
7 changes: 7 additions & 0 deletions src/doc/man/generated_txt/cargo-update.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ OPTIONS
to set the package to. If the package comes from a git repository,
this can be a git revision (such as a SHA hash or tag).

-w, --workspace
Attempt to update only packages defined in the workspace. Other
packages are updated only if they don't already exist in the
lockfile. This option is useful for updating Cargo.lock after you've
changed version numbers in Cargo.toml. Cannot be used with --precise
or --aggressive.

--dry-run
Displays what would be updated, but doesn't actually write the
lockfile.
Expand Down
9 changes: 9 additions & 0 deletions src/doc/src/commands/cargo-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ the package to. If the package comes from a git repository, this can be a git
revision (such as a SHA hash or tag).</dd>


<dt class="option-term" id="option-cargo-update--w"><a class="option-anchor" href="#option-cargo-update--w"></a><code>-w</code></dt>
<dt class="option-term" id="option-cargo-update---workspace"><a class="option-anchor" href="#option-cargo-update---workspace"></a><code>--workspace</code></dt>
<dd class="option-desc">Attempt to update only packages defined in the workspace. Other packages
are updated only if they don't already exist in the lockfile. This
option is useful for updating <code>Cargo.lock</code> after you've changed version
numbers in <code>Cargo.toml</code>.
Cannot be used with <code>--precise</code> or <code>--aggressive</code>.</dd>


<dt class="option-term" id="option-cargo-update---dry-run"><a class="option-anchor" href="#option-cargo-update---dry-run"></a><code>--dry-run</code></dt>
<dd class="option-desc">Displays what would be updated, but doesn't actually write the lockfile.</dd>

Expand Down
10 changes: 10 additions & 0 deletions src/etc/man/cargo-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,16 @@ the package to. If the package comes from a git repository, this can be a git
revision (such as a SHA hash or tag).
.RE
.sp
\fB\-w\fR,
\fB\-\-workspace\fR
.RS 4
Attempt to update only packages defined in the workspace. Other packages
are updated only if they don't already exist in the lockfile. This
option is useful for updating \fBCargo.lock\fR after you've changed version
numbers in \fBCargo.toml\fR\&.
Cannot be used with \fB\-\-precise\fR or \fB\-\-aggressive\fR\&.
.RE
.sp
\fB\-\-dry\-run\fR
.RS 4
Displays what would be updated, but doesn't actually write the lockfile.
Expand Down
25 changes: 25 additions & 0 deletions tests/testsuite/update.rs
Original file line number Diff line number Diff line change
Expand Up @@ -649,3 +649,28 @@ fn dry_run_update() {
let new_lockfile = p.read_lockfile();
assert_eq!(old_lockfile, new_lockfile)
}

#[cargo_test]
fn workspace_only() {
let p = project().file("src/main.rs", "fn main() {}").build();
p.cargo("generate-lockfile").run();
let lock1 = p.read_lockfile();

p.change_file(
"Cargo.toml",
r#"
[package]
name = "foo"
authors = []
version = "0.0.2"
"#,
);
p.cargo("update --workspace").run();
let lock2 = p.read_lockfile();

assert_ne!(lock1, lock2);
assert!(lock1.contains("0.0.1"));
assert!(lock2.contains("0.0.2"));
assert!(!lock1.contains("0.0.2"));
assert!(!lock2.contains("0.0.1"));
}