Merge pull request #2530 from itowlson/moar-manifest-validations

Validate variable keys as part of schema

Author: itowlson

crates/doctor/tests/ui/maximal_v1.cured

@@ -11,7 +11,7 @@ global_option = true
 
 [variables]
 var_one = { default = "Default" }
-var_TWO = { required = true, secret = true }
+var_two = { required = true, secret = true }
 
 [[trigger.fake]]
 id = "trigger-minimal-component"

crates/doctor/tests/ui/maximal_v1.toml

@@ -11,7 +11,7 @@ global_option = true
 
 [variables]
 var_one = { default = "Default" }
-var_TWO = { required = true, secret = true }
+var_two = { required = true, secret = true }
 
 [[component]]
 id = "minimal-component"

crates/manifest/src/compat.rs

@@ -144,7 +144,9 @@ fn component_id_from_string(id: String) -> Result<v2::KebabId, Error> {
         .map_err(|err: String| Error::InvalidID { id, reason: err })
 }
 
-fn id_from_string<const DELIM: char>(id: String) -> Result<spin_serde::id::Id<DELIM>, Error> {
+fn id_from_string<const DELIM: char, const LOWER: bool>(
+    id: String,
+) -> Result<spin_serde::id::Id<DELIM, LOWER>, Error> {
     id.clone()
         .try_into()
         .map_err(|err: String| Error::InvalidID { id, reason: err })

crates/manifest/src/schema/v2.rs

@@ -1,5 +1,5 @@
 use serde::{Deserialize, Serialize};
-use spin_serde::FixedVersion;
+use spin_serde::{FixedVersion, LowerSnakeId};
 pub use spin_serde::{KebabId, SnakeId};
 
 pub use super::common::{ComponentBuildConfig, ComponentSource, Variable, WasiFilesMount};
@@ -16,7 +16,7 @@ pub struct AppManifest {
     pub application: AppDetails,
     /// `[variables]`
     #[serde(default, skip_serializing_if = "Map::is_empty")]
-    pub variables: Map<SnakeId, Variable>,
+    pub variables: Map<LowerSnakeId, Variable>,
     /// `[[trigger.<type>]]`
     #[serde(rename = "trigger")]
     pub triggers: Map<String, Vec<Trigger>>,
@@ -106,7 +106,7 @@ pub struct Component {
     pub description: String,
     /// `variables = { name = "{{ app_var }}"}`
     #[serde(default, skip_serializing_if = "Map::is_empty")]
-    pub variables: Map<SnakeId, String>,
+    pub variables: Map<LowerSnakeId, String>,
     /// `environment = { VAR = "value" }`
     #[serde(default, skip_serializing_if = "Map::is_empty")]
     pub environment: Map<String, String>,

crates/manifest/tests/ui/maximal.json

@@ -23,7 +23,7 @@
     "var_one": {
       "default": "Default"
     },
-    "var_TWO": {
+    "var_two": {
       "required": true,
       "secret": true
     }

crates/manifest/tests/ui/maximal.toml

@@ -14,7 +14,7 @@ lint_level = "savage"
 
 [variables]
 var_one = { default = "Default" }
-var_TWO = { required = true, secret = true }
+var_two = { required = true, secret = true }
 
 [[trigger.fake]]
 component = "minimal-component"

crates/manifest/tests/ui/v1/maximal.json

@@ -18,7 +18,7 @@
     "var_one": {
       "default": "Default"
     },
-    "var_TWO": {
+    "var_two": {
       "required": true,
       "secret": true
     }

crates/manifest/tests/ui/v1/maximal.toml

@@ -11,7 +11,7 @@ global_option = true
 
 [variables]
 var_one = { default = "Default" }
-var_TWO = { required = true, secret = true }
+var_two = { required = true, secret = true }
 
 [[component]]
 id = "minimal-component"

crates/manifest/tests/ui/v1/maximal.toml.v2

@@ -12,7 +12,7 @@ global_option = true
 [variables.var_one]
 default = "Default"
 
-[variables.var_TWO]
+[variables.var_two]
 required = true
 secret = true
 

crates/serde/src/id.rs

@@ -6,27 +6,27 @@ use serde::{Deserialize, Serialize};
 /// `word`s separated by a delimiter char.
 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
 #[serde(into = "String", try_from = "String")]
-pub struct Id<const DELIM: char>(String);
+pub struct Id<const DELIM: char, const LOWER: bool>(String);
 
-impl<const DELIM: char> std::fmt::Display for Id<DELIM> {
+impl<const DELIM: char, const LOWER: bool> std::fmt::Display for Id<DELIM, LOWER> {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(f, "{}", self.0)
     }
 }
 
-impl<const DELIM: char> AsRef<str> for Id<DELIM> {
+impl<const DELIM: char, const LOWER: bool> AsRef<str> for Id<DELIM, LOWER> {
     fn as_ref(&self) -> &str {
         &self.0
     }
 }
 
-impl<const DELIM: char> From<Id<DELIM>> for String {
-    fn from(value: Id<DELIM>) -> Self {
+impl<const DELIM: char, const LOWER: bool> From<Id<DELIM, LOWER>> for String {
+    fn from(value: Id<DELIM, LOWER>) -> Self {
         value.0
     }
 }
 
-impl<const DELIM: char> TryFrom<String> for Id<DELIM> {
+impl<const DELIM: char, const LOWER: bool> TryFrom<String> for Id<DELIM, LOWER> {
     type Error = String;
 
     fn try_from(id: String) -> Result<Self, Self::Error> {
@@ -63,6 +63,11 @@ impl<const DELIM: char> TryFrom<String> for Id<DELIM> {
                     return Err(format!("{DELIM:?}-separated words must be all lowercase or all UPPERCASE; got {word:?}"));
                 }
             }
+            if LOWER && word_is_uppercase {
+                return Err(format!(
+                    "Lower-case identifiers must be all lowercase; got {id:?}"
+                ));
+            }
         }
         Ok(Self(id))
     }