Merge branch 'main' into Hani/cm-peacocks-gb

Author: sv-hyacoub

modules/testrail.py

@@ -350,6 +350,18 @@ def create_new_plan_entry(
             payload["runs"] = runs
         return self.client.send_post(f"/add_plan_entry/{plan_id}", payload)
 
+    def update_plan(self, plan_id, **kwargs):
+        """Given a plan id, update the plan per kwargs"""
+        if not kwargs:
+            return False
+        return self.client.send_post(f"/update_plan/{plan_id}", kwargs)
+
+    def update_plan_entry(self, plan_id, entry_id, **kwargs):
+        """Given a plan id and entry id, update the entry per kwargs"""
+        if not kwargs:
+            return False
+        return self.client.send_post(f"/update_plan_entry/{plan_id}/{entry_id}", kwargs)
+
     def matching_configs(self, testrail_project_id, config_group_id, config_name):
         """Given a project id, a config group id, and a config name, return the matching config object"""
         configs = self.client.send_get(f"/get_configs/{testrail_project_id}")

modules/testrail_integration.py

@@ -19,6 +19,37 @@
 PLAN_NAME_RE = re.compile(r"\[(\w+) (\d+)\]")
 CONFIG_GROUP_ID = 95
 TESTRAIL_FX_DESK_PRJ = 17
+TC_EXECUTION_TEMPLATE = "https://firefox-ci-tc.services.mozilla.com/tasks/%TASK_ID%/runs/%RUN_ID%/logs/public/logs/live.log"
+
+
+def get_execution_link() -> str:
+    """Using environment variables, get the link to the test execution"""
+    link = ""
+    if "TASKCLUSTER_PROXY_URL" in os.environ:
+        link = TC_EXECUTION_TEMPLATE
+        for item in ["RUN_ID", "TASK_ID"]:
+            link = link.replace(f"%{item}%", os.environ.get(item))
+        return link
+
+
+def replace_link_in_description(description, os_name) -> str:
+    """Add or replace a test execution link in the test run description"""
+    logging.warning(f"Modifying plan description for %{os_name}%")
+    if os_name not in description:
+        # TODO: remove following conditional when links for GHA resolved
+        if os_name == "Linux":
+            return f"{description}\n[{os_name} execution link]({get_execution_link()})"
+    else:
+        link = get_execution_link()
+        if link in description:
+            return description
+        lines = description.split("\n")
+        for i, line in enumerate(lines):
+            if os_name in line:
+                lines[i] = (
+                    f"{description}\n[{os_name} execution link]({get_execution_link()})"
+                )
+    return description
 
 
 def get_plan_title(version_str: str, channel: str) -> str:
@@ -321,6 +352,12 @@ def organize_l10n_entries(
     if len(site_entries) != 1:
         logging.info("Suite entries are broken somehow")
 
+    # Add execution link to plan description
+
+    os_name = config.split(" ")[0]
+    description = replace_link_in_description(expected_plan["description"], os_name)
+    testrail_session.update_plan(plan_id, description=description)
+
     # There should only be one entry per site per plan
     # Check that this entry has a run with the correct config
     # And if not, make that run