Merge pull request #338 from cgeisel/get-suites-pagination

update check_suite_id to handle paginated results

Author: acuanico-tr-galt

tests/test_api_request_handler.py

@@ -163,6 +163,7 @@ def test_check_suite_exists_with_pagination(self, api_request_handler: ApiReques
             "offset": 0,
             "limit": 250,
             "size": 2,
+            "_links": {"next": None, "prev": None},
             "suites": [
                 {"id": 4, "name": "Suite1", "description": "Test1", "project_id": 3},
                 {"id": 5, "name": "Suite2", "description": "Test2", "project_id": 3},
@@ -549,18 +550,82 @@ def test_check_missing_test_cases_ids_false(
         assert error == "", "No error should have occurred"
 
     @pytest.mark.api_handler
-    def test_get_suites_id(self, api_request_handler: ApiRequestHandler, requests_mock):
+    def test_get_suite_ids(self, api_request_handler: ApiRequestHandler, requests_mock):
         project_id = 3
         mocked_response = [
             {"id": 100, "name": "Master"},
+            {"id": 101, "name": "Smoke"},
         ]
 
         requests_mock.get(create_url(f"get_suites/{project_id}"), json=mocked_response)
         resources_added, error = api_request_handler.get_suite_ids(project_id)
         assert (
-            resources_added[0] == mocked_response[0]["id"]
+            resources_added[0] == mocked_response[0]["id"] and
+            resources_added[1] == mocked_response[1]["id"]
         ), "ID in response doesn't match mocked response"
-        assert error == "", "Error occurred in get_suite_ids"
+
+    @pytest.mark.api_handler
+    def test_get_suite_ids_error(
+        self, api_request_handler: ApiRequestHandler, requests_mock
+    ):
+        project_id = 3
+        
+        requests_mock.get(
+            create_url(f"get_suites/{project_id}"), exc=requests.exceptions.ConnectTimeout
+        )
+        
+        suite_ids, error = api_request_handler.get_suite_ids(project_id)
+        
+        assert suite_ids == [], "Should return empty list on API error"
+        assert error == "Your upload to TestRail did not receive a successful response from your TestRail Instance." \
+                    " Please check your settings and try again.", "Should return connection error message"
+
+    @pytest.mark.api_handler
+    def test_resolve_suite_id_using_name(
+        self, api_request_handler: ApiRequestHandler, requests_mock, mocker
+    ):
+        project_id = 3
+        suite_name = "Suite2"
+        api_request_handler.suites_data_from_provider.name = suite_name
+
+        update_data_mock = mocker.patch('trcli.api.api_request_handler.ApiDataProvider.update_data')
+
+        mocked_response = {
+            "offset": 0,
+            "limit": 250,
+            "size": 2,
+            "_links": {"next": None, "prev": None},
+            "suites": [
+                {"id": 4, "name": "Suite1", "description": "Test1", "project_id": 3},
+                {"id": 5, "name": "Suite2", "description": "Test2", "project_id": 3},
+            ]
+        }
+        
+        requests_mock.get(create_url(f"get_suites/{project_id}"), json=mocked_response)
+        
+        suite_id, error = api_request_handler.resolve_suite_id_using_name(project_id)
+        
+        assert suite_id == 5, "Should return the correct suite ID for matching name with pagination"
+        assert error == "", "Should have no error message"
+        
+        update_data_mock.assert_called_once_with([{"suite_id": 5, "name": "Suite2"}])
+
+    @pytest.mark.api_handler
+    def test_resolve_suite_id_using_name_error(
+        self, api_request_handler: ApiRequestHandler, requests_mock
+    ):
+        project_id = 3
+
+        requests_mock.get(
+            create_url(f"get_suites/{project_id}"), exc=requests.exceptions.ConnectTimeout
+        )
+
+        suite_id, error = api_request_handler.resolve_suite_id_using_name(project_id)
+
+        assert suite_id == -1, "Should return -1 on API error"
+        assert error == "Your upload to TestRail did not receive a successful response from your TestRail Instance." \
+                    " Please check your settings and try again.", "Should return connection error message"
+
 
     @pytest.mark.api_handler
     def test_return_project_error(

trcli/api/api_request_handler.py

@@ -122,83 +122,76 @@ def get_project_data(self, project_name: str, project_id: int = None) -> Project
                 error_message=error,
             )
 
-    def check_suite_id(self, project_id: int) -> (bool, str):
+    def check_suite_id(self, project_id: int) -> Tuple[bool, str]:
         """
         Check if suite from DataProvider exist using get_suites endpoint
         :project_id: project id
         :returns: True if exists in suites. False if not.
         """
         suite_id = self.suites_data_from_provider.suite_id
-        response = self.client.send_get(f"get_suites/{project_id}")
-        if not response.error_message:
-            try:
-                parsed = json.loads(response.response_text) if isinstance(response.response_text, str) else response.response_text
-                suite_list = parsed.get("suites") if isinstance(parsed, dict) else parsed
-                available_suites = [suite["id"] for suite in suite_list]
-                return (
-                    (True, "")
-                    if suite_id in available_suites
-                    else (False, FAULT_MAPPING["missing_suite"].format(suite_id=suite_id))
-                )
-            except Exception as e:
-                return None, f"Error parsing suites response: {e}"
+        suites_data, error = self.__get_all_suites(project_id)
+        if not error:
+            available_suites = [
+                suite
+                for suite in suites_data
+                if suite["id"] == suite_id
+            ]
+            return (
+                (True, "")
+                if len(available_suites) > 0
+                else (False, FAULT_MAPPING["missing_suite"].format(suite_id=suite_id))
+            )
         else:
-            return None, response.error_message
+            return None, suites_data.error_message
 
     def resolve_suite_id_using_name(self, project_id: int) -> Tuple[int, str]:
         """Get suite ID matching suite name on data provider or returns -1 if unable to match any suite.
         :arg project_id: project id
         :returns: tuple with id of the suite and error message"""
         suite_id = -1
-        error_message = ""
-        response = self.client.send_get(f"get_suites/{project_id}")
-        if not response.error_message:
-            try:
-                parsed = json.loads(response.response_text) if isinstance(response.response_text, str) else response.response_text
-                suite_list = parsed.get("suites") if isinstance(parsed, dict) else parsed
-                suite = next(
-                    filter(lambda x: x["name"] == self.suites_data_from_provider.name, suite_list),
-                    None
-                )
-                if suite:
+        suite_name = self.suites_data_from_provider.name
+        suites_data, error = self.__get_all_suites(project_id)
+        if not error:
+            for suite in suites_data:
+                if suite["name"] == suite_name:
                     suite_id = suite["id"]
                     self.data_provider.update_data([{"suite_id": suite["id"], "name": suite["name"]}])
-            except Exception as e:
-                error_message = f"Error parsing suites response: {e}"
+                    break
+            return (
+                (suite_id, "")
+                if suite_id != -1
+                else (-1, FAULT_MAPPING["missing_suite"].format(suite_name=suite_name))
+            )
         else:
-            error_message = response.error_message
-
-        return suite_id, error_message
+            return -1, error
 
     def get_suite_ids(self, project_id: int) -> Tuple[List[int], str]:
         """Get suite IDs for requested project_id.
         : project_id: project id
         : returns: tuple with list of suite ids and error string"""
         available_suites = []
         returned_resources = []
-        error_message = ""
-        response = self.client.send_get(f"get_suites/{project_id}")
-        if not response.error_message:
-            try:
-                parsed = json.loads(response.response_text) if isinstance(response.response_text, str) else response.response_text
-                suite_list = parsed.get("suites") if isinstance(parsed, dict) else parsed
-                for suite in suite_list:
-                    available_suites.append(int(suite["id"]))
-                    returned_resources.append({
+        suites_data, error = self.__get_all_suites(project_id)
+        if not error:
+            for suite in suites_data:
+                available_suites.append(suite["id"])
+                returned_resources.append(
+                    {
                         "suite_id": suite["id"],
                         "name": suite["name"],
-                    })
-            except Exception as e:
-                error_message = f"Error parsing suites response: {e}"
-        else:
-            error_message = response.error_message
-
-        if returned_resources:
-            self.data_provider.update_data(suite_data=returned_resources)
+                    }
+                )
+            if returned_resources:
+                self.data_provider.update_data(suite_data=returned_resources)
+            else:
+                print("Update skipped")
+            return (
+                (available_suites, "")
+                if len(available_suites) > 0
+                else ([], FAULT_MAPPING["no_suites_found"].format(project_id=project_id))
+            )
         else:
-            print("Update skipped")
-
-        return available_suites, error_message
+            return [], error
 
     def add_suites(self, project_id: int) -> Tuple[List[Dict], str]:
         """
@@ -707,10 +700,16 @@ def __get_all_tests_in_run(self, run_id=None) -> Tuple[List[dict], str]:
 
     def __get_all_projects(self) -> Tuple[List[dict], str]:
         """
-        Get all cases from all pages
+        Get all projects from all pages
         """
         return self.__get_all_entities('projects', f"get_projects")
 
+    def __get_all_suites(self, project_id) -> Tuple[List[dict], str]:
+        """
+        Get all suites from all pages
+        """
+        return self.__get_all_entities('suites', f"get_suites/{project_id}")
+
     def __get_all_entities(self, entity: str, link=None, entities=[]) -> Tuple[List[Dict], str]:
         """
         Get all entities from all pages if number of entities is too big to return in single response.

trcli/constants.py

@@ -63,7 +63,8 @@
     proxy_bypass_error= "Failed to bypass the proxy for host. Please check the settings.",
     proxy_invalid_configuration= "The provided proxy configuration is invalid. Please check the proxy URL and format.",
     ssl_error_on_proxy= "SSL error encountered while using the HTTPS proxy. Please check the proxy's SSL certificate.",
-    no_proxy_match_error= "The host {host} does not match any NO_PROXY rules. Ensure the correct domains or IP addresses are specified for bypassing the proxy."
+    no_proxy_match_error= "The host {host} does not match any NO_PROXY rules. Ensure the correct domains or IP addresses are specified for bypassing the proxy.",
+    no_suites_found= "The project {project_id} does not have any suites."
 )
 
 COMMAND_FAULT_MAPPING = dict(