testit-python-commons 3.7.2.post530__tar.gz → 3.8.0__tar.gz

{testit_python_commons-3.7.2.post530 → testit_python_commons-3.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testit-python-commons
-Version: 3.7.2.post530
+Version: 3.8.0
 Summary: Python commons for Test IT
 Home-page: https://github.com/testit-tms/adapters-python/
 Author: Integration team
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 Requires-Dist: pluggy
 Requires-Dist: tomli
-Requires-Dist: testit-api-client==7.0.1.post530
+Requires-Dist: testit-api-client==7.0.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{testit_python_commons-3.7.2.post530 → testit_python_commons-3.8.0}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import find_packages, setup
 
-VERSION = "3.7.2.post530"
+VERSION = "3.8.0"
 
 setup(
     name='testit-python-commons',
@@ -25,5 +25,5 @@ setup(
     py_modules=['testit', 'testit_python_commons'],
     packages=find_packages(where='src'),
     package_dir={'': 'src'},
-    install_requires=['pluggy', 'tomli', 'testit-api-client==7.0.1.post530']
+    install_requires=['pluggy', 'tomli', 'testit-api-client==7.0.1']
 )

{testit_python_commons-3.7.2.post530 → testit_python_commons-3.8.0}/src/testit_python_commons/client/api_client.py

@@ -12,12 +12,13 @@ from testit_api_client.models import (
     AttachmentPutModel,
     AutoTestResultsForTestRunModel,
     TestResultResponse,
-    WorkItemIdModel,
+    LinkAutoTestToWorkItemRequest,
     WorkItemIdentifierModel
 )
 
 from testit_python_commons.client.client_configuration import ClientConfiguration
 from testit_python_commons.client.converter import Converter
+from testit_python_commons.client.helpers.bulk_autotest_helper import BulkAutotestHelper
 from testit_python_commons.models.test_result import TestResult
 from testit_python_commons.services.logger import adapter_logger
 from testit_python_commons.services.retry import retry
@@ -89,6 +90,14 @@ class ApiClientWorker:
             response,
             self.__config.get_configuration_id())
 
+    @adapter_logger
+    def __get_autotests_by_external_id(self, external_id: str) -> list:
+        model = Converter.project_id_and_external_id_to_auto_tests_search_post_request(
+            self.__config.get_project_id(),
+            external_id)
+
+        return self.__autotest_api.api_v2_auto_tests_search_post(api_v2_auto_tests_search_post_request=model)
+
     @adapter_logger
     def write_test(self, test_result: TestResult):
         model = Converter.project_id_and_external_id_to_auto_tests_search_post_request(
@@ -99,6 +108,10 @@ class ApiClientWorker:
 
         if autotests:
             self.__update_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:
             self.__create_test(test_result)
 
@@ -106,120 +119,43 @@ class ApiClientWorker:
 
     @adapter_logger
     def write_tests(self, test_results: typing.List[TestResult], fixture_containers: dict):
-        autotests_for_create = []
-        autotests_for_update = []
-        results_for_autotests_being_created = []
-        results_for_autotests_being_updated = []
+        bulk_autotest_helper = BulkAutotestHelper(self.__autotest_api, self.__test_run_api, self.__config)
 
         for test_result in test_results:
             test_result = self.__add_fixtures_to_test_result(test_result, fixture_containers)
 
-            model = Converter.project_id_and_external_id_to_auto_tests_search_post_request(
-                self.__config.get_project_id(),
-                test_result.get_external_id())
-
             test_result_model = Converter.test_result_to_testrun_result_post_model(
                 test_result,
                 self.__config.get_configuration_id())
 
-            autotests = self.__autotest_api.api_v2_auto_tests_search_post(api_v2_auto_tests_search_post_request=model)
-
-            if autotests:
-                autotest_for_update = self.__prepare_to_mass_update_autotest(test_result, autotests[0])
-
-                autotests_for_update.append(autotest_for_update)
-                results_for_autotests_being_updated.append(test_result_model)
+            work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
+                test_result.get_work_item_ids())
 
-                if len(autotests_for_update) >= self.__max_tests_for_write:
-                    self.__update_tests(autotests_for_update)
-                    self.__load_test_results(results_for_autotests_being_updated)
+            autotests = self.__get_autotests_by_external_id(test_result.get_external_id())
 
-                    autotests_for_update.clear()
-                    results_for_autotests_being_updated.clear()
+            if autotests:
+                autotest_links_to_wi_for_update = {}
+                autotest_for_update = Converter.prepare_to_mass_update_autotest(
+                    test_result,
+                    autotests[0],
+                    self.__config.get_project_id())
+
+                autotest_id = autotests[0].id
+                autotest_links_to_wi_for_update[autotest_id] = test_result.get_work_item_ids()
+
+                bulk_autotest_helper.add_for_update(
+                    autotest_for_update,
+                    test_result_model,
+                    autotest_links_to_wi_for_update)
             else:
-                autotest_for_create = self.__prepare_to_mass_create_autotest(test_result)
+                autotest_for_create = Converter.prepare_to_mass_create_autotest(
+                    test_result,
+                    self.__config.get_project_id(),
+                    work_item_ids_for_link_with_auto_test)
 
-                autotests_for_create.append(autotest_for_create)
-                results_for_autotests_being_created.append(test_result_model)
+                bulk_autotest_helper.add_for_create(autotest_for_create, test_result_model)
 
-                if len(autotests_for_create) >= self.__max_tests_for_write:
-                    self.__create_tests(autotests_for_create)
-                    self.__load_test_results(results_for_autotests_being_created)
-
-                    autotests_for_create.clear()
-                    results_for_autotests_being_created.clear()
-
-        if len(autotests_for_update) > 0:
-            self.__update_tests(autotests_for_update)
-            self.__load_test_results(results_for_autotests_being_updated)
-
-            autotests_for_update.clear()
-            results_for_autotests_being_updated.clear()
-
-        if len(autotests_for_create) > 0:
-            self.__create_tests(autotests_for_create)
-            self.__load_test_results(results_for_autotests_being_created)
-
-            autotests_for_create.clear()
-            results_for_autotests_being_created.clear()
-
-    @adapter_logger
-    def __prepare_to_create_autotest(self, test_result: TestResult) -> AutoTestPostModel:
-        logging.debug('Preparing to create the auto test ' + test_result.get_external_id())
-
-        model = Converter.test_result_to_create_autotest_request(
-            test_result,
-            self.__config.get_project_id())
-        model.work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
-            test_result.get_work_item_ids())
-
-        return model
-
-    @adapter_logger
-    def __prepare_to_mass_create_autotest(self, test_result: TestResult) -> AutoTestPostModel:
-        logging.debug('Preparing to create the auto test ' + test_result.get_external_id())
-
-        model = Converter.test_result_to_autotest_post_model(
-            test_result,
-            self.__config.get_project_id())
-        model.work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
-            test_result.get_work_item_ids())
-
-        return model
-
-    @adapter_logger
-    def __prepare_to_update_autotest(
-            self,
-            test_result: TestResult,
-            autotest: AutoTestApiResult) -> AutoTestPutModel:
-        logging.debug('Preparing to update the auto test ' + test_result.get_external_id())
-
-        model = Converter.test_result_to_update_autotest_request(
-            test_result,
-            self.__config.get_project_id())
-        model.is_flaky = autotest.is_flaky
-        model.work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
-            test_result.get_work_item_ids(),
-            str(autotest.global_id))
-
-        return model
-
-    @adapter_logger
-    def __prepare_to_mass_update_autotest(
-            self,
-            test_result: TestResult,
-            autotest: AutoTestApiResult) -> AutoTestPutModel:
-        logging.debug('Preparing to update the auto test ' + test_result.get_external_id())
-
-        model = Converter.test_result_to_autotest_put_model(
-            test_result,
-            self.__config.get_project_id())
-        model.is_flaky = autotest.is_flaky
-        model.work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
-            test_result.get_work_item_ids(),
-            str(autotest.global_id))
-
-        return model
+        bulk_autotest_helper.teardown()
 
     @staticmethod
     @adapter_logger
