feat: add cancel_pr for testplan.py (sonic-net#23101)

What is the motivation for this PR?
Currently, when running a new testplan, there is no safety check to cancel all the previous dangling job.

This add the ability to test_plan.py to cancel all related job with PR number using cancel_pr. However this PR does not add the call, only the implementation. The real call will be implemented in sonic-net#22861

How did you do it?
Added a cancel_pr method that hits Elastictest endpoint API to cancel all previous job for the same PR

How did you verify/test it?
Verified locally and manually using CI
Signed-off-by: Austin Pham <[email protected]>
Signed-off-by: Venkata Gouri Rajesh Etla <[email protected]>

Author: auspham

.azure-pipelines/test_plan.py

@@ -450,6 +450,31 @@ def cancel(self, test_plan_id):
         print(f"Result of cancelling test plan at {tp_url}:")
         print(str(resp["data"]))
 
+    def cancel_pr(self, pr_id):
+        tp_url = f"{self.scheduler_url}/test_plan/pr/{pr_id}"
+        cancel_url = f"{tp_url}/cancel"
+
+        print(f"Cancelling old PR testplans at {cancel_url}")
+
+        payload = json.dumps({})
+        headers = {
+            "Authorization": f"Bearer {self.get_token()}",
+            "Content-Type": "application/json"
+        }
+
+        raw_resp = {}
+        try:
+            raw_resp = requests.post(cancel_url, headers=headers, data=payload, timeout=10)
+            resp = raw_resp.json()
+        except Exception as exception:
+            raise Exception(f"HTTP execute failure, url: {cancel_url}, raw_resp: {str(raw_resp)}, "
+                            f"exception: {str(exception)}")
+        if not resp["success"]:
+            raise Exception(f"Cancel test PR failed with error: {resp['errmsg']}")
+
+        print(f"Result of cancelling PR testplans at {tp_url}:")
+        print(str(resp["data"]))
+
     def poll(self, test_plan_id, interval=60, timeout=-1, expected_state="", expected_result=None):
         print(f"Polling progress and status of test plan at {self.frontend_url}/scheduler/testplan/{test_plan_id}")
         print(f"Polling interval: {interval} seconds")
@@ -464,6 +489,7 @@ def poll(self, test_plan_id, interval=60, timeout=-1, expected_state="", expecte
         start_time = time.time()
         poll_retry_times = 0
         while timeout < 0 or (time.time() - start_time) < timeout:
+
             resp = None
             try:
                 resp = requests.get(poll_url, headers=headers, timeout=10).json()
@@ -1041,6 +1067,7 @@ def poll(self, test_plan_id, interval=60, timeout=-1, expected_state="", expecte
 
     parser_poll = subparsers.add_parser("poll", help="Poll test plan status.")
     parser_cancel = subparsers.add_parser("cancel", help="Cancel running test plan.")
+    parser_cancel_pr = subparsers.add_parser("cancel_pr", help="Cancel test plans for a PR.")
 
     for p in [parser_cancel, parser_poll]:
         p.add_argument(
@@ -1121,9 +1148,10 @@ def poll(self, test_plan_id, interval=60, timeout=-1, expected_state="", expecte
             env["SONIC_AUTOMATION_UMI"]
         )
 
+        pr_id = os.environ.get("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER") or os.environ.get(
+            "SYSTEM_PULLREQUEST_PULLREQUESTID")
+
         if args.action == "create":
-            pr_id = os.environ.get("SYSTEM_PULLREQUEST_PULLREQUESTNUMBER") or os.environ.get(
-                "SYSTEM_PULLREQUEST_PULLREQUESTID")
             build_repo_provider = os.environ.get("BUILD_REPOSITORY_PROVIDER")
             build_reason = args.build_reason if args.build_reason else os.environ.get("BUILD_REASON")
             build_id = os.environ.get("BUILD_BUILDID")
@@ -1211,6 +1239,8 @@ def poll(self, test_plan_id, interval=60, timeout=-1, expected_state="", expecte
             tp.poll(args.test_plan_id, args.interval, args.timeout, args.expected_state, args.expected_result)
         elif args.action == "cancel":
             tp.cancel(args.test_plan_id)
+        elif args.action == "cancel_pr":
+            tp.cancel_pr(pr_id=pr_id)
         sys.exit(0)
     except PollTimeoutException as e:
         print(f"Polling test plan failed with exception: {repr(e)}")