qase-python-commons 3.3.2__tar.gz → 3.4.1__tar.gz

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qase-python-commons
-Version: 3.3.2
+Version: 3.4.1
 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/main/qase-python-commons
@@ -22,8 +22,8 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.2.2
 Requires-Dist: attrs>=23.2.0
-Requires-Dist: qase-api-client~=1.1.1
-Requires-Dist: qase-api-v2-client~=1.1.0
+Requires-Dist: qase-api-client~=1.2.0
+Requires-Dist: qase-api-v2-client~=1.2.0
 Requires-Dist: more_itertools
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qase-python-commons"
-version = "3.3.2"
+version = "3.4.1"
 description = "A library for Qase TestOps and Qase Report"
 readme = "README.md"
 authors = [{name = "Qase Team", email = "support@qase.io"}]
@@ -30,8 +30,8 @@ requires-python = ">=3.7"
 dependencies = [
     "certifi>=2024.2.2",
     "attrs>=23.2.0",
-    "qase-api-client~=1.1.1",
-    "qase-api-v2-client~=1.1.0",
+    "qase-api-client~=1.2.0",
+    "qase-api-v2-client~=1.2.0",
     "more_itertools"
 ]
 

qase_python_commons-3.4.1/src/qase/commons/client/api_v1_client.py

@@ -0,0 +1,137 @@
+from datetime import datetime, timezone
+from typing import Union
+
+import certifi
+from qase.api_client_v1 import ApiClient, ProjectsApi, Project, EnvironmentsApi, RunsApi, AttachmentsApi, \
+    AttachmentGet, RunCreate
+from qase.api_client_v1.configuration import Configuration
+from .. import Logger
+from .base_api_client import BaseApiClient
+from ..exceptions.reporter import ReporterException
+from ..models import Attachment
+from ..models.config.framework import Video, Trace
+from ..models.config.qaseconfig import QaseConfig
+
+
+class ApiV1Client(BaseApiClient):
+    def __init__(self, config: QaseConfig, logger: Logger):
+        self.logger = logger
+        self.config = config
+        self.__authors = {}
+
+        try:
+            self.logger.log_debug("Preparing API client")
+            configuration = Configuration()
+            configuration.api_key['TokenAuth'] = self.config.testops.api.token
+            configuration.ssl_ca_cert = certifi.where()
+            host = self.config.testops.api.host
+            if host == 'qase.io':
+                configuration.host = f'https://api.{host}/v1'
+                self.web = f'https://app.{host}'
+            else:
+                configuration.host = f'https://api-{host}/v1'
+                self.web = f'https://{host}'
+
+            self.client = ApiClient(configuration)
+            self.logger.log_debug("API client prepared")
+        except Exception as e:
+            self.logger.log(f"Error at preparing API client: {e}", "error")
+            raise ReporterException(e)
+
+    def get_project(self, project_code: str) -> Union[Project, None]:
+        try:
+            self.logger.log_debug(f"Getting project {project_code}")
+            response = ProjectsApi(self.client).get_project(code=project_code)
+            if hasattr(response, 'result'):
+                self.logger.log_debug(f"Project {project_code} found: {response.result.to_json()}")
+                return response.result
+            raise ReporterException("Unable to find given project code")
+        except Exception as e:
+            self.logger.log("Exception when calling ProjectApi->get_project: %s\n" % e, "error")
+            raise ReporterException("Exception when calling ProjectApi")
+
+    def get_environment(self, environment: str, project_code: str) -> Union[str, None]:
+        try:
+            self.logger.log_debug(f"Getting environment {environment}")
+            api_instance = EnvironmentsApi(self.client)
+            response = api_instance.get_environments(code=project_code)
+            if hasattr(response, 'result') and hasattr(response.result, 'entities'):
+                for env in response.result.entities:
+                    if env.slug == environment:
+                        self.logger.log_debug(f"Environment {environment} found: {env.to_json()}")
+                        return env.id
+            self.logger.log_debug(f"Environment {environment} not found")
+            return None
+        except Exception as e:
+            self.logger.log("Exception when calling EnvironmentsApi->get_environments: %s\n" % e, "error")
+            raise ReporterException(e)
+
+    def complete_run(self, project_code: str, run_id: str) -> None:
+        api_runs = RunsApi(self.client)
+        self.logger.log_debug(f"Completing run {run_id}")
+        res = api_runs.get_run(project_code, run_id).result
+        if res.status == 1:
+            self.logger.log_debug(f"Run {run_id} already completed")
+            return
+        try:
+            api_runs.complete_run(project_code, run_id)
+            self.logger.log(f"Test run link: {self.web}/run/{project_code}/dashboard/{run_id}", "info")
+        except Exception as e:
+            self.logger.log(f"Error at completing run {run_id}: {e}", "error")
+            raise ReporterException(e)
+
+    def _upload_attachment(self, project_code: str, attachment: Attachment) -> Union[AttachmentGet, None]:
+        try:
+            self.logger.log_debug(f"Uploading attachment {attachment.id} for project {project_code}")
+            attach_api = AttachmentsApi(self.client)
+            response = attach_api.upload_attachment(project_code, file=[attachment.get_for_upload()])
+
+            return response.result
+
+        except Exception as e:
+            self.logger.log(f"Error at uploading attachment: {e}", "error")
+            return None
+
+    def create_test_run(self, project_code: str, title: str, description: str, plan_id=None,
+                        environment_id=None) -> str:
+        kwargs = dict(
+            title=title,
+            description=description,
+            environment_id=(int(environment_id) if environment_id else None),
+            plan_id=(int(plan_id) if plan_id else plan_id),
+            is_autotest=True,
+            start_time=datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S")
+        )
+        self.logger.log_debug(f"Creating test run with parameters: {kwargs}")
+        try:
+            result = RunsApi(self.client).create_run(
+                code=project_code,
+                run_create=RunCreate(**{k: v for k, v in kwargs.items() if v is not None})
+            )
+
+            return result.result.id
+
+        except Exception as e:
+            self.logger.log(f"Error at creating test run: {e}", "error")
+            raise ReporterException(e)
+
+    def check_test_run(self, project_code: str, run_id: int) -> bool:
+        api_runs = RunsApi(self.client)
+        run = api_runs.get_run(code=project_code, id=run_id)
+        if run.result.id:
+            return True
+        return False
+
+    def __should_skip_attachment(self, attachment, result):
+        if (self.config.framework.playwright.video == Video.failed and
+                result.execution.status != 'failed' and
+                attachment.file_name == 'video.webm'):
+            return True
+        if (self.config.framework.playwright.trace == Trace.failed and
+                result.execution.status != 'failed' and
+                attachment.file_name == 'trace.zip'):
+            return True
+        return False
+
+    def send_results(self, project_code: str, run_id: str, results: []) -> None:
+        raise NotImplementedError("use ApiV2Client instead")

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/client/api_v2_client.py

