19157489699

Committed 07 Nov 2025 03:44AM UTC coverage: 68.549% (+0.1%) from 68.442%

Build # 19157489699

Build Type

Pull #545

github

Committed by

web-flow

Commit Message

Merge 258367de4 into b703f0134

Pull Request Pull Request #545: feat(docs): Formalize Voting Formats as signed documents.

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

26 existing lines in 5 files now uncovered.

13923 of 20311 relevant lines covered (68.55%)

2906.42 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.46

/rust/signed_doc/src/validator/rules/content_encoding.rs

//! `content-encoding` rule type impl.

use std::string::ToString;

use catalyst_signed_doc_spec::is_required::IsRequired;

use crate::{metadata::ContentEncoding, CatalystSignedDocument};

/// `content-encoding` field validation rule.
#[derive(Debug)]
pub(crate) enum ContentEncodingRule {
    /// Content Encoding field is optionally present in the document.
    Specified {
        /// expected `content-encoding` field.
        exp: Vec<ContentEncoding>,
        /// optional flag for the `content-encoding` field.
        optional: bool,
    },
    /// Content Encoding field must not be present in the document.
    NotSpecified,
}

impl ContentEncodingRule {
    /// Create a new rule from specs.
    pub(crate) fn new(
        spec: &catalyst_signed_doc_spec::headers::content_encoding::ContentEncoding
    ) -> anyhow::Result<Self> {
        if let IsRequired::Excluded = spec.required {
            anyhow::ensure!(
                spec.value.is_none(),
                "'content type' field must not exist when 'required' is 'excluded'"
            );
            return Ok(Self::NotSpecified);
        }

        let optional = IsRequired::Optional == spec.required;

        let exp = spec
            .value
            .as_ref()
            .ok_or(anyhow::anyhow!("'content-encoding' field must have value "))?
            .iter()
            .flat_map(|encoding| encoding.parse())
            .collect();

        Ok(Self::Specified { exp, optional })
    }

