Skip to content

feat: treating required-feature as default feature for cli #16852

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.

Sign up for GitHub

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

Closed
cathaysia wants to merge 1 commit into from
Closed

feat: treating required-feature as default feature for cli #16852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
74 changes: 55 additions & 19 deletions src/cargo/core/workspace.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1548,7 +1548,7 @@ impl<'gctx> Workspace<'gctx> {
found_features: &mut BTreeSet<FeatureValue>,
) -> CliFeatures {
if cli_features.features.is_empty() {
return cli_features.clone();
return Workspace::with_default_bin_required_features(member, cli_features.clone());
}

// Only include features this member defines.
Expand Down Expand Up @@ -1613,11 +1613,41 @@ impl<'gctx> Workspace<'gctx> {
}
}
}
CliFeatures {
features: Rc::new(features),
all_features: cli_features.all_features,
uses_default_features: cli_features.uses_default_features,
Workspace::with_default_bin_required_features(
member,
CliFeatures {
features: Rc::new(features),
all_features: cli_features.all_features,
uses_default_features: cli_features.uses_default_features,
},
)
}

fn with_default_bin_required_features(
member: &Package,
mut cli_features: CliFeatures,
) -> CliFeatures {
if !cli_features.uses_default_features || cli_features.all_features {
return cli_features;
}

let mut features = (*cli_features.features).clone();
let original_len = features.len();
features.extend(
member
.targets()
.iter()
.filter(|target| target.is_bin())
.filter_map(|target| target.required_features())
.flatten()
.cloned()
.map(Into::into)
.map(FeatureValue::new),
);
if features.len() != original_len {
cli_features.features = Rc::new(features);
}
cli_features
}

fn missing_feature_spelling_suggestions(
Expand Down Expand Up @@ -1959,11 +1989,14 @@ impl<'gctx> Workspace<'gctx> {
// The features passed on the command-line only apply to
// the "current" package (determined by the cwd).
Some(current) if member_id == current.package_id() => {
let feats = CliFeatures {
features: Rc::new(cwd_features.clone()),
all_features: cli_features.all_features,
uses_default_features: cli_features.uses_default_features,
};
let feats = Workspace::with_default_bin_required_features(
member,
CliFeatures {
features: Rc::new(cwd_features.clone()),
all_features: cli_features.all_features,
uses_default_features: cli_features.uses_default_features,
},
);
Some((member, feats))
}
_ => {
Expand All @@ -1978,15 +2011,18 @@ impl<'gctx> Workspace<'gctx> {
// "current" package. As an extension, this allows
// member-name/feature-name to set member-specific
// features, which should be backwards-compatible.
let feats = CliFeatures {
features: Rc::new(
member_specific_features
.remove(member.name().as_str())
.unwrap_or_default(),
),
uses_default_features: true,
all_features: cli_features.all_features,
};
let feats = Workspace::with_default_bin_required_features(
member,
CliFeatures {
features: Rc::new(
member_specific_features
.remove(member.name().as_str())
.unwrap_or_default(),
),
uses_default_features: true,
all_features: cli_features.all_features,
},
);
Some((member, feats))
} else {
// This member was not requested on the command-line, skip.
Expand Down
40 changes: 36 additions & 4 deletions tests/testsuite/required_features.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,9 @@ fn build_bin_arg_features() {
.file("src/main.rs", "fn main() {}")
.build();

p.cargo("build").run();
assert!(p.bin("foo").is_file());

p.cargo("build --features a").run();
assert!(p.bin("foo").is_file());
}
Expand Down Expand Up @@ -124,14 +127,23 @@ fn build_bin_multiple_required_features() {

p.cargo("build").run();

assert!(!p.bin("foo_1").is_file());
assert!(p.bin("foo_1").is_file());
assert!(p.bin("foo_2").is_file());

p.cargo("build --features c").run();

assert!(p.bin("foo_1").is_file());
assert!(p.bin("foo_2").is_file());

p.cargo("build --bin=foo_1 --no-default-features")
.with_status(101)
.with_stderr_data(str![[r#"
[ERROR] target `foo_1` in package `foo` requires the features: `b`, `c`
Consider enabling them by passing, e.g., `--features="b c"`

"#]])
.run();

p.cargo("build --no-default-features").run();
}

Expand Down Expand Up @@ -819,6 +831,10 @@ fn install_arg_features() {
.file("src/main.rs", "fn main() {}")
.build();

p.cargo("install --path .").run();
assert_has_installed_exe(paths::cargo_home(), "foo");
p.cargo("uninstall foo").run();

p.cargo("install --features a").run();
assert_has_installed_exe(paths::cargo_home(), "foo");
p.cargo("uninstall foo").run();
Expand Down Expand Up @@ -870,16 +886,16 @@ fn install_multiple_required_features() {
.build();

p.cargo("install --path .").run();
assert_has_not_installed_exe(paths::cargo_home(), "foo_1");
assert_has_installed_exe(paths::cargo_home(), "foo_1");
assert_has_installed_exe(paths::cargo_home(), "foo_2");
assert_has_not_installed_exe(paths::cargo_home(), "foo_3");
assert_has_not_installed_exe(paths::cargo_home(), "foo_4");
p.cargo("uninstall foo").run();

p.cargo("install --path . --bins --examples").run();
assert_has_not_installed_exe(paths::cargo_home(), "foo_1");
assert_has_installed_exe(paths::cargo_home(), "foo_1");
assert_has_installed_exe(paths::cargo_home(), "foo_2");
assert_has_not_installed_exe(paths::cargo_home(), "foo_3");
assert_has_installed_exe(paths::cargo_home(), "foo_3");
assert_has_installed_exe(paths::cargo_home(), "foo_4");
p.cargo("uninstall foo").run();

Expand All @@ -890,6 +906,22 @@ fn install_multiple_required_features() {
assert_has_not_installed_exe(paths::cargo_home(), "foo_4");
p.cargo("uninstall foo").run();

p.cargo("install --path . --bin foo_1 --no-default-features")
.with_status(101)
.with_stderr_data(str![[r#"
[INSTALLING] foo v0.0.1 ([ROOT]/foo)
[ERROR] failed to compile `foo v0.0.1 ([ROOT]/foo)`, intermediate artifacts can be found at `[ROOT]/foo/target`.
To reuse those artifacts with a future compilation, set the environment variable `CARGO_BUILD_BUILD_DIR` to that path.

Caused by:
target `foo_1` in package `foo` requires the features: `b`, `c`
Consider enabling them by passing, e.g., `--features="b c"`

"#]])
.run();
assert_has_not_installed_exe(paths::cargo_home(), "foo_1");
assert_has_not_installed_exe(paths::cargo_home(), "foo_2");

p.cargo("install --path . --features c --bins --examples")
.run();
assert_has_installed_exe(paths::cargo_home(), "foo_1");
Expand Down
Loading