Guard sbom logic behind unstable feature

Author: justahero

src/cargo/core/compiler/build_config.rs

@@ -104,11 +104,16 @@ impl BuildConfig {
             anyhow::bail!("-Zbuild-std requires --target");
         }
 
+        // If sbom flag is set, it requires the unstable feature
         let sbom = match gctx.get_env_os("CARGO_BUILD_SBOM") {
             Some(sbom) => sbom == "true",
             None => cfg.sbom == Some(true),
         };
 
+        if sbom && !gctx.cli_unstable().sbom {
+            anyhow::bail!("Cargo build config 'sbom' is unstable; pass `-Zsbom` to enable it");
+        }
+
         Ok(BuildConfig {
             requested_kinds,
             jobs,

src/cargo/core/compiler/mod.rs

@@ -674,9 +674,9 @@ where
 /// completion of other units will be added later in runtime, such as flags
 /// from build scripts.
 fn prepare_rustc(build_runner: &BuildRunner<'_, '_>, unit: &Unit) -> CargoResult<ProcessBuilder> {
+    let gctx = build_runner.bcx.gctx;
     let is_primary = build_runner.is_primary_package(unit);
     let is_workspace = build_runner.bcx.ws.is_member(&unit.pkg);
-    let sbom = build_runner.bcx.build_config.sbom;
 
     let mut base = build_runner
         .compilation
@@ -687,14 +687,14 @@ fn prepare_rustc(build_runner: &BuildRunner<'_, '_>, unit: &Unit) -> CargoResult
     build_deps_args(&mut base, build_runner, unit)?;
     add_cap_lints(build_runner.bcx, unit, &mut base);
     base.args(build_runner.bcx.rustflags_args(unit));
-    if build_runner.bcx.gctx.cli_unstable().binary_dep_depinfo {
+    if gctx.cli_unstable().binary_dep_depinfo {
         base.arg("-Z").arg("binary-dep-depinfo");
     }
 
     if is_primary {
         base.env("CARGO_PRIMARY_PACKAGE", "1");
 
-        if sbom {
+        if gctx.cli_unstable().sbom && build_runner.bcx.build_config.sbom {
             let file_list = build_runner
                 .sbom_output_files(unit)?
                 .iter()

src/cargo/core/features.rs

@@ -773,6 +773,7 @@ unstable_cli_options!(
     publish_timeout: bool = ("Enable the `publish.timeout` key in .cargo/config.toml file"),
     rustdoc_map: bool = ("Allow passing external documentation mappings to rustdoc"),
     rustdoc_scrape_examples: bool = ("Allows Rustdoc to scrape code examples from reverse-dependencies"),
+    sbom: bool = ("Enable the `sbom` option in build config in .cargo/config.toml file"),
     script: bool = ("Enable support for single-file, `.rs` packages"),
     separate_nightlies: bool,
     skip_rustdoc_fingerprint: bool,
@@ -1155,9 +1156,10 @@ impl CliUnstable {
             "publish-timeout" => self.publish_timeout = parse_empty(k, v)?,
             "rustdoc-map" => self.rustdoc_map = parse_empty(k, v)?,
             "rustdoc-scrape-examples" => self.rustdoc_scrape_examples = parse_empty(k, v)?,
+            "sbom" => self.sbom = parse_empty(k, v)?,
+            "script" => self.script = parse_empty(k, v)?,
             "separate-nightlies" => self.separate_nightlies = parse_empty(k, v)?,
             "skip-rustdoc-fingerprint" => self.skip_rustdoc_fingerprint = parse_empty(k, v)?,
-            "script" => self.script = parse_empty(k, v)?,
             "target-applies-to-host" => self.target_applies_to_host = parse_empty(k, v)?,
             "unstable-options" => self.unstable_options = parse_empty(k, v)?,
             _ => bail!("\

src/cargo/util/context/mod.rs

@@ -2581,6 +2581,7 @@ pub struct CargoBuildConfig {
     pub rustc: Option<ConfigRelativePath>,
     pub rustdoc: Option<ConfigRelativePath>,
     pub out_dir: Option<ConfigRelativePath>,
+    /// Unstable feature `-Zsbom`.
     pub sbom: Option<bool>,
 }
 

tests/testsuite/cargo/z_help/stdout.term.svg

@@ -34,7 +34,9 @@ fn build_sbom_using_cargo_config() {
         .file("src/main.rs", r#"fn main() {}"#)
         .build();
 
-    p.cargo("build").run();
+    p.cargo("build -Zsbom")
+        .masquerade_as_nightly_cargo(&["sbom"])
+        .run();
 
     let file = p.bin("foo").with_extension("cargo-sbom.json");
     assert!(file.is_file());
@@ -47,7 +49,10 @@ fn build_sbom_using_env_var() {
         .file("src/foo.rs", r#"fn main() {}"#)
         .build();
 
-    p.cargo("build").env("CARGO_BUILD_SBOM", "true").run();
+    p.cargo("build -Zsbom")
+        .env("CARGO_BUILD_SBOM", "true")
+        .masquerade_as_nightly_cargo(&["sbom"])
+        .run();
 
     let file = p.bin("foo").with_extension("cargo-sbom.json");
     assert!(file.is_file());
@@ -72,7 +77,10 @@ fn build_sbom_project_bin_and_lib() {
         .file("src/lib.rs", r#"pub fn give_five() -> i32 { 5 }"#)
         .build();
 
-    p.cargo("build").stream().run();
+    p.cargo("build -Zsbom")
+        .stream()
+        .masquerade_as_nightly_cargo(&["sbom"])
+        .run();
 
     assert!(p.bin("foo").with_extension("cargo-sbom.json").is_file());
     assert_eq!(
@@ -102,7 +110,10 @@ fn build_sbom_with_simple_build_script() {
         )
         .build();
 
-    p.cargo("build").stream().run();
+    p.cargo("build -Zsbom")
+        .stream()
+        .masquerade_as_nightly_cargo(&["sbom"])
+        .run();
 
     let path = p.bin("foo").with_extension("cargo-sbom.json");
     assert!(path.is_file());