qase-python-commons 3.1.8__py3-none-any.whl → 3.2.0__py3-none-any.whl

qase/commons/client/api_v1_client.py

@@ -8,6 +8,7 @@ from .. import Logger
 from .base_api_client import BaseApiClient
 from ..exceptions.reporter import ReporterException
 from ..models import Attachment, Result, Step
+from ..models.config.framework import Video, Trace
 from ..models.config.qaseconfig import QaseConfig
 from ..models.step import StepType
 
@@ -137,6 +138,8 @@ class ApiV1Client(BaseApiClient):
         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)
@@ -168,8 +171,14 @@ class ApiV1Client(BaseApiClient):
             case_data["layer"] = result.get_field('layer')
 
         suite = None
-        if result.get_suite_title():
-            suite = "\t".join(result.get_suite_title().split("."))
+        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')
@@ -278,3 +287,14 @@ class ApiV1Client(BaseApiClient):
         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/commons/client/api_v2_client.py

@@ -1,7 +1,7 @@
 from typing import Dict
 
 import certifi
-from qase.api_client_v2 import ResultsApi
+from qase.api_client_v2 import ResultsApi, ResultCreateFields
 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
@@ -75,23 +75,25 @@ class ApiV2Client(ApiV1Client):
             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,
+            fields=ResultCreateFields.from_dict(result.fields),
             attachments=[attach.hash for attach in attached],
             steps=steps,
-            step_type=ResultStepsType.CLASSIC,
+            steps_type=ResultStepsType.CLASSIC,
             params=result.params,
+            param_groups=result.param_groups,
             muted=False,
             message=result.message,
         )
 
-        if result.get_suite_title():
+        if result.relations is not None and result.relations.suite is not None and len(
+                result.relations.suite.data) != 0:
             data = []
             root_suite = self.config.root_suite
             if root_suite:
                 data.append(RelationSuiteItem(title=root_suite))
 
-            for suite in result.get_suite_title().split("."):
-                data.append(RelationSuiteItem(title=suite))
+            for raw in result.relations.suite.data:
+                data.append(RelationSuiteItem(title=raw.title))
 
             result_model_v2.relations = ResultRelations(suite=RelationSuite(data=data))
 

qase/commons/models/__init__.py

@@ -1,7 +1,6 @@
 from .result import Result, Field
 from .run import Run
 from .attachment import Attachment
-from .suite import Suite
 from .relation import Relation
 from .step import Step
 from .runtime import Runtime
