qase-python-commons 2.0.12__tar.gz → 3.0.0__tar.gz

{qase_python_commons-2.0.12/src/qase_python_commons.egg-info → qase_python_commons-3.0.0}/PKG-INFO

@@ -1,17 +1,28 @@
 Metadata-Version: 2.1
 Name: qase-python-commons
-Version: 2.0.12
+Version: 3.0.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
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
-License-File: AUTHORS.rst
 Requires-Dist: certifi>=2024.2.2
-Requires-Dist: qaseio<5.0.0,>=4.0.2
 Requires-Dist: attrs>=23.2.0
+Requires-Dist: qaseio
 Requires-Dist: more_itertools
 Provides-Extra: testing
 Requires-Dist: pytest; extra == "testing"

{qase_python_commons-2.0.12 → qase_python_commons-3.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qase-python-commons"
-version = "2.0.12"
+version = "3.0.0"
 description = "A library for Qase TestOps and Qase Report"
 readme = "README.md"
 authors = [{name = "Qase Team", email = "support@qase.io"}]
@@ -12,13 +12,25 @@ license = {file = "LICENSE"}
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python",
+    'Intended Audience :: Developers',
+    'License :: OSI Approved :: Apache Software License',
+    'Topic :: Software Development :: Quality Assurance',
+    'Topic :: Software Development :: Testing',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3 :: Only',
+    'Programming Language :: Python :: 3.7',
+    'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
 ]
 urls = {"Homepage" = "https://github.com/qase-tms/qase-python/tree/master/qase-python-commons"}
 requires-python = ">=3.7"
 dependencies = [
     "certifi>=2024.2.2",
-    "qaseio>=4.0.2,<5.0.0",
     "attrs>=23.2.0",
+    "qaseio",
     "more_itertools"
 ]
 
@@ -66,7 +78,7 @@ exclude = [".tox", "build", "dist", ".eggs", "docs/conf.py"]
 branch = true
 
 [tool.coverage.paths]
-source = ["src/qaseio/commons"]
+source = ["src/qase/commons"]
 
 [tool.coverage.report]
 # Regexes for lines to exclude from consideration

qase_python_commons-3.0.0/src/qase/commons/__init__.py

@@ -0,0 +1,14 @@
+from .utils import QaseUtils, StringFormatter
+from .config import ConfigManager
+from .loader import TestOpsPlanLoader
+from .logger import Logger
+from .exceptions.reporter import ReporterException
+
+__all__ = [
+    QaseUtils,
+    StringFormatter,
+    ConfigManager,
+    TestOpsPlanLoader,
+    Logger,
+    ReporterException
+]

qase_python_commons-3.0.0/src/qase/commons/config.py

@@ -0,0 +1,61 @@
+import os
+import json
+from .logger import Logger
+
+
+class ConfigManager:
+
+    def __init__(self, config_file='./qase.config.json', env_vars_prefix='QASE_'):
+        self.logger = Logger()
+        self.config = {}
+        self.parseBool = lambda d: d in ("y", "yes", "true", "1", 1, True)
+
+        try:
+            if os.path.exists(config_file):
+                with open(config_file, "r") as file:
+                    self.config = json.load(file)
+        except Exception as e:
+            self.logger.log("Failed to load config from file", "error")
+
+        # Load from env vars
+        try:
+            for key, value in os.environ.items():
+                if key.startswith(env_vars_prefix):
+                    self._set_config(key[len(env_vars_prefix):].lower().replace('_', '.'), value)
+        except Exception as e:
+            self.logger.log("Failed to load config from env vars {e}", "error")
+
+    def get(self, key, default=None, value_type=None):
+        # Use _get_config method to get the value. If None, return default.
+        value = self._get_config(key)
+        if value_type and value_type == bool:
+            return self.parseBool(value or default)
+        return value or default
+
+    def validate_config(self):
+        if self.validator:
+            self.validator.validate(self.config)
+
+    def set(self, key, value):
+        self._set_config(key, value)
+
+    def _get_keys(self, config, prefix=""):
+        for key, value in config.items():
+            if isinstance(value, dict):
+                yield from self._get_keys(value, f"{prefix}{key}.")
+            else:
+                yield f"{prefix}{key}"
+
+    def _set_config(self, key, value, delimiter="."):
+        keys = key.split(delimiter)
+        config = self.config
+        for key in keys[:-1]:
+            config = config.setdefault(key, {})
+        config[keys[-1]] = value
+
+    def _get_config(self, key):
+        keys = key.split(".")
+        config = self.config
+        for key in keys[:-1]:
+            config = config.get(key, {})
+        return config.get(keys[-1], None)

