qase-python-commons 4.0.0__tar.gz → 4.0.1__tar.gz

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qase-python-commons
-Version: 4.0.0
+Version: 4.0.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
@@ -21,7 +21,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.2.2
 Requires-Dist: attrs>=23.2.0
-Requires-Dist: qase-api-client~=2.0.0
+Requires-Dist: qase-api-client~=2.0.1
 Requires-Dist: qase-api-v2-client~=2.0.0
 Requires-Dist: more_itertools
 Provides-Extra: testing
@@ -36,7 +36,12 @@ Requires-Dist: urllib3; extra == "testing"
 
 ## Description
 
-This package contains reporters for Qase TestOps and Qase Report that are used in [qase-pytest](https://github.com/qase-tms/qase-python/tree/master/qase-pytest) and [qase-robotframework](https://github.com/qase-tms/qase-python/tree/master/qase-robotframework).
+This package contains reporters for Qase TestOps and Qase Report that are used in following projects:
+
+- [qase-pytest](https://github.com/qase-tms/qase-python/tree/main/qase-pytest)
+- [qase-robotframework](https://github.com/qase-tms/qase-python/tree/main/qase-robotframework)
+- [qase-behave](https://github.com/qase-tms/qase-python/tree/main/qase-behave)
+- [qase-tavern](https://github.com/qase-tms/qase-python/tree/main/qase-tavern)
 
 ## How to install
 

qase_python_commons-4.0.1/README.md

@@ -0,0 +1,14 @@
+# Qase Python Commons
+
+## Description
+
+This package contains reporters for Qase TestOps and Qase Report that are used in following projects:
+
+- [qase-pytest](https://github.com/qase-tms/qase-python/tree/main/qase-pytest)
+- [qase-robotframework](https://github.com/qase-tms/qase-python/tree/main/qase-robotframework)
+- [qase-behave](https://github.com/qase-tms/qase-python/tree/main/qase-behave)
+- [qase-tavern](https://github.com/qase-tms/qase-python/tree/main/qase-tavern)
+
+## How to install
+
+`pip install qase-python-commons`

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qase-python-commons"
-version = "4.0.0"
+version = "4.0.1"
 description = "A library for Qase TestOps and Qase Report"
 readme = "README.md"
 authors = [{name = "Qase Team", email = "support@qase.io"}]
@@ -29,7 +29,7 @@ requires-python = ">=3.9"
 dependencies = [
     "certifi>=2024.2.2",
     "attrs>=23.2.0",
-    "qase-api-client~=2.0.0",
+    "qase-api-client~=2.0.1",
     "qase-api-v2-client~=2.0.0",
     "more_itertools"
 ]

qase_python_commons-4.0.1/src/qase/__init__.py

@@ -0,0 +1,3 @@
+"""
+Qase Python Commons package.
+"""

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/src/qase/commons/config.py

@@ -63,6 +63,11 @@ class ConfigManager:
                             config.get("excludeParams")
                         )
 
+                    if config.get("statusMapping"):
+                        self.config.set_status_mapping(
+                            config.get("statusMapping")
+                        )
+
                     if config.get("executionPlan"):
                         execution_plan = config.get("executionPlan")
                         if execution_plan.get("path"):
@@ -224,6 +229,19 @@ class ConfigManager:
                     self.config.set_exclude_params(
                         [param.strip() for param in value.split(',')])
 
+                if key == 'QASE_STATUS_MAPPING':
+                    # Parse status mapping from environment variable
+                    # Format: "source1=target1,source2=target2"
+                    if value:
+                        mapping_dict = {}
+                        pairs = value.split(',')
+                        for pair in pairs:
+                            pair = pair.strip()
+                            if pair and '=' in pair:
+                                source_status, target_status = pair.split('=', 1)
+                                mapping_dict[source_status.strip()] = target_status.strip()
+                        self.config.set_status_mapping(mapping_dict)
+
                 if key == 'QASE_EXECUTION_PLAN_PATH':
                     self.config.execution_plan.set_path(value)
 

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/src/qase/commons/models/config/qaseconfig.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import List
+from typing import List, Dict
 
 from .framework import Framework
 from .report import ReportConfig
@@ -36,6 +36,7 @@ class QaseConfig(BaseModel):
     profilers: list = None
     framework: Framework = None
     exclude_params: list = None
+    status_mapping: Dict[str, str] = None
 
     def __init__(self):
         self.mode = Mode.off
@@ -47,6 +48,7 @@ class QaseConfig(BaseModel):
         self.framework = Framework()
         self.profilers = []
         self.exclude_params = []
+        self.status_mapping = {}
 
     def set_mode(self, mode: str):
         if any(mode == e.value for e in Mode.__members__.values()):
@@ -70,3 +72,6 @@ class QaseConfig(BaseModel):
 
     def set_exclude_params(self, exclude_params: List[str]):
         self.exclude_params = exclude_params
+
+    def set_status_mapping(self, status_mapping: Dict[str, str]):
+        self.status_mapping = status_mapping

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/src/qase/commons/models/result.py

@@ -33,10 +33,16 @@ class Execution(BaseModel):
         self.thread = thread
 
     def set_status(self, status: Optional[str]):
-        if status in ['passed', 'failed', 'skipped', 'untested', 'invalid']:
+        if status is None:
             self.status = status
+            return
+        
+        # Convert to lowercase for validation
+        status_lower = status.lower()
+        if status_lower in ['passed', 'failed', 'skipped', 'untested', 'invalid', 'disabled', 'blocked']:
+            self.status = status_lower
         else:
-            raise ValueError('Step status must be one of: passed, failed, skipped, untested, invalid')
+            raise ValueError('Step status must be one of: passed, failed, skipped, untested, invalid, disabled, blocked')
 
     def get_status(self):
         return self.status

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/src/qase/commons/reporters/core.py

@@ -11,6 +11,7 @@ from ..models.config.qaseconfig import Mode
 from typing import Union, List
 
 from ..util import get_host_info
+from ..status_mapping.status_mapping import StatusMapping
 
 """
     CoreReporter is a facade for all reporters and it is used to initialize and manage them.
@@ -28,6 +29,11 @@ class QaseCoreReporter:
         self.profilers = []
         self.overhead = 0
 
+        # Initialize status mapping
+        self.status_mapping = StatusMapping.from_dict(self.config.status_mapping)
+        if not self.status_mapping.is_empty():
+            self.logger.log_debug(f"Status mapping initialized: {self.status_mapping}")
+
         # self._selective_execution_setup()
         self.fallback = self._fallback_setup()
 
@@ -87,6 +93,9 @@ class QaseCoreReporter:
                 ts = time.time()
                 self.logger.log_debug(f"Adding result {result}")
 
+                # Apply status mapping before adding result
+                self._apply_status_mapping(result)
+
                 self.reporter.add_result(result)
 
                 self.logger.log_debug(f"Result {result.get_title()} added")
@@ -208,3 +217,26 @@ class QaseCoreReporter:
         if self.config.fallback == Mode.report:
             return QaseReport(config=self.config, logger=self.logger)
         return None
+
+    def _apply_status_mapping(self, result: Result) -> None:
+        """
+        Apply status mapping to a test result.
+        
+        This method applies the configured status mapping to the result's execution status.
+        The mapping is applied before the result is sent to the reporter.
+        
+        Args:
+            result: Test result to apply status mapping to
+        """
+        if self.status_mapping.is_empty():
+            return
+        
+        original_status = result.get_status()
+        if not original_status:
+            return
+        
+        mapped_status = self.status_mapping.apply_mapping(original_status)
+        
+        if mapped_status != original_status:
+            result.execution.set_status(mapped_status)
+            self.logger.log_debug(f"Status mapped for '{result.get_title()}': {original_status} -> {mapped_status}")

qase_python_commons-4.0.1/src/qase/commons/status_mapping/__init__.py

@@ -0,0 +1,12 @@
+"""
+Utilities package for Qase Python Commons.
+"""
+
+from .status_mapping import StatusMapping, StatusMappingError, create_status_mapping_from_config, create_status_mapping_from_env
+
+__all__ = [
+    'StatusMapping',
+    'StatusMappingError', 
+    'create_status_mapping_from_config',
+    'create_status_mapping_from_env'
+]

qase_python_commons-4.0.1/src/qase/commons/status_mapping/status_mapping.py

@@ -0,0 +1,237 @@
+"""
+Status mapping utilities for Qase Python Commons.
+
+This module provides functionality to map test result statuses from one value to another
+based on configuration. This is useful for standardizing status values across different
+testing frameworks or for custom status transformations.
+"""
+
+from typing import Dict, Optional, List
+import os
+import logging
+
+
+class StatusMappingError(Exception):
+    """Exception raised when status mapping encounters an error."""
+    pass
+
+
+class StatusMapping:
+    """
+    Handles mapping of test result statuses.
+    
+    This class provides functionality to:
+    - Parse status mapping from configuration
+    - Validate status mappings
+    - Apply status mappings to test results
+    - Support both JSON configuration and environment variables
+    """
+    
+    # Valid statuses that can be mapped
+    VALID_STATUSES = {
+        'passed', 'failed', 'skipped', 'disabled', 'blocked', 'invalid'
+    }
+    
+    def __init__(self, mapping: Optional[Dict[str, str]] = None):
+        """
+        Initialize StatusMapping with optional mapping dictionary.
+        
+        Args:
+            mapping: Dictionary mapping source status to target status
+        """
+        self.mapping = mapping or {}
+        self.logger = logging.getLogger(__name__)
+    
+    @classmethod
+    def from_dict(cls, mapping_dict: Dict[str, str]) -> 'StatusMapping':
+        """
+        Create StatusMapping from dictionary.
+        
+        Args:
+            mapping_dict: Dictionary with status mappings
+            
+        Returns:
+            StatusMapping instance
+            
+        Raises:
+            StatusMappingError: If mapping contains invalid statuses
+        """
+        instance = cls()
+        instance.set_mapping(mapping_dict)
+        return instance
+    
+    @classmethod
+    def from_env_string(cls, env_string: str) -> 'StatusMapping':
+        """
+        Create StatusMapping from environment variable string.
+        
+        Expected format: "source1=target1,source2=target2"
+        
+        Args:
+            env_string: Environment variable string
+            
+        Returns:
+            StatusMapping instance
+            
+        Raises:
+            StatusMappingError: If string format is invalid
+        """
+        instance = cls()
+        instance.parse_env_string(env_string)
+        return instance
+    
+    def set_mapping(self, mapping_dict: Dict[str, str]) -> None:
+        """
+        Set status mapping from dictionary.
+        
+        Args:
+            mapping_dict: Dictionary with status mappings
+            
+        Raises:
+            StatusMappingError: If mapping contains invalid statuses
+        """
+        if not isinstance(mapping_dict, dict):
+            raise StatusMappingError("Mapping must be a dictionary")
+        
+        # Validate all statuses in the mapping
+        for source_status, target_status in mapping_dict.items():
+            if source_status not in self.VALID_STATUSES:
+                raise StatusMappingError(f"Invalid source status: {source_status}")
+            if target_status not in self.VALID_STATUSES:
+                raise StatusMappingError(f"Invalid target status: {target_status}")
+        
+        self.mapping = mapping_dict.copy()
+        self.logger.debug(f"Status mapping set: {self.mapping}")
+    
+    def parse_env_string(self, env_string: str) -> None:
+        """
+        Parse status mapping from environment variable string.
+        
+        Expected format: "source1=target1,source2=target2"
+        
+        Args:
+            env_string: Environment variable string
+            
+        Raises:
+            StatusMappingError: If string format is invalid
+        """
+        if not env_string or not env_string.strip():
+            self.mapping = {}
+            return
+        
+        mapping_dict = {}
+        pairs = env_string.split(',')
+        
+        for pair in pairs:
+            pair = pair.strip()
+            if not pair:
+                continue
+                
+            if '=' not in pair:
+                raise StatusMappingError(f"Invalid mapping format: {pair}. Expected 'source=target'")
+            
+            source_status, target_status = pair.split('=', 1)
+            source_status = source_status.strip()
+            target_status = target_status.strip()
+            
+            if not source_status or not target_status:
+                raise StatusMappingError(f"Empty status in mapping: {pair}")
+            
+            mapping_dict[source_status] = target_status
+        
+        self.set_mapping(mapping_dict)
+    
+    def apply_mapping(self, status: str) -> str:
+        """
+        Apply status mapping to a given status.
+        
+        Args:
+            status: Original status
+            
+        Returns:
+            Mapped status if mapping exists, otherwise original status
+        """
+        if not status:
+            return status
+        
+        if status in self.mapping:
+            mapped_status = self.mapping[status]
+            self.logger.debug(f"Status mapped: {status} -> {mapped_status}")
+            return mapped_status
+        
+        return status
+    
+    def get_mapping(self) -> Dict[str, str]:
+        """
+        Get current status mapping.
+        
+        Returns:
+            Dictionary with current status mappings
+        """
+        return self.mapping.copy()
+    
+    def is_empty(self) -> bool:
+        """
+        Check if mapping is empty.
+        
+        Returns:
+            True if no mappings are defined
+        """
+        return len(self.mapping) == 0
+    
+    def validate(self) -> List[str]:
+        """
+        Validate current mapping and return any issues.
+        
+        Returns:
+            List of validation error messages
+        """
+        errors = []
+        
+        for source_status, target_status in self.mapping.items():
+            if source_status not in self.VALID_STATUSES:
+                errors.append(f"Invalid source status: {source_status}")
+            if target_status not in self.VALID_STATUSES:
+                errors.append(f"Invalid target status: {target_status}")
+        
+        return errors
+    
+    def __str__(self) -> str:
+        """String representation of the mapping."""
+        return str(self.mapping)
+    
+    def __repr__(self) -> str:
+        """Detailed string representation."""
+        return f"StatusMapping({self.mapping})"
+
+
+def create_status_mapping_from_config(config_value: Optional[Dict[str, str]]) -> StatusMapping:
+    """
+    Create StatusMapping from configuration value.
+    
+    Args:
+        config_value: Configuration dictionary or None
+        
+    Returns:
+        StatusMapping instance
+    """
+    if config_value is None:
+        return StatusMapping()
+    
+    return StatusMapping.from_dict(config_value)
+
+
+def create_status_mapping_from_env(env_var_name: str = 'STATUS_MAPPING') -> StatusMapping:
+    """
+    Create StatusMapping from environment variable.
+    
+    Args:
+        env_var_name: Name of environment variable
+        
+    Returns:
+        StatusMapping instance
+    """
+    env_value = os.getenv(env_var_name)
+    if env_value:
+        return StatusMapping.from_env_string(env_value)
+    return StatusMapping()

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/src/qase_python_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qase-python-commons
-Version: 4.0.0
+Version: 4.0.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
@@ -21,7 +21,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: certifi>=2024.2.2
 Requires-Dist: attrs>=23.2.0
-Requires-Dist: qase-api-client~=2.0.0
+Requires-Dist: qase-api-client~=2.0.1
 Requires-Dist: qase-api-v2-client~=2.0.0
 Requires-Dist: more_itertools
 Provides-Extra: testing
@@ -36,7 +36,12 @@ Requires-Dist: urllib3; extra == "testing"
 
 ## Description
 
-This package contains reporters for Qase TestOps and Qase Report that are used in [qase-pytest](https://github.com/qase-tms/qase-python/tree/master/qase-pytest) and [qase-robotframework](https://github.com/qase-tms/qase-python/tree/master/qase-robotframework).
+This package contains reporters for Qase TestOps and Qase Report that are used in following projects:
+
+- [qase-pytest](https://github.com/qase-tms/qase-python/tree/main/qase-pytest)
+- [qase-robotframework](https://github.com/qase-tms/qase-python/tree/main/qase-robotframework)
+- [qase-behave](https://github.com/qase-tms/qase-python/tree/main/qase-behave)
+- [qase-tavern](https://github.com/qase-tms/qase-python/tree/main/qase-tavern)
 
 ## How to install
 

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/src/qase_python_commons.egg-info/SOURCES.txt

@@ -1,5 +1,6 @@
 README.md
 pyproject.toml
+src/qase/__init__.py
 src/qase/commons/__init__.py
 src/qase/commons/config.py
 src/qase/commons/loader.py
@@ -35,6 +36,8 @@ src/qase/commons/reporters/__init__.py
 src/qase/commons/reporters/core.py
 src/qase/commons/reporters/report.py
 src/qase/commons/reporters/testops.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/host_data.py
 src/qase/commons/validators/base.py

{qase_python_commons-4.0.0 → qase_python_commons-4.0.1}/src/qase_python_commons.egg-info/requires.txt

@@ -1,6 +1,6 @@
 certifi>=2024.2.2
 attrs>=23.2.0
-qase-api-client~=2.0.0
+qase-api-client~=2.0.1
 qase-api-v2-client~=2.0.0
 more_itertools
 

qase_python_commons-4.0.0/README.md

@@ -1,9 +0,0 @@
-# Qase Python Commons
-
-## Description
-
-This package contains reporters for Qase TestOps and Qase Report that are used in [qase-pytest](https://github.com/qase-tms/qase-python/tree/master/qase-pytest) and [qase-robotframework](https://github.com/qase-tms/qase-python/tree/master/qase-robotframework).
-
-## How to install
-
-`pip install qase-python-commons`