refactor(toml): Pull out profile name validation

epage · epage · commit 2a314c764256 · 2023-11-08T13:25:55.000-06:00
It now lives with other name validation logic.
diff --git a/src/cargo/util/command_prelude.rs b/src/cargo/util/command_prelude.rs
@@ -6,9 +6,8 @@ use crate::ops::{CompileFilter, CompileOptions, NewOptions, Packages, VersionCon
 use crate::util::important_paths::find_root_manifest_for_wd;
 use crate::util::interning::InternedString;
 use crate::util::is_rustup;
-use crate::util::restricted_names::is_glob_pattern;
-use crate::util::toml::schema::{StringOrVec, TomlProfile};
-use crate::util::validate_package_name;
+use crate::util::restricted_names;
+use crate::util::toml::schema::StringOrVec;
 use crate::util::{
     print_available_benches, print_available_binaries, print_available_examples,
     print_available_packages, print_available_tests,
@@ -607,7 +606,7 @@ Run `{cmd}` to see possible targets."
                 bail!("profile `doc` is reserved and not allowed to be explicitly specified")
             }
             (_, _, Some(name)) => {
-                TomlProfile::validate_name(name)?;
+                restricted_names::validate_profile_name(name)?;
                 name
             }
         };
@@ -801,7 +800,7 @@ Run `{cmd}` to see possible targets."
     ) -> CargoResult<CompileOptions> {
         let mut compile_opts = self.compile_options(config, mode, workspace, profile_checking)?;
         let spec = self._values_of("package");
-        if spec.iter().any(is_glob_pattern) {
+        if spec.iter().any(restricted_names::is_glob_pattern) {
             anyhow::bail!("Glob patterns on package selection are not supported.")
         }
         compile_opts.spec = Packages::Packages(spec);
@@ -835,7 +834,7 @@ Run `{cmd}` to see possible targets."
             (None, None) => config.default_registry()?.map(RegistryOrIndex::Registry),
             (None, Some(i)) => Some(RegistryOrIndex::Index(i.into_url()?)),
             (Some(r), None) => {
-                validate_package_name(r, "registry name", "")?;
+                restricted_names::validate_package_name(r, "registry name", "")?;
                 Some(RegistryOrIndex::Registry(r.to_string()))
             }
             (Some(_), Some(_)) => {
@@ -850,7 +849,7 @@ Run `{cmd}` to see possible targets."
         match self._value_of("registry").map(|s| s.to_string()) {
             None => config.default_registry(),
             Some(registry) => {
-                validate_package_name(&registry, "registry name", "")?;
+                restricted_names::validate_package_name(&registry, "registry name", "")?;
                 Ok(Some(registry))
             }
         }
diff --git a/src/cargo/util/restricted_names.rs b/src/cargo/util/restricted_names.rs
@@ -120,3 +120,82 @@ pub fn is_windows_reserved_path(path: &Path) -> bool {
 pub fn is_glob_pattern<T: AsRef<str>>(name: T) -> bool {
     name.as_ref().contains(&['*', '?', '[', ']'][..])
 }
+
+/// Validate dir-names and profile names according to RFC 2678.
+pub fn validate_profile_name(name: &str) -> CargoResult<()> {
+    if let Some(ch) = name
+        .chars()
+        .find(|ch| !ch.is_alphanumeric() && *ch != '_' && *ch != '-')
+    {
+        bail!(
+            "invalid character `{}` in profile name `{}`\n\
+                Allowed characters are letters, numbers, underscore, and hyphen.",
+            ch,
+            name
+        );
+    }
+
+    const SEE_DOCS: &str = "See https://doc.rust-lang.org/cargo/reference/profiles.html \
+            for more on configuring profiles.";
+
+    let lower_name = name.to_lowercase();
+    if lower_name == "debug" {
+        bail!(
+            "profile name `{}` is reserved\n\
+                 To configure the default development profile, use the name `dev` \
+                 as in [profile.dev]\n\
+                {}",
+            name,
+            SEE_DOCS
+        );
+    }
+    if lower_name == "build-override" {
+        bail!(
+            "profile name `{}` is reserved\n\
+                 To configure build dependency settings, use [profile.dev.build-override] \
+                 and [profile.release.build-override]\n\
+                 {}",
+            name,
+            SEE_DOCS
+        );
+    }
+
+    // These are some arbitrary reservations. We have no plans to use
+    // these, but it seems safer to reserve a few just in case we want to
+    // add more built-in profiles in the future. We can also uses special
+    // syntax like cargo:foo if needed. But it is unlikely these will ever
+    // be used.
+    if matches!(
+        lower_name.as_str(),
+        "build"
+            | "check"
+            | "clean"
+            | "config"
+            | "fetch"
+            | "fix"
+            | "install"
+            | "metadata"
+            | "package"
+            | "publish"
+            | "report"
+            | "root"
+            | "run"
+            | "rust"
+            | "rustc"
+            | "rustdoc"
+            | "target"
+            | "tmp"
+            | "uninstall"
+    ) || lower_name.starts_with("cargo")
+    {
+        bail!(
+            "profile name `{}` is reserved\n\
+                 Please choose a different name.\n\
+                 {}",
+            name,
+            SEE_DOCS
+        );
+    }
+
+    Ok(())
+}
diff --git a/src/cargo/util/toml/mod.rs b/src/cargo/util/toml/mod.rs
@@ -23,6 +23,7 @@ use crate::core::{GitReference, PackageIdSpec, SourceId, WorkspaceConfig, Worksp
 use crate::sources::{CRATES_IO_INDEX, CRATES_IO_REGISTRY};
 use crate::util::errors::{CargoResult, ManifestError};
 use crate::util::interning::InternedString;
+use crate::util::restricted_names;
 use crate::util::{
     self, config::ConfigRelativePath, validate_package_name, Config, IntoUrl, OptVersionReq,
     RustVersion,
@@ -2122,7 +2123,7 @@ impl schema::TomlProfile {
         }
 
         // Profile name validation
-        Self::validate_name(name)?;
+        restricted_names::validate_profile_name(name)?;
 
         if let Some(dir_name) = &self.dir_name {
             // This is disabled for now, as we would like to stabilize named
@@ -2180,85 +2181,6 @@ impl schema::TomlProfile {
         Ok(())
     }
 
-    /// Validate dir-names and profile names according to RFC 2678.
-    pub fn validate_name(name: &str) -> CargoResult<()> {
-        if let Some(ch) = name
-            .chars()
-            .find(|ch| !ch.is_alphanumeric() && *ch != '_' && *ch != '-')
-        {
-            bail!(
-                "invalid character `{}` in profile name `{}`\n\
-                Allowed characters are letters, numbers, underscore, and hyphen.",
-                ch,
-                name
-            );
-        }
-
-        const SEE_DOCS: &str = "See https://doc.rust-lang.org/cargo/reference/profiles.html \
-            for more on configuring profiles.";
-
-        let lower_name = name.to_lowercase();
-        if lower_name == "debug" {
-            bail!(
-                "profile name `{}` is reserved\n\
-                 To configure the default development profile, use the name `dev` \
-                 as in [profile.dev]\n\
-                {}",
-                name,
-                SEE_DOCS
-            );
-        }
-        if lower_name == "build-override" {
-            bail!(
-                "profile name `{}` is reserved\n\
-                 To configure build dependency settings, use [profile.dev.build-override] \
-                 and [profile.release.build-override]\n\
-                 {}",
-                name,
-                SEE_DOCS
-            );
-        }
-
-        // These are some arbitrary reservations. We have no plans to use
-        // these, but it seems safer to reserve a few just in case we want to
-        // add more built-in profiles in the future. We can also uses special
-        // syntax like cargo:foo if needed. But it is unlikely these will ever
-        // be used.
-        if matches!(
-            lower_name.as_str(),
-            "build"
-                | "check"
-                | "clean"
-                | "config"
-                | "fetch"
-                | "fix"
-                | "install"
-                | "metadata"
-                | "package"
-                | "publish"
-                | "report"
-                | "root"
-                | "run"
-                | "rust"
-                | "rustc"
-                | "rustdoc"
-                | "target"
-                | "tmp"
-                | "uninstall"
-        ) || lower_name.starts_with("cargo")
-        {
-            bail!(
-                "profile name `{}` is reserved\n\
-                 Please choose a different name.\n\
-                 {}",
-                name,
-                SEE_DOCS
-            );
-        }
-
-        Ok(())
-    }
-
     /// Validates a profile.
     ///
     /// This is a shallow check, which is reused for the profile itself and any overrides.