@@ -323,7 +259,13 @@ class ApiClientWorker:
     def __create_test(self, test_result: TestResult) -> str:
         logging.debug(f'Autotest "{test_result.get_autotest_name()}" was not found')
 
-        model = self.__prepare_to_create_autotest(test_result)
+        work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
+            test_result.get_work_item_ids())
+
+        model = Converter.prepare_to_create_autotest(
+            test_result,
+            self.__config.get_project_id(),
+            work_item_ids_for_link_with_auto_test)
         model = self._escape_html_in_model(model)
 
         autotest_response = self.__autotest_api.create_auto_test(create_auto_test_request=model)
@@ -345,7 +287,7 @@ class ApiClientWorker:
     def __update_test(self, test_result: TestResult, autotest: AutoTestApiResult):
         logging.debug(f'Autotest "{test_result.get_autotest_name()}" was found')
 
-        model = self.__prepare_to_update_autotest(test_result, autotest)
+        model = Converter.prepare_to_update_autotest(test_result, autotest, self.__config.get_project_id())
         model = self._escape_html_in_model(model)
 
         try:
@@ -378,7 +320,7 @@ class ApiClientWorker:
     def __link_test_to_work_item(self, autotest_global_id: str, work_item_id: str):
         self.__autotest_api.link_auto_test_to_work_item(
             autotest_global_id,
-            work_item_id_model=WorkItemIdModel(id=work_item_id))
+            link_auto_test_to_work_item_request=LinkAutoTestToWorkItemRequest(id=work_item_id))
 
         logging.debug(f'Autotest was linked with workItem "{work_item_id}" by global id "{autotest_global_id}')
 