@@ -17,7 +17,7 @@ from .api_v1_client import ApiV1Client
 from .. import Logger
 from ..exceptions.reporter import ReporterException
 from ..models.config.framework import Video, Trace
-from ..models import Attachment, InternalResult
+from ..models import Attachment, Result
 from ..models.config.qaseconfig import QaseConfig
 from ..models.step import StepType, Step
 
@@ -53,7 +53,7 @@ class ApiV2Client(ApiV1Client):
                                       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: InternalResult) -> ResultCreate:
+    def _prepare_result(self, project_code: str, result: Result) -> ResultCreate:
         attached = []
         if result.attachments:
             for attachment in result.attachments:
@@ -76,7 +76,7 @@ class ApiV2Client(ApiV1Client):
         result_model_v2 = ResultCreate(
             title=result.get_title(),
             signature=result.signature,
-            testops_id=result.get_testops_id(),
+            testops_ids=result.get_testops_ids(),
             execution=ResultExecution(status=result.execution.status, duration=result.execution.duration,
                                       start_time=result.execution.start_time, end_time=result.execution.end_time,
                                       stacktrace=result.execution.stacktrace, thread=result.execution.thread),
@@ -125,18 +125,18 @@ class ApiV2Client(ApiV1Client):
                 prepared_step['data']['action'] = step.data.request_method + " " + step.data.request_url
 
                 if step.data.request_body:
-                    step.attachments.append(
+                    step.add_attachment(
                         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(
+                    step.add_attachment(
                         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))
+                    step.add_attachment(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(
+                    step.add_attachment(
                         Attachment(file_name='response_headers.txt', content=step.data.response_headers,
                                    mime_type='text/plain', temporary=True))
 
@@ -149,9 +149,9 @@ class ApiV2Client(ApiV1Client):
             if step.step_type == StepType.SLEEP:
                 prepared_step['data']['action'] = f"Sleep for {step.data.duration} seconds"
 
-            if step.attachments:
+            if step.execution.attachments:
                 uploaded_attachments = []
-                for file in step.attachments:
+                for file in step.execution.attachments:
                     attach_id = self._upload_attachment(project_code, file)
                     if attach_id:
                         uploaded_attachments.extend(attach_id)

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/config.py

@@ -83,11 +83,6 @@ class ConfigManager:
                                 testops.get("defect")
                             )
 
-                        if testops.get("useV2"):
-                            self.config.testops.set_use_v2(
-                                testops.get("useV2")
-                            )
-
                         if testops.get("plan"):
                             plan = testops.get("plan")
 

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/logger.py

@@ -24,7 +24,12 @@ class Logger:
     def log(self, message: str, level: str = 'info'):
         time_str = self._get_timestamp("%H:%M:%S")
         log = f"[Qase][{time_str}][{level}] {message}\n"
-        print(log)
+
+        try:
+            print(log, end='')
+        except (OSError, IOError):
+            pass
+
         if self.debug:
             with self.lock:
                 with open(Logger._log_file, 'a', encoding='utf-8') as f:

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/models/__init__.py

@@ -1,4 +1,4 @@
-from .result import Result, InternalResult, Field
+from .result import Result, Field
 from .run import Run
 from .attachment import Attachment
 from .relation import Relation
@@ -12,6 +12,5 @@ __all__ = [
     Relation,
     Step,
     Runtime,
-    Field,
-    InternalResult
+    Field
 ]

qase_python_commons-3.4.1/src/qase/commons/models/basemodel.py

@@ -0,0 +1,16 @@
+import json
+
+from enum import Enum
+
+
+class BaseModel:
+    def __str__(self, enum_as_name=False) -> str:
+        def serialize(o):
+            if isinstance(o, Enum):
+                return o.name if enum_as_name else o.value
+            elif hasattr(o, '__dict__'):
+                return o.__dict__
+            else:
+                return str(o)
+
+        return json.dumps(self, default=serialize, indent=4, sort_keys=True)

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/models/config/testops.py

@@ -20,13 +20,9 @@ class TestopsConfig(BaseModel):
         self.batch = BatchConfig()
         self.plan = PlanConfig()
         self.defect = False
-        self.use_v2 = True
 
     def set_project(self, project: str):
         self.project = project
 
     def set_defect(self, defect):
         self.defect = QaseUtils.parse_bool(defect)
-
-    def set_use_v2(self, use_v2):
-        self.use_v2 = QaseUtils.parse_bool(use_v2)

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/models/result.py

@@ -1,4 +1,3 @@
-import copy
 import time
 import uuid
 
@@ -70,19 +69,16 @@ class Result(BaseModel):
         self.id: str = str(uuid.uuid4())
         self.title: str = title
         self.signature: str = signature
-        self.run_id: Optional[str] = None
-        self.testops_id: Optional[List[int]] = None
+        self.testops_ids: Optional[List[int]] = None
         self.execution: Type[Execution] = Execution()
         self.fields: Dict[Type[Field]] = {}
         self.attachments: List[Attachment] = []
         self.steps: List[Type[Step]] = []
         self.params: Optional[dict] = {}
         self.param_groups: Optional[List[List[str]]] = []
-        self.author: Optional[str] = None
         self.relations: Type[Relation] = None
         self.muted: bool = False
         self.message: Optional[str] = None
-        QaseUtils.get_host_data()
 
     def add_message(self, message: str) -> None:
         self.message = message
@@ -119,96 +115,8 @@ class Result(BaseModel):
             return self.fields[name]
         return None
 
-    def get_testops_id(self) -> Optional[List[int]]:
-        return self.testops_id
+    def get_testops_ids(self) -> Optional[List[int]]:
+        return self.testops_ids
 
     def get_duration(self) -> int:
         return self.execution.duration
-
-    def set_run_id(self, run_id: str) -> None:
-        self.run_id = run_id
-
-
-class InternalResult(BaseModel):
-    def __init__(self, title: str, signature: str) -> None:
-        self.id: str = str(uuid.uuid4())
-        self.title: str = title
-        self.signature: str = signature
-        self.run_id: Optional[str] = None
-        self.testops_id: Optional[int] = None
-        self.execution: Type[Execution] = Execution()
-        self.fields: Dict[Type[Field]] = {}
-        self.attachments: List[Attachment] = []
-        self.steps: List[Type[Step]] = []
-        self.params: Optional[dict] = {}
-        self.param_groups: Optional[List[List[str]]] = []
-        self.author: Optional[str] = None
-        self.relations: Type[Relation] = None
-        self.muted: bool = False
-        self.message: Optional[str] = None
-        QaseUtils.get_host_data()
-
-    def add_message(self, message: str) -> None:
-        self.message = message
-
-    def add_field(self, field: Type[Field]) -> None:
-        self.fields[field.name] = field.value
-
-    def add_steps(self, steps: List[Type[Step]]) -> None:
-        self.steps = QaseUtils().build_tree(steps)
-
-    def add_attachment(self, attachment: Attachment) -> None:
-        self.attachments.append(attachment)
-
-    def add_param(self, key: str, value: str) -> None:
-        self.params[key] = value
-
-    def add_param_groups(self, values: List[str]) -> None:
-        self.param_groups.append(values)
-
-    def set_relation(self, relation: Relation) -> None:
-        self.relations = relation
-
-    def get_status(self) -> Optional[str]:
-        return self.execution.status
-
-    def get_id(self) -> str:
-        return self.id
-
-    def get_title(self) -> str:
-        return self.title
-
-    def get_field(self, name: str) -> Optional[Type[Field]]:
-        if name in self.fields:
-            return self.fields[name]
-        return None
-
-    def get_testops_id(self) -> Optional[int]:
-        return self.testops_id
-
-    def get_duration(self) -> int:
-        return self.execution.duration
-
-    def set_run_id(self, run_id: str) -> None:
-        self.run_id = run_id
-
-    @classmethod
-    def convert_from_result(cls, result: Result, testops_id: Optional[int] = None):
-        int_result = cls(result.title, result.signature)
-
-        int_result.id = result.id
-        int_result.title = result.title
-        int_result.signature = result.signature
-        int_result.run_id = result.run_id
-        int_result.testops_id = testops_id
-        int_result.execution = copy.deepcopy(result.execution)
-        int_result.fields = result.fields
-        int_result.attachments = result.attachments
-        int_result.steps = result.steps
-        int_result.params = result.params
-        int_result.author = result.author
-        int_result.relations = result.relations
-        int_result.muted = result.muted
-        int_result.message = result.message
-
-        return int_result

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/models/run.py

@@ -1,5 +1,3 @@
-import json
-
 from typing import Optional, List
 
 from .basemodel import BaseModel
@@ -71,6 +69,7 @@ class Run(BaseModel):
             "duration": result["execution"]["duration"],
             "thread": result["execution"]["thread"]
         }
+        self._extract_path_from_relations(result)
         self.results.append(compact_result)
         self.execution.track(result)
         self.stats.track(result)
@@ -79,3 +78,16 @@ class Run(BaseModel):
 
     def add_host_data(self, host_data: dict):
         self.host_data = host_data
+
+    def _extract_path_from_relations(self, relations_dict):
+
+        titles = []
+        if "relations" in relations_dict and "suite" in relations_dict["relations"]:
+            if "data" in relations_dict["relations"]["suite"]:
+                data_list = relations_dict["relations"]["suite"]["data"]
+                titles = [item["title"] for item in data_list if "title" in item]
+
+        path = "/".join(titles)
+
+        if path and path not in self.suites:
+            self.suites.append(path)

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/models/step.py

@@ -20,6 +20,7 @@ class StepTextData(BaseModel):
     def __init__(self, action: str, expected_result: Optional[str] = None):
         self.action = action
         self.expected_result = expected_result
+        self.input_data = None
 
 
 class StepAssertData(BaseModel):
@@ -78,6 +79,7 @@ class StepExecution(BaseModel):
         self.status = status
         self.end_time = end_time
         self.duration = duration
+        self.attachments = []
 
     def set_status(self, status: Optional[str]):
         if status in ['passed', 'failed', 'skipped', 'blocked', 'untested']:
@@ -89,6 +91,9 @@ class StepExecution(BaseModel):
         self.end_time = time.time()
         self.duration = int((self.end_time - self.start_time) * 1000)
 
+    def add_attachment(self, attachment: Attachment):
+        self.attachments.append(attachment)
+
 
 class Step(BaseModel):
     def __init__(self,
@@ -107,7 +112,6 @@ class Step(BaseModel):
         self.data = data
         self.parent_id = parent_id
         self.execution = StepExecution()
-        self.attachments = []
         self.steps = []
 
     def set_parent_id(self, parent_id: Optional[str]):
@@ -132,4 +136,4 @@ class Step(BaseModel):
         self.steps = steps
 
     def add_attachment(self, attachment: Attachment):
-        self.attachments.append(attachment)
+        self.execution.add_attachment(attachment)

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/reporters/core.py

@@ -6,7 +6,7 @@ from ..logger import Logger
 from .report import QaseReport
 from .testops import QaseTestOps
 
-from ..models import InternalResult, Result, Attachment, Runtime
+from ..models import Result, Attachment, Runtime
 from ..models.config.qaseconfig import Mode
 from typing import Union, List
 
@@ -84,20 +84,8 @@ class QaseCoreReporter:
             try:
                 ts = time.time()
                 self.logger.log_debug(f"Adding result {result}")
-                ids = result.get_testops_id()
-
-                if ids is None:
-                    int_result = InternalResult.convert_from_result(result)
-                    self.reporter.add_result(int_result)
-                else:
-                    first = True
-                    for testops_id in ids:
-                        int_result = InternalResult.convert_from_result(result, testops_id)
-                        if not first:
-                            int_result.execution.duration = 0
-                        else:
-                            first = False
-                        self.reporter.add_result(int_result)
+
+                self.reporter.add_result(result)
 
                 self.logger.log_debug(f"Result {result.get_title()} added")
                 self.overhead += time.time() - ts

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/reporters/report.py

@@ -3,7 +3,7 @@ import os
 import shutil
 import json
 import re
-from ..models import InternalResult, Run, Attachment
+from ..models import Result, Run, Attachment
 from .. import QaseUtils, Logger
 from ..models.config.connection import Format
 from ..models.config.qaseconfig import QaseConfig
@@ -40,8 +40,7 @@ class QaseReport:
     def complete_worker(self):
         pass
 
-    def add_result(self, result: InternalResult):
-        result.set_run_id(self.run_id)
+    def add_result(self, result: Result):
         for attachment in result.attachments:
             self._persist_attachment(attachment)
 
@@ -84,14 +83,14 @@ class QaseReport:
 
     def _persist_attachments_in_steps(self, steps: list):
         for step in steps:
-            if step.attachments:
-                for attachment in step.attachments:
+            if step.execution.attachments:
+                for attachment in step.execution.attachments:
                     self._persist_attachment(attachment)
                 if step.steps:
                     self._persist_attachments_in_steps(step.steps)
 
     # Method saves result to a file
-    def _store_result(self, result: InternalResult):
+    def _store_result(self, result: Result):
         self._store_object(result, self.report_path + "/results/", result.id)
 
     def _check_report_path(self):

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase/commons/reporters/testops.py

@@ -2,11 +2,11 @@ import threading
 import urllib.parse
 
 from datetime import datetime
-from typing import List
+from typing import List, Union
 from .. import Logger, ReporterException
-from ..client.api_v1_client import ApiV1Client
+from ..client.api_v2_client import ApiV2Client
 from ..client.base_api_client import BaseApiClient
-from ..models import InternalResult
+from ..models import Result
 from ..models.config.qaseconfig import QaseConfig
 
 DEFAULT_BATCH_SIZE = 200
@@ -69,10 +69,7 @@ class QaseTestOps:
         self.client.get_project(self.project_code)
 
     def _prepare_client(self) -> BaseApiClient:
-        if self.config.testops.use_v2:
-            from ..client.api_v2_client import ApiV2Client
-            return ApiV2Client(self.config, self.logger)
-        return ApiV1Client(self.config, self.logger)
+        return ApiV2Client(self.config, self.logger)
 
     def _send_results_threaded(self, results):
         try:
@@ -129,9 +126,9 @@ class QaseTestOps:
         if len(self.results) > 0:
             self._send_results()
 
-    def add_result(self, result: InternalResult) -> None:
+    def add_result(self, result: Result) -> None:
         if result.get_status() == 'failed':
-            self.__show_link(result.testops_id, result.title)
+            self.__show_link(result.testops_ids, result.title)
         self.results.append(result)
         if len(self.results) >= self.batch_size:
             self._send_results()
@@ -142,15 +139,14 @@ class QaseTestOps:
     def set_results(self, results) -> None:
         self.results = results
 
-    def __show_link(self, id, title: str):
-        link = self.__prepare_link(id, title)
+    def __show_link(self, ids: Union[None, List[int]], title: str):
+        link = self.__prepare_link(ids, title)
         self.logger.log(f"See why this test failed: {link}", "info")
 
-    def __prepare_link(self, id, title: str):
+    def __prepare_link(self, ids: Union[None, List[int]], title: str):
         link = f"{self.__baseUrl}/run/{self.project_code}/dashboard/{self.run_id}?source=logs&status=%5B2%5D&search="
-        if id:
-            return f"{link}{id}`"
-
+        if ids is not None and len(ids) > 0:
+            return f"{link}{ids[0]}"
         return f"{link}{urllib.parse.quote_plus(title)}"
 
     @staticmethod

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase_python_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qase-python-commons
-Version: 3.3.2
+Version: 3.4.1
 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/main/qase-python-commons
@@ -22,8 +22,8 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.2.2
 Requires-Dist: attrs>=23.2.0
-Requires-Dist: qase-api-client~=1.1.1
-Requires-Dist: qase-api-v2-client~=1.1.0
+Requires-Dist: qase-api-client~=1.2.0
+Requires-Dist: qase-api-v2-client~=1.2.0
 Requires-Dist: more_itertools
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{qase_python_commons-3.3.2 → qase_python_commons-3.4.1}/src/qase_python_commons.egg-info/requires.txt

@@ -1,7 +1,7 @@
 certifi>=2024.2.2
 attrs>=23.2.0
-qase-api-client~=1.1.1
-qase-api-v2-client~=1.1.0
+qase-api-client~=1.2.0
+qase-api-v2-client~=1.2.0
 more_itertools
 
 [testing]

qase_python_commons-3.3.2/src/qase/commons/client/api_v1_client.py

@@ -1,302 +0,0 @@
-from datetime import datetime, timezone
-from typing import Dict, Union
-
-import certifi
-from qase.api_client_v1 import ApiClient, ProjectsApi, Project, EnvironmentsApi, RunsApi, AttachmentsApi, \
-    AttachmentGet, RunCreate, ResultsApi, ResultcreateBulk, AuthorsApi
-from qase.api_client_v1.configuration import Configuration
-from .. import Logger
-from .base_api_client import BaseApiClient
-from ..exceptions.reporter import ReporterException
-from ..models import Attachment, InternalResult, Step
-from ..models.config.framework import Video, Trace
-from ..models.config.qaseconfig import QaseConfig
-from ..models.step import StepType
-
-
-class ApiV1Client(BaseApiClient):
-    def __init__(self, config: QaseConfig, logger: Logger):
-        self.logger = logger
-        self.config = config
-        self.__authors = {}
-
-        try:
-            self.logger.log_debug("Preparing API client")
-            configuration = Configuration()
-            configuration.api_key['TokenAuth'] = self.config.testops.api.token
-            configuration.ssl_ca_cert = certifi.where()
-            host = self.config.testops.api.host
-            if host == 'qase.io':
-                configuration.host = f'https://api.{host}/v1'
-                self.web = f'https://app.{host}'
-            else:
-                configuration.host = f'https://api-{host}/v1'
-                self.web = f'https://{host}'
-
-            self.client = ApiClient(configuration)
-            self.logger.log_debug("API client prepared")
-        except Exception as e:
-            self.logger.log(f"Error at preparing API client: {e}", "error")
-            raise ReporterException(e)
-
-    def get_project(self, project_code: str) -> Union[Project, None]:
-        try:
-            self.logger.log_debug(f"Getting project {project_code}")
-            response = ProjectsApi(self.client).get_project(code=project_code)
-            if hasattr(response, 'result'):
-                self.logger.log_debug(f"Project {project_code} found: {response.result.to_json()}")
-                return response.result
-            raise ReporterException("Unable to find given project code")
-        except Exception as e:
-            self.logger.log("Exception when calling ProjectApi->get_project: %s\n" % e, "error")
-            raise ReporterException("Exception when calling ProjectApi")
-
-    def get_environment(self, environment: str, project_code: str) -> Union[str, None]:
-        try:
-            self.logger.log_debug(f"Getting environment {environment}")
-            api_instance = EnvironmentsApi(self.client)
-            response = api_instance.get_environments(code=project_code)
-            if hasattr(response, 'result') and hasattr(response.result, 'entities'):
-                for env in response.result.entities:
-                    if env.slug == environment:
-                        self.logger.log_debug(f"Environment {environment} found: {env.to_json()}")
-                        return env.id
-            self.logger.log_debug(f"Environment {environment} not found")
-            return None
-        except Exception as e:
-            self.logger.log("Exception when calling EnvironmentsApi->get_environments: %s\n" % e, "error")
-            raise ReporterException(e)
-
-    def complete_run(self, project_code: str, run_id: str) -> None:
-        api_runs = RunsApi(self.client)
-        self.logger.log_debug(f"Completing run {run_id}")
-        res = api_runs.get_run(project_code, run_id).result
-        if res.status == 1:
-            self.logger.log_debug(f"Run {run_id} already completed")
-            return
-        try:
-            api_runs.complete_run(project_code, run_id)
-            self.logger.log(f"Test run link: {self.web}/run/{project_code}/dashboard/{run_id}", "info")
-        except Exception as e:
-            self.logger.log(f"Error at completing run {run_id}: {e}", "error")
-            raise ReporterException(e)
-
-    def _upload_attachment(self, project_code: str, attachment: Attachment) -> Union[AttachmentGet, None]:
-        try:
-            self.logger.log_debug(f"Uploading attachment {attachment.id} for project {project_code}")
-            attach_api = AttachmentsApi(self.client)
-            response = attach_api.upload_attachment(project_code, file=[attachment.get_for_upload()])
-
-            return response.result
-
-        except Exception as e:
-            self.logger.log(f"Error at uploading attachment: {e}", "error")
-            return None
-
-    def create_test_run(self, project_code: str, title: str, description: str, plan_id=None,
-                        environment_id=None) -> str:
-        kwargs = dict(
-            title=title,
-            description=description,
-            environment_id=(int(environment_id) if environment_id else None),
-            plan_id=(int(plan_id) if plan_id else plan_id),
-            is_autotest=True,
-            start_time=datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M:%S")
-        )
-        self.logger.log_debug(f"Creating test run with parameters: {kwargs}")
-        try:
-            result = RunsApi(self.client).create_run(
-                code=project_code,
-                run_create=RunCreate(**{k: v for k, v in kwargs.items() if v is not None})
-            )
-
-            return result.result.id
-
-        except Exception as e:
-            self.logger.log(f"Error at creating test run: {e}", "error")
-            raise ReporterException(e)
-
-    def check_test_run(self, project_code: str, run_id: int) -> bool:
-        api_runs = RunsApi(self.client)
-        run = api_runs.get_run(code=project_code, id=run_id)
-        if run.result.id:
-            return True
-        return False
-
-    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}")
-        api_results.create_result_bulk(
-            code=project_code,
-            id=run_id,
-            resultcreate_bulk=ResultcreateBulk(
-                results=results_to_send
-            )
-        )
-        self.logger.log_debug(f"Results for run {run_id} sent successfully")
-
-    def _prepare_result(self, project_code: str, result: InternalResult) -> Dict:
-        attached = []
-        if result.attachments:
-            for attachment in result.attachments:
-                if self.__should_skip_attachment(attachment, result):
-                    continue
-                attach_id = self._upload_attachment(project_code, attachment)
-                if attach_id:
-                    attached.extend(attach_id)
-
-        steps = []
-        for step in result.steps:
-            prepared = self._prepare_step(project_code, step)
-            steps.append(prepared)
-
-        case_data = {
-            "title": result.get_title(),
-            "description": result.get_field('description'),
-            "preconditions": result.get_field('preconditions'),
-            "postconditions": result.get_field('postconditions'),
-        }
-
-        for key, param in result.params.items():
-            # Hack to match old TestOps API
-            if param == "":
-                result.params[key] = "empty"
-
-        if result.get_field('severity'):
-            case_data["severity"] = result.get_field('severity')
-
-        if result.get_field('priority'):
-            case_data["priority"] = result.get_field('priority')
-
-        if result.get_field('layer'):
-            case_data["layer"] = result.get_field('layer')
-
-        suite = None
-        if result.relations is not None and result.relations.suite is not None and len(
-                result.relations.suite.data) != 0:
-            suites = []
-
-            for raw in result.relations.suite.data:
-                suites.append(raw.title)
-
-            suite = "\t".join(suites)
-
-        if result.get_field('suite'):
-            suite = result.get_field('suite')
-
-        root_suite = self.config.root_suite
-        if root_suite:
-            suite = f"{root_suite}\t{suite}"
-
-        if suite:
-            case_data["suite_title"] = suite
-
-        result_model = {
-            "status": result.execution.status,
-            "stacktrace": result.execution.stacktrace,
-            "time_ms": result.execution.duration,
-            "comment": result.message,
-            "attachments": [attach.hash for attach in attached],
-            "steps": steps,
-            "param": result.params,
-            "param_groups": result.param_groups,
-            "defect": self.config.testops.defect,
-            "case": case_data
-        }
-
-        test_ops_id = result.get_testops_id()
-
-        if test_ops_id:
-            result_model["case_id"] = test_ops_id
-
-        if result.get_field('author'):
-            author_id = self._get_author_id(result.get_field('author'))
-            if author_id:
-                result_model["author_id"] = author_id
-
-        self.logger.log_debug(f"Prepared result: {result_model}")
-
-        return result_model
-
-    def _prepare_step(self, project_code: str, step: Step) -> Dict:
-        prepared_children = []
-
-        try:
-            prepared_step = {"time": step.execution.duration, "status": step.execution.status}
-
-            if step.execution.status == 'untested':
-                prepared_step["status"] = 'passed'
-
-            if step.execution.status == 'skipped':
-                prepared_step["status"] = 'blocked'
-
-            if step.step_type == StepType.TEXT:
-                prepared_step['action'] = step.data.action
-                if step.data.expected_result:
-                    prepared_step['expected_result'] = step.data.expected_result
-
-            if step.step_type == StepType.REQUEST:
-                prepared_step['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['action'] = step.data.keyword
-
-            if step.step_type == StepType.SLEEP:
-                prepared_step['action'] = f"Sleep for {step.data.duration} seconds"
-
-            if step.attachments:
-                uploaded_attachments = []
-                for file in step.attachments:
-                    attach_id = self._upload_attachment(project_code, file)
-                    if attach_id:
-                        uploaded_attachments.extend(attach_id)
-                prepared_step['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)
-
-    def _get_author_id(self, author: str) -> Union[str, None]:
-        if author in self.__authors:
-            return self.__authors[author]
-
-        author_api = AuthorsApi(self.client)
-        authors = author_api.get_authors(search=author)
-        if authors.result.total == 0:
-            return None
-
-        self.__authors[author] = authors.result.entities[0].author_id
-
-        return authors.result.entities[0].author_id
-
-    def __should_skip_attachment(self, attachment, result):
-        if (self.config.framework.playwright.video == Video.failed and
-                result.execution.status != 'failed' and
-                attachment.file_name == 'video.webm'):
-            return True
-        if (self.config.framework.playwright.trace == Trace.failed and
-                result.execution.status != 'failed' and
-                attachment.file_name == 'trace.zip'):
-            return True
-        return False

qase_python_commons-3.3.2/src/qase/commons/models/basemodel.py

@@ -1,7 +0,0 @@
-import json
-
-
-class BaseModel:
-    def __str__(self) -> str:
-        return json.dumps(self, default=lambda o: o.__dict__ if hasattr(o, '__dict__') else str(o), indent=4,
-                          sort_keys=True)