qase-python-commons 5.1.4__tar.gz → 5.1.6__tar.gz

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qase-python-commons
-Version: 5.1.4
+Version: 5.1.6
 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
@@ -435,6 +435,12 @@ When a 429 carries a `Retry-After` header, that value replaces the computed
 backoff. Qase sends roughly 60 seconds, so a run that hits the rate limit takes
 longer to finish rather than losing the batch.
 
+The same timeout and retry settings apply to attachment uploads, which go
+through the API v1 client in batches of up to 20 files. **If an attachment batch
+cannot be uploaded after all attempts**, the reporter logs an error, drops those
+attachments and still submits the results they belong to — a failed attachment
+never costs you the test results.
+
 **If a batch cannot be delivered after all attempts**, the reporter logs an
 error naming how many results were lost and **does not mark the run complete**.
 An open run is the signal that its data is incomplete; a completed run over

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/README.md

@@ -400,6 +400,12 @@ When a 429 carries a `Retry-After` header, that value replaces the computed
 backoff. Qase sends roughly 60 seconds, so a run that hits the rate limit takes
 longer to finish rather than losing the batch.
 
+The same timeout and retry settings apply to attachment uploads, which go
+through the API v1 client in batches of up to 20 files. **If an attachment batch
+cannot be uploaded after all attempts**, the reporter logs an error, drops those
+attachments and still submits the results they belong to — a failed attachment
+never costs you the test results.
+
 **If a batch cannot be delivered after all attempts**, the reporter logs an
 error naming how many results were lost and **does not mark the run complete**.
 An open run is the signal that its data is incomplete; a completed run over

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qase-python-commons"
-version = "5.1.4"
+version = "5.1.6"
 description = "A library for Qase TestOps and Qase Report"
 readme = "README.md"
 authors = [{name = "Qase Team", email = "support@qase.io"}]

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/src/qase/commons/client/api_v1_client.py

@@ -8,6 +8,8 @@ from qase.api_client_v1.models.attachmentupload import Attachmentupload
 from qase.api_client_v1.configuration import Configuration
 from .. import Logger
 from .base_api_client import BaseApiClient
+from ..retry import send_with_retry
+from ..util.api_host import get_web_app_url
 from ..exceptions.reporter import ReporterException
 from ..models import Attachment
 from ..models.config.framework import Video, Trace
@@ -30,12 +32,11 @@ class ApiV1Client(BaseApiClient):
             # pinned off so it cannot multiply with the application-level one.
             configuration.retries = 0
             host = self.config.testops.api.host
+            self.web = get_web_app_url(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")
@@ -46,7 +47,9 @@ class ApiV1Client(BaseApiClient):
     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)
+            response = ProjectsApi(self.client).get_project(
+                code=project_code, _request_timeout=self.config.testops.api.timeout
+            )
             if hasattr(response, 'result'):
                 self.logger.log_debug(f"Project {project_code} found: {response.result.to_json()}")
                 return response.result
@@ -59,7 +62,9 @@ class ApiV1Client(BaseApiClient):
         try:
             self.logger.log_debug(f"Getting environment {environment}")
             api_instance = EnvironmentsApi(self.client)
-            response = api_instance.get_environments(code=project_code)
+            response = api_instance.get_environments(
+                code=project_code, _request_timeout=self.config.testops.api.timeout
+            )
             if hasattr(response, 'result') and hasattr(response.result, 'entities'):
                 for env in response.result.entities:
                     if env.slug == environment:
@@ -76,7 +81,9 @@ class ApiV1Client(BaseApiClient):
         try:
             self.logger.log_debug(f"Getting configurations for project {project_code}")
             api_instance = ConfigurationsApi(self.client)
-            response = api_instance.get_configurations(code=project_code)
+            response = api_instance.get_configurations(
+                code=project_code, _request_timeout=self.config.testops.api.timeout
+            )
             if hasattr(response, 'result') and hasattr(response.result, 'entities'):
                 return response.result.entities
             return []
@@ -117,8 +124,9 @@ class ApiV1Client(BaseApiClient):
                 # Create new group
                 group_create = ConfigurationGroupCreate(title=config_value.name)
                 group_response = ConfigurationsApi(self.client).create_configuration_group(
-                    code=project_code, 
-                    configuration_group_create=group_create
+                    code=project_code,
+                    configuration_group_create=group_create,
+                    _request_timeout=self.config.testops.api.timeout
                 )
                 group_id = group_response.result.id
             
@@ -129,7 +137,8 @@ class ApiV1Client(BaseApiClient):
             )
             config_response = ConfigurationsApi(self.client).create_configuration(
                 code=project_code,
-                configuration_create=config_create
+                configuration_create=config_create,
+                _request_timeout=self.config.testops.api.timeout
             )
             config_id = config_response.result.id
             return config_id
