Create output variables for TestRun (#121)

* revert chai version
6.2.0 is incompatible with ES Module

* create output variables

* Add regression test for TestRunId

* use runtime expression for joboutput variable

* try macro syntax

* file path correction for xUnitExample

* additional logging / fix for expectedResults

* assertion in validation script

Author: bryanbcook

PublishTestPlanResultsV1/package-lock.json

@@ -21,7 +21,7 @@
     "@types/node": "^20.19.22",
     "@types/q": "^1.5.7",
     "@types/sinon": "^17.0.4",
-    "chai": "^6.2.0",
+    "chai": "^4.5.0",
     "sinon": "^21.0.0",
     "sync-request": "^6.1.0"
   }

PublishTestPlanResultsV1/package.json

@@ -1,4 +1,5 @@
 import * as Contracts from "azure-devops-node-api/interfaces/TestInterfaces";
+import * as tl from 'azure-pipelines-task-lib/task';
 import { TestAttachment, TestFrameworkResult } from "../framework/TestFrameworkResult";
 import { TestRunPublisherParameters } from "./TestRunPublisherParameters";
 import { TestResultProcessorResult } from "../processing/TestResultProcessor";
@@ -99,6 +100,8 @@ export class TestRunPublisher {
       var finalRun = await this.ado.updateTestRun(projectId, testRun);
 
       this.logger.info(`Published Test Run: ${testRun.webAccessUrl}`)
+      tl.setVariable("TestRunId", finalRun.id!.toString(), /*secret*/false, /*output*/true);
+      tl.setVariable("TestRunUrl", finalRun.webAccessUrl!, /*secret*/false, /*output*/true);
 
       return finalRun;
     } else {

PublishTestPlanResultsV1/publishing/TestRunPublisher.ts

@@ -2,6 +2,7 @@ import * as Contracts from 'azure-devops-node-api/interfaces/TestInterfaces';
 import { expect } from "chai";
 import path from "path";
 import sinon from "sinon";
+import * as tl from "azure-pipelines-task-lib/task";
 import { TestResultProcessorResult } from "../processing/TestResultProcessor";
 import { TestRunPublisher } from "../publishing/TestRunPublisher";
 import { TestRunPublisherParameters } from "../publishing/TestRunPublisherParameters";
@@ -15,11 +16,15 @@ context("TestRunPublisher", () => {
   var ado : sinon.SinonStubbedInstance<AdoWrapper>;
   var testData : TestResultProcessorResult;
   var subject : TestRunPublisher;
+  var tlStub : sinon.SinonStubbedInstance<typeof tl>;
 
   beforeEach(() => {
     logger = new NullLogger();
     ado = sinon.createStubInstance(AdoWrapper);
 
+    // mock task library
+    tlStub = sinon.stub(tl);
+
     testData = new TestResultProcessorResult("project1", <Contracts.TestPlan>{ id: 1});
 
     subject = new TestRunPublisher(ado, logger);
@@ -251,6 +256,20 @@ context("TestRunPublisher", () => {
     await testUtil.shouldThrowAsync(async () => { return subject.publishTestRun(testData)}, "Couldn't create a TestRun for this TestPlan because the test results could not be correlated to any known TestCases.")
   });
 
+  it("Should set output variables when test run is published", async () => {
+    // arrange
+    testData.matches.set(/*testpoint*/ 1, testUtil.newTestFrameworkResult());
+    setupTestRun( /*runid*/ 400);
+    setupTestCaseResults( [1] );
+
+    // act
+    var result = await subject.publishTestRun(testData);
+
+    // assert
+    expect(tlStub.setVariable.calledWith("TestRunId", "400", false, true)).eq(true);
+    expect(tlStub.setVariable.calledWith("TestRunUrl", result?.webAccessUrl, false, true)).eq(true);
+  })
+
   function setupTestRun(runId: number) {
     ado.createTestRun.callsFake( (prjId, plnId, points) => {
 
@@ -260,6 +279,11 @@ context("TestRunPublisher", () => {
 
       return Promise.resolve(testRun);
     })
+
+    ado.updateTestRun.callsFake( (prjId, tr: Contracts.TestRun) => {
+      tr.webAccessUrl = `https://dev.azure.com/fake/${tr.id}`;
+      return Promise.resolve(tr);
+    });
   }
   function setupTestCaseResults(points: number[]) {
     ado.getTestResults.callsFake( (prjId, runId) => {

PublishTestPlanResultsV1/test/TestRunPublisher.specs.ts

@@ -17,6 +17,16 @@ parameters:
   - name: JUnitExample-Maven
     format: junit
     testResultsFile: '$(Build.SourcesDirectory)/examples/java/JUnitExample-maven/TestResults.xml'
+  - name: xUnitExample
+    format: xunit
+    testResultsFile: '$(Build.SourcesDirectory)/examples/dotnet/xUnitExample/TestResults/TestResults.xml'
+    expectedResults:
+      - outcome: Passed
+        count: 7
+      - outcome: Failed
+        count: 1
+      - outcome: NotExecuted
+        count: 1
   - name: FailOnFailedTests
     format: nunit
     testResultsFile: '$(Build.SourcesDirectory)/examples/dotnet/NUnitExample/TestResults/TestResults.xml'
@@ -81,3 +91,49 @@ steps:
         -failTaskOnSkippedTests '${{ iif( ne(test.failTaskOnSkippedTests,''), test.failTaskOnSkippedTests, 'false' ) }}'
         -DryRun ''
 
+  - ${{ if ne(test.expectedResults, '') }}:
+    - task: PowerShell@2
+      displayName: 'Validate results for ${{ test.name }}'
+      inputs:
+        targetType: 'inline'
+        script: |
+          $expected = $env:expected | ConvertFrom-Json
+          $testRun = $env:testrun
+          $testRunUrl = $env:testrunurl
+
+          if (-not $testRun) {
+            Write-Error "Test Run ID is not available. Cannot validate results."
+            exit 0
+          }
+          if ( -not $testRunUrl) {
+            Write-Error "Test Run URL is not available. Cannot validate results."
+            exit 0
+          }
+
+          Write-Host "Validating Test Run ID: $testRun"
+          Write-Host "Test Run URL: $testRunUrl"
+
+          $auth64 = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$(System.AccessToken)"))
+          $headers = @{ Authorization = "Basic $auth64" }
+          $uri = "$(System.CollectionUri)/Test%20Plan%20Extension/_apis/test/runs/$($testRun)?api-version=7.1"
+
+          $response = Invoke-RestMethod -Uri $uri -Headers $headers -Method Get
+
+          foreach ($expect in $expected) {
+            $outcome = $expect.outcome
+            $count = $expect.count
+
+            $actualCount = ($response.runStatistics | Where-Object { $_.outcome -eq $outcome }).count
+
+            if ($actualCount -ne $count) {
+              Write-Error "Validation failed for outcome '$outcome'. Expected: $count, Actual: $actualCount"
+            }
+            else {
+              Write-Host "Validation succeeded for outcome '$outcome'. Count: $count"
+            }
+          }
+
+      env:
+        expected: ${{ convertToJson(test.expectedResults) }}
+        testrun: $(${{ replace(lower(test.name), '-','_') }}.TestRunId)
+        testrunurl: $(${{ replace(lower(test.name), '-','_') }}.TestRunUrl)