{testit_python_commons-3.7.2.post530 → testit_python_commons-3.8.0}/src/testit_python_commons/client/converter.py

@@ -1,6 +1,8 @@
+import logging
 import typing
 
 from testit_api_client.models import (
+    AutoTestApiResult,
     AttachmentPutModelAutoTestStepResultsModel,
     AutoTestStepResultUpdateRequest,
     CreateAutoTestRequest,
@@ -450,3 +452,75 @@ class Converter:
             )
 
         return autotest_model_step_results
+
+    @classmethod
+    @adapter_logger
+    def prepare_to_create_autotest(
+            cls,
+            test_result: TestResult,
+            project_id: str,
+            work_item_ids_for_link_with_auto_test: list) -> AutoTestPostModel:
+        logging.debug('Preparing to create the auto test ' + test_result.get_external_id())
+
+        model = cls.test_result_to_create_autotest_request(
+            test_result,
+            project_id)
+        model.work_item_ids_for_link_with_auto_test = work_item_ids_for_link_with_auto_test
+
+        return model
+
+    @classmethod
+    @adapter_logger
+    def prepare_to_mass_create_autotest(
+            cls,
+            test_result: TestResult,
+            project_id: str,
+            work_item_ids_for_link_with_auto_test: list) -> AutoTestPostModel:
+        logging.debug('Preparing to create the auto test ' + test_result.get_external_id())
+
+        model = cls.test_result_to_autotest_post_model(
+            test_result,
+            project_id)
+        model.work_item_ids_for_link_with_auto_test = work_item_ids_for_link_with_auto_test
+
+        return model
+
+    @classmethod
+    @adapter_logger
+    def prepare_to_update_autotest(
+            cls,
+            test_result: TestResult,
+            autotest: AutoTestApiResult,
+            project_id: str) -> UpdateAutoTestRequest:
+        logging.debug('Preparing to update the auto test ' + test_result.get_external_id())
+
+        model = cls.test_result_to_update_autotest_request(
+            test_result,
+            project_id)
+        model.is_flaky = autotest.is_flaky
+        # TODO: return after fix PUT/api/v2/autoTests
+        # model.work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
+        #     test_result.get_work_item_ids(),
+        #     str(autotest.global_id))
+
+        return model
+
+    @classmethod
+    @adapter_logger
+    def prepare_to_mass_update_autotest(
+            cls,
+            test_result: TestResult,
+            autotest: AutoTestApiResult,
+            project_id: str) -> AutoTestPutModel:
+        logging.debug('Preparing to update the auto test ' + test_result.get_external_id())
+
+        model = cls.test_result_to_autotest_put_model(
+            test_result,
+            project_id)
+        model.is_flaky = autotest.is_flaky
+        # TODO: return after fix PUT/api/v2/autoTests
+        # model.work_item_ids_for_link_with_auto_test = self.__get_work_item_uuids_for_link_with_auto_test(
+        #     test_result.get_work_item_ids(),
+        #     str(autotest.global_id))
+
+        return model

