test(cat-gateway): Generate auth token for test (#2163)

* test(cat-gateway): generate auth token with already registered account

Signed-off-by: bkioshn <[email protected]>

* test(cat-gateway): remove BEARER_TOKEN env

Signed-off-by: bkioshn <[email protected]>

* test(cat-gateway): fix rbac auth token factory

Signed-off-by: bkioshn <[email protected]>

---------

Signed-off-by: bkioshn <[email protected]>

Author: bkioshn

catalyst-gateway/tests/api_tests/Earthfile

@@ -21,8 +21,6 @@ test:
 
     ENV EVENT_DB_TEST_URL "postgres://catalyst-event-dev:CHANGE_ME@localhost/CatalystEventDev"
     ENV CAT_GATEWAY_TEST_URL "http://127.0.0.1:3030"
-    # cspell: disable-next-line
-    ENV BEARER_TOKEN = "catid.:[email protected]/ycih6xARcuFGiRrtf1ETLWPvXGd_UBheZ4A5kccWNAU.2CB_ByoGhZ8xBjLveK6jcGbKZ7_5TDjCwbTyNtHWFXnyKuvkTp9zo9tmBOVkPRbHjSwzx85kX3lIoGtKF3_dDQ"
 
     WITH DOCKER \
         --compose docker-compose.yml \

catalyst-gateway/tests/api_tests/api/__init__.py

@@ -7,14 +7,6 @@
    print ("Please set the environment variable CAT_GATEWAY_TEST_URL")
    sys.exit(1)
 
-try:
-   os.environ["BEARER_TOKEN"]
-except KeyError:
-   print ("Please set the environment variable BEARER_TOKEN")
-   sys.exit(1)
-   
-
-BEARER_TOKEN = os.environ["BEARER_TOKEN"]
 CAT_GATEWAY_TEST_URL = os.environ["CAT_GATEWAY_TEST_URL"]
 
 def cat_gateway_endpoint_url(endpoint: str):

catalyst-gateway/tests/api_tests/api/v1/document.py

@@ -1,29 +1,29 @@
 import requests
-from api import cat_gateway_endpoint_url, BEARER_TOKEN
+from api import cat_gateway_endpoint_url
 
 URL = cat_gateway_endpoint_url("api/v1/document")
 
 # Signed document GET
-def get(document_id: str):
+def get(document_id: str, token: str):
     document_url = f"{URL}/{document_id}"
     headers = {
-        "Authorization": f"Bearer {BEARER_TOKEN}"
+        "Authorization": f"Bearer {token}"
     }
     return requests.get(document_url, headers=headers)
 
 # Signed document PUT
-def put(data: str):
+def put(data: str, token: str):
     headers = {
-        "Authorization": f"Bearer {BEARER_TOKEN}",
+        "Authorization": f"Bearer {token}",
         "Content-Type": "application/cbor"
     }
     data = bytes.fromhex(data)
     return requests.put(URL, headers=headers, data=data)
 
 # Signed document POST
-def post(document_url: str, filter: dict):
+def post(document_url: str, filter: dict, token: str):
     headers = {
-        "Authorization": f"Bearer {BEARER_TOKEN}",
+        "Authorization": f"Bearer {token}",
         "Content-Type": "application/json"
     }
     return requests.post(f"{URL}{document_url}", headers=headers, json=filter)

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

@@ -7,6 +7,7 @@
 from typing import Dict, Any, List
 from uuid_extensions import uuid7str
 import copy
+from utils.auth_token import rbac_auth_token_factory
 
 
 class SignedDocument:
@@ -66,8 +67,9 @@ def comment_templates() -> List[str]:
 
 # return a Proposal document which is already published to the cat-gateway
 @pytest.fixture
-def proposal_doc_factory(proposal_templates):
+def proposal_doc_factory(proposal_templates, rbac_auth_token_factory):
     def __proposal_doc_factory() -> SignedDocument:
+        rbac_auth_token = rbac_auth_token_factory()
         proposal_doc_id = uuid7str()
         proposal_metadata_json = {
             "id": proposal_doc_id,
@@ -85,7 +87,7 @@ def __proposal_doc_factory() -> SignedDocument:
             proposal_json = json.load(proposal_json_file)
 
         doc = SignedDocument(proposal_metadata_json, proposal_json)
-        resp = document.put(data=doc.hex())
+        resp = document.put(data=doc.hex(), token=rbac_auth_token)
         assert (
             resp.status_code == 201
         ), f"Failed to publish document: {resp.status_code} - {resp.text}"
@@ -97,8 +99,9 @@ def __proposal_doc_factory() -> SignedDocument:
 
 # return a Comment document which is already published to the cat-gateway
 @pytest.fixture
-def comment_doc_factory(proposal_doc_factory, comment_templates) -> SignedDocument:
+def comment_doc_factory(proposal_doc_factory, comment_templates, rbac_auth_token_factory) -> SignedDocument:
     def __comment_doc_factory() -> SignedDocument:
+        rbac_auth_token = rbac_auth_token_factory()
         proposal_doc = proposal_doc_factory()
         comment_doc_id = uuid7str()
         comment_metadata_json = {
@@ -115,7 +118,7 @@ def __comment_doc_factory() -> SignedDocument:
             comment_json = json.load(comment_json_file)
 
         doc = SignedDocument(comment_metadata_json, comment_json)
-        resp = document.put(data=doc.hex())
+        resp = document.put(data=doc.hex(), token=rbac_auth_token)
         assert (
             resp.status_code == 201
         ), f"Failed to publish document: {resp.status_code} - {resp.text}"
@@ -128,9 +131,10 @@ def __comment_doc_factory() -> SignedDocument:
 # return a submission action document.
 @pytest.fixture
 def submission_action_factory(
-    proposal_doc_factory, comment_templates
+    proposal_doc_factory, comment_templates, rbac_auth_token_factory
 ) -> SignedDocument:
     def __submission_action_factory() -> SignedDocument:
+        rbac_auth_token = rbac_auth_token_factory()
         proposal_doc = proposal_doc_factory()
         submission_action_id = uuid7str()
         sub_action_metadata_json = {
@@ -148,7 +152,7 @@ def __submission_action_factory() -> SignedDocument:
             comment_json = json.load(comment_json_file)
 
         doc = SignedDocument(sub_action_metadata_json, comment_json)
-        resp = document.put(data=doc.hex())
+        resp = document.put(data=doc.hex(), token=rbac_auth_token)
         assert (
             resp.status_code == 201
         ), f"Failed to publish sub_action: {resp.status_code} - {resp.text}"
@@ -158,41 +162,43 @@ def __submission_action_factory() -> SignedDocument:
     return __submission_action_factory
 
 
-def test_templates(proposal_templates, comment_templates):
+def test_templates(proposal_templates, comment_templates, rbac_auth_token_factory):
+    rbac_auth_token = rbac_auth_token_factory()
     templates = proposal_templates + comment_templates
     for template_id in templates:
-        resp = document.get(document_id=template_id)
+        resp = document.get(document_id=template_id, token=rbac_auth_token)
         assert (
             resp.status_code == 200
         ), f"Failed to get document: {resp.status_code} - {resp.text} for id {template_id}"
 
 
-def test_proposal_doc(proposal_doc_factory):
+def test_proposal_doc(proposal_doc_factory, rbac_auth_token_factory):
+    rbac_auth_token = rbac_auth_token_factory()
     proposal_doc = proposal_doc_factory()
     proposal_doc_id = proposal_doc.metadata["id"]
 
     # Put a proposal document again
-    resp = document.put(data=proposal_doc.hex())
+    resp = document.put(data=proposal_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 204
     ), f"Failed to publish document: {resp.status_code} - {resp.text}"
 
     # Get the proposal document
-    resp = document.get(document_id=proposal_doc_id)
+    resp = document.get(document_id=proposal_doc_id, token=rbac_auth_token)
     assert (
         resp.status_code == 200
     ), f"Failed to get document: {resp.status_code} - {resp.text}"
 
     # Post a signed document with filter ID
-    resp = document.post("/index", filter={"id": {"eq": proposal_doc_id}})
+    resp = document.post("/index", filter={"id": {"eq": proposal_doc_id}}, token=rbac_auth_token)
     assert (
         resp.status_code == 200
     ), f"Failed to post document: {resp.status_code} - {resp.text}"
 
     # Put a proposal document with same ID different content
     invalid_doc = proposal_doc.copy()
     invalid_doc.content["setup"]["title"]["title"] = "another title"
-    resp = document.put(data=invalid_doc.hex())
+    resp = document.put(data=invalid_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 422
     ), f"Publish document, expected 422 Unprocessable Content: {resp.status_code} - {resp.text}"
@@ -201,15 +207,15 @@ def test_proposal_doc(proposal_doc_factory):
     new_doc = proposal_doc.copy()
     new_doc.metadata["ver"] = uuid7str()
     new_doc.content["setup"]["title"]["title"] = "another title"
-    resp = document.put(data=new_doc.hex())
+    resp = document.put(data=new_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 201
     ), f"Failed to publish document: {resp.status_code} - {resp.text}"
 
     # Put a proposal document with the not known template field
     invalid_doc = proposal_doc.copy()
     invalid_doc.metadata["template"] = {"id": uuid7str()}
-    resp = document.put(data=invalid_doc.hex())
+    resp = document.put(data=invalid_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 422
     ), f"Publish document, expected 422 Unprocessable Content: {resp.status_code} - {resp.text}"
@@ -218,32 +224,33 @@ def test_proposal_doc(proposal_doc_factory):
     invalid_doc = proposal_doc.copy()
     invalid_doc.metadata["ver"] = uuid7str()
     invalid_doc.content = {}
-    resp = document.put(data=invalid_doc.hex())
+    resp = document.put(data=invalid_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 422
     ), f"Publish document, expected 422 Unprocessable Content: {resp.status_code} - {resp.text}"
 
     logger.info("Proposal document test successful.")
 
 
-def test_comment_doc(comment_doc_factory):
+def test_comment_doc(comment_doc_factory, rbac_auth_token_factory):
+    rbac_auth_token = rbac_auth_token_factory()
     comment_doc = comment_doc_factory()
     comment_doc_id = comment_doc.metadata["id"]
 
     # Put a comment document again
-    resp = document.put(data=comment_doc.hex())
+    resp = document.put(data=comment_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 204
     ), f"Failed to publish document: {resp.status_code} - {resp.text}"
 
     # Get the comment document
-    resp = document.get(document_id=comment_doc_id)
+    resp = document.get(document_id=comment_doc_id, token=rbac_auth_token)
     assert (
         resp.status_code == 200
     ), f"Failed to get document: {resp.status_code} - {resp.text}"
 
     # Post a signed document with filter ID
-    resp = document.post("/index", filter={"id": {"eq": comment_doc_id}})
+    resp = document.post("/index", filter={"id": {"eq": comment_doc_id}}, token=rbac_auth_token)
     assert (
         resp.status_code == 200
     ), f"Failed to post document: {resp.status_code} - {resp.text}"
@@ -252,72 +259,74 @@ def test_comment_doc(comment_doc_factory):
     invalid_doc = comment_doc.copy()
     invalid_doc.metadata["ver"] = uuid7str()
     invalid_doc.content = {}
-    resp = document.put(data=invalid_doc.hex())
+    resp = document.put(data=invalid_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 422
     ), f"Publish document, expected 422 Unprocessable Content: {resp.status_code} - {resp.text}"
 
     # Put a comment document referencing to the not known proposal
     invalid_doc = comment_doc.copy()
     invalid_doc.metadata["ref"] = {"id": uuid7str()}
-    resp = document.put(data=invalid_doc.hex())
+    resp = document.put(data=invalid_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 422
     ), f"Publish document, expected 422 Unprocessable Content: {resp.status_code} - {resp.text}"
 
     logger.info("Comment document test successful.")
 
 
-def test_submission_action(submission_action_factory):
+def test_submission_action(submission_action_factory, rbac_auth_token_factory):
+    rbac_auth_token = rbac_auth_token_factory()
     submission_action = submission_action_factory()
     submission_action_id = submission_action.metadata["id"]
 
     # Put a submission action document
-    resp = document.put(data=submission_action.hex())
+    resp = document.put(data=submission_action.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 204
     ), f"Failed to publish document: {resp.status_code} - {resp.text}"
 
     # Get the submission action doc
-    resp = document.get(document_id=submission_action_id)
+    resp = document.get(document_id=submission_action_id, token=rbac_auth_token)
     assert (
         resp.status_code == 200
     ), f"Failed to get document: {resp.status_code} - {resp.text}"
 
     # Post a signed document with filter ID
-    resp = document.post("/index", filter={"id": {"eq": submission_action_id}})
+    resp = document.post("/index", filter={"id": {"eq": submission_action_id}}, token=rbac_auth_token)
     assert (
         resp.status_code == 200
     ), f"Failed to post document: {resp.status_code} - {resp.text}"
 
     # Submission action document MUST have a ref
     invalid_doc = submission_action.copy()
     invalid_doc.metadata["ref"] = {}
-    resp = document.put(data=invalid_doc.hex())
+    resp = document.put(data=invalid_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 422
     ), f"Publish document, expected 422 Unprocessable Content: {resp.status_code} - {resp.text}"
 
     # Put a submission action document referencing an unknown proposal
     invalid_doc = submission_action.copy()
     invalid_doc.metadata["ref"] = {"id": uuid7str()}
-    resp = document.put(data=invalid_doc.hex())
+    resp = document.put(data=invalid_doc.hex(), token=rbac_auth_token)
     assert (
         resp.status_code == 422
     ), f"Publish document, expected 422 Unprocessable Content: {resp.status_code} - {resp.text}"
 
     logger.info("Submission action document test successful.")
 
 
-def test_document_index_endpoint(proposal_doc_factory):
+def test_document_index_endpoint(proposal_doc_factory, rbac_auth_token_factory):
+    rbac_auth_token = rbac_auth_token_factory()
     # submiting 10 proposal documents
     total_amount = 10
     first_proposal = proposal_doc_factory()
     for _ in range(total_amount - 1):
         doc = first_proposal.copy()
         # keep the same id, but different version
         doc.metadata["ver"] = uuid7str()
-        resp = document.put(data=doc.hex())
+        resp = document.put(data=doc.hex(), token=rbac_auth_token)
         assert (
             resp.status_code == 201
         ), f"Failed to publish document: {resp.status_code} - {resp.text}"
@@ -328,6 +337,7 @@ def test_document_index_endpoint(proposal_doc_factory):
     resp = document.post(
         f"/index?limit={limit}&page={page}",
         filter=filter,
+        token=rbac_auth_token
     )
     assert (
         resp.status_code == 200
@@ -342,6 +352,7 @@ def test_document_index_endpoint(proposal_doc_factory):
     resp = document.post(
         f"/index?limit={limit}&page={page}",
         filter=filter,
+        token=rbac_auth_token
     )
     assert (
         resp.status_code == 200
@@ -355,6 +366,7 @@ def test_document_index_endpoint(proposal_doc_factory):
     resp = document.post(
         f"/index?limit={total_amount}",
         filter=filter,
+        token=rbac_auth_token
     )
     assert (
         resp.status_code == 200
@@ -368,6 +380,7 @@ def test_document_index_endpoint(proposal_doc_factory):
     resp = document.post(
         "/index?page=92233720368547759",
         filter={},
+        token=rbac_auth_token
     )
     assert (
         resp.status_code == 412