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.

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

Jump to bottom

Allow only specified optional dependencies to be considered as features #51

Merged
merged 1 commit into from
Sep 18, 2020
Merged

Allow only specified optional dependencies to be considered as features #51

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
49 changes: 33 additions & 16 deletions src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const HELP: &[(&str, &str, &str, &[&str])] = &[
("", "--workspace", "Perform command for all packages in the workspace", &[]),
("", "--exclude <SPEC>...", "Exclude packages from the check", &[]),
("", "--manifest-path <PATH>", "Path to Cargo.toml", &[]),
("", "--features <FEATURES>", "Space-separated list of features to activate", &[]),
("", "--features <FEATURES>...", "Space-separated list of features to activate", &[]),
(
"",
"--each-feature",
Expand All @@ -28,10 +28,11 @@ const HELP: &[(&str, &str, &str, &[&str])] = &[
"Perform for the feature powerset which includes --no-default-features flag and default features of the package",
&[],
),
("", "--optional-deps", "Use optional dependencies as features", &[
("", "--optional-deps [DEPS]...", "Use optional dependencies as features", &[
"If DEPS are not specified, all optional dependencies are considered as features.",
"This flag can only be used with either --each-feature flag or --feature-powerset flag.",
]),
("", "--skip <FEATURES>", "Space-separated list of features to skip", &[
("", "--skip <FEATURES>...", "Space-separated list of features to skip", &[
"To skip run of default feature, using value `--skip default`.",
"This flag can only be used with either --each-feature flag or --feature-powerset flag.",
]),
Expand Down Expand Up @@ -181,8 +182,8 @@ pub(crate) struct Args {
pub(crate) ignore_private: bool,
/// --ignore-unknown-features, (--ignore-non-exist-features)
pub(crate) ignore_unknown_features: bool,
/// --optional-deps
pub(crate) optional_deps: bool,
/// --optional-deps [DEPS]...
pub(crate) optional_deps: Option<Vec<String>>,
/// --skip-no-default-features
pub(crate) skip_no_default_features: bool,
/// --clean-per-run
Expand All @@ -205,7 +206,7 @@ pub(crate) enum Coloring {
}

impl Coloring {
pub(crate) fn color_choice(color: Option<Coloring>) -> ColorChoice {
pub(crate) fn color_choice(color: Option<Self>) -> ColorChoice {
match color {
Some(Coloring::Auto) | None => ColorChoice::Auto,
Some(Coloring::Always) => ColorChoice::Always,
Expand Down Expand Up @@ -236,7 +237,7 @@ impl FromStr for Coloring {
}

pub(crate) fn args(coloring: &mut Option<Coloring>) -> Result<Option<Args>> {
let mut args = env::args();
let mut args = env::args().peekable();
let _ = args.next(); // executable name
match &args.next() {
Some(a) if a == "hack" => {}
Expand All @@ -256,6 +257,7 @@ pub(crate) fn args(coloring: &mut Option<Coloring>) -> Result<Option<Args>> {
let mut exclude = Vec::new();
let mut features = Vec::new();
let mut skip = Vec::new();
let mut optional_deps = None;

let mut workspace = None;
let mut no_dev_deps = false;
Expand All @@ -265,7 +267,6 @@ pub(crate) fn args(coloring: &mut Option<Coloring>) -> Result<Option<Args>> {
let mut ignore_private = false;
let mut ignore_unknown_features = false;
let mut ignore_non_exist_features = false;
let mut optional_deps = false;
let mut skip_no_default_features = false;
let mut clean_per_run = false;

Expand Down Expand Up @@ -322,8 +323,11 @@ pub(crate) fn args(coloring: &mut Option<Coloring>) -> Result<Option<Args>> {
}

macro_rules! parse_multi_opt {
($v:ident, $allow_split:expr, $pat:expr, $help:expr) => {
($v:ident, $allow_split:expr, $require_value:expr, $pat:expr, $help:expr) => {
if arg == $pat {
if !$require_value && args.peek().map_or(true, |s| s.starts_with('-')) {
continue;
}
let arg = args.next().ok_or_else(|| req_arg($help, subcommand.as_ref()))?;
if $allow_split {
if arg.contains(',') {
Expand Down Expand Up @@ -370,11 +374,25 @@ pub(crate) fn args(coloring: &mut Option<Coloring>) -> Result<Option<Args>> {
parse_opt!(manifest_path, false, "--manifest-path", "--manifest-path <PATH>");
parse_opt!(color, true, "--color", "--color <WHEN>");

parse_multi_opt!(package, false, "--package", "--package <SPEC>");
parse_multi_opt!(package, false, "-p", "--package <SPEC>");
parse_multi_opt!(exclude, false, "--exclude", "--exclude <SPEC>");
parse_multi_opt!(features, true, "--features", "--features <FEATURES>");
parse_multi_opt!(skip, true, "--skip", "--skip <FEATURES>");
parse_multi_opt!(package, false, true, "--package", "--package <SPEC>...");
parse_multi_opt!(package, false, true, "-p", "--package <SPEC>...");
parse_multi_opt!(exclude, false, true, "--exclude", "--exclude <SPEC>...");
parse_multi_opt!(features, true, true, "--features", "--features <FEATURES>...");
parse_multi_opt!(skip, true, true, "--skip", "--skip <FEATURES>...");

if arg.starts_with("--optional-deps") {
if optional_deps.is_some() {
return Err(multi_arg(&arg, subcommand.as_ref()));
}
let optional_deps = optional_deps.get_or_insert_with(Vec::new);
parse_multi_opt!(
optional_deps,
true,
false,
"--optional-deps",
"--optional-deps [DEPS]..."
);
}

match arg.as_str() {
"--workspace" | "--all" => {
Expand All @@ -387,7 +405,6 @@ pub(crate) fn args(coloring: &mut Option<Coloring>) -> Result<Option<Args>> {
"--each-feature" => parse_flag!(each_feature),
"--feature-powerset" => parse_flag!(feature_powerset),
"--ignore-private" => parse_flag!(ignore_private),
"--optional-deps" => parse_flag!(optional_deps),
"--skip-no-default-features" => parse_flag!(skip_no_default_features),
"--clean-per-run" => parse_flag!(clean_per_run),
"--ignore-unknown-features" => {
Expand Down Expand Up @@ -434,7 +451,7 @@ pub(crate) fn args(coloring: &mut Option<Coloring>) -> Result<Option<Args>> {
if !each_feature && !feature_powerset {
if !skip.is_empty() {
bail!("--skip can only be used with either --each-feature or --feature-powerset");
} else if optional_deps {
} else if optional_deps.is_some() {
bail!(
"--optional-deps can only be used with either --each-feature or --feature-powerset"
);
Expand Down
1 change: 1 addition & 0 deletions src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ fn exec_on_package(
} else {
let mut line = line.clone();
line.features(args, package);

line.arg("--manifest-path");
line.arg(&package.manifest_path);

Expand Down
21 changes: 9 additions & 12 deletions src/package.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
use std::{ffi::OsStr, fmt::Write, ops::Deref};

use crate::{metadata, Args, Info, Manifest, ProcessBuilder, Result};
use crate::{
metadata::{self, Dependency},
Args, Info, Manifest, ProcessBuilder, Result,
};

pub(crate) struct Package<'a> {
package: &'a metadata::Package,
Expand Down Expand Up @@ -61,17 +64,11 @@ impl<'a> Kind<'a> {

let features =
package.features.keys().filter(|f| *f != "default" && !args.skip.contains(f));
let opt_deps = if args.optional_deps {
Some(
package
.dependencies
.iter()
.filter_map(|dep| dep.as_feature())
.filter(|f| !args.skip.contains(f)),
)
} else {
None
};
let opt_deps = args.optional_deps.as_ref().map(|opt_deps| {
package.dependencies.iter().filter_map(Dependency::as_feature).filter(move |f| {
!args.skip.contains(f) && (opt_deps.is_empty() || opt_deps.contains(f))
})
});

if args.each_feature {
let features: Vec<_> = if let Some(opt_deps) = opt_deps {
Expand Down
8 changes: 5 additions & 3 deletions tests/long-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ OPTIONS:
--manifest-path <PATH>
Path to Cargo.toml.

--features <FEATURES>
--features <FEATURES>...
Space-separated list of features to activate.

--each-feature
Expand All @@ -32,12 +32,14 @@ OPTIONS:
--feature-powerset
Perform for the feature powerset which includes --no-default-features flag and default features of the package.

--optional-deps
--optional-deps [DEPS]...
Use optional dependencies as features.

If DEPS are not specified, all optional dependencies are considered as features.

This flag can only be used with either --each-feature flag or --feature-powerset flag.

--skip <FEATURES>
--skip <FEATURES>...
Space-separated list of features to skip.

To skip run of default feature, using value `--skip default`.
Expand Down
6 changes: 3 additions & 3 deletions tests/short-help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ OPTIONS:
--workspace Perform command for all packages in the workspace
--exclude <SPEC>... Exclude packages from the check
--manifest-path <PATH> Path to Cargo.toml
--features <FEATURES> Space-separated list of features to activate
--features <FEATURES>... Space-separated list of features to activate
--each-feature Perform for each feature which includes --no-default-features flag and default features of the package
--feature-powerset Perform for the feature powerset which includes --no-default-features flag and default features of the package
--optional-deps Use optional dependencies as features
--skip <FEATURES> Space-separated list of features to skip
--optional-deps [DEPS]... Use optional dependencies as features
--skip <FEATURES>... Space-separated list of features to skip
--skip-no-default-features Skip run of just --no-default-features flag
--no-dev-deps Perform without dev-dependencies
--remove-dev-deps Equivalent to --no-dev-deps flag except for does not restore the original `Cargo.toml` after performed
Expand Down
48 changes: 48 additions & 0 deletions tests/test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ impl Output {
fn stdout(&self) -> Cow<'_, str> {
String::from_utf8_lossy(&self.stdout)
}

fn stderr(&self) -> Cow<'_, str> {
String::from_utf8_lossy(&self.stderr)
}

fn assert_success(&self) -> &Self {
if !self.status.success() {
panic!(
Expand All @@ -51,6 +53,7 @@ impl Output {
}
self
}

fn assert_stderr_contains(&self, pat: &str) -> &Self {
if !self.stderr().contains(pat) {
panic!(
Expand All @@ -61,6 +64,7 @@ impl Output {
}
self
}

fn assert_stderr_not_contains(&self, pat: &str) -> &Self {
if self.stderr().contains(pat) {
panic!(
Expand All @@ -71,6 +75,7 @@ impl Output {
}
self
}

fn assert_stdout_contains(&self, pat: &str) -> &Self {
if !self.stdout().contains(pat) {
panic!(
Expand All @@ -81,6 +86,7 @@ impl Output {
}
self
}

fn assert_stdout_not_contains(&self, pat: &str) -> &Self {
if self.stdout().contains(pat) {
panic!(
Expand Down Expand Up @@ -829,6 +835,48 @@ fn optional_deps() {
.assert_stderr_contains(
"running `cargo check --no-default-features --features renemed` on optional_deps (4/4)",
);

cargo_hack()
.args(&["check", "--each-feature", "--optional-deps", "real"])
.current_dir(test_dir("tests/fixtures/optional_deps"))
.output()
.unwrap()
.assert_success()
.assert_stderr_contains("running `cargo check` on optional_deps (1/3)")
.assert_stderr_contains(
"running `cargo check --no-default-features` on optional_deps (2/3)",
)
.assert_stderr_contains(
"running `cargo check --no-default-features --features real` on optional_deps (3/3)",
)
.assert_stderr_not_contains(
"running `cargo check --no-default-features --features renemed` on optional_deps",
);

cargo_hack()
.args(&["check", "--each-feature", "--optional-deps=renemed"])
.current_dir(test_dir("tests/fixtures/optional_deps"))
.output()
.unwrap()
.assert_success()
.assert_stderr_contains("running `cargo check` on optional_deps (1/3)")
.assert_stderr_contains(
"running `cargo check --no-default-features` on optional_deps (2/3)",
)
.assert_stderr_not_contains(
"running `cargo check --no-default-features --features real` on optional_deps",
)
.assert_stderr_contains(
"running `cargo check --no-default-features --features renemed` on optional_deps (3/3)",
);

cargo_hack()
.args(&["check", "--each-feature", "--optional-deps="])
.current_dir(test_dir("tests/fixtures/optional_deps"))
.output()
.unwrap()
.assert_success()
.assert_stderr_contains("running `cargo check` on optional_deps (1/1)");
}

#[test]
Expand Down