qase-python-commons 3.0.2b2__tar.gz → 3.0.2b3__tar.gz

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qase-python-commons
-Version: 3.0.2b2
+Version: 3.0.2b3
 Summary: A library for Qase TestOps and Qase Report
 Author-email: Qase Team <support@qase.io>
 Project-URL: Homepage, https://github.com/qase-tms/qase-python/tree/master/qase-python-commons
@@ -23,6 +23,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.2.2
 Requires-Dist: attrs>=23.2.0
 Requires-Dist: qase-api-client~=1.0.0b2
+Requires-Dist: qase-api-v2-client~=1.0.0b2
 Requires-Dist: more_itertools
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qase-python-commons"
-version = "3.0.2b2"
+version = "3.0.2b3"
 description = "A library for Qase TestOps and Qase Report"
 readme = "README.md"
 authors = [{name = "Qase Team", email = "support@qase.io"}]
@@ -31,6 +31,7 @@ dependencies = [
     "certifi>=2024.2.2",
     "attrs>=23.2.0",
     "qase-api-client~=1.0.0b2",
+    "qase-api-v2-client~=1.0.0b2",
     "more_itertools"
 ]
 

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/src/qase/commons/client/api_v1_client.py

@@ -120,7 +120,7 @@ class ApiV1Client(BaseApiClient):
             return True
         return False
 
-    def send_results(self, project_code: str, run_id: int, results: []) -> None:
+    def send_results(self, project_code: str, run_id: str, results: []) -> None:
         api_results = ResultsApi(self.client)
         results_to_send = [self._prepare_result(project_code, result) for result in results]
         self.logger.log_debug(f"Sending results for run {run_id}: {results_to_send}")

qase_python_commons-3.0.2b3/src/qase/commons/client/api_v2_client.py

@@ -0,0 +1,148 @@
+from typing import Dict
+
+import certifi
+from qase.api_client_v2 import ResultsApi
+from qase.api_client_v2.api_client import ApiClient
+from qase.api_client_v2.configuration import Configuration
+from qase.api_client_v2.models.create_results_request_v2 import CreateResultsRequestV2
+from qase.api_client_v2.models.relation_suite import RelationSuite
+from qase.api_client_v2.models.relation_suite_item import RelationSuiteItem
+from qase.api_client_v2.models.result_create import ResultCreate
+from qase.api_client_v2.models.result_execution import ResultExecution
+from qase.api_client_v2.models.result_relations import ResultRelations
+from qase.api_client_v2.models.result_step_status import ResultStepStatus
+from qase.api_client_v2.models.result_steps_type import ResultStepsType
+
+from .api_v1_client import ApiV1Client
+from .. import ConfigManager, Logger
+from ..exceptions.reporter import ReporterException
+from ..models import Attachment, Result
+from ..models.step import StepType, Step
+
+
+class ApiV2Client(ApiV1Client):
+    def __init__(self, config: ConfigManager, logger: Logger):
+        ApiV1Client.__init__(self, config, logger)
+
+        try:
+            self.logger.log_debug("Preparing API V2 client")
+            configuration = Configuration()
+            configuration.api_key['TokenAuth'] = self.config.get('testops.api.token')
+            configuration.ssl_ca_cert = certifi.where()
+            host = self.config.get('testops.api.host', 'qase.io')
+            if self.config.get('testops.api.enterprise', False, bool):
+                configuration.host = f'https://api-{host}/v2'
+            else:
+                configuration.host = f'https://api.{host}/v2'
+
+            self.client_v2 = ApiClient(configuration)
+            self.logger.log_debug("API V2 client prepared")
+        except Exception as e:
+            self.logger.log(f"Error at preparing API V2 client: {e}", "error")
+            raise ReporterException(e)
+
+    def send_results(self, project_code: str, run_id: str, results: []) -> None:
+        api_results = ResultsApi(self.client_v2)
+        results_to_send = [self._prepare_result(project_code, result) for result in results]
+        self.logger.log_debug(f"Sending results for run {run_id}: {results_to_send}")
+        api_results.create_results_v2(project_code, run_id,
+                                      create_results_request_v2=CreateResultsRequestV2(results=results_to_send))
+        self.logger.log_debug(f"Results for run {run_id} sent successfully")
+
+    def _prepare_result(self, project_code: str, result: Result) -> ResultCreate:
+        attached = []
+        if result.attachments:
+            for attachment in result.attachments:
+                attached.extend(self._upload_attachment(project_code, attachment))
+
+        steps = []
+        for step in result.steps:
+            prepared = self._prepare_step(project_code, step)
+            steps.append(prepared)
+
+        for key, param in result.params.items():
+            # Hack to match old TestOps API
+            if param == "":
+                result.params[key] = "empty"
+
+        result_model_v2 = ResultCreate(
+            title=result.get_title(),
+            signature=result.signature,
+            testops_id=result.get_testops_id(),
+            execution=ResultExecution(start_time=result.execution.start_time, end_time=result.execution.end_time,
+                                      status=result.execution.status, duration=result.execution.duration,
+                                      stacktrace=result.execution.stacktrace, thread=result.execution.thread),
+            fields=result.fields,
+            attachments=[attach.hash for attach in attached],
+            steps=steps,
+            step_type=ResultStepsType.CLASSIC,
+            params=result.params,
+            muted=False,
+            message=result.message,
+        )
+
+        if result.get_suite_title():
+            data = []
+
+            for suite in result.get_suite_title().split("."):
+                data.append(RelationSuiteItem(title=suite))
+
+            result_model_v2.relations = ResultRelations(suite=RelationSuite(data=data))
+
+        self.logger.log_debug(f"Prepared result: {result_model_v2.to_json()}")
+
+        return result_model_v2
+
+    def _prepare_step(self, project_code: str, step: Step) -> Dict:
+        prepared_children = []
+
+        try:
+            prepared_step = {'execution': {}, 'data': {}, 'steps': []}
+            prepared_step['execution']['status'] = ResultStepStatus(step.execution.status)
+            prepared_step['execution']['duration'] = step.execution.duration
+
+            if step.step_type == StepType.TEXT:
+                prepared_step['data']['action'] = step.data.action
+                if step.data.expected_result:
+                    prepared_step['data']['expected_result'] = step.data.expected_result
+
+            if step.step_type == StepType.REQUEST:
+                prepared_step['data']['action'] = step.data.request_method + " " + step.data.request_url
+
+                if step.data.request_body:
+                    step.attachments.append(
+                        Attachment(file_name='request_body.txt', content=step.data.request_body, mime_type='text/plain',
+                                   temporary=True))
+                if step.data.request_headers:
+                    step.attachments.append(
+                        Attachment(file_name='request_headers.txt', content=step.data.request_headers,
+                                   mime_type='text/plain', temporary=True))
+                if step.data.response_body:
+                    step.attachments.append(Attachment(file_name='response_body.txt', content=step.data.response_body,
+                                                       mime_type='text/plain', temporary=True))
+                if step.data.response_headers:
+                    step.attachments.append(
+                        Attachment(file_name='response_headers.txt', content=step.data.response_headers,
+                                   mime_type='text/plain', temporary=True))
+
+            if step.step_type == StepType.GHERKIN:
+                prepared_step['data']['action'] = step.data.keyword
+
+            if step.step_type == StepType.SLEEP:
+                prepared_step['data']['action'] = f"Sleep for {step.data.duration} seconds"
+
+            if step.attachments:
+                uploaded_attachments = []
+                for file in step.attachments:
+                    uploaded_attachments.extend(self._upload_attachment(project_code, file))
+
+                prepared_step['execution']['attachments'] = [attach.hash for attach in uploaded_attachments]
+
+            if step.steps:
+                for substep in step.steps:
+                    prepared_children.append(self._prepare_step(project_code, substep))
+                prepared_step['steps'] = prepared_children
+            return prepared_step
+        except Exception as e:
+            self.logger.log(f"Error at preparing step: {e}", "error")
+            raise ReporterException(e)

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/src/qase/commons/client/base_api_client.py

