add cbor roundtrip test

Author: Mr-Leshiy

rust/signed_doc/src/lib.rs

@@ -45,7 +45,7 @@ impl Display for CatalystSignedDocument {
         writeln!(f, "{}", self.inner.metadata)?;
         writeln!(f, "Payload Size: {} bytes", self.inner.content.len())?;
         writeln!(f, "Signature Information")?;
-        if self.inner.signatures.0.is_empty() {
+        if self.inner.signatures.is_empty() {
             writeln!(f, "  This document is unsigned.")?;
         } else {
             for kid in &self.inner.signatures.kids() {
@@ -177,7 +177,7 @@ impl Encode<()> for CatalystSignedDocument {
             .protected(protected_header)
             .payload(self.inner.content.bytes().to_vec());
 
-        for signature in self.signatures().signatures() {
+        for signature in self.signatures().cose_signatures() {
             builder = builder.add_signature(signature);
         }
 
@@ -192,3 +192,54 @@ impl Encode<()> for CatalystSignedDocument {
             .map_err(|_| minicbor::encode::Error::message("Failed to encode to CBOR"))
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use metadata::{ContentEncoding, ContentType};
+
+    use super::*;
+
+    #[test]
+    fn catalyst_signed_doc_cbor_roundtrip_test() {
+        let uuid_v7 = UuidV7::new();
+        let uuid_v4 = UuidV4::new();
+        let section = "some section".to_string();
+        let collabs = vec!["collab1".to_string(), "collab2".to_string()];
+        let content_type = ContentType::Json;
+        let content_encoding = ContentEncoding::Brotli;
+
+        let metadata = serde_json::from_value(serde_json::json!({
+            "content-type": content_type.to_string(),
+            "content-encoding": content_encoding.to_string(),
+            "type": uuid_v4.to_string(),
+            "id": uuid_v7.to_string(),
+            "ver": uuid_v7.to_string(),
+            "ref": {"id": uuid_v7.to_string()},
+            "reply": {"id": uuid_v7.to_string(), "ver": uuid_v7.to_string()},
+            "template": {"id": uuid_v7.to_string()},
+            "section": section,
+            "collabs": collabs,
+            "campaign_id": uuid_v4.to_string(),
+            "election_id":  uuid_v4.to_string(),
+            "brand_id":  uuid_v4.to_string(),
+            "category_id": uuid_v4.to_string(),
+        }))
+        .unwrap();
+        let payload = vec![1, 2, 4, 5, 6, 7, 8, 9];
+        let content = Content::new(payload, content_type, Some(content_encoding)).unwrap();
+
+        let doc = CatalystSignedDocument {
+            inner: InnerCatalystSignedDocument {
+                metadata,
+                content,
+                signatures: Signatures::new(),
+            }
+            .into(),
+        };
+
+        let mut bytes = Vec::new();
+        minicbor::encode_with(doc, &mut bytes, &mut ()).unwrap();
+        let _decoded: CatalystSignedDocument =
+            minicbor::decode_with(bytes.as_slice(), &mut ()).unwrap();
+    }
+}

rust/signed_doc/src/metadata/algorithm.rs

@@ -1,7 +1,7 @@
 //! Cryptographic Algorithm in COSE SIGN protected header.
 
 /// Cryptography Algorithm.
-#[derive(Copy, Clone, Debug, serde::Deserialize)]
+#[derive(Copy, Clone, Debug, PartialEq, serde::Deserialize)]
 pub enum Algorithm {
     /// `EdDSA`
     EdDSA,

rust/signed_doc/src/metadata/document_ref.rs

@@ -4,7 +4,7 @@ use coset::cbor::Value;
 use super::{decode_cbor_uuid, encode_cbor_uuid, UuidV7};
 
 /// Reference to a Document.
-#[derive(Copy, Clone, Debug, serde::Serialize, serde::Deserialize)]
+#[derive(Copy, Clone, Debug, PartialEq, serde::Serialize, serde::Deserialize)]
 #[serde(untagged)]
 pub enum DocumentRef {
     /// Reference to the latest document

rust/signed_doc/src/metadata/extra_fields.rs

@@ -27,7 +27,7 @@ const CATEGORY_ID_KEY: &str = "category_id";
 /// Extra Metadata Fields.
 ///
 /// These values are extracted from the COSE Sign protected header labels.
-#[derive(Clone, Default, Debug, serde::Serialize, serde::Deserialize)]
+#[derive(Clone, Default, Debug, PartialEq, serde::Serialize, serde::Deserialize)]
 pub struct ExtraFields {
     /// Reference to the latest document.
     #[serde(rename = "ref", skip_serializing_if = "Option::is_none")]
@@ -271,50 +271,13 @@ impl TryFrom<&ProtectedHeader> for ExtraFields {
 
 #[cfg(test)]
 mod tests {
-    use catalyst_types::uuid::{V4, V7};
-
     use super::*;
 
     #[test]
-    fn extra_fields_json_serde_test() {
+    fn empty_extra_fields_json_serde_test() {
         let extra = ExtraFields::default();
 
         let json = serde_json::to_value(extra).unwrap();
         assert_eq!(json, serde_json::json!({}));
-
-        let uuid_v7 = V7::new();
-        let uuid_v4 = V4::new();
-        let section = "some section".to_string();
-        let collabs = vec!["collab1".to_string(), "collab2".to_string()];
-        let extra = ExtraFields {
-            doc_ref: Some(DocumentRef::Latest { id: uuid_v7 }),
-            reply: Some(DocumentRef::WithVer {
-                id: uuid_v7,
-                ver: uuid_v7,
-            }),
-            template: Some(DocumentRef::Latest { id: uuid_v7 }),
-            section: Some(section.clone()),
-            collabs: collabs.clone(),
-            campaign_id: Some(uuid_v4),
-            election_id: Some(uuid_v4),
-            brand_id: Some(uuid_v4),
-            category_id: Some(uuid_v4),
-        };
-
-        let json = serde_json::to_value(extra).unwrap();
-        assert_eq!(
-            json,
-            serde_json::json!({
-                "ref": {"id": uuid_v7.to_string()},
-                "reply": {"id": uuid_v7.to_string(), "ver": uuid_v7.to_string()},
-                "template": {"id": uuid_v7.to_string()},
-                "section": section,
-                "collabs": collabs,
-                "campaign_id": uuid_v4.to_string(),
-                "election_id":  uuid_v4.to_string(),
-                "brand_id":  uuid_v4.to_string(),
-                "category_id": uuid_v4.to_string(),
-            })
-        );
     }
 }

rust/signed_doc/src/metadata/mod.rs

@@ -34,17 +34,18 @@ const VER_KEY: &str = "ver";
 /// Document Metadata.
 ///
 /// These values are extracted from the COSE Sign protected header.
-#[derive(Clone, Debug, serde::Deserialize)]
+#[derive(Clone, Debug, PartialEq, serde::Deserialize)]
 pub struct Metadata {
+    /// Cryptographic Algorithm
+    #[serde(default = "Algorithm::default")]
+    alg: Algorithm,
     /// Document Type `UUIDv4`.
     #[serde(rename = "type")]
     doc_type: DocumentType,
     /// Document ID `UUIDv7`.
     id: DocumentId,
     /// Document Version `UUIDv7`.
     ver: DocumentVersion,
-    /// Cryptographic Algorithm
-    alg: Algorithm,
     /// Document Payload Content Type.
     #[serde(rename = "content-type")]
     content_type: ContentType,
@@ -75,12 +76,6 @@ impl Metadata {
         self.ver.into()
     }
 
-    /// Return Cryptography Algorithm.
-    #[must_use]
-    pub fn algorithm(&self) -> coset::iana::Algorithm {
-        self.alg.into()
-    }
-
     /// Returns the Document Content Type, if any.
     #[must_use]
     pub fn content_type(&self) -> ContentType {
@@ -154,9 +149,7 @@ impl TryFrom<&coset::ProtectedHeader> for Metadata {
                 Err(e) => errors.push(anyhow!("Invalid Document Algorithm: {e}")),
             }
         } else {
-            errors.push(anyhow!(
-                "Invalid COSE protected header, missing Content-Type field"
-            ));
+            errors.push(anyhow!("Invalid COSE protected header, missing alg field"));
         }
 
         let mut content_type = None;

rust/signed_doc/src/signature/mod.rs

@@ -13,10 +13,16 @@ pub struct Signature {
 }
 
 /// List of Signatures.
-#[derive(Debug, Clone)]
-pub struct Signatures(pub(crate) Vec<Signature>);
+#[derive(Debug, Clone, Default)]
+pub struct Signatures(Vec<Signature>);
 
 impl Signatures {
+    /// Creates an empty signatures list.
+    #[must_use]
+    pub fn new() -> Self {
+        Self(Vec::new())
+    }
+
     /// List of signature Key IDs.
     #[must_use]
     pub fn kids(&self) -> Vec<KidUri> {
@@ -25,7 +31,7 @@ impl Signatures {
 
     /// List of signatures.
     #[must_use]
-    pub fn signatures(&self) -> Vec<CoseSignature> {
+    pub fn cose_signatures(&self) -> Vec<CoseSignature> {
         self.0.iter().map(|sig| sig.signature.clone()).collect()
     }