Fix script

Author: Hani Yacoub

modules/testrail_script_set_all_subs_to_functional.py

@@ -1,79 +1,97 @@
-import os
 import logging
+from dotenv import load_dotenv
 from modules.testrail_integration import testrail_init
 
-# Configuration
-PROJECT_ID = 17
-SUITE_NAMES = ["Downloads"]
-CUSTOM_SUB_TEST_SUITES = 1  # "Functional Only"
+# Load environment variables from .env file
+load_dotenv()
 
-# Set TestRail credentials
-os.environ["TESTRAIL_BASE_URL"] = "https://mozilla.testrail.io"
-os.environ["TESTRAIL_USERNAME"] = ""
-os.environ["TESTRAIL_API_KEY"] = ""
+# Configuration Constants
+PROJECT_ID = 17  # The ID of the TestRail project to work with
+SUITE_NAMES = ["Downloads", "Address Bar and Search <136 (to use with late beta) - locked"]  # 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 suite by handling pagination."""
-    all_cases = []
-    offset = 0
-    limit = 240  # Default limit for TestRail API is 250
+    """
+    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 endpoint with pagination parameters
-        endpoint = (
-            f"get_cases/{project_id}&suite_id={suite_id}&limit={limit}&offset={offset}"
-        )
-        response = tr.client.send_get(endpoint)
-        cases = response.get("cases", [])
+        # 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 the number of cases returned is less than the limit, we've reached the last page.
+
         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()
 
-    # Get suite IDs for the selected suite names
+    # Fetch suite IDs matching the given suite names
     suites = tr.get_suites(PROJECT_ID)
-    # suite_ids = [suite["id"] for suite in suites]
     suite_ids = [suite["id"] for suite in suites if suite["name"] in SUITE_NAMES]
     logging.info(f"Found suites: {suite_ids}")
 
-    all_cases = []
+    # 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)}")
 
-    for case in all_cases:
-        result = tr.update_case_field(case["id"], "custom_sub_tests_suites", CUSTOM_SUB_TEST_SUITES)
-        logging.debug(f"Updated case {case['id']} result: {result}")
-
-    logging.info("All applicable test cases updated to 'Functional Only' successfully!")
+    updated_count = 0  # Counter for the number of cases updated
 
-    # Re-verify that all cases have been updated correctly
-    logging.info("Verifying that all test cases were updated correctly...")
-    failed_updates = []
-
-    for suite_id in suite_ids:
-        updated_cases = get_all_cases_from_suite(tr, PROJECT_ID, suite_id)
-        for case in updated_cases:
-            if case.get("custom_sub_tests_suites") != CUSTOM_SUB_TEST_SUITES:
-                failed_updates.append(case["id"])
-
-    if failed_updates:
-        logging.warning(f"The following case IDs were not updated correctly: {failed_updates}")
-        logging.warning(f"Number of failed updates: {len(failed_updates)}")
-
-    else:
-        logging.info("All test cases have the correct 'custom_sub_tests_suites' value.")
+    # 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}")