test(cat-gateway): Prepare document submission in different types for integration test (#3713)

* initial

* feat: tmp setup

* feat: prepare test data

* chore: minor

* chore: preparing minor

* feat: apply json auto generate

* feat: apply json auto generate

* feat: general factory

* feat: campaign setup

* feat: minor rework

* feat: pre final

* chore: fmt

* chore: add jsf

* chore: remove unused template

* chore: once fixture

* fix: factory calling

* chore: update lockfile

* fix: comments

* chore: move metadata

* fix: type

* chore: reorder fixtures

* chore: reorder fixtures

* fix: imports

* fix: proposal form template metadata

* fix: proposal form template id, ver, and params

* fix: proposal form template id, ver, and params

* feat: admin key setup initial

* feat: admin auth key

* fix: cspell

* chore: minor builder clean up

* chore: minor format

* chore: minor format

* chore: role id as param

* chore: minor admin

* chore: admin cat-id

* test(cat-gateway): Prepare document submission in different types for integration test [CI fixes] (#3781)

* rename ProposalParameterType to ParameterType

* cleanup

* set the 3.13 python version

* fix

* fix

* fix

* fix

* fix

* try

* try

* bump mk_signed_doc to `catalyst-signed-doc/v0.0.10`

* replace JSF with ranjg

* fix spelling

* chore: minor cleanup

* wip

---------

Co-authored-by: Alex Pozhylenkov <[email protected]>

Author: apskhem

.config/dictionaries/project.dic

@@ -294,6 +294,7 @@ pyproject
 pyright
 pytest
 qrcode
+ranjg
 rapidoc
 ratelimit
 redoc

catalyst-gateway/bin/src/db/event/signed_docs/tests/mod.rs

@@ -189,9 +189,8 @@ async fn filter_by_type(
     }
 }
 
-/// Pre-seeded documents `f14.sql`, `f15.sql`, `old_format_signed_doc.sql` and
-/// `test_signed_documents.sql`
-const PRE_SEED_DATA: usize = 57;
+/// Pre-seeded documents `f14.sql`, `f15.sql`, `old_format_signed_doc.sql`
+const PRE_SEED_DATA: usize = 55;
 
 async fn filter_all(docs: &[FullSignedDoc]) {
     let filter = DocsQueryFilter::all();

catalyst-gateway/bin/src/service/api/documents/common/mod.rs

@@ -208,12 +208,13 @@ impl VerifyingKeyProvider {
         token: &mut CatalystRBACTokenV1,
         kids: &[catalyst_signed_doc::CatalystId],
     ) -> anyhow::Result<Self> {
-        if kids.len() > 1 {
-            anyhow::bail!("Multi-signature document is currently unsupported");
-        }
+        use itertools::Itertools as _;
 
         let [kid] = kids else {
-            anyhow::bail!("Multi-signature document is currently unsupported");
+            anyhow::bail!(
+                "Must have only one signature. Multi-signature document is currently unsupported. kids: [{}]",
+                kids.iter().map(ToString::to_string).join(",")
+            );
         };
 
         if kid != token.catalyst_id() {

catalyst-gateway/docker-compose.yml

@@ -57,6 +57,9 @@ services:
       - CHAIN_NETWORK=Preprod
       - SIGNED_DOC_SK=0x6455585b5dcc565c8975bc136e215d6d4dd96540620f37783c564da3cb3686dd
       - INTERNAL_API_KEY=123
+      # cspell: disable
+      - SIGNED_DOC_ADMIN_KEYS=admin.catalyst://preprod.cardano/0KGVpkXVe5-h1RfIb08Mnc-xMZTzSX5VVnPDaHvhrqQ/0/10
+      # cspell: enable
       # - LOG_LEVEL=error
       # - RUST_LOG="error,cat_gateway=debug,cardano_chain_follower=debug,mithril-client=debug"
     ports:

catalyst-gateway/event-db/seed/test_signed_documents.sql

@@ -0,0 +1 @@
+3.14.0rc1

catalyst-gateway/tests/api_tests/.python-version

@@ -1,7 +1,7 @@
 VERSION 0.8
 
 IMPORT github.com/input-output-hk/catalyst-ci/earthly/python:v3.6.3 AS python-ci
-IMPORT github.com/input-output-hk/catalyst-libs/rust:catalyst-signed-doc/v0.0.8 AS cat-libs-rust
+IMPORT github.com/input-output-hk/catalyst-libs/rust:catalyst-signed-doc/v0.0.10 AS cat-libs-rust
 IMPORT github.com/input-output-hk/catalyst-libs/rust:catalyst-signed-doc/v.0.0.4-fix-earthly-build AS dep-cat-libs-rust
 IMPORT github.com/input-output-hk/catalyst-storage AS cat-storage
 

catalyst-gateway/tests/api_tests/Earthfile

@@ -2,16 +2,25 @@
 from utils import uuid_v7
 from api.v1 import document as document_v1
 from api.v2 import document as document_v2
-from utils.rbac_chain import rbac_chain_factory
+from utils.rbac_chain import rbac_chain_factory, RoleID
+from utils.admin import admin_key
 from utils.signed_doc import (
     proposal_doc_factory,
+    proposal_form_template_doc,
+    category_parameters_doc,
+    category_parameters_form_template_doc,
+    campaign_parameters_doc,
+    campaign_parameters_form_template_doc,
+    brand_parameters_doc,
+    brand_parameters_form_template_doc,
 )
 
 
 @pytest.mark.preprod_indexing
 def test_document_put_and_get_endpoints(proposal_doc_factory, rbac_chain_factory):
-    (proposal_doc, role_id) = proposal_doc_factory()
     rbac_chain = rbac_chain_factory()
+    role_id = RoleID.PROPOSER
+    proposal_doc = proposal_doc_factory(role_id)
     (cat_id, sk_hex) = rbac_chain.cat_id_for_role(role_id)
     proposal_doc_id = proposal_doc.metadata["id"]
 
@@ -55,7 +64,7 @@ def test_document_put_and_get_endpoints(proposal_doc_factory, rbac_chain_factory
 
     # Put a non valid document with same ID different content
     invalid_doc = proposal_doc.copy()
-    invalid_doc.content["setup"]["title"]["title"] = "another title"
+    invalid_doc.content["setup"]["title"] = {"title": "another title"}
     resp = document_v1.put(
         data=invalid_doc.build_and_sign(cat_id, sk_hex),
         token=rbac_chain.auth_token(),
@@ -82,7 +91,8 @@ def test_document_index_endpoint(
     proposal_doc_factory,
     rbac_chain_factory,
 ):
-    (doc, role_id) = proposal_doc_factory()
+    role_id = RoleID.PROPOSER
+    doc = proposal_doc_factory(role_id)
 
     rbac_chain = rbac_chain_factory()
     (cat_id, sk_hex) = rbac_chain.cat_id_for_role(role_id)

catalyst-gateway/tests/api_tests/integration/signed_doc/test_signed_doc.py

@@ -272,7 +272,7 @@ def deprecated_proposal(rbac_chain):
             "ver": "0194d490-30bf-7473-81c8-a0eaef369619",
         },
     }
-    with open("./test_data/signed_docs/proposal.json", "r") as json_file:
+    with open("./test_data/signed_docs/proposal.deprecated.json", "r") as json_file:
         content = json.load(json_file)
 
     doc = SignedDocumentV1(proposal_metadata_json, content)
@@ -300,7 +300,7 @@ def deprecated_comment(rbac_chain, proposal_id):
             "ver": "0194d494-4402-7e0e-b8d6-171f8fea18b0",
         },
     }
-    with open("./test_data/signed_docs/comment.json", "r") as json_file:
+    with open("./test_data/signed_docs/comment.deprecated.json", "r") as json_file:
         content = json.load(json_file)
 
     doc = SignedDocumentV1(comment_metadata_json, content)
@@ -323,7 +323,7 @@ def deprecated_proposal_submission(rbac_chain, proposal_id):
             "ver": proposal_id,
         },
     }
-    with open("./test_data/signed_docs/submission_action.json", "r") as json_file:
+    with open("./test_data/signed_docs/submission_action.deprecated.json", "r") as json_file:
         content = json.load(json_file)
 
     doc = SignedDocumentV1(sub_action_metadata_json, content)