testit-python-commons 4.1.0__tar.gz → 4.1.1__tar.gz

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/PKG-INFO

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

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/setup.py

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

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/api_client_syncstorage/api/completion_api.py

@@ -21,6 +21,7 @@ from api_client_syncstorage.model_utils import (  # noqa: F401
     none_type,
     validate_and_convert_types
 )
+from api_client_syncstorage.model.completion_response import CompletionResponse
 
 
 class CompletionApi(object):
@@ -36,7 +37,7 @@ class CompletionApi(object):
         self.api_client = api_client
         self.force_completion_get_endpoint = _Endpoint(
             settings={
-                'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
+                'response_type': (CompletionResponse,),
                 'auth': [],
                 'endpoint_path': '/force-completion',
                 'operation_id': 'force_completion_get',
@@ -85,7 +86,7 @@ class CompletionApi(object):
         )
         self.wait_completion_get_endpoint = _Endpoint(
             settings={
-                'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
+                'response_type': (CompletionResponse,),
                 'auth': [],
                 'endpoint_path': '/wait-completion',
                 'operation_id': 'wait_completion_get',
@@ -183,7 +184,7 @@ class CompletionApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            bool, date, datetime, dict, float, int, list, str, none_type
+            CompletionResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -266,7 +267,7 @@ class CompletionApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            bool, date, datetime, dict, float, int, list, str, none_type
+            CompletionResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """

testit_python_commons-4.1.1/src/api_client_syncstorage/model/completion_response.py

@@ -0,0 +1,267 @@
+"""
+    Sync Storage Service API
+
+    This is a sync storage service for coordinating test workers.  # noqa: E501
+
+    The version of the OpenAPI document: 1.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from api_client_syncstorage.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from api_client_syncstorage.exceptions import ApiAttributeError
+
+
+
+class CompletionResponse(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+    }
+
+    validations = {
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            'completed': (bool,),  # noqa: E501
+            'message': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'completed': 'completed',  # noqa: E501
+        'message': 'message',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """CompletionResponse - a model defined in OpenAPI
+
+        Keyword Args:
+            _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.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            completed (bool): [optional]  # noqa: E501
+            message (str): [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """CompletionResponse - a model defined in OpenAPI
+
+        Keyword Args:
+            _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.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _spec_property_naming (bool): True if the variable names in the input data
+                                are serialized names, as specified in the OpenAPI document.
+                                False if the variable names in the input data
+                                are pythonic names, e.g. snake case (default)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            completed (bool): [optional]  # noqa: E501
+            message (str): [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/api_client_syncstorage/model/register_request.py

@@ -83,6 +83,8 @@ class RegisterRequest(ModelNormal):
         return {
             'pid': (str,),  # noqa: E501
             'test_run_id': (str,),  # noqa: E501
+            'base_url': (str,),  # noqa: E501
+            'private_token': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -93,6 +95,8 @@ class RegisterRequest(ModelNormal):
     attribute_map = {
         'pid': 'pid',  # noqa: E501
         'test_run_id': 'testRunId',  # noqa: E501
+        'base_url': 'baseUrl',  # noqa: E501
+        'private_token': 'privateToken',  # noqa: E501
     }
 
     read_only_vars = {
@@ -138,6 +142,8 @@ class RegisterRequest(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             pid (str): [optional]  # noqa: E501
             test_run_id (str): [optional]  # noqa: E501
+            base_url (str): [optional]  # noqa: E501
+            private_token (str): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -225,6 +231,8 @@ class RegisterRequest(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             pid (str): [optional]  # noqa: E501
             test_run_id (str): [optional]  # noqa: E501
+            base_url (str): [optional]  # noqa: E501
+            private_token (str): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/api_client_syncstorage/models/__init__.py

@@ -9,6 +9,7 @@
 # import sys
 # sys.setrecursionlimit(n)
 
+from api_client_syncstorage.model.completion_response import CompletionResponse
 from api_client_syncstorage.model.health_status_response import HealthStatusResponse
 from api_client_syncstorage.model.register_request import RegisterRequest
 from api_client_syncstorage.model.register_response import RegisterResponse

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/testit_python_commons/client/api_client.py

@@ -170,14 +170,29 @@ class ApiClientWorker:
             test_result.get_external_id())
 
         autotests = self.__autotest_api.api_v2_auto_tests_search_post(api_v2_auto_tests_search_post_request=model)
+        should_create_work_item = test_result.get_automatic_creation_test_cases()
 
         if autotests:
+            logging.info(
+                'Autotest "%s" already exists (external_id="%s"), using update path. '
+                "automaticCreationTestCases=%s applies only on create path.",
+                test_result.get_autotest_name(),
+                test_result.get_external_id(),
+                should_create_work_item,
+            )
             self.__update_auto_test(test_result, autotests[0])
 
             autotest_id = autotests[0].id
 
             self.__update_autotest_link_from_work_items(autotest_id, test_result.get_work_item_ids())
         else:
+            logging.info(
+                'Autotest "%s" not found (external_id="%s"), using create path with '
+                "automaticCreationTestCases=%s.",
+                test_result.get_autotest_name(),
+                test_result.get_external_id(),
+                should_create_work_item,
+            )
             self.__create_auto_test(test_result)
 
         return self.__load_test_result(test_result)
@@ -186,9 +201,12 @@ class ApiClientWorker:
     def write_tests(self, test_results: List[TestResult], fixture_containers: dict) -> None:
         logging.debug("call __write_tests")
         bulk_autotest_helper = BulkAutotestHelper(self.__autotest_api, self.__test_run_api, self.__config)
+        create_count = 0
+        update_count = 0
 
         for test_result in test_results:
             test_result = self.__add_fixtures_to_test_result(test_result, fixture_containers)
+            should_create_work_item = test_result.get_automatic_creation_test_cases()
 
             test_result_model = Converter.test_result_to_testrun_result_post_model(
                 test_result,
@@ -201,6 +219,13 @@ class ApiClientWorker:
             autotests = self.__get_autotests_by_external_id(test_result.get_external_id())
 
             if autotests:
+                update_count += 1
+                logging.debug(
+                    'Bulk update path for external_id="%s", automaticCreationTestCases=%s '
+                    "(manual work item auto-creation is create-path behavior).",
+                    test_result.get_external_id(),
+                    should_create_work_item,
+                )
                 autotest_links_to_wi_for_update = {}
                 autotest_for_update = Converter.prepare_to_mass_update_autotest(
                     test_result,
@@ -215,6 +240,12 @@ class ApiClientWorker:
                     test_result_model,
                     autotest_links_to_wi_for_update)
             else:
+                create_count += 1
+                logging.debug(
+                    'Bulk create path for external_id="%s", automaticCreationTestCases=%s.',
+                    test_result.get_external_id(),
+                    should_create_work_item,
+                )
                 autotest_for_create = Converter.prepare_to_mass_create_autotest(
                     test_result,
                     self.__config.get_project_id(),
@@ -222,6 +253,12 @@ class ApiClientWorker:
 
                 bulk_autotest_helper.add_for_create(autotest_for_create, test_result_model)
 
+        logging.info(
+            "Bulk write summary: create=%d, update=%d, total=%d",
+            create_count,
+            update_count,
+            len(test_results),
+        )
         bulk_autotest_helper.teardown()
 
     @staticmethod

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/testit_python_commons/services/adapter_manager.py

@@ -247,6 +247,11 @@ class AdapterManager:
 
         fixtures = self.__fixture_manager.get_all_items()
 
+        # Ensure this option is propagated for each buffered test result in bulk mode.
+        should_create_work_item = self.__config.should_automatic_creation_test_cases()
+        for test_result in self.__test_results:
+            test_result.set_automatic_creation_test_cases(should_create_work_item)
+
         self.__api_client.write_tests(self.__test_results, fixtures)
 
     @adapter_logger

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/testit_python_commons/services/sync_storage/sync_storage_runner.py

@@ -39,7 +39,7 @@ class SyncStorageRunner:
     across multiple workers.
     """
 
-    SYNC_STORAGE_VERSION = "v0.1.27"
+    SYNC_STORAGE_VERSION = "v0.2.3"
     SYNC_STORAGE_REPO_URL = (
         "https://github.com/testit-tms/sync-storage-public/releases/download/"
     )
@@ -490,7 +490,7 @@ class SyncStorageRunner:
             # Create registration request
 
             register_request = RegisterRequest(
-                pid=self.worker_pid, test_run_id=self.test_run_id
+                pid=self.worker_pid, test_run_id=self.test_run_id, base_url=self.base_url, private_token=self.private_token
             )
 
             # Send registration request

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/testit_python_commons/utils/html_escape_utils.py

@@ -123,7 +123,12 @@ class HtmlEscapeUtils:
                 # Skip private/protected attributes and methods
                 if attr_name.startswith('_') or callable(getattr(obj, attr_name, None)):
                     continue
-                if attr_name.startswith("external_id") or attr_name.startswith("externalId"):
+                if (
+                    attr_name.startswith("external_id")
+                    or attr_name.startswith("externalId")
+                    or attr_name.startswith("auto_test_external_id")
+                    or attr_name.startswith("autoTestExternalId")
+                ):
                     continue
                     
                 try:

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/testit_python_commons.egg-info/PKG-INFO

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

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/src/testit_python_commons.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ src/api_client_syncstorage/api/test_results_api.py
 src/api_client_syncstorage/api/workers_api.py
 src/api_client_syncstorage/apis/__init__.py
 src/api_client_syncstorage/model/__init__.py
+src/api_client_syncstorage/model/completion_response.py
 src/api_client_syncstorage/model/health_status_response.py
 src/api_client_syncstorage/model/register_request.py
 src/api_client_syncstorage/model/register_response.py

{testit_python_commons-4.1.0 → testit_python_commons-4.1.1}/tests/test_html_escape_utils.py

@@ -10,6 +10,15 @@ class SampleData:
         self.tags = ["<tag>", "normal_tag"]
 
 
+class SampleExternalIdsData:
+    def __init__(self):
+        self.external_id = "<test>"
+        self.externalId = "<test-camel>"
+        self.auto_test_external_id = "<auto-test>"
+        self.autoTestExternalId = "<auto-test-camel>"
+        self.description = "<script>alert('xss')</script>"
+
+
 class TestHtmlEscapeUtils(unittest.TestCase):
 
     def test_escape_html_tags_basic(self):
@@ -70,6 +79,17 @@ class TestHtmlEscapeUtils(unittest.TestCase):
         self.assertEqual(result.tags[0], "&lt;tag&gt;")  # Escaped
         self.assertEqual(result.tags[1], "normal_tag")  # No escaping needed
 
+    def test_escape_html_in_object_skips_external_id_fields(self):
+        """Test that externalId fields are not escaped"""
+        test_obj = SampleExternalIdsData()
+        result = HtmlEscapeUtils.escape_html_in_object(test_obj)
+
+        self.assertEqual(result.external_id, "<test>")
+        self.assertEqual(result.externalId, "<test-camel>")
+        self.assertEqual(result.auto_test_external_id, "<auto-test>")
+        self.assertEqual(result.autoTestExternalId, "<auto-test-camel>")
+        self.assertEqual(result.description, "&lt;script&gt;alert('xss')&lt;/script&gt;")
+
     def test_escape_html_in_object_list(self):
         """Test HTML escaping in list of objects"""
         test_list = [