make test builder public

Author: Mr-Leshiy

rust/signed_doc/bins/mk_signed_doc.rs

@@ -77,7 +77,7 @@ impl Cli {
  let signed_doc = signed_doc_from_bytes(cose_bytes.as_slice())?;
 
  let new_signed_doc = signed_doc
- .into_builder()?
+ .into_builder()
  .add_signature(
  |message| sk.sign::<()>(&message).to_bytes().to_vec(),
  kid.clone(),

rust/signed_doc/src/builder.rs

@@ -183,26 +183,28 @@ fn build_signature(
  Ok(Signature::new(kid, sign_bytes))
 }
 
-impl TryFrom<&CatalystSignedDocument> for SignaturesBuilder {
- type Error = anyhow::Error;
-
- fn try_from(value: &CatalystSignedDocument) -> Result<Self, Self::Error> {
- Ok(Self {
+impl From<&CatalystSignedDocument> for SignaturesBuilder {
+ fn from(value: &CatalystSignedDocument) -> Self {
+ Self {
  metadata: value.inner.metadata.clone(),
  content: value.inner.content.clone(),
  signatures: value.inner.signatures.clone(),
- })
+ }
  }
 }
 
-#[cfg(test)]
-pub(crate) mod tests {
+pub mod tests {
+ //! Catalyst Signed Document Builder for testing purposes.
+
  use cbork_utils::with_cbor_bytes::WithCborBytes;
 
+ use super::{CatalystSignedDocument, Content};
+ use crate::Signatures;
+
  /// A test version of the builder, which allows to build a not fully valid catalyst
  /// signed document
  #[derive(Default)]
- pub(crate) struct Builder {
+ pub struct Builder {
  /// metadata
  metadata: super::Metadata,
  /// content
@@ -211,36 +213,64 @@ pub(crate) mod tests {
  signatures: super::Signatures,
  }
 
+ impl From<&CatalystSignedDocument> for Builder {
+ fn from(value: &CatalystSignedDocument) -> Self {
+ Self {
+ metadata: value.inner.metadata.clone().inner(),
+ content: value.inner.content.clone(),
+ signatures: value.inner.signatures.clone(),
+ }
+ }
+ }
+
  impl Builder {
  /// Start building a signed document
  #[must_use]
- pub(crate) fn new() -> Self {
+ pub fn new() -> Self {
  Self::default()
  }
 
  /// Add provided `SupportedField` into the `Metadata`.
- pub(crate) fn with_metadata_field(
+ pub fn with_metadata_field(
  mut self,
  field: crate::metadata::SupportedField,
  ) -> Self {
  self.metadata.add_field(field);
  self
  }
 
+ /// Add provided `SupportedField` into the `Metadata`.
+ pub fn remove_metadata_field(
+ mut self,
+ field_label: crate::metadata::SupportedLabel,
+ ) -> Self {
+ self.metadata.remove_field(field_label);
+ self
+ }
+
  /// Set the content (COSE payload) to the document builder.
  /// It will set the content as its provided, make sure by yourself that
  /// `content-type` and `content-encoding` fields are aligned with the
  /// provided content bytes.
- pub(crate) fn with_content(
+ pub fn with_content(
  mut self,
  content: Vec<u8>,
  ) -> Self {
  self.content = content.into();
  self
  }
 
+ /// Set the content (COSE payload) to CBOR nil to the document builder.
+ /// It will set the content as its provided, make sure by yourself that
+ /// `content-type` and `content-encoding` fields are aligned with the
+ /// provided content bytes.
+ pub fn with_empty_content(mut self) -> Self {
+ self.content = Content::default();
+ self
+ }
+
  /// Add a signature to the document
- pub(crate) fn add_signature(
+ pub fn add_signature(
  mut self,
  sign_fn: impl FnOnce(Vec<u8>) -> Vec<u8>,
  kid: super::CatalystId,
@@ -256,9 +286,15 @@ pub(crate) mod tests {
  Ok(self)
  }
 
+ /// Clear all existing signatures.
+ pub fn clear_signatures(mut self) -> anyhow::Result<Self> {
+ self.signatures = Signatures::default();
+ Ok(self)
+ }
+
  /// Build a signed document with the collected error report.
  /// Could provide an invalid document.
- pub(crate) fn build(self) -> super::CatalystSignedDocument {
+ pub fn build(self) -> super::CatalystSignedDocument {
  let metadata_bytes = minicbor::to_vec(self.metadata).unwrap();
  let content_bytes = minicbor::to_vec(self.content).unwrap();
  let signature_bytes = minicbor::to_vec(self.signatures).unwrap();

rust/signed_doc/src/lib.rs

@@ -1,6 +1,6 @@
 //! Catalyst documents signing crate
 
-mod builder;
+pub mod builder;
 mod content;
 pub mod decode_context;
 pub mod doc_types;
@@ -231,12 +231,8 @@ impl CatalystSignedDocument {
 
  /// Returns a signed document `Builder` pre-loaded with the current signed document's
  /// data.
- ///
- /// # Errors
- /// - If error returned its probably a bug. `CatalystSignedDocument` must be a valid
- /// COSE structure.
- pub fn into_builder(&self) -> anyhow::Result<SignaturesBuilder> {
- self.try_into()
+ pub fn into_builder(&self) -> SignaturesBuilder {
+ self.into()
  }
 }
 

rust/signed_doc/src/metadata/mod.rs

@@ -139,14 +139,27 @@ impl Metadata {
  /// Building metadata by-field with this function doesn't ensure the presence of
  /// required fields. Use [`Self::from_fields`] or [`Self::from_json`] if it's
  /// important for metadata to be valid.
- #[cfg(test)]
  pub(crate) fn add_field(
  &mut self,
  field: SupportedField,
  ) {
  self.0.insert(field.discriminant(), field);
  }
 
+ /// Removes `SupportedField` from the `Metadata`.
+ ///
+ /// # Warning
+ ///
+ /// Building metadata by-field with this function doesn't ensure the presence of
+ /// required fields. Use [`Self::from_fields`] or [`Self::from_json`] if it's
+ /// important for metadata to be valid.
+ pub(crate) fn remove_field(
+ &mut self,
+ field_label: SupportedLabel,
+ ) {
+ self.0.remove(&field_label);
+ }
+
  /// Build `Metadata` object from the metadata fields, doing all necessary validation.
  pub(crate) fn from_fields<E>(
  fields: impl Iterator<Item = Result<SupportedField, E>>,

rust/signed_doc/src/metadata/supported_field.rs

@@ -86,7 +86,7 @@ impl fmt::Display for Label<'_> {
 )]
 #[non_exhaustive]
 #[repr(usize)]
-pub(crate) enum SupportedField {
+pub enum SupportedField {
  /// `content-type` field. In COSE it's represented as the signed integer `3` (see [RFC
  /// 8949 section 3.1]).
  ///

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

@@ -180,7 +180,6 @@ mod tests {
  let (another_sk, ..) = create_dummy_key_pair(RoleId::Role0);
  let invalid_doc = signed_doc
  .into_builder()
- .unwrap()
  .add_signature(|m| another_sk.sign(&m).to_vec(), kid.clone())
  .unwrap()
  .build()