qase_python_commons-3.0.0/src/qase/commons/exceptions/reporter.py

@@ -0,0 +1,2 @@
+class ReporterException(Exception):
+    pass

{qase_python_commons-2.0.12/src/qaseio → qase_python_commons-3.0.0/src/qase}/commons/loader.py

@@ -2,10 +2,12 @@ from qaseio.api_client import ApiClient
 from qaseio.configuration import Configuration
 from qaseio.api.plans_api import PlansApi
 from qaseio.rest import ApiException
+
 import certifi
 
+
 class TestOpsPlanLoader:
-    def __init__(self, api_token, host = 'qase.io'):
+    def __init__(self, api_token, host='qase.io'):
         configuration = Configuration()
         configuration.api_key['TokenAuth'] = api_token
         configuration.host = f'https://api.{host}/v1'
@@ -16,13 +18,12 @@ class TestOpsPlanLoader:
         configuration.ssl_ca_cert = certifi.where()
 
     def load(self, code: str, plan_id: int) -> list:
-        api_instance = PlansApi(self.client)
         try:
-            response = api_instance.get_plan(code=code, id=plan_id)
+            response = PlansApi(self.client).get_plan(code=code, id=plan_id)
             if hasattr(response, 'result'):
                 self.case_list = [c.case_id for c in response.result.cases]
                 return self.case_list
             raise ValueError("Unable to find given plan")
         except ApiException as e:
             print("Unable to load test plan data: %s\n" % e)
-        return []
+        return []

qase_python_commons-3.0.0/src/qase/commons/logger.py

@@ -0,0 +1,28 @@
+import datetime
+
+import os
+
+
+class Logger:
+    def __init__(self, debug: bool = False, prefix: str = '', dir: str = './logs') -> None:
+        self.debug = debug
+        if self.debug:
+            filename = f'{prefix}_{self._get_timestamp()}.log'
+            if not os.path.exists(dir):
+                os.makedirs(dir)
+            self.log_file = os.path.join(dir, f'{filename}')
+            with open(self.log_file, 'w'):
+                pass
+
+    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)
+        if self.debug:
+            with open(self.log_file, 'a') as f:
+                f.write(log)
+
+    @staticmethod
+    def _get_timestamp(format: str = "%Y%m%d_%H:%M:%S"):
+        now = datetime.datetime.now()
+        return now.strftime(format)

qase_python_commons-3.0.0/src/qase/commons/models/__init__.py

@@ -0,0 +1,17 @@
+from .result import Result
+from .run import Run
+from .attachment import Attachment
+from .suite import Suite
+from .relation import Relation
+from .step import Step
+from .runtime import Runtime
+
+__all__ = [
+    Result,
+    Run,
+    Attachment,
+    Suite,
+    Relation,
+    Step,
+    Runtime
+]

{qase_python_commons-2.0.12/src/qaseio → qase_python_commons-3.0.0/src/qase}/commons/models/attachment.py

@@ -1,28 +1,32 @@
 import os
 import uuid
-from typing import Optional
+from typing import Optional, Union
 from io import BytesIO, StringIO
 import json
+import pathlib
+
 
 class Attachment:
-    def __init__(self, 
+    def __init__(self,
                  file_name: str,
                  mime_type: str,
                  content: Optional[str] = None,
-                 file_path: Optional[str] = None):
+                 file_path: Optional[str] = None,
+                 temporary: bool = False):
         self.file_name = file_name
         self.mime_type = mime_type
         if (not content) and (not file_path):
             raise ValueError('Either content or file_path must be provided.')
         self.file_path = file_path
         self.content = content
+        self.temporary = temporary
 
         if (not isinstance(content, str)) and (not isinstance(content, bytes)):
             self.content = json.dumps(self.content, default=lambda o: o.__dict__, sort_keys=False, indent=4)
 
         self.size = self._get_size(content)
         self.id = str(uuid.uuid4())