@@ -53,7 +53,7 @@ class BaseApiClient(abc.ABC):
 
     @abc.abstractmethod
     def create_test_run(self, project_code: str, title: str, description: str, plan_id=None,
-                        environment_id=None) -> int:
+                        environment_id=None) -> str:
         """
         Create a test run in Qase TestOps
 
@@ -67,7 +67,7 @@ class BaseApiClient(abc.ABC):
         pass
 
     @abc.abstractmethod
-    def check_test_run(self, project_code: str, run_id: int) -> bool:
+    def check_test_run(self, project_code: str, run_id: str) -> bool:
         """
         Check if test run exists in Qase TestOps
         :param project_code: project code
@@ -77,7 +77,7 @@ class BaseApiClient(abc.ABC):
         pass
 
     @abc.abstractmethod
-    def send_results(self, project_code: str, run_id: int, results: []) -> None:
+    def send_results(self, project_code: str, run_id: str, results: []) -> None:
         """
         Send test results to Qase TestOps
         :param project_code: project code

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/src/qase/commons/config.py

@@ -13,7 +13,9 @@ class ConfigManager:
         try:
             if os.path.exists(config_file):
                 with open(config_file, "r") as file:
-                    self.config = json.load(file)
+                    def transform_keys(obj):
+                        return {k.lower(): v for k, v in obj.items()}
+                    self.config = json.load(file, object_hook=transform_keys)
         except Exception as e:
             self.logger.log("Failed to load config from file", "error")
 

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/src/qase/commons/reporters/testops.py

@@ -65,6 +65,9 @@ class QaseTestOps:
         self.client.get_project(self.project_code)
 
     def _prepare_client(self) -> BaseApiClient:
+        if self.config.get('testops.usev2', False, bool):
+            from ..client.api_v2_client import ApiV2Client
+            return ApiV2Client(self.config, self.logger)
         return ApiV1Client(self.config, self.logger)
 
     def _send_results_threaded(self, results):

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/src/qase_python_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qase-python-commons
-Version: 3.0.2b2
+Version: 3.0.2b3
 Summary: A library for Qase TestOps and Qase Report
 Author-email: Qase Team <support@qase.io>
 Project-URL: Homepage, https://github.com/qase-tms/qase-python/tree/master/qase-python-commons
@@ -23,6 +23,7 @@ Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.2.2
 Requires-Dist: attrs>=23.2.0
 Requires-Dist: qase-api-client~=1.0.0b2
+Requires-Dist: qase-api-v2-client~=1.0.0b2
 Requires-Dist: more_itertools
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/src/qase_python_commons.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ src/qase/commons/loader.py
 src/qase/commons/logger.py
 src/qase/commons/utils.py
 src/qase/commons/client/api_v1_client.py
+src/qase/commons/client/api_v2_client.py
 src/qase/commons/client/base_api_client.py
 src/qase/commons/exceptions/reporter.py
 src/qase/commons/models/__init__.py

{qase_python_commons-3.0.2b2 → qase_python_commons-3.0.2b3}/src/qase_python_commons.egg-info/requires.txt

@@ -1,6 +1,7 @@
 certifi>=2024.2.2
 attrs>=23.2.0
 qase-api-client~=1.0.0b2
+qase-api-v2-client~=1.0.0b2
 more_itertools
 
 [testing]