Merge pull request #560 from mozilla/Hani/testrail_set_all_subs_to_functional

Hani/ Testrail set all custom sub teste suites to functional

Author: sv-hyacoub

modules/testrail.py

@@ -160,6 +160,10 @@ def get_test_case(self, case_id):
         """Get a given Test Case"""
         return self.client.send_get(f"get_case/{case_id}")
 
+    def get_suites(self, project_id):
+        """Get all suites for project"""
+        return self.client.send_get(f"get_suites/{project_id}")
+
     def update_cases_in_suite(self, suite_id, case_ids, **kwargs):
         """Given a suite and a list of test cases, update all listed
         test cases according to keyword args"""

modules/testrail_scripts/testrail_script_set_all_subs_to_functional.py

@@ -0,0 +1,98 @@
+import logging
+from dotenv import load_dotenv
+from modules.testrail_integration import testrail_init
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Configuration Constants
+PROJECT_ID = 17  # The ID of the TestRail project to work with
+SUITE_NAMES = ["Fakespot Shopping Sidebar"]  # List of suite names to process
+
+CUSTOM_SUB_TEST_SUITES = [1]  # Value to set for the 'custom_sub_test_suites' field
+DRY_RUN = True  # If True, only log actions without making changes
+
+
+def get_all_cases_from_suite(tr, project_id, suite_id):
+    """
+    Fetch all test cases from a given TestRail suite using pagination.
+
+    Args:
+        tr: TestRail API client instance.
+        project_id (int): The ID of the TestRail project.
+        suite_id (int): The ID of the suite to fetch cases from.
+
+    Returns:
+        list: A list of test case dictionaries.
+    """
+    all_cases = []  # List to store all fetched test cases
+    offset = 0  # Starting point for pagination
+    limit = 240  # Maximum number of cases to fetch in each API call
+
+    while True:
+        # Build the API endpoint with pagination parameters
+        endpoint = f"get_cases/{project_id}&suite_id={suite_id}&limit={limit}&offset={offset}"
+        response = tr.client.send_get(endpoint)  # Send API request to TestRail
+        cases = response.get("cases", [])  # Extract the list of test cases
+
+        if not cases:
+            # If no more cases are found, break the loop
+            break
+
+        # Add the fetched cases to the complete list
+        all_cases.extend(cases)
+
+        if len(cases) < limit:
+            # If the number of fetched cases is less than the limit, we are at the last page
+            break
+
+        # Increment offset to fetch the next batch of cases
+        offset += limit
+
+    # Log the total number of fetched cases
+    logging.info(f"Total cases fetched from suite {suite_id}: {len(all_cases)}")
+    return all_cases
+
+
+if __name__ == "__main__":
+    # Initialize logging to display info messages
+    logging.basicConfig(level=logging.INFO)
+
+    # Initialize the TestRail API client
+    tr = testrail_init()
+
+    # Fetch suite IDs matching the given suite names
+    suites = tr.get_suites(PROJECT_ID)
+    suite_ids = [suite["id"] for suite in suites if suite["name"] in SUITE_NAMES]
+    logging.info(f"Found suites: {suite_ids}")
+
+    # Fetch all test cases from the selected suites
+    all_cases = []  # List to store all fetched test cases
+    for suite_id in suite_ids:
+        # Fetch and add cases from each suite
+        cases = get_all_cases_from_suite(tr, PROJECT_ID, suite_id)
+        all_cases.extend(cases)
+
+    # Log the total number of test cases found
+    logging.info(f"Total test cases found for selected suites: {len(all_cases)}")
+
+    updated_count = 0  # Counter for the number of cases updated
+
+    # Iterate over each test case to display and update the 'custom_sub_test_suites' field
+    for case in all_cases:
+        # Get the current value of the 'custom_sub_test_suites' field
+        current_value = case.get("custom_sub_test_suites", "Not Set")
+        logging.info(f"Case ID {case['id']} current value: {current_value}")
+
+        if not DRY_RUN:
+            # If not in dry run mode, perform the update
+            result = tr.update_case_field(case["id"], "custom_sub_test_suites", CUSTOM_SUB_TEST_SUITES)
+            logging.info(f"Updated case {case['id']} to '{CUSTOM_SUB_TEST_SUITES}', Result: {result}")
+        else:
+            # In dry run mode, just log the intended change without making it
+            logging.info(f"[DRY RUN] Would update case {case['id']} from '{current_value}' to '{CUSTOM_SUB_TEST_SUITES}'.")
+
+        updated_count += 1  # Increment the updated count
+
+    # Log the total number of cases updated or to be updated
+    logging.info(f"Total cases {'updated' if not DRY_RUN else 'to be updated'}: {updated_count}")