Run ATP from Test Plans - Run with Options to execute custom selected test cases (#20887)

* add test run in input.

* start using test api to retrieve test cases using testRunId.

* methods created.

* tests getting populated.

* manual test detection.

* type safety.

* nit.

* fix run issue

* version

* switched to console log

* Revert "switched to console log"

This reverts commit d2e7493.

* api endpoint.

Author: KathanS

Tasks/AzureTestPlanV0/Automated Flow/automatedFlow.ts

@@ -109,7 +109,8 @@ async function publishResults(
         }
 
         await publishAutomatedTestResult(
-            JSON.stringify(testPlanInfo.listOfAutomatedTestPoints)
+            JSON.stringify(testPlanInfo.listOfAutomatedTestPoints),
+            testPlanInfo.listOfAutomatedTestPoints.length ? testPlanInfo.listOfAutomatedTestPoints[0].testPlan?.id : ""
         );
         return createSuccessResult();
 

Tasks/AzureTestPlanV0/Common/publishAutomatedTests.ts

@@ -2,7 +2,7 @@ import tl = require('azure-pipelines-task-lib/task');
 import * as path from 'path';
 import constants = require('./constants');
 
-function publish(testRunner, resultFiles, mergeResults, failTaskOnFailedTests, platform, publishRunAttachments, testRunSystem , failTaskOnFailureToPublishResults, listOfAutomatedTestPoints) {
+function publish(testRunner, resultFiles, mergeResults, failTaskOnFailedTests, platform, publishRunAttachments, testRunSystem , failTaskOnFailureToPublishResults, listOfAutomatedTestPoints, testPlan) {
     var properties = <{ [key: string]: string }>{};    
     properties['type'] = testRunner;
     properties['mergeResults'] = mergeResults;
@@ -14,14 +14,14 @@ function publish(testRunner, resultFiles, mergeResults, failTaskOnFailedTests, p
     properties['testRunSystem'] = testRunSystem;
     properties['listOfAutomatedTestPoints'] = listOfAutomatedTestPoints;
 
-    var testPlanId = tl.getInput('testPlan');
+    var testPlanId = testPlan ?? tl.getInput('testPlan');
     tl.debug('testPlanId: ' + testPlanId);
     properties['testPlanId'] = testPlanId;
 
     tl.command('results.publish', properties, '');
 }
 
-export async function publishAutomatedTestResult(listOfAutomatedTestPoints: string) {
+export async function publishAutomatedTestResult(listOfAutomatedTestPoints: string, testPlan: string) {
     try{
         const testRunner = "JUnit";
         const testResultsFiles: string[] = ["**/TEST-*.xml"];
@@ -81,7 +81,8 @@ export async function publishAutomatedTestResult(listOfAutomatedTestPoints: stri
                 publishRunAttachments,
                 testRunSystem,
                 failTaskOnFailureToPublishResults,
-                listOfAutomatedTestPoints);
+                listOfAutomatedTestPoints,
+                testPlan);
         }
     } catch (err) {
         throw new Error('Faced error while publishing test results:' + err.message);

Tasks/AzureTestPlanV0/OldAutomatedFlow/automatedTests.ts

@@ -49,7 +49,7 @@ async function publishResults(testPlanInfo: TestPlanData, ciData: ciDictionary,
     publishingTimer.start();
 
     try {
-        await publishAutomatedTestResult(JSON.stringify(testPlanInfo.listOfAutomatedTestPoints));
+        await publishAutomatedTestResult(JSON.stringify(testPlanInfo.listOfAutomatedTestPoints), testPlanInfo.listOfAutomatedTestPoints.length ? testPlanInfo.listOfAutomatedTestPoints[0].testPlan?.id : "");
     } catch (err) {
         automatedTestInvokerResult.returnCode = 1;
         automatedTestInvokerResult.errorMessage = err.message || String(err);

Tasks/AzureTestPlanV0/Strings/resources.resjson/en-US/resources.resjson

@@ -5,6 +5,10 @@
   "loc.instanceNameFormat": "Azure Test Plan - $(testSelector)",
   "loc.input.label.testSelector": "Test cases to be executed",
   "loc.input.help.testSelector": "<ul><li><b>Manual tests: </b>Use this option to trigger manual tests from your test plan.</li><li><b>Automated tests: </b>Use this option to run tests from your test plan that have automated test method associated with it.</li>",
+  "loc.input.label.testPlanOrRunSelector": "Select tests using",
+  "loc.input.help.testPlanOrRunSelector": "<ul><li><b>Test assembly: </b>Use this option to specify one or more test assemblies that contain your tests. You can optionally specify a filter criteria to select only specific tests.</li><li><b>Test plan: </b>Use this option to run tests from your test plan that have an automated test method associated with it.</li><li><b>Test run: </b>Use this option when you are setting up an environment to run tests from the Test hub. This option should not be used when running tests in a continuous integration / continuous deployment (CI/CD) pipeline.</li>",
+  "loc.input.label.testRunId": "Test Run",
+  "loc.input.help.testRunId": "Test run based selection is used when triggering automated test runs from the test hub, value for this should be kept as it is",
   "loc.input.label.testPlan": "Test plan",
   "loc.input.help.testPlan": "Type or paste the test plan ID containing test suites with test cases.",
   "loc.input.label.testSuite": "Test suite",

Tasks/AzureTestPlanV0/task.json

@@ -13,8 +13,8 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 0,
-    "Minor": 253,
-    "Patch": 8
+    "Minor": 254,
+    "Patch": 1
   },
   "preview": true,
   "demands": [],
@@ -34,6 +34,30 @@
         "MultiSelectFlatList": "True"
       }
     },
+    {
+      "name": "testPlanOrRunSelector",
+      "type": "pickList",
+      "label": "Select tests using",
+      "defaultValue": "testPlan",
+      "required": true,
+      "helpMarkDown": "<ul><li><b>Test assembly: </b>Use this option to specify one or more test assemblies that contain your tests. You can optionally specify a filter criteria to select only specific tests.</li><li><b>Test plan: </b>Use this option to run tests from your test plan that have an automated test method associated with it.</li><li><b>Test run: </b>Use this option when you are setting up an environment to run tests from the Test hub. This option should not be used when running tests in a continuous integration / continuous deployment (CI/CD) pipeline.</li>",
+      "options": {
+        "testPlan": "Test plan",
+        "testRun": "Test run"
+      },
+      "properties": {
+        "EditableOptions": "True"
+      }
+    },
+    {
+      "name": "testRunId",
+      "type": "string",
+      "label": "Test Run",
+      "defaultValue": "$(test.RunId)",
+      "required": true,
+      "helpMarkDown": "Test run based selection is used when triggering automated test runs from the test hub, value for this should be kept as it is",
+      "visibleRule": "testPlanOrRunSelector = testRun"
+    },
     {
       "name": "testPlan",
       "type": "string",
@@ -44,7 +68,8 @@
       "properties": {
         "DisableManageLink": "True",
         "EditableOptions": "True"
-      }
+      },
+      "visibleRule": "testPlanOrRunSelector = testPlan"
     },
     {
       "name": "testSuite",
@@ -54,10 +79,10 @@
       "helpMarkDown": "Select one or more test suites containing test cases.",
       "required": true,
       "properties": {
-        "MultiSelect": "True",
         "DisableManageLink": "True",
         "EditableOptions": "True"
-      }
+      },
+      "visibleRule": "testPlanOrRunSelector = testPlan"
     },
     {
       "name": "testConfiguration",

Tasks/AzureTestPlanV0/task.loc.json

@@ -13,8 +13,8 @@
   "author": "Microsoft Corporation",
   "version": {
     "Major": 0,
-    "Minor": 253,
-    "Patch": 8
+    "Minor": 254,
+    "Patch": 1
   },
   "preview": true,
   "demands": [],
@@ -34,6 +34,30 @@
         "MultiSelectFlatList": "True"
       }
     },
