testit-python-commons 5.1.6__tar.gz → 5.2.0__tar.gz

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testit-python-commons
-Version: 5.1.6
+Version: 5.2.0
 Summary: Python commons for Test IT
 Home-page: https://github.com/testit-tms/adapters-python/
 Author: Integration team

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import find_packages, setup
 
-VERSION = "5.1.6"
+VERSION = "5.2.0"
 
 setup(
     name='testit-python-commons',

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/adapters_api/model/custom_attribute_api_result.py

@@ -90,9 +90,9 @@ class CustomAttributeApiResult(ModelNormal):
             'is_enabled': (bool,),  # noqa: E501
             'is_required': (bool,),  # noqa: E501
             'is_global': (bool,),  # noqa: E501
-            'is_read_only': (bool, none_type,),  # noqa: E501
-            'is_system': (bool, none_type,),  # noqa: E501
-            'targets': ([str], none_type,),  # noqa: E501
+            'is_read_only': (bool,),  # noqa: E501
+            'is_system': (bool,),  # noqa: E501
+            'targets': ([str],),  # noqa: E501
             'code': (str, none_type,),  # noqa: E501
         }
 
@@ -123,7 +123,7 @@ class CustomAttributeApiResult(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, id, options, type, is_deleted, name, is_enabled, is_required, is_global, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, id, options, type, is_deleted, name, is_enabled, is_required, is_global, is_read_only, is_system, targets, *args, **kwargs):  # noqa: E501
         """CustomAttributeApiResult - a model defined in OpenAPI
 
         Args:
@@ -135,11 +135,11 @@ class CustomAttributeApiResult(ModelNormal):
             is_enabled (bool): Indicates if the attribute is enabled
             is_required (bool): Indicates if the attribute value is mandatory to specify
             is_global (bool): Indicates if the attribute is available across all projects
+            is_read_only (bool): Indicates if the attribute is read-only
+            is_system (bool): Indicates if the attribute is system
+            targets ([str]): Collection of the attribute targets   Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)
 
         Keyword Args:
-            is_read_only (bool): Indicates if the attribute is read-only. [optional]  # noqa: E501
-            is_system (bool): Indicates if the attribute is system. [optional]  # noqa: E501
-            targets ([str]): Collection of the attribute targets. [optional]  # noqa: E501
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
                                 raised if the wrong type is input.
@@ -178,9 +178,6 @@ class CustomAttributeApiResult(ModelNormal):
         _path_to_item = kwargs.pop('_path_to_item', ())
         _configuration = kwargs.pop('_configuration', None)
         _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
-        is_read_only = kwargs.pop('is_read_only', False)
-        is_system = kwargs.pop('is_system', False)
-        targets = kwargs.pop('targets', None)
 
         self = super(OpenApiModel, cls).__new__(cls)
 
@@ -236,7 +233,7 @@ class CustomAttributeApiResult(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, id, options, type, is_deleted, name, is_enabled, is_required, is_global, *args, **kwargs):  # noqa: E501
+    def __init__(self, id, options, type, is_deleted, name, is_enabled, is_required, is_global, is_read_only, is_system, targets, *args, **kwargs):  # noqa: E501
         """CustomAttributeApiResult - a model defined in OpenAPI
 
         Args:
@@ -248,11 +245,11 @@ class CustomAttributeApiResult(ModelNormal):
             is_enabled (bool): Indicates if the attribute is enabled
             is_required (bool): Indicates if the attribute value is mandatory to specify
             is_global (bool): Indicates if the attribute is available across all projects
+            is_read_only (bool): Indicates if the attribute is read-only
+            is_system (bool): Indicates if the attribute is system
+            targets ([str]): Collection of the attribute targets   Defines where the attribute can be used (e.g., TestCases, AutoTestCases, TestPlans)
 
         Keyword Args:
-            is_read_only (bool): Indicates if the attribute is read-only. [optional]  # noqa: E501
-            is_system (bool): Indicates if the attribute is system. [optional]  # noqa: E501
-            targets ([str]): Collection of the attribute targets. [optional]  # noqa: E501
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
                                 raised if the wrong type is input.
@@ -291,9 +288,6 @@ class CustomAttributeApiResult(ModelNormal):
         _path_to_item = kwargs.pop('_path_to_item', ())
         _configuration = kwargs.pop('_configuration', None)
         _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
