feat: accept to deserialize & serialize custom event (content is defined as JSON)

Signed-off-by: David Bernard <[email protected]>

Author: davidB

cdevents-sdk/src/generated/mod.rs

@@ -438,6 +438,12 @@ pub enum Content {
     TicketClosed010(ticket_closed_0_1_0::Content),
     TicketCreated010(ticket_created_0_1_0::Content),
     TicketUpdated010(ticket_updated_0_1_0::Content),
+    Custom{
+      #[serde(skip)]
+      ty: String,
+      #[serde(flatten)]
+      json: serde_json::Value,
+    },
 }
 
 impl Content {
@@ -783,14 +789,18 @@ impl Content {
                 let variant: ticket_updated_0_1_0::Content = serde_json::from_value(json)?;
                 Ok(variant.into())
             },
-            variant => Err(serde_json::Error::custom(format_args!(
-                "unknown variant `{}`, expected 'dev.cdevents.{{subject}}.{{predicate}}.{{version}}'",
-                variant,
-            ))),
+            variant => if variant.starts_with("dev.cdeventsx.") {
+                Ok(Self::Custom{ ty: ty.to_string(), json })
+            } else {
+              Err(serde_json::Error::custom(format_args!(
+                  "unknown variant `{}`, expected 'dev.cdevents.{{subject}}.{{predicate}}.{{version}}'",
+                  variant,
+              )))
+            },
         }
     }
 
