PublishTestResults@2 - Publish Test Results v2 task

Publish Test Results to VSTS/TFS.

Inputs

testResultsFiles - Test results files
string. Required. Default value: **\TEST-*.xml.

Specifies one or more test results files.

• You can use a single-folder wildcard (*) and recursive wildcards (**). For example, **/TEST-*.xml searches for all the XML files whose names start with TEST- in all subdirectories. If using VSTest as the test result format, the file type should be changed to .trx e.g. **/TEST-*.trx
• Multiple paths can be specified, separated by a newline.
• Additionally accepts minimatch patterns.

For example, !TEST[1-3].xml excludes files named TEST1.xml, TEST2.xml, or TEST3.xml.

searchFolder - Search folder
string. Default value: $(System.DefaultWorkingDirectory).

Optional. Specifies the folder to search for the test result files.

mergeTestResults - Merge test results
boolean. Default value: false.

When this boolean's value is true, the task reports test results from all the files against a single test run. If the value is false, the task creates a separate test run for each test result file.

testRunTitle - Test run title
string.

Optional. Specifies a name for the test run against which the results will be reported. Variable names declared in the build or release pipeline can be used.

publishRunAttachments - Upload test results files
boolean. Default value: true.

Optional. When this boolean's value is true, the task uploads all the test result files as attachments to the test run.

testRunner - Test result format
string. Required. Allowed values: JUnit, NUnit, VSTest, XUnit. Default value: JUnit.

Specifies the format of the results files you want to publish. The following formats are supported: CTest, JUnit, NUnit 2, NUnit 3, Visual Studio Test (TRX) and xUnit 2.

platform - Platform
string.

Optional. Specifies the build platform against which the test run should be reported. For example: x64 or x86. If you defined a variable for the platform in your build task, use it here.

configuration - Configuration
string.

Optional. Specifies the build configuration against which the test run should be reported. For example: Debug or Release. If you defined a variable for the configuration in your build task, use it here.

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Remarks

• Prerequisites
• Task defaults
• Result formats mapping
• Attachments support

This task publishes test results to Azure Pipelines or TFS when tests are executed to provide a comprehensive test reporting and analytics experience. You can use the test runner of your choice that supports the results format you require. Supported results formats include CTest, JUnit (including PHPUnit), NUnit 2, NUnit 3, Visual Studio Test (TRX), and xUnit 2.

Other built-in tasks, such as Visual Studio Test task and Dot NetCore CLI task automatically publish test results to the pipeline. Tasks such as Ant, Maven, Gulp, Grunt, and Xcode provide publishing results as an option within the task, or build libraries such as Cobertura and JaCoCo. If you are using any of these tasks, you do not need a separate Publish Test Results task in the pipeline.

The published test results are displayed in the Tests tab in the pipeline summary. The results help you to measure pipeline quality, review traceability, troubleshoot failures, and drive failure ownership.

The following example shows the task is configured to publish test results.

You can also use this task in a build pipeline to publish code coverage results produced when running tests to Azure Pipelines or TFS in order to obtain coverage reporting.

Prerequisites

If you're using a Windows self-hosted agent, your machine must have this prerequisite installed:

• .NET Framework 4.6.2 or a later version

Task defaults

The default option uses JUnit format to publish test results. When using VSTest as the testRunner, the testResultsFiles option should be changed to **/TEST-*.trx.

testResultsFormat is an alias for the testRunner input name. The results files can be produced by multiple runners, not just a specific runner. For example, the jUnit results format is supported by many runners and not just jUnit.

To publish test results for Python using YAML, see Python in the Ecosystems section of these topics, which also includes examples for other languages.

Result formats mapping

This table lists the fields reported in the Tests tab in a build or release summary, and the corresponding mapping with the attributes in the supported test result formats.

Attachments support

The Publish Test Results task provides support for attachments for both test run and test results for the following formats. For public projects, we support 2GB of total attachments.

Examples

Docker

For Docker based apps, there are many ways to build your application and run tests:

• Build and test in a build pipeline: builds and tests execute in the pipeline and test results are published using the Publish Test Results task.
• Build and test with a multi-stage Dockerfile: builds and tests execute inside the container using a multi-stage Docker file, as such test results are not published back to the pipeline.
• Build, test, and publish results with a Dockerfile: builds and tests execute inside the container, and results are published back to the pipeline. See the example below.

Build, test, and publish results with a Docker file

In this approach, you build your code and run tests inside the container using a Docker file. The test results are then copied to the host to be published to the pipeline. To publish the test results to Azure Pipelines, you can use the Publish Test Results task. The final image will be published to Docker or Azure Container Registry.

Get the code

1. Create a Dockerfile.build file at the root of your project directory with the following:

   # Build and run tests inside the docker container
   FROM mcr.microsoft.com/dotnet/sdk:2.1
   WORKDIR /app
   # copy the contents of agent working directory on host to workdir in container
   COPY . ./
   # dotnet commands to build, test, and publish
   RUN dotnet restore
   RUN dotnet build -c Release
   RUN dotnet test dotnetcore-tests/dotnetcore-tests.csproj -c Release --logger "trx;LogFileName=testresults.trx"
   RUN dotnet publish -c Release -o out
   ENTRYPOINT dotnet dotnetcore-sample/out/dotnetcore-sample.dll
   

   This file contains the instructions to build code and run tests. The tests are then copied to a file testresults.trx inside the container.

2. To make the final image as small as possible, containing only the runtime and deployment artifacts, replace the contents of the existing Dockerfile with the following:

   # This Dockerfile creates the final image to be published to Docker or
   # Azure Container Registry
   # Create a container with the compiled asp.net core app
   FROM mcr.microsoft.com/dotnet/aspnet:2.1
   # Create app directory
   WORKDIR /app
   # Copy only the deployment artifacts
   COPY /out .
   ENTRYPOINT ["dotnet", "dotnetcore-sample.dll"]
   

Define the build pipeline

Requirements