Auto merge of #8758 - ebroto:cargo_primary_package, r=ehuss

Reinstate CARGO_PRIMARY_PACKAGE (take 2)

As discussed in [this Zulip thread](https://rust-lang.zulipchat.com/#narrow/stream/246057-t-cargo/topic/RUSTC_WORKSPACE_WRAPPER/near/212461098)

r? `@ehuss`

Author: bors

src/cargo/core/compiler/mod.rs

@@ -530,6 +530,11 @@ fn prepare_rustc(
     let mut base = cx
         .compilation
         .rustc_process(unit, is_primary, is_workspace)?;
+
+    if is_primary {
+        base.env("CARGO_PRIMARY_PACKAGE", "1");
+    }
+
     if cx.bcx.config.cli_unstable().jobserver_per_rustc {
         let client = cx.new_jobserver()?;
         base.inherit_jobserver(&client);

src/doc/src/reference/environment-variables.md

@@ -265,6 +265,12 @@ let out_dir = env::var("OUT_DIR").unwrap();
                       Currently Cargo doesn't set the `MAKEFLAGS` variable,
                       but it's free for build scripts invoking GNU Make
                       to set it to the contents of `CARGO_MAKEFLAGS`.
+* `CARGO_PRIMARY_PACKAGE` — This environment variable will be set if the package being
+                            built is primary. Primary packages are the ones the user 
+                            selected on the command-line, either with `-p` flags or 
+                            the defaults based on the current directory and the default 
+                            workspace members.
+                            This environment variable will not be set when building dependencies.
 * `CARGO_FEATURE_<name>` — For each activated feature of the package being
                            built, this environment variable will be present
                            where `<name>` is the name of the feature uppercased

tests/testsuite/build.rs

@@ -10,7 +10,7 @@ use cargo::{
 use cargo_test_support::paths::{root, CargoPathExt};
 use cargo_test_support::registry::Package;
 use cargo_test_support::{
-    basic_bin_manifest, basic_lib_manifest, basic_manifest, is_nightly, lines_match_unordered,
+    basic_bin_manifest, basic_lib_manifest, basic_manifest, git, is_nightly, lines_match_unordered,
     main_file, paths, project, rustc_host, sleep_ms, symlink_supported, t, Execs, ProjectBuilder,
 };
 use std::env;
@@ -5179,3 +5179,83 @@ fn build_script_o0_default_even_with_release() {
         .with_stderr_does_not_contain("[..]build_script_build[..]opt-level[..]")
         .run();
 }
+
+#[cargo_test]
+fn primary_package_env_var() {
+    // "foo" depends on "bar" (local) which depends on "baz" (git) which depends on "qux" (registry)
+    // Test that CARGO_PRIMARY_PACKAGE is enabled only for "foo".
+
+    Package::new("qux", "1.0.0")
+        .file("src/lib.rs", "")
+        .publish();
+
+    let baz = git::new("baz", |project| {
+        project
+            .file(
+                "Cargo.toml",
+                r#"
+        [package]
+        name = "baz"
+        version = "1.0.0"
+
+        [dependencies]
+        qux = "1.0"
+    "#,
+            )
+            .file("src/lib.rs", "extern crate qux;")
+    });
+
+    let foo = project()
+        .file(
+            "Cargo.toml",
+            r#"
+        [package]
+        name = "foo"
+        version = "1.0.0"
+
+        [dependencies]
+        bar = {path = "bar"}
+"#,
+        )
+        .file("src/lib.rs", "extern crate bar;")
+        .file(
+            "bar/Cargo.toml",
+            &format!(
+                r#"
+        [package]
+        name = "bar"
+        version = "1.0.0"
+
+        [dependencies]
+        baz = {{ git = '{}' }}
+    "#,
+                baz.url()
+            ),
+        )
+        .file("bar/src/lib.rs", "extern crate baz;")
+        .build();
+
+    foo.cargo("build -vv")
+        .with_stderr_contains("[COMPILING] qux[..]")
+        .with_stderr_line_without(
+            &["[RUNNING]", "CARGO_CRATE_NAME=qux"],
+            &["CARGO_PRIMARY_PACKAGE=1"],
+        )
+        .with_stderr_contains("[COMPILING] baz[..]")
+        .with_stderr_line_without(
+            &["[RUNNING]", "CARGO_CRATE_NAME=baz"],
+            &["CARGO_PRIMARY_PACKAGE=1"],
+        )
+        .with_stderr_contains("[COMPILING] bar[..]")
+        .with_stderr_line_without(
+            &["[RUNNING]", "CARGO_CRATE_NAME=bar"],
+            &["CARGO_PRIMARY_PACKAGE=1"],
+        )
+        .with_stderr_contains(
+            "\
+[COMPILING] foo[..]
+[RUNNING] [..] CARGO_CRATE_NAME=foo [..] CARGO_PRIMARY_PACKAGE=1 [..]
+[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]",
+        )
+        .run();
+}

tests/testsuite/workspaces.rs

@@ -2319,3 +2319,92 @@ Caused by:
         )
         .run();
 }
+
+#[cargo_test]
+fn simple_primary_package_env_var() {
+    let p = project()
+        .file(
+            "Cargo.toml",
+            r#"
+                [project]
+                name = "foo"
+                version = "0.1.0"
+                authors = []
+
+                [workspace]
+                members = ["bar"]
+            "#,
+        )
+        .file("src/main.rs", "fn main() {}")
+        .file(
+            "bar/Cargo.toml",
+            r#"
+                [project]
+                name = "bar"
+                version = "0.1.0"
+                authors = []
+                workspace = ".."
+            "#,
+        )
+        .file("bar/src/main.rs", "fn main() {}");
+    let p = p.build();
+
+    p.cargo("build -vv")
+        .with_stderr_contains(
+            "[RUNNING] [..] CARGO_CRATE_NAME=foo [..] CARGO_PRIMARY_PACKAGE=1 [..]",
+        )
+        .run();
+
+    // Again, this time selecting a specific crate
+    p.cargo("clean").run();
+    p.cargo("build -vv -p bar")
+        .with_stderr_contains(
+            "[RUNNING] [..] CARGO_CRATE_NAME=bar [..] CARGO_PRIMARY_PACKAGE=1 [..]",
+        )
+        .run();
+
+    // Again, this time selecting all crates
+    p.cargo("clean").run();
+    p.cargo("build -vv --all")
+        .with_stderr_contains(
+            "[RUNNING] [..] CARGO_CRATE_NAME=foo [..] CARGO_PRIMARY_PACKAGE=1 [..]",
+        )
+        .with_stderr_contains(
+            "[RUNNING] [..] CARGO_CRATE_NAME=bar [..] CARGO_PRIMARY_PACKAGE=1 [..]",
+        )
+        .run();
+}
+
+#[cargo_test]
+fn virtual_primary_package_env_var() {
+    let p = project()
+        .file(
+            "Cargo.toml",
+            r#"
+                [workspace]
+                members = ["foo", "bar"]
+            "#,
+        )
+        .file("foo/Cargo.toml", &basic_manifest("foo", "0.1.0"))
+        .file("foo/src/main.rs", "fn main() {}")
+        .file("bar/Cargo.toml", &basic_manifest("bar", "0.1.0"))
+        .file("bar/src/main.rs", "fn main() {}");
+    let p = p.build();
+
+    p.cargo("build -vv")
+        .with_stderr_contains(
+            "[RUNNING] [..] CARGO_CRATE_NAME=foo [..] CARGO_PRIMARY_PACKAGE=1 [..]",
+        )
+        .with_stderr_contains(
+            "[RUNNING] [..] CARGO_CRATE_NAME=bar [..] CARGO_PRIMARY_PACKAGE=1 [..]",
+        )
+        .run();
+
+    // Again, this time selecting a specific crate
+    p.cargo("clean").run();
+    p.cargo("build -vv -p foo")
+        .with_stderr_contains(
+            "[RUNNING] [..] CARGO_CRATE_NAME=foo [..] CARGO_PRIMARY_PACKAGE=1 [..]",
+        )
+        .run();
+}