-    pub fn ty(&self) -> &'static str {
+    pub fn ty(&self) -> &str {
         match self {
             Self::ArtifactDeleted010(_) => ARTIFACT_DELETED_0_1_0,
             Self::ArtifactDownloaded010(_) => ARTIFACT_DOWNLOADED_0_1_0,
@@ -877,10 +887,11 @@ impl Content {
             Self::TicketClosed010(_) => TICKET_CLOSED_0_1_0,
             Self::TicketCreated010(_) => TICKET_CREATED_0_1_0,
             Self::TicketUpdated010(_) => TICKET_UPDATED_0_1_0,
+            Self::Custom{ty, ..} => ty,
         }
     }
 
-    pub fn subject(&self) -> &'static str {
+    pub fn subject(&self) -> &str {
         match self {
             Self::ArtifactDeleted010(_) => "artifact",
             Self::ArtifactDownloaded010(_) => "artifact",
@@ -967,10 +978,11 @@ impl Content {
             Self::TicketClosed010(_) => "ticket",
             Self::TicketCreated010(_) => "ticket",
             Self::TicketUpdated010(_) => "ticket",
+            Self::Custom{ty, ..} => ty.split('.').nth(2).unwrap_or_default(),
         }
     }
 
-    pub fn predicate(&self) -> &'static str {
+    pub fn predicate(&self) -> &str {
         match self {
             Self::ArtifactDeleted010(_) => "deleted",
             Self::ArtifactDownloaded010(_) => "downloaded",
@@ -1057,11 +1069,13 @@ impl Content {
             Self::TicketClosed010(_) => "closed",
             Self::TicketCreated010(_) => "created",
             Self::TicketUpdated010(_) => "updated",
+            Self::Custom{ty, ..} => ty.split('.').nth(3).unwrap_or_default(),
         }
     }
 }
 
-// due to inconstency in case/format the subject could be not be extracted from the context.type (ty), jsonshema $id, spec filename (shema, examples)
+/// Due to inconstency in case/format the subject could be not be extracted from the context.type (ty), jsonshema $id, spec filename (shema, examples)
+/// Custom type are not supported
 pub fn extract_subject_predicate(ty: &str) -> Option<(&str, &str)>{
     // let mut split = ty.split('.');
     match ty {
@@ -1680,7 +1694,7 @@ impl<> proptest::arbitrary::Arbitrary for Content {
 // #[cfg(test)]
 // mod tests {
 //     use super::*;
-// 
+//
 //     #[test]
 //     fn test_true() {
 //         
@@ -1855,4 +1869,4 @@ impl<> proptest::arbitrary::Arbitrary for Content {
 //         assert_eq!(extract_subject_predicate(TICKET_UPDATED_0_1_0), Some(("ticket","updated")));
 //         
 //     }
-// }
+// }

cdevents-sdk/tests/specs.rs

@@ -77,12 +77,12 @@ impl UrlLoader for HackUrlLoader {
 }
 static EVENTS_SCHEMA_CELL: OnceLock<EventsSchemas> = OnceLock::new();
 
-fn events_schemas() -> &'static EventsSchemas { 
+fn events_schemas() -> &'static EventsSchemas {
     EVENTS_SCHEMA_CELL.get_or_init(EventsSchemas::load)
 }
 
 #[rstest]
-fn can_serde_example(#[files("../cdevents-specs/spec-*/examples/*.json")] #[files("../cdevents-specs/spec-*/conformance/*.json")] path: PathBuf) {
+fn can_serde_example(#[files("../cdevents-specs/spec-*/examples/*.json")] #[files("../cdevents-specs/spec-*/conformance/*.json")] #[files("../cdevents-specs/spec-*/custom/conformance.json")] path: PathBuf) {
     let example_txt = fs::read_to_string(path).expect("to read file as string");
     // HACK uri are stored ad http::Uri, they are "normalized" when serialized, so prenormalization to avoid failure like
     // json atoms at path ".subject.content.repository.source" are not equal:
@@ -96,12 +96,12 @@ fn can_serde_example(#[files("../cdevents-specs/spec-*/examples/*.json")] #[file
 
     let example_json: serde_json::Value =
         serde_json::from_str(&example_txt).expect("to parse as json");
-    dbg!(&example_json);
+    // dbg!(&example_json);
     let cdevent: CDEvent =
         serde_json::from_value(example_json.clone()).expect("to parse as cdevent");
-    dbg!(&cdevent);
+    // dbg!(&cdevent);
     let cdevent_json = serde_json::to_value(cdevent).expect("to convert into json");
-    dbg!(&cdevent_json);
+    // dbg!(&cdevent_json);
     assert_json_eq!(example_json, cdevent_json);
 }
 

generator/templates/mod.hbs

@@ -25,6 +25,12 @@ pub enum Content {
     {{#each variants }}
     {{to_class_case this.rust_module}}({{this.rust_module}}::Content),
     {{/each}}
+    Custom{
+      #[serde(skip)]
+      ty: String,
+      #[serde(flatten)]
+      json: serde_json::Value,
+    },
 }
 
 impl Content {
@@ -36,39 +42,47 @@ impl Content {
                 Ok(variant.into())
             },
             {{/each}}
-            variant => Err(serde_json::Error::custom(format_args!(
-                "unknown variant `{}`, expected 'dev.cdevents.\{{subject}}.\{{predicate}}.\{{version}}'",
-                variant,
-            ))),
+            variant => if variant.starts_with("dev.cdeventsx.") {
+                Ok(Self::Custom{ ty: ty.to_string(), json })
+            } else {
+              Err(serde_json::Error::custom(format_args!(
+                  "unknown variant `{}`, expected 'dev.cdevents.\{{subject}}.\{{predicate}}.\{{version}}'",
+                  variant,
+              )))
+            },
         }
     }
 
-    pub fn ty(&self) -> &'static str {
+    pub fn ty(&self) -> &str {
         match self {
             {{#each variants }}
             Self::{{to_class_case this.rust_module}}(_) => {{to_screaming_snake_case this.rust_module}},
             {{/each}}
+            Self::Custom{ty, ..} => ty,
         }
     }
 
-    pub fn subject(&self) -> &'static str {
+    pub fn subject(&self) -> &str {
         match self {
             {{#each variants }}
             Self::{{to_class_case this.rust_module}}(_) => "{{ this.subject_type }}",
             {{/each}}
+            Self::Custom{ty, ..} => ty.split('.').nth(2).unwrap_or_default(),
         }
     }
 
-    pub fn predicate(&self) -> &'static str {
+    pub fn predicate(&self) -> &str {
         match self {
             {{#each variants }}
             Self::{{to_class_case this.rust_module}}(_) => "{{ this.predicate }}",
             {{/each}}
+            Self::Custom{ty, ..} => ty.split('.').nth(3).unwrap_or_default(),
         }
     }
 }
 
-// due to inconstency in case/format the subject could be not be extracted from the context.type (ty), jsonshema $id, spec filename (shema, examples)
+/// Due to inconstency in case/format the subject could be not be extracted from the context.type (ty), jsonshema $id, spec filename (shema, examples)
+/// Custom type are not supported
 pub fn extract_subject_predicate(ty: &str) -> Option<(&str, &str)>{
     // let mut split = ty.split('.');
     match ty {
@@ -105,11 +119,11 @@ impl<> proptest::arbitrary::Arbitrary for Content {
 // #[cfg(test)]
 // mod tests {
 //     use super::*;
-// 
+//
 //     #[test]
 //     fn test_true() {
 //         {{#each variants }}
 //         assert_eq!(extract_subject_predicate({{to_screaming_snake_case this.rust_module}}), Some(("{{ this.subject }}","{{ this.predicate }}")));
 //         {{/each}}
 //     }
-// }
+// }