Auto merge of #13011 - Urgau:check-cfg-zero-features, r=weihanglo

bors · bors · commit 79acbdb6366b · 2023-11-20T14:13:39.000Z
Fix `--check-cfg` invocations with zero features

When generating the `--check-cfg` arguments for `-Zcheck-cfg` we currently generate `cfg(feature, values())` when there is 0 features. This is wrong since a empty `values()` would mean that it's possible to have `cfg(feature)` without a feature name which is impossible.

We replace this by a simple `cfg()` to still enable well known names and values.

----

Note that currently `rustc` defines `feature` as a well known name with ANY values if it's not overridden by Cargo. I plan on submitting a PR to `rustc` to remove `feature` from being a well known name so that Cargo is the only source of truth.

*This doesn't block this PR from being merged*
diff --git a/src/cargo/core/compiler/mod.rs b/src/cargo/core/compiler/mod.rs
@@ -1243,24 +1243,31 @@ fn trim_paths_args(
 fn check_cfg_args(cx: &Context<'_, '_>, unit: &Unit) -> Vec<OsString> {
     if cx.bcx.config.cli_unstable().check_cfg {
         // This generate something like this:
-        //  - cfg(feature, values())
+        //  - cfg()
         //  - cfg(feature, values("foo", "bar"))
         //
         // NOTE: Despite only explicitly specifying `feature`, well known names and values
         // are implicitly enabled when one or more `--check-cfg` argument is passed.
+        // NOTE: Never generate a empty `values()` since it would mean that it's possible
+        // to have `cfg(feature)` without a feature name which is impossible.
 
         let gross_cap_estimation = unit.pkg.summary().features().len() * 7 + 25;
         let mut arg_feature = OsString::with_capacity(gross_cap_estimation);
-        arg_feature.push("cfg(feature, values(");
-        for (i, feature) in unit.pkg.summary().features().keys().enumerate() {
-            if i != 0 {
-                arg_feature.push(", ");
+
+        arg_feature.push("cfg(");
+        if !unit.pkg.summary().features().is_empty() {
+            arg_feature.push("feature, values(");
+            for (i, feature) in unit.pkg.summary().features().keys().enumerate() {
+                if i != 0 {
+                    arg_feature.push(", ");
+                }
+                arg_feature.push("\"");
+                arg_feature.push(feature);
+                arg_feature.push("\"");
             }
-            arg_feature.push("\"");
-            arg_feature.push(feature);
-            arg_feature.push("\"");
+            arg_feature.push(")");
         }
-        arg_feature.push("))");
+        arg_feature.push(")");
 
         vec![
             OsString::from("-Zunstable-options"),
diff --git a/tests/testsuite/check_cfg.rs b/tests/testsuite/check_cfg.rs
@@ -15,16 +15,16 @@ macro_rules! x {
                     $what, '(', $($who,)* ')', "'", "[..]")
         }
     }};
-    ($tool:tt => $what:tt of $who:tt with $($first_value:tt $($other_values:tt)*)?) => {{
+    ($tool:tt => $what:tt of $who:tt with $first_value:tt $($other_values:tt)*) => {{
         #[cfg(windows)]
         {
             concat!("[RUNNING] [..]", $tool, "[..] --check-cfg \"",
-                    $what, '(', $who, ", values(", $("/\"", $first_value, "/\"", $(", ", "/\"", $other_values, "/\"",)*)* "))", '"', "[..]")
+                    $what, '(', $who, ", values(", "/\"", $first_value, "/\"", $(", ", "/\"", $other_values, "/\"",)* "))", '"', "[..]")
         }
         #[cfg(not(windows))]
         {
             concat!("[RUNNING] [..]", $tool, "[..] --check-cfg '",
-                    $what, '(', $who, ", values(", $("\"", $first_value, "\"", $(", ", "\"", $other_values, "\"",)*)* "))", "'", "[..]")
+                    $what, '(', $who, ", values(", "\"", $first_value, "\"", $(", ", "\"", $other_values, "\"",)* "))", "'", "[..]")
         }
     }};
 }
@@ -150,7 +150,7 @@ fn well_known_names_values() {
 
     p.cargo("check -v -Zcheck-cfg")
         .masquerade_as_nightly_cargo(&["check-cfg"])
-        .with_stderr_contains(x!("rustc" => "cfg" of "feature" with))
+        .with_stderr_contains(x!("rustc" => "cfg"))
         .run();
 }
 
@@ -213,7 +213,7 @@ fn well_known_names_values_test() {
 
     p.cargo("test -v -Zcheck-cfg")
         .masquerade_as_nightly_cargo(&["check-cfg"])
-        .with_stderr_contains(x!("rustc" => "cfg" of "feature" with))
+        .with_stderr_contains(x!("rustc" => "cfg"))
         .run();
 }
 
@@ -226,8 +226,8 @@ fn well_known_names_values_doctest() {
 
     p.cargo("test -v --doc -Zcheck-cfg")
         .masquerade_as_nightly_cargo(&["check-cfg"])
-        .with_stderr_contains(x!("rustc" => "cfg" of "feature" with))
-        .with_stderr_contains(x!("rustdoc" => "cfg" of "feature" with))
+        .with_stderr_contains(x!("rustc" => "cfg"))
+        .with_stderr_contains(x!("rustdoc" => "cfg"))
         .run();
 }
 

Original file line number	Diff line number	Diff line change
`@@ -15,16 +15,16 @@ macro_rules! x {`
`15`	`15`	`$what, '(', $($who,)* ')', "'", "[..]")`
`16`	`16`	`}`
`17`	`17`	`}};`
`18`		`- ($tool:tt => $what:tt of $who:tt with $($first_value:tt $($other_values:tt)*)?) => {{`
	`18`	`+ ($tool:tt => $what:tt of $who:tt with $first_value:tt $($other_values:tt)*) => {{`
`19`	`19`	`#[cfg(windows)]`
`20`	`20`	`{`
`21`	`21`	`concat!("[RUNNING] [..]", $tool, "[..] --check-cfg \"",`
`22`		`- $what, '(', $who, ", values(", $("/\"", $first_value, "/\"", $(", ", "/\"", $other_values, "/\"",)) "))", '"', "[..]")`
	`22`	`+ $what, '(', $who, ", values(", "/\"", $first_value, "/\"", $(", ", "/\"", $other_values, "/\"",)* "))", '"', "[..]")`
`23`	`23`	`}`
`24`	`24`	`#[cfg(not(windows))]`
`25`	`25`	`{`
`26`	`26`	`concat!("[RUNNING] [..]", $tool, "[..] --check-cfg '",`
`27`		`- $what, '(', $who, ", values(", $("\"", $first_value, "\"", $(", ", "\"", $other_values, "\"",)) "))", "'", "[..]")`
	`27`	`+ $what, '(', $who, ", values(", "\"", $first_value, "\"", $(", ", "\"", $other_values, "\"",)* "))", "'", "[..]")`
`28`	`28`	`}`
`29`	`29`	`}};`
`30`	`30`	`}`
`@@ -150,7 +150,7 @@ fn well_known_names_values() {`
`150`	`150`
`151`	`151`	`p.cargo("check -v -Zcheck-cfg")`
`152`	`152`	`.masquerade_as_nightly_cargo(&["check-cfg"])`
`153`		`- .with_stderr_contains(x!("rustc" => "cfg" of "feature" with))`
	`153`	`+ .with_stderr_contains(x!("rustc" => "cfg"))`
`154`	`154`	`.run();`
`155`	`155`	`}`
`156`	`156`
`@@ -213,7 +213,7 @@ fn well_known_names_values_test() {`
`213`	`213`
`214`	`214`	`p.cargo("test -v -Zcheck-cfg")`
`215`	`215`	`.masquerade_as_nightly_cargo(&["check-cfg"])`
`216`		`- .with_stderr_contains(x!("rustc" => "cfg" of "feature" with))`
	`216`	`+ .with_stderr_contains(x!("rustc" => "cfg"))`
`217`	`217`	`.run();`
`218`	`218`	`}`
`219`	`219`
`@@ -226,8 +226,8 @@ fn well_known_names_values_doctest() {`
`226`	`226`
`227`	`227`	`p.cargo("test -v --doc -Zcheck-cfg")`
`228`	`228`	`.masquerade_as_nightly_cargo(&["check-cfg"])`
`229`		`- .with_stderr_contains(x!("rustc" => "cfg" of "feature" with))`
`230`		`- .with_stderr_contains(x!("rustdoc" => "cfg" of "feature" with))`
	`229`	`+ .with_stderr_contains(x!("rustc" => "cfg"))`
	`230`	`+ .with_stderr_contains(x!("rustdoc" => "cfg"))`
`231`	`231`	`.run();`
`232`	`232`	`}`
`233`	`233`