-        is_read_only = kwargs.pop('is_read_only', False)
-        is_system = kwargs.pop('is_system', False)
-        targets = kwargs.pop('targets', None)
 
         if args:
             for arg in args:

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/adapters_api/model/layer_source.py

@@ -53,6 +53,7 @@ class LayerSource(ModelSimple):
     allowed_values = {
         ('value',): {
             'MANUAL': "Manual",
+            'REPORT': "Report",
             'RUN': "Run",
             'RULE': "Rule",
         },
@@ -106,10 +107,10 @@ class LayerSource(ModelSimple):
         Note that value can be passed either in args or in kwargs, but not in both.
 
         Args:
-            args[0] (str):, must be one of ["Manual", "Run", "Rule", ]  # noqa: E501
+            args[0] (str):, must be one of ["Manual", "Report", "Run", "Rule", ]  # noqa: E501
 
         Keyword Args:
-            value (str):, must be one of ["Manual", "Run", "Rule", ]  # noqa: E501
+            value (str):, must be one of ["Manual", "Report", "Run", "Rule", ]  # noqa: E501
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
                                 raised if the wrong type is input.
@@ -200,10 +201,10 @@ class LayerSource(ModelSimple):
         Note that value can be passed either in args or in kwargs, but not in both.
 
         Args:
-            args[0] (str):, must be one of ["Manual", "Run", "Rule", ]  # noqa: E501
+            args[0] (str):, must be one of ["Manual", "Report", "Run", "Rule", ]  # noqa: E501
 
         Keyword Args:
-            value (str):, must be one of ["Manual", "Run", "Rule", ]  # noqa: E501
+            value (str):, must be one of ["Manual", "Report", "Run", "Rule", ]  # noqa: E501
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
                                 raised if the wrong type is input.

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/testit.py

@@ -5,6 +5,7 @@ from testit_python_commons.decorators import (
     externalID,
     externalId,
     labels,
+    layer,
     tags,
     link,
     links,
@@ -32,6 +33,7 @@ from testit_python_commons.dynamic_methods import (
     message
 )
 from testit_python_commons.models import LinkType
+from testit_python_commons.models.test_layers import TestLayers
 from testit_python_commons.step import step
 
 __all__ = [
@@ -45,6 +47,7 @@ __all__ = [
     'title',
     'description',
     'labels',
+    'layer',
     'tags',
     'link',
     'links',
@@ -65,5 +68,6 @@ __all__ = [
     'addTags',
     'addParameter',
     'step',
-    'LinkType'
+    'LinkType',
+    'TestLayers',
 ]

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/testit_python_commons/client/converter.py

@@ -36,6 +36,8 @@ from adapters_api.models import (
     TestStatusApiType,
     CreateLinkApiModel,
     LabelApiModel,
+    AutoTestCreateApiModelLayer,
+    LayerSource,
 )
 
 from testit_python_commons.models.link import Link
@@ -241,6 +243,36 @@ class Converter:
 
         return label_models or None
 
+    @staticmethod
+    @adapter_logger
+    def layer_to_api_model(layer: Optional[str]) -> Optional[AutoTestCreateApiModelLayer]:
+        if not layer or not str(layer).strip():
+            return None
+
+        return AutoTestCreateApiModelLayer(
+            name=str(layer).strip(),
+            source=LayerSource("Run"),
+        )
+
+    @classmethod
+    @adapter_logger
+    def _autotest_layer_kwargs_for_create(cls, test_result: TestResult) -> dict:
+        layer = cls.layer_to_api_model(test_result.get_layer())
+        if not layer:
+            return {}
+
+        return {'layer': layer}
+
+    @classmethod
+    @adapter_logger
+    def _autotest_layer_kwargs_for_update(cls, test_result: TestResult) -> dict:
+        kwargs = {'reset_layer': False}
+        layer = cls.layer_to_api_model(test_result.get_layer())
+        if layer:
+            kwargs['layer'] = layer
+
+        return kwargs
+
     @classmethod
     @adapter_logger
     def test_result_to_autotest_post_model(
@@ -265,7 +297,8 @@ class Converter:
             labels=cls.labels_to_label_api_models(test_result.get_labels()),
             tags=test_result.get_tags(),
             should_create_work_item=test_result.get_automatic_creation_test_cases(),
-            external_key=test_result.get_external_key()
+            external_key=test_result.get_external_key(),
+            **cls._autotest_layer_kwargs_for_create(test_result),
         )
 
     @classmethod
@@ -292,7 +325,8 @@ class Converter:
             labels=cls.labels_to_label_api_models(test_result.get_labels()),
             tags=test_result.get_tags(),
             should_create_work_item=test_result.get_automatic_creation_test_cases(),
-            external_key=test_result.get_external_key()
+            external_key=test_result.get_external_key(),
+            **cls._autotest_layer_kwargs_for_create(test_result),
         )
 
     @classmethod
@@ -305,7 +339,6 @@ class Converter:
             external_id=test_result.get_external_id(),
             project_id=project_id,
             name=test_result.get_autotest_name(),
-            reset_layer=False,
             steps=cls.step_results_to_autotest_steps_model(
                 test_result.get_step_results()),
             setup=cls.step_results_to_autotest_steps_model(
@@ -319,7 +352,8 @@ class Converter:
             links=cls.links_to_links_put_model(test_result.get_links()),
             labels=cls.labels_to_label_api_models(test_result.get_labels()),
             tags=test_result.get_tags(),
-            external_key=test_result.get_external_key()
+            external_key=test_result.get_external_key(),
+            **cls._autotest_layer_kwargs_for_update(test_result),
         )
 
     @classmethod
@@ -332,7 +366,6 @@ class Converter:
             external_id=test_result.get_external_id(),
             project_id=project_id,
             name=test_result.get_autotest_name(),
-            reset_layer=False,
             steps=cls.step_results_to_autotest_steps_model(
                 test_result.get_step_results()),
             setup=cls.step_results_to_autotest_steps_model(
@@ -346,7 +379,8 @@ class Converter:
             links=cls.links_to_links_put_model(test_result.get_links()),
             labels=cls.labels_to_label_api_models(test_result.get_labels()),
             tags=test_result.get_tags(),
-            external_key=test_result.get_external_key()
+            external_key=test_result.get_external_key(),
+            **cls._autotest_layer_kwargs_for_update(test_result),
         )
 
     @classmethod

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/testit_python_commons/decorators.py

@@ -171,6 +171,18 @@ def tags(*test_tags: str):
     return outer
 
 
+@adapter_logger
+def layer(test_layer: str):
+    """
+    specifies the test pyramid layer for the autotest card
+    """
+    def outer(function):
+        function.test_layer = test_layer
+        return inner(function)
+
+    return outer
+
+
 @Utils.deprecated('Use "links" instead.')
 @adapter_logger
 def link(url: str, title: str = None, type: str = None, description: str = None):  # noqa: A002,VNE003

testit_python_commons-5.2.0/src/testit_python_commons/models/test_layers.py

@@ -0,0 +1,8 @@
+class TestLayers:
+    E2E = "E2E"
+    UI = "UI"
+    API = "API"
+    CONTRACT = "Contract"
+    INTEGRATION = "Integration"
+    COMPONENT = "Component"
+    UNIT = "Unit"

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/testit_python_commons/models/test_result.py

@@ -33,6 +33,7 @@ class TestResult:
     __properties: dict = {}
     __automatic_creation_test_cases: bool = False
     __external_key: str = None
+    __layer: str = None
 
     @adapter_logger
     def set_external_id(self, external_id: str):
@@ -295,3 +296,13 @@ class TestResult:
     @adapter_logger
     def get_external_key(self) -> str:
         return self.__external_key
+
+    @adapter_logger
+    def set_layer(self, layer: str):
+        self.__layer = HtmlEscapeUtils.escape_html_tags(layer) if layer else None
+
+        return self
+
+    @adapter_logger
+    def get_layer(self) -> str:
+        return self.__layer

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/testit_python_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testit-python-commons
-Version: 5.1.6
+Version: 5.2.0
 Summary: Python commons for Test IT
 Home-page: https://github.com/testit-tms/adapters-python/
 Author: Integration team

{testit_python_commons-5.1.6 → testit_python_commons-5.2.0}/src/testit_python_commons.egg-info/SOURCES.txt

@@ -254,6 +254,7 @@ src/testit_python_commons/models/link_type.py
 src/testit_python_commons/models/outcome_type.py
 src/testit_python_commons/models/status_type.py
 src/testit_python_commons/models/step_result.py
+src/testit_python_commons/models/test_layers.py
 src/testit_python_commons/models/test_result.py
 src/testit_python_commons/models/test_result_with_all_fixture_step_results_model.py
 src/testit_python_commons/services/__init__.py