-        
+
     def _get_size(self, content):
         if self.file_path:
             return os.path.getsize(self.file_path)
@@ -30,17 +34,16 @@ class Attachment:
             return len(content)
         else:
             return 0
-        
-    def get_id(self):
+
+    def get_id(self) -> str:
         return self.id
-    
+
     def get_for_upload(self) -> BytesIO:
         if self.file_path:
-            with open(self.file_path, "rb") as fc:
-                content = BytesIO(fc.read())
+            return pathlib.Path(os.path.abspath(self.file_path))
         else:
             if isinstance(self.content, str):
-                content = BytesIO(bytes(self.content, 'utf-8'))
+                content = BytesIO(self.content.encode('utf-8'))
             elif isinstance(self.content, bytes):
                 content = BytesIO(self.content)
         content.name = self.file_name

{qase_python_commons-2.0.12/src/qaseio → qase_python_commons-3.0.0/src/qase}/commons/models/relation.py

@@ -3,7 +3,8 @@ class RelationSuite(object):
         self.suite_id = suite_id
         self.title = title
 
+
 class Relation(object):
     def __init__(self, type: str, data: RelationSuite):
         self.type = type
-        self.data = data
+        self.data = data

{qase_python_commons-2.0.12/src/qaseio → qase_python_commons-3.0.0/src/qase}/commons/models/result.py

@@ -3,27 +3,29 @@ from pathlib import PosixPath
 import time
 import uuid
 import json
-from qaseio.commons.models.step import Step
-from qaseio.commons.models.suite import Suite
-from qaseio.commons.models.relation import Relation
-from qaseio.commons.models.attachment import Attachment
-from qaseio.commons.utils import QaseUtils
+from .step import Step
+from .suite import Suite
+from .attachment import Attachment
+from .relation import Relation
+from .. import QaseUtils
+
 
 class Field:
-    def __init__(self, 
+    def __init__(self,
                  name: str,
                  value: Union[str, list]):
         self.name = name
         self.value = value
 
+
 class Execution(object):
-    def __init__(self, 
-                    status: Optional[str] = None,
-                    end_time: int = 0, 
-                    duration: int = 0, 
-                    stacktrace: Optional[str] = None, 
-                    thread: Optional[str] = QaseUtils.get_thread_name()
-                    ):
+    def __init__(self,
+                 status: Optional[str] = None,
+                 end_time: int = 0,
+                 duration: int = 0,
+                 stacktrace: Optional[str] = None,
+                 thread: Optional[str] = QaseUtils.get_thread_name()
+                 ):
         self.start_time = time.time()
         self.status = status
         self.end_time = end_time
@@ -32,11 +34,11 @@ class Execution(object):
         self.thread = thread
 
     def set_status(self, status: Optional[str]):
-        if (status in ['passed', 'failed', 'skipped', 'untested']):
+        if status in ['passed', 'failed', 'skipped', 'untested']:
             self.status = status
         else:
             raise ValueError('Step status must be one of: passed, failed, skipped, untested')
-        
+
     def get_status(self):
         return self.status
 
@@ -44,15 +46,16 @@ class Execution(object):
         self.end_time = time.time()
         self.duration = (int)((self.end_time - self.start_time) * 1000)
 
+
 class Request(object):
     def __init__(self,
-            method: str,
-            url: str,
-            status: int,
-            request_headers: Dict[str, str],
-            request_body: str,
-            response_headers: Dict[str, str],
-            response_body: str):
+                 method: str,
+                 url: str,
+                 status: int,
+                 request_headers: Dict[str, str],
+                 request_body: str,
+                 response_headers: Dict[str, str],
+                 response_body: str):
         self.method = method
         self.url = url
         self.status = status
@@ -61,6 +64,7 @@ class Request(object):
         self.response_headers = response_headers
         self.response_body = response_body
 
+
 class Result(object):
     def __init__(self, title: str, signature: str) -> None:
         self.id: str = str(uuid.uuid4())
@@ -82,7 +86,7 @@ class Result(object):
 
     def add_message(self, message: str) -> None:
         self.message = message