+    {
+      "name": "testPlanOrRunSelector",
+      "type": "pickList",
+      "label": "ms-resource:loc.input.label.testPlanOrRunSelector",
+      "defaultValue": "testPlan",
+      "required": true,
+      "helpMarkDown": "ms-resource:loc.input.help.testPlanOrRunSelector",
+      "options": {
+        "testPlan": "Test plan",
+        "testRun": "Test run"
+      },
+      "properties": {
+        "EditableOptions": "True"
+      }
+    },
+    {
+      "name": "testRunId",
+      "type": "string",
+      "label": "ms-resource:loc.input.label.testRunId",
+      "defaultValue": "$(test.RunId)",
+      "required": true,
+      "helpMarkDown": "ms-resource:loc.input.help.testRunId",
+      "visibleRule": "testPlanOrRunSelector = testRun"
+    },
     {
       "name": "testPlan",
       "type": "string",
@@ -44,7 +68,8 @@
       "properties": {
         "DisableManageLink": "True",
         "EditableOptions": "True"
-      }
+      },
+      "visibleRule": "testPlanOrRunSelector = testPlan"
     },
     {
       "name": "testSuite",
@@ -54,10 +79,10 @@
       "helpMarkDown": "ms-resource:loc.input.help.testSuite",
       "required": true,
       "properties": {
-        "MultiSelect": "True",
         "DisableManageLink": "True",
         "EditableOptions": "True"
-      }
+      },
+      "visibleRule": "testPlanOrRunSelector = testPlan"
     },
     {
       "name": "testConfiguration",