Move profile name and dir-name validation and gating to Toml level

Author: da-x

src/cargo/core/profiles.rs

@@ -6,7 +6,7 @@ use serde::Deserialize;
 
 use crate::core::compiler::{CompileMode, ProfileKind};
 use crate::core::interning::InternedString;
-use crate::core::{Feature, Features, PackageId, PackageIdSpec, PackageSet, Shell};
+use crate::core::{Features, PackageId, PackageIdSpec, PackageSet, Shell};
 use crate::util::errors::CargoResultExt;
 use crate::util::toml::{ProfilePackageSpec, StringOrBool, TomlProfile, TomlProfiles, U32OrBool};
 use crate::util::{closest_msg, CargoResult, Config};
@@ -54,33 +54,6 @@ impl Profiles {
             BTreeMap::new()
         };
 
-        // Feature gating and name validation
-        for (profile_name, profile) in &profiles {
-            match profile_name.as_str() {
-                "dev" | "release" | "bench" | "test" | "doc" | "check" => {
-                    match &profile.dir_name {
-                        None => {}
-                        Some(dir_name) => {
-                            features.require(Feature::named_profiles())?;
-                            validate_name(&dir_name, "dir-name")?;
-                        }
-                    }
-
-                    match &profile.inherits {
-                        None => {}
-                        Some(inherits) => {
-                            features.require(Feature::named_profiles())?;
-                            validate_name(&inherits, "inherits")?;
-                        }
-                    }
-                }
-                _ => {
-                    features.require(Feature::named_profiles())?;
-                    break;
-                }
-            }
-        }
-
         // Merge with predefined profiles
         use std::collections::btree_map::Entry;
         for (predef_name, mut predef_prof) in Self::predefined_profiles().into_iter() {
@@ -334,25 +307,6 @@ impl Profiles {
     }
 }
 
-/// Validate dir-names and profile names according to RFC 2678.
-pub fn validate_name(name: &str, what: &str) -> CargoResult<()> {
-    if let Some(ch) = name
-        .chars()
-        .find(|ch| !ch.is_alphanumeric() && *ch != '_' && *ch != '-')
-    {
-        failure::bail!("Invalid character `{}` in {}: `{}`", ch, what, name);
-    }
-
-    match name {
-        "package" | "build" | "debug" => {
-            failure::bail!("Invalid {}: `{}`", what, name);
-        }
-        _ => {}
-    }
-
-    Ok(())
-}
-
 /// An object used for handling the profile override hierarchy.
 ///
 /// The precedence of profiles are (first one wins):

src/cargo/util/command_prelude.rs

@@ -1,9 +1,9 @@
 use crate::core::compiler::{BuildConfig, MessageFormat};
-use crate::core::{profiles, Workspace};
+use crate::core::Workspace;
 use crate::ops::{CompileFilter, CompileOptions, NewOptions, Packages, VersionControl};
 use crate::sources::CRATES_IO_REGISTRY;
 use crate::util::important_paths::find_root_manifest_for_wd;
-use crate::util::{paths, validate_package_name};
+use crate::util::{paths, toml::TomlProfile, validate_package_name};
 use crate::util::{
     print_available_benches, print_available_binaries, print_available_examples,
     print_available_tests,
@@ -305,7 +305,7 @@ pub trait ArgMatchesExt {
             Some("dev") => Some(ProfileKind::Dev),
             Some("release") => Some(ProfileKind::Release),
             Some(name) => {
-                profiles::validate_name(name, "profile name")?;
+                TomlProfile::validate_name(name, "profile name")?;
                 Some(ProfileKind::Custom(name.to_string()))
             }
         };

src/cargo/util/toml/mod.rs

@@ -466,6 +466,39 @@ impl TomlProfile {
             }
         }
 
+        // Feature gate definition of named profiles
+        match name {
+            "dev" | "release" | "bench" | "test" | "doc" | "check" => {}
+            _ => {
+                features.require(Feature::named_profiles())?;
+            }
+        }
+
+        // Feature gate on uses of keys related to named profiles
+        if self.inherits.is_some() {
+            features.require(Feature::named_profiles())?;
+        }
+
+        if self.dir_name.is_some() { 
+            features.require(Feature::named_profiles())?;
+        }
+
+        // `dir-name` validation
+        match &self.dir_name {
+            None => {}
+            Some(dir_name) => {
+                Self::validate_name(&dir_name, "dir-name")?;
+            }
+        }
+
+        // `inherits` validation
+        match &self.inherits {
+            None => {}
+            Some(inherits) => {
+                Self::validate_name(&inherits, "inherits")?;
+            }
+        }
+
         match name {
             "doc" => {
                 warnings.push("profile `doc` is deprecated and has no effect".to_string());
@@ -490,6 +523,25 @@ impl TomlProfile {
         Ok(())
     }
 
+    /// Validate dir-names and profile names according to RFC 2678.
+    pub fn validate_name(name: &str, what: &str) -> CargoResult<()> {
+        if let Some(ch) = name
+            .chars()
+            .find(|ch| !ch.is_alphanumeric() && *ch != '_' && *ch != '-')
+        {
+            failure::bail!("Invalid character `{}` in {}: `{}`", ch, what, name);
+        }
+
+        match name {
+            "package" | "build" | "debug" => {
+                failure::bail!("Invalid {}: `{}`", what, name);
+            }
+            _ => {}
+        }
+
+        Ok(())
+    }
+
     fn validate_override(&self) -> CargoResult<()> {
         if self.overrides.is_some() || self.build_override.is_some() {
             bail!("Profile overrides cannot be nested.");