testit_python_commons-3.8.0/src/testit_python_commons/client/helpers/bulk_autotest_helper.py

@@ -0,0 +1,158 @@
+import logging
+import typing
+
+from testit_api_client.apis import AutoTestsApi, TestRunsApi
+from testit_api_client.models import (
+    AutoTestPostModel,
+    AutoTestPutModel,
+    AutoTestResultsForTestRunModel,
+    LinkAutoTestToWorkItemRequest,
+    WorkItemIdentifierModel,
+)
+
+from testit_python_commons.client.client_configuration import ClientConfiguration
+from testit_python_commons.services.logger import adapter_logger
+from testit_python_commons.services.retry import retry
+from testit_python_commons.utils.html_escape_utils import HtmlEscapeUtils
+
+
+class BulkAutotestHelper:
+    __max_tests_for_import = 100
+
+    def __init__(
+            self,
+            autotests_api: AutoTestsApi,
+            test_runs_api: TestRunsApi,
+            config: ClientConfiguration):
+        self.__autotests_api = autotests_api
+        self.__test_runs_api = test_runs_api
+        self.__test_run_id = config.get_test_run_id()
+        self.__automatic_updation_links_to_test_cases = config.get_automatic_updation_links_to_test_cases()
+        self.__autotests_for_create = []
+        self.__autotests_for_update = []
+        self.__autotest_links_to_wi_for_update = {}
+        self.__results_for_autotests_being_created = []
+        self.__results_for_autotests_being_updated = []
+
+    @adapter_logger
+    def add_for_create(
+            self,
+            create_model: AutoTestPostModel,
+            result_model: AutoTestResultsForTestRunModel):
+        self.__autotests_for_create.append(create_model)
+        self.__results_for_autotests_being_created.append(result_model)
+
+        if len(self.__autotests_for_create) >= self.__max_tests_for_import:
+            self.__bulk_create()
+
+    @adapter_logger
+    def add_for_update(
+            self,
+            update_model: AutoTestPutModel,
+            result_model: AutoTestResultsForTestRunModel,
+            autotest_links_to_wi_for_update: dict):
+        self.__autotests_for_update.append(update_model)
+        self.__results_for_autotests_being_updated.append(result_model)
+        self.__autotest_links_to_wi_for_update.update(autotest_links_to_wi_for_update)
+
+        if len(self.__autotests_for_create) >= self.__max_tests_for_import:
+            self.__bulk_update()
+
+    @adapter_logger
+    def teardown(self):
+        if len(self.__autotests_for_create) > 0:
+            self.__bulk_create()
+
+        if len(self.__autotests_for_update) > 0:
+            self.__bulk_update()
+
+    @adapter_logger
+    def __bulk_create(self):
+        self.__create_tests(self.__autotests_for_create)
+        self.__load_test_results(self.__results_for_autotests_being_created)
+
+        self.__autotests_for_create.clear()
+        self.__results_for_autotests_being_created.clear()
+
+    @adapter_logger
+    def __bulk_update(self):
+        self.__update_tests(self.__autotests_for_update)
+        self.__load_test_results(self.__results_for_autotests_being_updated)
+
+        for autotest_id, work_item_ids in self.__autotest_links_to_wi_for_update.items():
+            self.__update_autotest_link_from_work_items(autotest_id, work_item_ids)
+
+        self.__autotests_for_update.clear()
+        self.__results_for_autotests_being_updated.clear()
+        self.__autotest_links_to_wi_for_update.clear()
+
+    @adapter_logger
+    def __create_tests(self, autotests_for_create: typing.List[AutoTestPostModel]):
+        logging.debug(f'Creating autotests: "{autotests_for_create}')
+
+        autotests_for_create = HtmlEscapeUtils.escape_html_in_object(autotests_for_create)
+        self.__autotests_api.create_multiple(auto_test_post_model=autotests_for_create)
+
+        logging.debug(f'Autotests were created')
+
+    @adapter_logger
+    def __update_tests(self, autotests_for_update: typing.List[AutoTestPutModel]):
+        logging.debug(f'Updating autotests: {autotests_for_update}')
+
+        autotests_for_update = HtmlEscapeUtils.escape_html_in_object(autotests_for_update)
+        self.__autotests_api.update_multiple(auto_test_put_model=autotests_for_update)
+
+        logging.debug(f'Autotests were updated')
+
+    @adapter_logger
+    def __load_test_results(self, test_results: typing.List[AutoTestResultsForTestRunModel]):
+        logging.debug(f'Loading test results: {test_results}')
+
+        test_results = HtmlEscapeUtils.escape_html_in_object(test_results)
+        self.__test_runs_api.set_auto_test_results_for_test_run(
+            id=self.__test_run_id,
+            auto_test_results_for_test_run_model=test_results)
+
+    # TODO: delete after fix PUT/api/v2/autoTests
+    @adapter_logger
+    def __get_work_items_linked_to_autotest(self, autotest_global_id: str) -> typing.List[WorkItemIdentifierModel]:
+        return self.__autotests_api.get_work_items_linked_to_auto_test(id=autotest_global_id)
+
+    # TODO: delete after fix PUT/api/v2/autoTests
+    @adapter_logger
+    @retry
+    def __unlink_test_to_work_item(self, autotest_global_id: str, work_item_id: str):
+        self.__autotests_api.delete_auto_test_link_from_work_item(
+            id=autotest_global_id,
+            work_item_id=work_item_id)
+
+        logging.debug(f'Autotest was unlinked with workItem "{work_item_id}" by global id "{autotest_global_id}')
+
+    # TODO: delete after fix PUT/api/v2/autoTests
+    @adapter_logger
+    @retry
+    def __link_test_to_work_item(self, autotest_global_id: str, work_item_id: str):
+        self.__autotests_api.link_auto_test_to_work_item(
+            autotest_global_id,
+            link_auto_test_to_work_item_request=LinkAutoTestToWorkItemRequest(id=work_item_id))
+
+        logging.debug(f'Autotest was linked with workItem "{work_item_id}" by global id "{autotest_global_id}')
+
+    # TODO: delete after fix PUT/api/v2/autoTests
+    @adapter_logger
+    def __update_autotest_link_from_work_items(self, autotest_global_id: str, work_item_ids: list):
+        linked_work_items = self.__get_work_items_linked_to_autotest(autotest_global_id)
+
+        for linked_work_item in linked_work_items:
+            linked_work_item_id = str(linked_work_item.global_id)
+
+            if linked_work_item_id in work_item_ids:
+                work_item_ids.remove(linked_work_item_id)
+
+                continue
+
+            if self.__automatic_updation_links_to_test_cases != 'false':
+                self.__unlink_test_to_work_item(autotest_global_id, linked_work_item_id)
+
+        for work_item_id in work_item_ids:
+            self.__link_test_to_work_item(autotest_global_id, work_item_id)