-    
+
     def add_field(self, field: Type[Field]) -> None:
         self.fields[field.name] = field.value
 
@@ -106,24 +110,24 @@ class Result(object):
 
     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]:
         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
 
@@ -135,4 +139,5 @@ class Result(object):
         self.run_id = run_id
 
     def to_json(self) -> str:
-        return json.dumps(self, default=lambda o: o.__str__() if isinstance(o, PosixPath) else o.__dict__, sort_keys=False, indent=4)
+        return json.dumps(self, default=lambda o: o.__str__() if isinstance(o, PosixPath) else o.__dict__,
+                          sort_keys=False, indent=4)

{qase_python_commons-2.0.12/src/qaseio → qase_python_commons-3.0.0/src/qase}/commons/models/run.py

@@ -1,6 +1,7 @@
 import json
 from typing import Optional, List
 
+
 class RunExecution(object):
     def __init__(self,
                  start_time: float,
@@ -9,12 +10,13 @@ class RunExecution(object):
                  ) -> None:
         self.start_time = start_time
         self.end_time = end_time
-        self.duration = int((end_time - start_time)*1000)
+        self.duration = int((end_time - start_time) * 1000)
         self.cumulative_duration = cumulative_duration
 
     def track(self, result: dict):
         self.cumulative_duration += result["execution"]["duration"]
 
+
 class RunStats(object):
     def __init__(self) -> None:
         self.passed = 0
@@ -23,7 +25,7 @@ class RunStats(object):
         self.broken = 0
         self.muted = 0
         self.total = 0
-        
+
     def track(self, result: dict):
         status = result["execution"]["status"]
         if status == "passed":
@@ -37,10 +39,10 @@ class RunStats(object):
         self.total += 1
         if result.get('muted', False):
             self.muted += 1
-            
+
 
 class Run(object):
-    def __init__(self, 
+    def __init__(self,
                  title: str,
                  start_time: float,
                  end_time: float,
@@ -49,6 +51,7 @@ class Run(object):
                  suites: List[str] = [],
                  environment: Optional[str] = None
                  ):
+        self.host_data = None
         self.title = title
         self.execution = RunExecution(start_time=start_time, end_time=end_time)
         self.stats = RunStats()
@@ -56,10 +59,10 @@ class Run(object):
         self.threads = threads
         self.suites = suites
         self.environment = environment
-    
+
     def to_json(self) -> str:
         return json.dumps(self, default=lambda o: o.__dict__, sort_keys=False, indent=4)
-    
+
     def add_result(self, result: dict):
         compact_result = {
             "id": result["id"],
@@ -71,8 +74,8 @@ class Run(object):
         self.results.append(compact_result)
         self.execution.track(result)
         self.stats.track(result)
-        if (result["execution"]["thread"] not in self.threads):
+        if result["execution"]["thread"] not in self.threads:
             self.threads.append(result["execution"]["thread"])
 
     def add_host_data(self, host_data: dict):
-        self.host_data = host_data
+        self.host_data = host_data

qase_python_commons-3.0.0/src/qase/commons/models/runtime.py

@@ -0,0 +1,43 @@
+from .step import Step, StepTextData
+from .attachment import Attachment
+
+
+class QaseRuntimeException(Exception):
+    pass
+
+
+class Runtime:
+    def __init__(self):
+        self.result = None
+        self.steps = {}
+        self.step_id = None
+
+    def add_step(self, step: Step):
+        try:
+            if self.step_id:
+                step.set_parent_id(self.step_id)
+
+            self.steps[step.id] = step
+            self.step_id = step.id
+        except Exception as e:
+            raise QaseRuntimeException(e)
+
+    def finish_step(self, id: str, status: str, data=None):
+        try:
+            self.steps[id].execution.set_status(status)
+            if data:
+                self.steps[id].set_data(data)
+
+            self.steps[id].execution.complete()
+            self.step_id = self.steps[id].parent_id
+        except Exception as e:
+            raise QaseRuntimeException(e)
+
+    def add_attachment(self, attachment: Attachment):
+        try:
+            if self.step_id:
+                self.steps[self.step_id].add_attachment(attachment)
+            else:
+                self.result.add_attachment(attachment)
+        except Exception as e:
+            raise QaseRuntimeException(e)