argus-alm 0.15.6__py3-none-any.whl → 0.15.8__py3-none-any.whl

argus/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.15.6'
-__version_tuple__ = version_tuple = (0, 15, 6)
+__version__ = version = '0.15.8'
+__version_tuple__ = version_tuple = (0, 15, 8)
 
 __commit_id__ = commit_id = None

argus/client/base.py

@@ -37,16 +37,14 @@ class ArgusClient:
         self._auth_token = auth_token
         self._base_url = base_url
         self._api_ver = api_version
-        self._extra_headers = extra_headers or {}
+        self.session = requests.Session()
+        if extra_headers:
+            self.session.headers.update(extra_headers)
 
     @property
     def auth_token(self) -> str:
         return self._auth_token
 
-    @property
-    def extra_headers(self) -> dict:
-        return self._extra_headers
-
     def verify_location_params(self, endpoint: str, location_params: dict[str, str]) -> bool:
         required_params: list[str] = re.findall(r"\$[\w_]+", endpoint)
         for param in required_params:
@@ -92,7 +90,6 @@ class ArgusClient:
             "Authorization": f"token {self.auth_token}",
             "Accept": "application/json",
             "Content-Type": "application/json",
-            **self.extra_headers,
         }
 
     def get(self, endpoint: str, location_params: dict[str, str] = None, params: dict = None) -> requests.Response:
@@ -101,7 +98,7 @@ class ArgusClient:
             location_params=location_params
         )
         LOGGER.debug("GET Request: %s, params: %s", url, params)