@@ -141,12 +150,16 @@ class ApiV1Client(BaseApiClient):
     def complete_run(self, project_code: str, run_id: int) -> 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
+        res = api_runs.get_run(
+            project_code, run_id, _request_timeout=self.config.testops.api.timeout
+        ).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)
+            api_runs.complete_run(
+                project_code, run_id, _request_timeout=self.config.testops.api.timeout
+            )
             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")
@@ -240,10 +253,33 @@ class ApiV1Client(BaseApiClient):
                 
                 # Prepare files for upload
                 files_for_upload = [att.get_for_upload() for att in batch]
-                
-                # Upload batch
-                response = attach_api.upload_attachment(project_code, file=files_for_upload)
-                
+
+                # The timeout is what keeps a stalled connection from blocking
+                # the reporter thread forever: without it urllib3 waits
+                # indefinitely, no exception is ever raised, and the retry below
+                # never gets a chance to run.
+                #
+                # Unlike results, an attachment carries no idempotency key, so a
+                # retry whose first response was lost can leave an unreferenced
+                # file behind. That is cheaper than the alternative: the whole
+                # batch of results these attachments belong to going nowhere.
+                response = None
+
+                def upload_batch():
+                    nonlocal response
+                    response = attach_api.upload_attachment(
+                        project_code,
+                        file=files_for_upload,
+                        _request_timeout=self.config.testops.api.timeout
+                    )
+
+                send_with_retry(
+                    upload_batch,
+                    attempts=self.config.testops.api.retries,
+                    backoff=self.config.testops.api.retry_backoff,
+                    logger=self.logger,
+                )
+
                 if response.result:
                     all_uploaded.extend(response.result)
                     self.logger.log_debug(
@@ -294,7 +330,8 @@ class ApiV1Client(BaseApiClient):
         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})
+                run_create=RunCreate(**{k: v for k, v in kwargs.items() if v is not None}),
+                _request_timeout=self.config.testops.api.timeout
             )
 
             run_id = result.result.id
@@ -311,7 +348,9 @@ class ApiV1Client(BaseApiClient):
 
     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)
+        run = api_runs.get_run(
+            code=project_code, id=run_id, _request_timeout=self.config.testops.api.timeout
+        )
         if run.result.id:
             return True
         return False
@@ -332,7 +371,10 @@ class ApiV1Client(BaseApiClient):
             run_public = RunPublic(status=True)
             
             # Call the API to enable public report
-            response = api_runs.update_run_publicity(project_code, run_id, run_public)
+            response = api_runs.update_run_publicity(
+                project_code, run_id, run_public,
+                _request_timeout=self.config.testops.api.timeout
+            )
             
             # Extract the public URL from response
             if response.result and response.result.url:
@@ -368,7 +410,8 @@ class ApiV1Client(BaseApiClient):
             
             RunsApi(self.client).run_update_external_issue(
                 code=project_code,
-                runexternal_issues=run_external_issues
+                runexternal_issues=run_external_issues,
+                _request_timeout=self.config.testops.api.timeout
             )
             
             self.logger.log(f"External link updated for run {run_id}: {external_link.link}", "debug")

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/src/qase/commons/client/api_v2_client.py

@@ -20,6 +20,7 @@ from ..models.config.framework import Video, Trace
 from ..models import Attachment, Result
 from ..models.config.qaseconfig import QaseConfig
 from ..models.step import StepType, Step
+from ..util.api_host import get_web_app_url
 from ..util.host_data import HostData
 
 
@@ -42,12 +43,11 @@ class ApiV2Client(ApiV1Client):
             # 9 requests, the opposite of what is wanted on a 429.
             configuration.retries = 0
             host = self.config.testops.api.host
+            self.web = get_web_app_url(host)
             if host == 'qase.io':
                 configuration.host = f'https://api.{host}/v2'
-                self.web = f'https://app.{host}'
             else:
                 configuration.host = f'https://api-{host}/v2'
-                self.web = f'https://{host}'
 
             self.client_v2 = ApiClient(configuration)
             

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/src/qase/commons/reporters/testops.py

@@ -9,6 +9,7 @@ from ..client.base_api_client import BaseApiClient
 from ..models import Result
 from ..models.config.qaseconfig import QaseConfig
 from ..retry import send_with_retry
+from ..util.api_host import get_web_app_url
 
 DEFAULT_BATCH_SIZE = 200
 DEFAULT_THREAD_COUNT = 4