{testit_python_commons-3.7.2.post530 → testit_python_commons-3.8.0}/src/testit_python_commons.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: testit-python-commons
-Version: 3.7.2.post530
+Version: 3.8.0
 Summary: Python commons for Test IT
 Home-page: https://github.com/testit-tms/adapters-python/
 Author: Integration team
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
 Description-Content-Type: text/markdown
 Requires-Dist: pluggy
 Requires-Dist: tomli
-Requires-Dist: testit-api-client==7.0.1.post530
+Requires-Dist: testit-api-client==7.0.1
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{testit_python_commons-3.7.2.post530 → testit_python_commons-3.8.0}/src/testit_python_commons.egg-info/SOURCES.txt

@@ -15,6 +15,8 @@ src/testit_python_commons/client/__init__.py
 src/testit_python_commons/client/api_client.py
 src/testit_python_commons/client/client_configuration.py
 src/testit_python_commons/client/converter.py
+src/testit_python_commons/client/helpers/__init__.py
+src/testit_python_commons/client/helpers/bulk_autotest_helper.py
 src/testit_python_commons/models/__init__.py
 src/testit_python_commons/models/adapter_mode.py
 src/testit_python_commons/models/fixture.py

testit_python_commons-3.8.0/src/testit_python_commons.egg-info/requires.txt

@@ -0,0 +1,3 @@
+pluggy
+tomli
+testit-api-client==7.0.1

testit_python_commons-3.7.2.post530/src/testit_python_commons.egg-info/requires.txt

@@ -1,3 +0,0 @@
-pluggy
-tomli
-testit-api-client==7.0.1.post530