-        response = requests.get(
+        response = self.session.get(
             url=url,
             params=params,
             headers=self.request_headers
@@ -122,7 +119,7 @@ class ArgusClient:
             location_params=location_params
         )
         LOGGER.debug("POST Request: %s, params: %s, body: %s", url, params, body)
-        response = requests.post(
+        response = self.session.post(
             url=url,
             params=params,
             json=body,

argus/client/sct/client.py

@@ -2,6 +2,7 @@ import base64
 from typing import Any
 from uuid import UUID
 from dataclasses import asdict
+from argus.common.email import RawAttachment, ReportSection, ReportSectionShortHand
 from argus.common.sct_types import GeminiResultsRequest, PerformanceResultsRequest, RawEventPayload
 from argus.common.enums import ResourceState, TestStatus
 from argus.client.base import ArgusClient
@@ -27,6 +28,7 @@ class ArgusSCTClient(ArgusClient):
         SUBMIT_EVENTS = "/sct/$id/events/submit"
         SUBMIT_EVENT = "/sct/$id/event/submit"
         SUBMIT_JUNIT_REPORT = "/sct/$id/junit/submit"
+        SUBMIT_EMAIL = "/testrun/report"
 
     def __init__(self, run_id: UUID, auth_token: str, base_url: str, api_version="v1", extra_headers: dict | None = None) -> None:
         super().__init__(auth_token, base_url, api_version, extra_headers=extra_headers)
@@ -136,6 +138,25 @@ class ArgusSCTClient(ArgusClient):
         )
         self.check_response(response)
 
+    def send_email(self, recipients: list[str], title: str = "#auto", sections: list[ReportSection | ReportSectionShortHand] = None, attachments: list[RawAttachment] | None = None) -> None:
+        """
+            Send a testrun report email using Argus.
+            Documentation: https://github.com/scylladb/argus/blob/master/docs/api_usage.md#L124
+        """
+        response = self.post(
+            endpoint=self.Routes.SUBMIT_EMAIL,
+            location_params={},
+            body={
+                **self.generic_body,
+                "run_id": self.run_id,
+                "title": title,
+                "recipients": recipients,
+                "sections": sections or [],
+                "attachments": attachments or [],
+            }
+        )
+        self.check_response(response)
+
     def submit_gemini_results(self, gemini_data: GeminiResultsRequest) -> None:
         """
             Submits gemini results such as oracle node information and gemini command & its results

argus/common/email.py

@@ -0,0 +1,33 @@
+
+from typing import Any, Literal, TypedDict
+
+
+class ReportSection(TypedDict):
+    type: str
+    options: dict[str, Any]
+
+
+ReportSectionShortHand = Literal["main",
+                                 "header",
+                                 "packages",
+                                 "logs",
+                                 "cloud",
+                                 "nemesis",
+                                 "events",
+                                 "screenshots",
+                                 "custom_table",
+                                 "custom_html",]
+
+
+class RawAttachment(TypedDict):
+    filename: str
+    data: str # Base64 string
+
+
+class RawReportSendRequest(TypedDict):
+    schema_version: str
+    run_id: str
+    title: str
+    recipients: list[str]
+    sections: list[ReportSection]
+    attachments: list[RawAttachment]

argus/common/enums.py

@@ -39,6 +39,7 @@ class PytestStatus(str, Enum):
 
 
 class TestInvestigationStatus(str, Enum):
+    __test__ = False  # prevent pytest from collecting this Enum as a test class
     NOT_INVESTIGATED = "not_investigated"
     IN_PROGRESS = "in_progress"
     INVESTIGATED = "investigated"

{argus_alm-0.15.6.dist-info → argus_alm-0.15.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: argus-alm
-Version: 0.15.6
+Version: 0.15.8
 Summary: Argus
 Author-email: Alexey Kartashov <alexey.kartashov@scylladb.com>, Łukasz Sójka <lukasz.sojka@scylladb.com>
 License-Expression: Apache-2.0
@@ -24,6 +24,7 @@ Requires-Dist: python-jenkins>=1.7.0; extra == "web-backend"
 Requires-Dist: python-slugify~=6.1.1; extra == "web-backend"
 Requires-Dist: pygithub>=2.6.1; extra == "web-backend"
 Requires-Dist: boto3~=1.38.9; extra == "web-backend"
+Requires-Dist: prometheus-flask-exporter>=0.23.2; extra == "web-backend"
 Provides-Extra: docker-image
 Requires-Dist: supervisor~=4.2.4; extra == "docker-image"
 Provides-Extra: dev
@@ -50,6 +51,10 @@ Dynamic: license-file
 
 Argus is a test tracking system intended to provide observability into automated test pipelines which use long-running resources. It allows observation of a test status, its events and its allocated resources. It also allows easy comparison between particular runs of a specific test.
 
+## Contributing
+
+Review the [Repository Guidelines](AGENTS.md) for project structure, tooling expectations, and pull request practices before submitting changes.
+
 ## Installation notes
 
 ### Development

{argus_alm-0.15.6.dist-info → argus_alm-0.15.8.dist-info}/RECORD

@@ -1,22 +1,23 @@
 argus/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argus/_version.py,sha256=qcnrtWShhkWqmd45V8inc2JAvXS6NkAKo5vOn5LwP3M,706
+argus/_version.py,sha256=OZz2ObefAkpiEMaFTa9SJuKISgl89HYDOVrF-rvuYh8,706
 argus/client/__init__.py,sha256=bO9_j5_jK5kvTHR46KEZ0Y-p0li7CBW8QSd-K5Ez4vA,42
-argus/client/base.py,sha256=XwqshXFkb6h_QJH3wlFmWjSYV3p66y7B2lufShSkWAs,8463
+argus/client/base.py,sha256=FZ9-quDXwViWbz892XnuZlWJiAmzpnTgvkRXV9i8HlE,8423
 argus/client/generic_result.py,sha256=9D0zrpfEDiIL7PjL12TZnqk5Mi_1T1UvesF5wWeMfz0,6264
 argus/client/driver_matrix_tests/cli.py,sha256=JpI0v1hzRQr9KkrxO7D4hEbkzumexFFC_iRM8558zHU,8375
 argus/client/driver_matrix_tests/client.py,sha256=fFucqwog6WnDnje1xB-4ERfwHXblXP4upmtt9RtOkls,2806
 argus/client/generic/cli.py,sha256=jsdSwzwzefX1POyrZ4lFTRcjWPmTauuXBGjceM54Zk4,4707
 argus/client/generic/client.py,sha256=3MONtLIcF7rZ5x5OaAQKi4YGHCHb3-9ooCUhWtKs4C4,1971
-argus/client/sct/client.py,sha256=rlsuy6I3zZYKUUjJ07PaBlIfCyCpXB2l4eZoJ4waE-g,11943
+argus/client/sct/client.py,sha256=3qn_2ioFEleg8XzZWXFvythTIpCwMPvLzXMBxf57fR8,12866
 argus/client/sct/types.py,sha256=VLgVe7qPmJtCLqtPnuX8N8kMKZq-iY3SKz68nvU6nJ4,371
 argus/client/sirenada/client.py,sha256=lzhmBFAUnvPSAJfCjeQ0L5nbp50Q0YLHwIondO9rvt4,6321
 argus/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-argus/common/enums.py,sha256=2ASF_NMUU_inJCHnrjkvZ1jXWL2zAWzVgmtjCUwSUjA,1206
+argus/common/email.py,sha256=YUgin4yA3-1bH6HbtXIh09SLAzYSzSJPKM9sIvroAMA,842
+argus/common/enums.py,sha256=FM308aseXxsaeOqoiyM-NIDWKHpbceLysd-sLDh7TkI,1287
 argus/common/sct_types.py,sha256=GX0S1_eH3eBOO17WqBVtsDKzz86vgL2VUM7gi9Cjrmc,1649
 argus/common/sirenada_types.py,sha256=CZH2JXA1KYUj29eXYe8rIAAWdN1XPqOsDPAXvM25bVQ,698
-argus_alm-0.15.6.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-argus_alm-0.15.6.dist-info/METADATA,sha256=jkkC_qxHOtsMDOX0OtuE9L84V8ve9f6rmqYpI3NdWrA,4862
-argus_alm-0.15.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-argus_alm-0.15.6.dist-info/entry_points.txt,sha256=5mSBLLPndhFHKY5M9SCF8WhDBAArrj-S2IL-uoiaJiE,140
-argus_alm-0.15.6.dist-info/top_level.txt,sha256=Pea173vTU-Et8xmNCctS34REW4cH0Xmjyiztu0HuM0c,6
-argus_alm-0.15.6.dist-info/RECORD,,
+argus_alm-0.15.8.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+argus_alm-0.15.8.dist-info/METADATA,sha256=fn-TaUp-ZELmGImVprz5aQxhcvm-vTPd9o9I9ZYF1bI,5098
+argus_alm-0.15.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+argus_alm-0.15.8.dist-info/entry_points.txt,sha256=5mSBLLPndhFHKY5M9SCF8WhDBAArrj-S2IL-uoiaJiE,140
+argus_alm-0.15.8.dist-info/top_level.txt,sha256=Pea173vTU-Et8xmNCctS34REW4cH0Xmjyiztu0HuM0c,6
+argus_alm-0.15.8.dist-info/RECORD,,