chore(rust/signed-doc): Making tests/common module as a public mod catalyst_signed_doc::tests_utils

rust/signed_doc/Cargo.toml

@@ -45,9 +45,11 @@ multibase = "0.9.2"
 async-trait = "0.1.89"
 dashmap = "6.1.0"
 
+# tests_utils dependencies
+rand = "0.8.5"
+
 [dev-dependencies]
 base64-url = "3.0.0"
-rand = "0.8.5"
 uuid = { version = "1.12.0", features = ["v7"] }
 tokio = { version = "1.42.0", features = ["macros"] }
 test-case = "3.3.1"

rust/signed_doc/src/lib.rs

@@ -8,6 +8,7 @@ pub mod doc_types;
 mod metadata;
 pub mod providers;
 mod signature;
+pub mod tests_utils;
 pub mod validator;
 
 use std::{

rust/signed_doc/src/metadata/document_refs/doc_locator.rs

@@ -146,7 +146,7 @@ mod tests {
     use minicbor::{Decoder, Encoder};
 
     use super::*;
-    use crate::{Builder, ContentType, metadata::document_refs::tests::create_dummy_doc_ref};
+    use crate::{Builder, ContentType, tests_utils::create_dummy_doc_ref};
 
     #[test]
     fn test_doc_locator_encode_decode() {

rust/signed_doc/src/metadata/document_refs/mod.rs

@@ -195,31 +195,12 @@ mod serde_impl {
 #[cfg(test)]
 pub(crate) mod tests {
 
-    use catalyst_types::uuid::{CborContext, UuidV4, UuidV7};
+    use catalyst_types::uuid::{CborContext, UuidV7};
     use minicbor::{Decoder, Encoder};
     use test_case::test_case;
 
     use super::*;
-    use crate::{ContentType, builder::Builder};
-
-    pub(crate) fn create_dummy_doc_ref() -> DocumentRef {
-        let id = UuidV7::new();
-        let ver = UuidV7::new();
-        let doc = Builder::new()
-            .with_json_metadata(serde_json::json!({
-                "id": id.to_string(),
-                "ver": ver.to_string(),
-                "type": UuidV4::new().to_string(),
-                "content-type": ContentType::Json,
-            }))
-            .expect("Should create metadata")
-            .with_json_content(&serde_json::json!({"test": "content"}))
-            .expect("Should set content")
-            .build()
-            .expect("Should build document");
-
-        doc.doc_ref().expect("Should generate DocumentRef")
-    }
+    use crate::tests_utils::create_dummy_doc_ref;
 
     #[test_case(
         CompatibilityPolicy::Accept,

rust/signed_doc/tests/common/brand_parameters.rs → rust/signed_doc/src/tests_utils/brand_parameters.rs

@@ -1,14 +1,17 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
+#[allow(clippy::missing_errors_doc)]
 pub fn brand_parameters_doc(
     template: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let template_ref = template.doc_ref()?;

rust/signed_doc/tests/common/brand_parameters_form_template.rs → rust/signed_doc/src/tests_utils/brand_parameters_form_template.rs

@@ -1,13 +1,16 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
+#[allow(clippy::missing_errors_doc)]
 pub fn brand_parameters_form_template_doc(
     provider: &mut TestCatalystProvider
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
     Builder::new()
         .with_json_metadata(serde_json::json!({

rust/signed_doc/tests/common/campaign_parameters.rs → rust/signed_doc/src/tests_utils/campaign_parameters.rs

@@ -1,15 +1,18 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
+#[allow(clippy::missing_errors_doc)]
 pub fn campaign_parameters_doc(
     template: &CatalystSignedDocument,
     parameters: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let template_ref = template.doc_ref()?;

rust/signed_doc/tests/common/campaign_parameters_form_template.rs → rust/signed_doc/src/tests_utils/campaign_parameters_form_template.rs

@@ -1,14 +1,17 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
+#[allow(clippy::missing_errors_doc)]
 pub fn campaign_parameters_form_template_doc(
     parameters: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let parameters_ref = parameters.doc_ref()?;

rust/signed_doc/tests/common/category_parameters.rs → rust/signed_doc/src/tests_utils/category_parameters.rs

@@ -1,15 +1,18 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
+#[allow(clippy::missing_errors_doc)]
 pub fn category_parameters_doc(
     template: &CatalystSignedDocument,
     parameters: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let template_ref = template.doc_ref()?;

rust/signed_doc/tests/common/category_parameters_form_template.rs → rust/signed_doc/src/tests_utils/category_parameters_form_template.rs

@@ -1,14 +1,17 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
+#[allow(clippy::missing_errors_doc)]
 pub fn category_parameters_form_template_doc(
     parameters: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let parameters_ref = parameters.doc_ref()?;

rust/signed_doc/tests/common/contest_ballot.rs → rust/signed_doc/src/tests_utils/contest_ballot.rs

@@ -1,16 +1,18 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
-/// Creates a contest ballot document.
+#[allow(clippy::missing_errors_doc)]
 pub fn contest_ballot_doc(
     ref_doc: &CatalystSignedDocument,
     parameters_doc: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let parameters_ref = parameters_doc.doc_ref()?;

rust/signed_doc/tests/common/contest_ballot_checkpoint.rs → rust/signed_doc/src/tests_utils/contest_ballot_checkpoint.rs

@@ -1,16 +1,18 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, Chain, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
-/// Creates a contest ballot checkpoint document.
+#[allow(clippy::missing_errors_doc)]
 pub fn contest_ballot_checkpoint_doc(
     linked_doc: &CatalystSignedDocument,
     parameters_doc: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let linked_ref = linked_doc.doc_ref()?;

rust/signed_doc/tests/common/contest_delegation.rs → rust/signed_doc/src/tests_utils/contest_delegation.rs

@@ -1,16 +1,19 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, catalyst_id::role_index::RoleId,
+    doc_types, providers::tests::TestCatalystProvider, tests_utils::create_dummy_key_pair,
+    uuid::UuidV7,
+};
 
-/// Creates a contest delegation document.
+#[allow(clippy::missing_errors_doc)]
 pub fn contest_delegation_doc(
     ref_doc: &CatalystSignedDocument,
     parameters_doc: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(Some(RoleId::Role0));
+    let (sk, kid) = create_dummy_key_pair(RoleId::Role0);
     provider.add_sk(kid.clone(), sk.clone());
 
     let parameters_ref = parameters_doc.doc_ref()?;

rust/signed_doc/tests/common/contest_parameters.rs → rust/signed_doc/src/tests_utils/contest_parameters.rs

@@ -1,16 +1,18 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
-/// Creates a contest parameters form template document.
+#[allow(clippy::missing_errors_doc)]
 pub fn contest_parameters_doc(
     template: &CatalystSignedDocument,
     parameters_doc: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let template_ref = template.doc_ref()?;

rust/signed_doc/tests/common/contest_parameters_form_template.rs → rust/signed_doc/src/tests_utils/contest_parameters_form_template.rs

@@ -1,15 +1,17 @@
-use catalyst_signed_doc::providers::tests::TestCatalystProvider;
 use ed25519_dalek::ed25519::signature::Signer;
 
-use super::*;
+use crate::{
+    Builder, CatalystSignedDocument, ContentEncoding, ContentType, doc_types,
+    providers::tests::TestCatalystProvider, tests_utils::create_dummy_admin_key_pair, uuid::UuidV7,
+};
 
-/// Creates a contest parameters form template document.
+#[allow(clippy::missing_errors_doc)]
 pub fn contest_parameters_form_template_doc(
     parameters_doc: &CatalystSignedDocument,
     provider: &mut TestCatalystProvider,
 ) -> anyhow::Result<CatalystSignedDocument> {
     let id = UuidV7::new();
-    let (sk, kid) = create_dummy_key_pair(None);
+    let (sk, kid) = create_dummy_admin_key_pair();
     provider.add_sk(kid.clone(), sk.clone());
 
     let parameters_ref = parameters_doc.doc_ref()?;