@@ -10,7 +9,6 @@ __all__ = [
     Result,
     Run,
     Attachment,
-    Suite,
     Relation,
     Step,
     Runtime,

qase/commons/models/config/framework.py

@@ -1,7 +1,22 @@
+from enum import Enum
+from typing import Type, Union
+
 from ..basemodel import BaseModel
 from ... import QaseUtils
 
 
+class Video(Enum):
+    off = "off"
+    on = "on"
+    failed = "retain-on-failure"
+
+
+class Trace(Enum):
+    off = "off"
+    on = "on"
+    failed = "retain-on-failure"
+
+
 class PytestConfig(BaseModel):
     capture_logs: bool = None
 
@@ -12,8 +27,37 @@ class PytestConfig(BaseModel):
         self.capture_logs = QaseUtils.parse_bool(capture_logs)
 
 
+class PlaywrightConfig(BaseModel):
+    output_dir: str = None
+    video: Video = None
+    trace: Trace = None
+
+    def __init__(self):
+        self.output_dir = "test-results"
+        self.video = Video.off
+        self.trace = Trace.off
+
+    def set_output_dir(self, output_dir: str):
+        self.output_dir = output_dir
+
+    def set_video(self, value: str):
+        self.video = self.__set_mode(Video, value)
+
+    def set_trace(self, value: str):
+        self.trace = self.__set_mode(Trace, value)
+
+    @staticmethod
+    def __set_mode(enum_class: Type[Union[Video, Trace]], value: str):
+        for mode in enum_class:
+            if mode.value == value:
+                return mode
+        return None
+
+
 class Framework(BaseModel):
     pytest: PytestConfig = None
+    playwright: PlaywrightConfig = None
 
     def __init__(self):
         self.pytest = PytestConfig()
+        self.playwright = PlaywrightConfig()

qase/commons/models/relation.py

@@ -1,13 +1,23 @@
 from .basemodel import BaseModel
 
 
-class RelationSuite(BaseModel):
-    def __init__(self, suite_id: int, title: str) -> None:
-        self.suite_id = suite_id
+class SuiteData(BaseModel):
+    def __init__(self, title: str) -> None:
+        self.public_id = None
         self.title = title
 
 
+class RelationSuite(BaseModel):
+    def __init__(self) -> None:
+        self.data = []
+
+    def add_data(self, data: SuiteData) -> None:
+        self.data.append(data)
+
+
 class Relation(BaseModel):
-    def __init__(self, type: str, data: RelationSuite):
-        self.type = type
-        self.data = data
+    def __init__(self):
+        self.suite = RelationSuite()
+
+    def add_suite(self, suite: SuiteData) -> None:
+        self.suite.add_data(suite)

qase/commons/models/result.py

@@ -4,7 +4,6 @@ import uuid
 from typing import Type, Optional, Union, Dict, List
 from .basemodel import BaseModel
 from .step import Step
-from .suite import Suite
 from .attachment import Attachment
 from .relation import Relation
 from .. import QaseUtils
@@ -79,10 +78,9 @@ class Result(BaseModel):
         self.params: Optional[dict] = {}
         self.param_groups: Optional[List[List[str]]] = []
         self.author: Optional[str] = None
-        self.relations: List[Type[Relation]] = []
+        self.relations: Type[Relation] = None
         self.muted: bool = False
         self.message: Optional[str] = None
-        self.suite: Optional[Type[Suite]] = None
         QaseUtils.get_host_data()
 
     def add_message(self, message: str) -> None:
@@ -97,20 +95,14 @@ class Result(BaseModel):
     def add_attachment(self, attachment: Attachment) -> None:
         self.attachments.append(attachment)
 
-    def add_relation(self, relation: Type[Relation]) -> None:
-        self.relations.append(relation)
-
     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 add_relation(self, relation: Type[Relation]) -> None:
-        self.relations.append(relation)
-
-    def add_suite(self, suite: Type[Suite]) -> None:
-        self.suite = suite
+    def set_relation(self, relation: Relation) -> None:
+        self.relations = relation
 
     def get_status(self) -> Optional[str]:
         return self.execution.status
@@ -127,17 +119,10 @@ class Result(BaseModel):
         return None
 
     def get_testops_id(self) -> Optional[int]:
-        if self.testops_id is None:
-            # Hack for old API
-            return 0
         return self.testops_id
 
     def get_duration(self) -> int:
         return self.execution.duration
 
-    def get_suite_title(self) -> Optional[str]:
-        if self.suite:
-            return self.suite.title
-
     def set_run_id(self, run_id: str) -> None:
         self.run_id = run_id

qase/commons/reporters/report.py

@@ -68,13 +68,19 @@ class QaseReport:
                 mode = "w"
             if isinstance(attachment.content, bytes):
                 mode = "wb"
-            with open(f"{self.report_path}/attachments/{attachment.id}-{attachment.file_name}", mode) as f:
+
+            file_path = f"{self.report_path}/attachments/{attachment.id}-{attachment.file_name}"
+            with open(file_path, mode) as f:
                 f.write(attachment.content)
             # Clear content to save memory and avoid double writing
             attachment.content = None
+            attachment.file_path = file_path
+
         elif attachment.file_path:
+            file_path = f"{self.report_path}/attachments/{attachment.id}-{attachment.file_name}"
             shutil.copy2(os.path.abspath(attachment.file_path),
                          f"{self.report_path}/attachments/{attachment.id}-{attachment.file_name}")
+            attachment.file_path = file_path
 
     def _persist_attachments_in_steps(self, steps: list):
         for step in steps:

{qase_python_commons-3.1.8.dist-info → qase_python_commons-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qase-python-commons
-Version: 3.1.8
+Version: 3.2.0
 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,7 +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.1.1
-Requires-Dist: qase-api-v2-client~=1.0.0
+Requires-Dist: qase-api-v2-client~=1.1.0
 Requires-Dist: more-itertools
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{qase_python_commons-3.1.8.dist-info → qase_python_commons-3.2.0.dist-info}/RECORD

@@ -3,23 +3,22 @@ qase/commons/config.py,sha256=meRRgDrsA9qQ9fZR4fnP0VdngrKiGcHF9nnJkf3eJpg,8320
 qase/commons/loader.py,sha256=-MMY4HgSI6q1xq3NaJoq_w4liM73qdFKjYLVCT1E7Pc,1064
 qase/commons/logger.py,sha256=ka5chQYBXLUB5pM4YHDBo3QCZfBTGMtC3H33tI4NbPQ,1027
 qase/commons/utils.py,sha256=OOr6kQ5hPZEyHXwbwiTOTkonRxmmtkyZPPGqXQKp5vY,2799
-qase/commons/client/api_v1_client.py,sha256=t93-wqb9Rxgsvsk49toRZPeaTtBUVWsDk-UQ8gpy9pU,11880
-qase/commons/client/api_v2_client.py,sha256=F3wU_2EKe6eUjNRahvnDmpbx99PwZB6Lxc4VPRj7w58,7247
+qase/commons/client/api_v1_client.py,sha256=YIaRWu9txJoIljcvPJ-4MECqgw72oae-o6z0Bl9t-Jo,12715
+qase/commons/client/api_v2_client.py,sha256=sh748gx9jjqBm42IrSeOduBWs6jKzz5QqCWSKcURDOA,7440
 qase/commons/client/base_api_client.py,sha256=H8JnjqSrBFNfghDd3T3zxYOyKYHYe9QiJQXol1JqdQk,2613
 qase/commons/exceptions/reporter.py,sha256=dP-Mwcq8HKBOjgu3YqhyULDmDGU09BmT6Fh9HjICaUc,45
-qase/commons/models/__init__.py,sha256=66rxcTqtfbx_zPshJW3f5JxtC4aoaDSCC0izyY_9GGI,308
+qase/commons/models/__init__.py,sha256=FTt5dYASBX4r6-tQi-_JAUVx4uvJs9GTxROdAZEV6Jo,272
 qase/commons/models/attachment.py,sha256=Rjq1mAP11uk7TN2RrtImntw6DUMV7U0R-44TYj8O5j0,1432
 qase/commons/models/basemodel.py,sha256=nyDSXhpQUecKdzhB-eWqujmso20oXB9p_42qpOsGVuQ,213
-qase/commons/models/relation.py,sha256=Hscui14vuSdKVdPPej4V1-SF4XHvJ2Tqg0KH8d49dH0,321
-qase/commons/models/result.py,sha256=im6L5F44yXAyD6HQy8kP9fncjrKn-7HN30ZnezSdi_Q,4423
+qase/commons/models/relation.py,sha256=HymHeh1uBcoQnTs4Vra7WJ_KFkhryj5o7cShjoGQImI,511
+qase/commons/models/result.py,sha256=RWryOX85T-_T3AngrGuREtwmPq6FyOPvM77H949vm1I,3953
 qase/commons/models/run.py,sha256=KkplvlHJNvVLORzVkdz5mHsLFBTUAdtuEYCqCy_RcvU,2469
 qase/commons/models/runtime.py,sha256=mfK-mOViD1orXOx-jP6nIgtnN0tUmRYY1aMH0qFDmXA,1287
 qase/commons/models/step.py,sha256=M-btRYZ4febYavDhwFqmKcCdLAgrhtuv7E_M3TKZdfg,4281
-qase/commons/models/suite.py,sha256=Z2tlxdeIsuzjIoPnuyVq23pt59Yt6LVmofcew5Njk_s,348
 qase/commons/models/config/api.py,sha256=IyYY2f3ncESUAEGvkE3-meatebBFJdvgo7KNOQnxLE0,288
 qase/commons/models/config/batch.py,sha256=X0H8SVOCCD2pV6LSMqjI-tIjRcLifnrM5MareK2FhQw,321
 qase/commons/models/config/connection.py,sha256=wK2fGjc0G0rMVVhPnjw_t_M1YWZwANlhwl-awmI7XSo,516
-qase/commons/models/config/framework.py,sha256=upGHFwmJ-i-VA_OLPgJiwgJRjB7vusuk-dhJMhgdYDM,416
+qase/commons/models/config/framework.py,sha256=N4vSS1EAu8LEzYSbpy3Z4rNY2DbpWQ4Mh1mknRfMDRM,1432
 qase/commons/models/config/plan.py,sha256=JbAY7qfGXYreXOLa32OLxw6z0paeCCf87-2b1m8xkks,137
 qase/commons/models/config/qaseconfig.py,sha256=-tuTsd6s4YSAkSca7vvNaFZbqhbWkxuw-mjeqhwmjlc,1722
 qase/commons/models/config/report.py,sha256=g3Z2B3Tewaasjc1TMj2mkXxz0Zc1C39sHeTXH0MRM2Y,497
@@ -31,10 +30,10 @@ qase/commons/profilers/network.py,sha256=zKNBnTQG4BMg8dn8O--tQzQLpu-qs5ADhHEnqIa
 qase/commons/profilers/sleep.py,sha256=HT6h0R-2XHZAoBYRxS2T_KC8RrnEoVjP7MXusaE4Nec,1624
 qase/commons/reporters/__init__.py,sha256=J0aNLzb_MPPT_zF8BtX_w9nj_U7Ad06RGpyWK5Pxq1o,169
 qase/commons/reporters/core.py,sha256=0x5G-KVfEOWyXiXaX5__7JBIr3Rxy8vhy0cByUSZUc0,8021
-qase/commons/reporters/report.py,sha256=MPsFv3k2l4652NyXEGFiSmwsSpwZT3Is-lLRXvsniz4,4606
+qase/commons/reporters/report.py,sha256=zyGeUOcJCOEoGtsewCOf3kypbPttJH7EM-LmZ_Y5huY,4829
 qase/commons/reporters/testops.py,sha256=f5BcorFwIK5BSeA4Rv4IKDddkWrAXL_w-Y5Xn--NdYs,6264
 qase/commons/validators/base.py,sha256=wwSn-4YiuXtfGMGnSKgo9Vm5hAKevVmmfd2Ro6Q7MYQ,173
-qase_python_commons-3.1.8.dist-info/METADATA,sha256=6lr1O9vlI3BDkCu9ekgNJ9HqC0Yxl0Cj3PMTMYJ1Tog,1859
-qase_python_commons-3.1.8.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-qase_python_commons-3.1.8.dist-info/top_level.txt,sha256=Mn5aFk7H7Uia4s1NRDsvebu8vCrFy9nOuRIBfkIY5kQ,5
-qase_python_commons-3.1.8.dist-info/RECORD,,
+qase_python_commons-3.2.0.dist-info/METADATA,sha256=7HxmqCpafL3UdsAHcKASQNFBnrubf9S3Crud2NQM8QQ,1859
+qase_python_commons-3.2.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+qase_python_commons-3.2.0.dist-info/top_level.txt,sha256=Mn5aFk7H7Uia4s1NRDsvebu8vCrFy9nOuRIBfkIY5kQ,5
+qase_python_commons-3.2.0.dist-info/RECORD,,

{qase_python_commons-3.1.8.dist-info → qase_python_commons-3.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

qase/commons/models/suite.py

@@ -1,13 +0,0 @@
-import uuid
-
-from typing import List, Optional
-
-from .basemodel import BaseModel
-
-
-class Suite(BaseModel):
-    def __init__(self, title: str, description: Optional[str] = None, parent_id: Optional[str] = None):
-        self.title = title
-        self.description = description
-        self.parent_id = parent_id
-        self.id = str(uuid.uuid4())