@@ -20,7 +21,7 @@ class QaseTestOps:
     def __init__(self, config: QaseConfig, logger: Logger, client: BaseApiClient) -> None:
         self.config = config
         self.logger = logger
-        self.__baseUrl = self.__get_host(config.testops.api.host)
+        self.__baseUrl = get_web_app_url(config.testops.api.host)
         self.client = client
 
         run_id = self.config.testops.run.id
@@ -210,10 +211,3 @@ class QaseTestOps:
         if ids is not None and len(ids) > 0:
             return f"{link}{self.project_code}-{ids[0]}"
         return f"{link}{urllib.parse.quote_plus(title)}"
-
-    @staticmethod
-    def __get_host(host: str):
-        if host == 'qase.io':
-            return 'https://app.qase.io'
-
-        return f'https://{host.replace("api", "app")}'

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/src/qase/commons/reporters/testops_multi.py

@@ -10,6 +10,7 @@ from ..client.base_api_client import BaseApiClient
 from ..models import Result
 from ..models.config.qaseconfig import QaseConfig
 from ..retry import send_with_retry
+from ..util.api_host import get_web_app_url
 
 DEFAULT_BATCH_SIZE = 200
 DEFAULT_THREAD_COUNT = 4
@@ -21,7 +22,7 @@ class QaseTestOpsMulti:
     def __init__(self, config: QaseConfig, logger: Logger, client: BaseApiClient) -> None:
         self.config = config
         self.logger = logger
-        self.__baseUrl = self.__get_host(config.testops.api.host)
+        self.__baseUrl = get_web_app_url(config.testops.api.host)
         self.client = client
 
         self.multi_config = config.testops_multi
@@ -369,10 +370,3 @@ class QaseTestOpsMulti:
         if ids is not None and len(ids) > 0:
             return f"{link}{project_code}-{ids[0]}"
         return f"{link}{urllib.parse.quote_plus(title)}"
-
-    @staticmethod
-    def __get_host(host: str):
-        """Get host URL for Qase."""
-        if host == 'qase.io':
-            return 'https://app.qase.io'
-        return f'https://{host.replace("api", "app")}'

qase_python_commons-5.1.6/src/qase/commons/util/api_host.py

@@ -0,0 +1,24 @@
+from typing import Optional
+
+DEFAULT_HOST = 'qase.io'
+
+# Enterprise hosts share the `api-<name>.qase.io` shape but serve the web app on
+# `<name>.qase.io`, so a cluster cannot be inferred from the API hostname and has
+# to be listed explicitly.
+CLUSTER_APP_HOSTS = {
+    'api-eu.qase.io': 'app-eu.qase.io',
+}
+
+
+def resolve_cluster_app_url(host: str) -> Optional[str]:
+    """Return the web app URL of a known Qase cluster, or None for any other host."""
+    # Mirrors how a host fragment becomes the API base URL: `https://api-<host>`.
+    app_host = CLUSTER_APP_HOSTS.get(f'api-{host}'.lower())
+    return f'https://{app_host}' if app_host else None
+
+
+def get_web_app_url(host: str) -> str:
+    """Return the Qase web app base URL for the `testops.api.host` value."""
+    if host == DEFAULT_HOST:
+        return f'https://app.{DEFAULT_HOST}'
+    return resolve_cluster_app_url(host) or f'https://{host}'

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/src/qase_python_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qase-python-commons
-Version: 5.1.4
+Version: 5.1.6
 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
@@ -435,6 +435,12 @@ When a 429 carries a `Retry-After` header, that value replaces the computed
 backoff. Qase sends roughly 60 seconds, so a run that hits the rate limit takes
 longer to finish rather than losing the batch.
 
+The same timeout and retry settings apply to attachment uploads, which go
+through the API v1 client in batches of up to 20 files. **If an attachment batch
+cannot be uploaded after all attempts**, the reporter logs an error, drops those
+attachments and still submits the results they belong to — a failed attachment
+never costs you the test results.
+
 **If a batch cannot be delivered after all attempts**, the reporter logs an
 error naming how many results were lost and **does not mark the run complete**.
 An open run is the signal that its data is incomplete; a completed run over

{qase_python_commons-5.1.4 → qase_python_commons-5.1.6}/src/qase_python_commons.egg-info/SOURCES.txt

@@ -41,6 +41,7 @@ src/qase/commons/reporters/testops_multi.py
 src/qase/commons/status_mapping/__init__.py
 src/qase/commons/status_mapping/status_mapping.py
 src/qase/commons/util/__init__.py
+src/qase/commons/util/api_host.py
 src/qase/commons/util/host_data.py
 src/qase/commons/util/token_masker.py
 src/qase/commons/validators/base.py