    /// Field validation rule
    #[allow(clippy::unused_async)]
    pub(crate) async fn check(
        &self,
        doc: &CatalystSignedDocument,
    ) -> anyhow::Result<bool> {
        let context = "Content Encoding Rule check";
        match self {
            Self::NotSpecified => {
                if let Some(content_encoding) = doc.doc_content_encoding() {
                    doc.report().unknown_field(
                        "content-encoding",
                        &content_encoding.to_string(),
                        &format!(
                            "{context}, document does not expect to have a content-encoding field"
                        ),
                    );
                    return Ok(false);
                }
            },
            Self::Specified { exp, optional } => {
                if let Some(content_encoding) = doc.doc_content_encoding() {
                    if !exp.contains(&content_encoding) {
                        doc.report().invalid_value(
                            "content-encoding",
                            content_encoding.to_string().as_str(),
                            &exp.iter()
                                .map(ToString::to_string)
                                .collect::<Vec<_>>()
                                .join(", "),
                            "Invalid document content-encoding value",
                        );
                        return Ok(false);
                    }
                    if content_encoding.decode(doc.encoded_content()).is_err() {
                        doc.report().invalid_value(
                            "payload",
                            &hex::encode(doc.encoded_content()),
                            content_encoding.to_string().as_str(),
                            "Document content is not decodable with the expected content-encoding",
                        );
                        return Ok(false);
                    }
                } else if !optional {
                    doc.report().missing_field(
                        "content-encoding",
                        "Document must have a content-encoding field",
                    );
                    return Ok(false);
                }
            },
        }
        Ok(true)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{builder::tests::Builder, metadata::SupportedField};

    #[tokio::test]
    async fn content_encoding_is_specified_rule_test() {
        let content_encoding = ContentEncoding::Brotli;

        let rule = ContentEncodingRule::Specified {
            exp: vec![content_encoding],
            optional: true,
        };

        let doc = Builder::new()
            .with_metadata_field(SupportedField::ContentEncoding(content_encoding))
            .with_content(content_encoding.encode(&[1, 2, 3]).unwrap())
            .build();
        assert!(rule.check(&doc).await.unwrap());

        // empty content (empty bytes) could not be brotli decoded
        let doc = Builder::new()
            .with_metadata_field(SupportedField::ContentEncoding(content_encoding))
            .build();
        assert!(!rule.check(&doc).await.unwrap());

        let doc = Builder::new().build();
        assert!(rule.check(&doc).await.unwrap());

        let rule = ContentEncodingRule::Specified {
            exp: vec![content_encoding],
            optional: false,
        };
        assert!(!rule.check(&doc).await.unwrap());
    }

    #[tokio::test]
    async fn content_encoding_is_not_specified_rule_test() {
        let content_encoding = ContentEncoding::Brotli;

        let rule = ContentEncodingRule::NotSpecified;

        // With Brotli content encoding
        let doc = Builder::new()
            .with_metadata_field(SupportedField::ContentEncoding(content_encoding))
            .build();
        assert!(!rule.check(&doc).await.unwrap());

        // No content encoding
        let doc = Builder::new().build();
        assert!(rule.check(&doc).await.unwrap());
    }
}

1	//! `content-encoding` rule type impl.
2
3	use std::string::ToString;
4
5	use catalyst_signed_doc_spec::is_required::IsRequired;
6
7	use crate::{metadata::ContentEncoding, CatalystSignedDocument};
8
9	/// `content-encoding` field validation rule.
10	#[derive(Debug)]
11	pub(crate) enum ContentEncodingRule {
12	/// Content Encoding field is optionally present in the document.
13	Specified {
14	/// expected `content-encoding` field.
15	exp: Vec<ContentEncoding>,
16	/// optional flag for the `content-encoding` field.
17	optional: bool,
18	},
19	/// Content Encoding field must not be present in the document.
20	NotSpecified,
21	}
22
23	impl ContentEncodingRule {
24	/// Create a new rule from specs.
25	pub(crate) fn new(	147✔
26	spec: &catalyst_signed_doc_spec::headers::content_encoding::ContentEncoding	147✔
27	) -> anyhow::Result<Self> {	147✔
28	if let IsRequired::Excluded = spec.required {	147✔
UNCOV 29	anyhow::ensure!(	×
UNCOV 30	spec.value.is_none(),	×
31	"'content type' field must not exist when 'required' is 'excluded'"	×
32	);
UNCOV 33	return Ok(Self::NotSpecified);	×
34	}	147✔
35
36	let optional = IsRequired::Optional == spec.required;	147✔
37
38	let exp = spec	147✔
39	.value	147✔
40	.as_ref()	147✔
41	.ok_or(anyhow::anyhow!("'content-encoding' field must have value "))?	147✔
42	.iter()	147✔
43	.flat_map(\|encoding\| encoding.parse())	147✔
44	.collect();	147✔
45
46	Ok(Self::Specified { exp, optional })	147✔
47	}	147✔
48
49	/// Field validation rule
50	#[allow(clippy::unused_async)]
51	pub(crate) async fn check(	11✔
52	&self,	11✔
53	doc: &CatalystSignedDocument,	11✔
54	) -> anyhow::Result<bool> {	11✔
55	let context = "Content Encoding Rule check";	11✔
56	match self {	11✔
57	Self::NotSpecified => {
58	if let Some(content_encoding) = doc.doc_content_encoding() {	2✔
59	doc.report().unknown_field(	1✔
60	"content-encoding",	1✔
61	&content_encoding.to_string(),	1✔
62	&format!(	1✔
63	"{context}, document does not expect to have a content-encoding field"	1✔
64	),	1✔
65	);
66	return Ok(false);	1✔
67	}	1✔
68	},
69	Self::Specified { exp, optional } => {	9✔
70	if let Some(content_encoding) = doc.doc_content_encoding() {	9✔
71	if !exp.contains(&content_encoding) {	7✔
72	doc.report().invalid_value(	×
73	"content-encoding",	×
74	content_encoding.to_string().as_str(),	×
75	&exp.iter()	×
76	.map(ToString::to_string)	×
77	.collect::<Vec<_>>()	×
78	.join(", "),	×
79	"Invalid document content-encoding value",	×
80	);
81	return Ok(false);	×
82	}	7✔
83	if content_encoding.decode(doc.encoded_content()).is_err() {	7✔
84	doc.report().invalid_value(	2✔
85	"payload",	2✔
86	&hex::encode(doc.encoded_content()),	2✔
87	content_encoding.to_string().as_str(),	2✔
88	"Document content is not decodable with the expected content-encoding",	2✔
89	);
90	return Ok(false);	2✔
91	}	5✔
92	} else if !optional {	2✔
93	doc.report().missing_field(	1✔
94	"content-encoding",	1✔
95	"Document must have a content-encoding field",	1✔
96	);
97	return Ok(false);	1✔
98	}	1✔
99	},
100	}
101	Ok(true)	7✔
102	}	11✔
103	}
104
105	#[cfg(test)]
106	mod tests {
107	use super::*;
108	use crate::{builder::tests::Builder, metadata::SupportedField};
109
110	#[tokio::test]
111	async fn content_encoding_is_specified_rule_test() {	1✔
112	let content_encoding = ContentEncoding::Brotli;	1✔
113
114	let rule = ContentEncodingRule::Specified {	1✔
115	exp: vec![content_encoding],	1✔
116	optional: true,	1✔
117	};	1✔
118
119	let doc = Builder::new()	1✔
120	.with_metadata_field(SupportedField::ContentEncoding(content_encoding))	1✔
121	.with_content(content_encoding.encode(&[1, 2, 3]).unwrap())	1✔
122	.build();	1✔
123	assert!(rule.check(&doc).await.unwrap());	1✔
124
125	// empty content (empty bytes) could not be brotli decoded
126	let doc = Builder::new()	1✔
127	.with_metadata_field(SupportedField::ContentEncoding(content_encoding))	1✔
128	.build();	1✔
129	assert!(!rule.check(&doc).await.unwrap());	1✔
130
131	let doc = Builder::new().build();	1✔
132	assert!(rule.check(&doc).await.unwrap());	1✔
133
134	let rule = ContentEncodingRule::Specified {	1✔
135	exp: vec![content_encoding],	1✔
136	optional: false,	1✔
137	};	1✔
138	assert!(!rule.check(&doc).await.unwrap());	1✔
139	}	1✔
140
141	#[tokio::test]
142	async fn content_encoding_is_not_specified_rule_test() {	1✔
143	let content_encoding = ContentEncoding::Brotli;	1✔
144
145	let rule = ContentEncodingRule::NotSpecified;	1✔
146
147	// With Brotli content encoding
148	let doc = Builder::new()	1✔
149	.with_metadata_field(SupportedField::ContentEncoding(content_encoding))	1✔
150	.build();	1✔
151	assert!(!rule.check(&doc).await.unwrap());	1✔
152
153	// No content encoding
154	let doc = Builder::new().build();	1✔
155	assert!(rule.check(&doc).await.unwrap());	1✔
156	}	1✔
157	}

input-output-hk / catalyst-libs / 19157489699

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous