feat: add support for cdevents 0.4

- with some hack, shortcut to improve

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

Author: davidB

.gitmodules

@@ -5,3 +5,7 @@
 [submodule "cdevents-specs/main"]
 	path = cdevents-specs/main
 	url = https://github.com/cdevents/spec.git
+[submodule "cdevents-specs/spec-v0.4"]
+	path = cdevents-specs/spec-v0.4
+	url = https://github.com/cdevents/spec.git
+	branch = spec-v0.4

Makefile

@@ -75,6 +75,14 @@ test:
 	cargo nextest run --all-features
 	cargo test --doc
 
+# buid_cdevents-specs:
+# 	git submodule deinit -f --all
+# 	git submodule init
+# 	git submodule add -f https://github.com/cdevents/spec.git cdevents-specs/main
+# 	git submodule add -f -b spec-v0.3 https://github.com/cdevents/spec.git cdevents-specs/spec-v0.3
+# 	git submodule add -f -b spec-v0.4 https://github.com/cdevents/spec.git cdevents-specs/spec-v0.4
+# 	git submodule update -f --rebase -- cdevents-specs/main
+
 .PHONY:
 	generate \
 	check check_no_uncommitted_changes_on_sdk \

cdevents-sdk/Cargo.toml

@@ -24,7 +24,7 @@ assert-json-diff = "2.0"
 boon = "0.5"
 glob = "0.3"
 proptest = "1"
-rstest = "0.18"
+rstest = "0.19"
 
 [features]
 default = ["cloudevents"]

cdevents-sdk/src/context.rs

@@ -1,6 +1,6 @@
 use serde::{Deserialize, Serialize};
 
-use crate::{Id, UriReference};
+use crate::{Id, Uri, UriReference};
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
 #[serde(deny_unknown_fields)]
@@ -12,6 +12,12 @@ pub(crate) struct Context {
     pub(crate) ty: String,
     #[serde(with = "crate::serde::datetime")]
     pub(crate) timestamp: time::OffsetDateTime,
+    #[serde(rename = "schemaUri", skip_serializing_if = "Option::is_none")]
+    pub(crate) schema_uri: Option<Uri>,
+    #[serde(rename = "chain_id", skip_serializing_if = "Option::is_none")]
+    pub(crate) chain_id: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub(crate) links: Option<serde_json::Value>,
 }
 
 impl Default for Context {
@@ -22,6 +28,9 @@ impl Default for Context {
             source: "/undef".try_into().expect("/undef is a valid uri-reference"),
             ty: "dev.cdevents.undef.undef.0.0.0".into(),
             timestamp: time::OffsetDateTime::now_utc(),
+            schema_uri: None,
+            chain_id: None,
+            links: None,
         }
     }
 }

cdevents-sdk/tests/specs.rs

@@ -4,7 +4,7 @@ use rstest::*;
 use std::{collections::HashMap, fs};
 use std::path::PathBuf;
 use proptest::prelude::*;
-use boon::{Schemas, Compiler, SchemaIndex};
+use boon::{Compiler, SchemaIndex, Schemas, UrlLoader};
 use glob::glob;
 use std::sync::OnceLock;
 
@@ -18,6 +18,10 @@ impl EventsSchemas {
         let mut schemas = Schemas::new();
         let mut compiler = Compiler::new();
         let mut mapping = HashMap::new();
+
+        //HACK to resolve invalid `$ref: "/schema/links/embeddedlinksarray.json"`
+        compiler.register_url_loader("https", Box::new(HackUrlLoader{}));
+
         for entry in glob("../cdevents-specs/*/schemas/*.json").expect("Failed to read glob pattern") {
             let schemapath = entry.unwrap();
             //TODO avoid to read the schema twice (as json, then as jsonschema)
@@ -47,14 +51,27 @@ impl EventsSchemas {
     }
 }
 
+struct HackUrlLoader;
+
+impl UrlLoader for HackUrlLoader {
+    fn load(&self, url: &str) -> Result<serde_json::Value, Box<dyn std::error::Error>> {
+        if url.starts_with("https://cdevents.dev/schema/links/") {
+            let path = url.replace("https://cdevents.dev/schema", "../cdevents-specs/spec-v0.4/schemas/");
+            let jsonschema: serde_json::Value = serde_json::from_str(&std::fs::read_to_string(path)?)?;
+            Ok(jsonschema)
+        } else {
+            Err(format!("fail to load {url}").into())
+        }
+    }
+}
 static EVENTS_SCHEMA_CELL: OnceLock<EventsSchemas> = OnceLock::new();
 
 fn events_schemas() -> &'static EventsSchemas { 
     EVENTS_SCHEMA_CELL.get_or_init(EventsSchemas::load)
 }
 
 #[rstest]
-fn for_each_example(#[files("../cdevents-specs/spec-v0.3/examples/*.json")] path: PathBuf) {
+fn can_serde_example(#[files("../cdevents-specs/spec-*/examples/*.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:
@@ -78,7 +95,7 @@ fn for_each_example(#[files("../cdevents-specs/spec-v0.3/examples/*.json")] path
 }
 
 #[rstest]
-fn validate_example_against_schema(#[files("../cdevents-specs/spec-v0.3/examples/*.json")] path: PathBuf) {
+fn validate_example_against_schema(#[files("../cdevents-specs/spec-*/examples/*.json")] path: PathBuf) {
     let events_schemas = events_schemas();
     let example_txt = fs::read_to_string(path).expect("to read file as string");
     let example_json: serde_json::Value =

cdevents-specs/spec-v0.4

@@ -13,9 +13,9 @@ Goals: generate rust code for cdevents from jsonschema provided as part of cdeve
 
 ## Run
 
-To generate the `subjects` into sibling crate `cdevents/src/generated` from content of `cdevents-specs/spec-v0.3/schemas`, from root workspace
+To generate the `subjects` into sibling crate `cdevents/src/generated` from content of `cdevents-specs/spec-v0.4/schemas`, from root workspace
 
 ```sh
 cargo run -p generator -- --help
-cargo run -p generator -- --templates-dir "generator/templates" --jsonschema-dir "cdevents-specs/spec-v0.3/schemas" --dest "cdevents-sdk/src/generated"
+cargo run -p generator -- --templates-dir "generator/templates" --jsonschema-dir "cdevents-specs/spec-v0.4/schemas" --dest "cdevents-sdk/src/generated"
 ```

generator/README.md

@@ -328,8 +328,30 @@ fn collect_structs(
                 type_info
             }
         },
-        Some(x) => todo!("impl for type='{}'", x),
-        None => unimplemented!("expected key 'type' in field '{}'", field_names.join(".")),
+        // Some("array") => TypeInfo {
+        //     type_declaration: "serde_json::Array<serde_json::Value>".to_string(),
+        //     ..Default::default()
+        // },
+        Some(x) => match field_names.last() {
+            // HACK for array of string
+            Some(&"assignees") | Some(&"labels") => TypeInfo {
+                type_declaration: "Vec<String>".to_string(),
+                ..Default::default()
+            },
+            _ => todo!(
+                "impl for type='{}' for field='{}'",
+                x,
+                field_names.join(".")
+            ),
+        },
+        None => match field_names.last() {
+            // HACK for an anyOf (string or enum/string)
+            Some(&"priority") | Some(&"ticketType") | Some(&"resolution") => TypeInfo {
+                type_declaration: "String".to_string(),
+                ..Default::default()
+            },
+            _ => unimplemented!("expected key 'type' in field '{}'", field_names.join(".")),
+        },
     }
 }