PublishTestResults@2 - 发布测试结果 v2 任务

将测试结果发布到 Azure Pipelines。

语法

# Publish Test Results v2
# Publish test results to Azure Pipelines.
- task: PublishTestResults@2
  inputs:
    testResultsFormat: 'JUnit' # 'JUnit' | 'NUnit' | 'VSTest' | 'XUnit' | 'CTest'. Alias: testRunner. Required. Test result format. Default: JUnit.
    testResultsFiles: '**/TEST-*.xml' # string. Required. Test results files. Default: **/TEST-*.xml.
    #searchFolder: '$(System.DefaultWorkingDirectory)' # string. Search folder. Default: $(System.DefaultWorkingDirectory).
    #mergeTestResults: false # boolean. Merge test results. Default: false.
    #failTaskOnFailedTests: false # boolean. Fail if there are test failures. Default: false.
    #failTaskOnFailureToPublishResults: false # boolean. Fail if there is failure in publishing test results. Default: false.
    #failTaskOnMissingResultsFile: false # boolean. Fail if no result files are found. Default: false.
    #testRunTitle: # string. Test run title. 
  # Advanced
    #buildPlatform: # string. Alias: platform. Build Platform. 
    #buildConfiguration: # string. Alias: configuration. Build Configuration. 
    #publishRunAttachments: true # boolean. Upload test results files. Default: true.
# Publish Test Results v2
# Publish test results to Azure Pipelines.
- task: PublishTestResults@2
  inputs:
    testResultsFormat: 'JUnit' # 'JUnit' | 'NUnit' | 'VSTest' | 'XUnit' | 'CTest'. Alias: testRunner. Required. Test result format. Default: JUnit.
    testResultsFiles: '**/TEST-*.xml' # string. Required. Test results files. Default: **/TEST-*.xml.
    #searchFolder: '$(System.DefaultWorkingDirectory)' # string. Search folder. Default: $(System.DefaultWorkingDirectory).
    #mergeTestResults: false # boolean. Merge test results. Default: false.
    #failTaskOnFailedTests: false # boolean. Fail if there are test failures. Default: false.
    #testRunTitle: # string. Test run title. 
  # Advanced
    #buildPlatform: # string. Alias: platform. Build Platform. 
    #buildConfiguration: # string. Alias: configuration. Build Configuration. 
    #publishRunAttachments: true # boolean. Upload test results files. Default: true.

输入

testResultsFormat - 测试结果格式
输入别名:testRunnerstring。 必填。 允许的值:JUnitNUnitVSTestXUnitCTest。 默认值:JUnit

指定要发布的结果文件的格式。 支持以下格式:CTestJUnitNUnit 2NUnit 3、Visual Studio Test(TRX)和 xUnit 2


testResultsFiles - 测试结果文件
string。 必填。 默认值:**/TEST-*.xml

指定一个或多个测试结果文件。

  • 可以使用单文件夹通配符(*)和递归通配符(**)。 例如,**/TEST-*.xml 搜索名称以所有子目录中 TEST- 开头的所有 XML 文件。 如果使用 VSTest 作为测试结果格式,应将文件类型更改为 .trx,例如 **/TEST-*.trx
  • 可以指定多个路径,用新行分隔。
  • 此外,还接受 微型模式。

例如,!TEST[1-3].xml 排除名为 TEST1.xmlTEST2.xmlTEST3.xml的文件。


searchFolder - 搜索文件夹
string。 默认值:$(System.DefaultWorkingDirectory)

可选。 指定要搜索测试结果文件的文件夹。


mergeTestResults - 合并测试结果
boolean。 默认值:false

当此布尔值 true时,任务会针对单个 测试运行报告来自所有文件的测试结果。 如果值为 false,则任务会为每个测试结果文件创建单独的测试运行。 为了优化性能,即使此选项设置为 false,如果结果文件超过 100 个,则结果将始终合并到单个运行中。

注释

使用合并测试结果设置合并同一测试框架中的文件,以确保正确计算结果映射和持续时间。


如果测试失败,则 failTaskOnFailedTests - 失败
boolean。 默认值:false

可选。 当此布尔值 true时,如果结果文件中的任何测试标记为失败,任务将失败。 默认值为 false,仅发布结果文件中的结果。


如果发布测试结果失败,failTaskOnFailureToPublishResults - 失败
boolean。 默认值:false

true时,如果发布测试结果失败,任务将失败。


如果找不到结果文件,则 failTaskOnMissingResultsFile - 失败
boolean。 默认值:false

如果未找到任何结果文件,则任务失败。


testRunTitle - 测试运行游戏
string

可选。 指定将对其报告结果的测试运行的名称。 可以使用在生成或发布管道中声明的变量名称。


buildPlatform - 生成平台
输入别名:platformstring

可选。 指定应报告测试运行所针对的生成平台。 例如:x64x86。 如果在生成任务中为平台定义了变量,请在此处使用它。


buildConfiguration - 生成配置
输入别名:configurationstring

可选。 指定应报告测试运行的生成配置。 例如:DebugRelease。 如果为生成任务中的配置定义了变量,请在此处使用它。


publishRunAttachments - 上传测试结果文件
boolean。 默认值:true

可选。 当此布尔值 true时,任务会将所有测试结果文件作为附件上传到测试运行。


任务控制选项

除任务输入之外,所有任务都具有控制选项。 有关详细信息,请参阅 控件选项和常见任务属性

输出变量

没有。

注解

执行测试以提供全面的测试报告和分析体验时,此任务会将测试结果发布到 Azure Pipelines 或 TFS。 可以使用所选的测试运行程序支持所需的结果格式。 支持的结果格式包括 CTestJUnit(包括 PHPUnit)、NUnit 2NUnit 3、Visual Studio Test(TRX)和 xUnit 2

其他内置任务,例如 Visual Studio 测试任务Dot NetCore CLI 任务 自动将测试结果发布到管道。 诸如 AntMavenGulpGruntXcode 等任务提供发布结果作为任务中的选项,或生成库(如 CoberturaJaCoCo)。 如果使用上述任一任务,则无需单独 在管道中发布测试结果 任务。

已发布的测试结果显示在管道摘要 的“ 测试”选项卡中。 结果可帮助你衡量管道质量、查看可跟踪性、排查故障以及驱动故障所有权。

以下示例演示任务配置为发布测试结果。

打开测试历史记录页

还可以在生成管道中使用此任务来 发布代码覆盖率结果, 在向 Azure Pipelines 或 TFS 运行测试时生成,以获取覆盖率报告。

先决条件

如果使用 Windows 自承载代理,计算机必须安装以下必备组件:

任务默认值

默认选项使用 JUnit 格式发布测试结果。 将 VSTest 用作 testRunner 时,应将 testResultsFiles 选项更改为 **/TEST-*.trx

testResultsFormattestRunner 输入名称的别名。 结果文件可由多个运行程序生成,而不仅仅是特定的运行程序。 例如,许多运行程序支持 jUnit 结果格式,而不仅仅是 jUnit。

若要使用 YAML 发布 Python 的测试结果,请参阅这些主题 生态系统 部分中的 Python,其中还包括其他语言的示例。

结果格式映射

下表列出了生成或发布摘要中 “测试”选项卡中报告的字段,以及具有受支持测试结果格式的属性的相应映射。

范围 领域 Visual Studio 测试 (TRX)
测试运行 标题 任务中指定的测试运行游戏
开始日期 /TestRun/Times.Attributes[“start”].价值
已完成日期 /TestRun/Times.Attributes[“完成”]。价值
持续时间 已完成日期 - 开始日期
附件 请参阅下面的 附件支持 部分
测试结果 标题 /TestRun/Results/UnitTestResult.Attributes[“testName”]。值或 /TestRun/Results/WebTestResult.Attributes[“testName”]。值或 /TestRun/Results/TestResultAggregation.Attributes[“testName”]。价值
开始日期 /TestRun/Results/UnitTestResult.Attributes[“startTime”].Value Or /TestRun/Results/WebTestResult.Attributes[“startTime”].值或 /TestRun/Results/TestResultAggregation.Attributes[“startTime”]。价值
已完成日期 /TestRun/Results/UnitTestResult.Attributes[“startTime”].Value + /TestRun/Results/UnitTestResult.Attributes[“duration”].Value Or /TestRun/Results/WebTestResult.Attributes[“startTime”].Value + /TestRun/Results/WebTestResult.Attributes[“duration”].值或 /TestRun/Results/TestResultAggregation.Attributes[“startTime”]。Value + /TestRun/Results/TestResultAggregation.Attributes[“duration”]。价值
持续时间 /TestRun/Results/UnitTestResult.Attributes[“duration”].值或 /TestRun/Results/WebTestResult.Attributes[“持续时间”]。值或 /TestRun/Results/TestResultAggregation.Attributes[“持续时间”]。价值
所有者 /TestRun/TestDefinitions/UnitTest/Owners/Owner.Attributes[“name”].价值
结果 /TestRun/Results/UnitTestResult.Attributes[“结果”].值或 /TestRun/Results/WebTestResult.Attributes[“结果”]。值或 /TestRun/Results/TestResultAggregation.Attributes[“结果”]。价值
错误信息 /TestRun/Results/UnitTestResult/Output/ErrorInfo/Message.InnerText 或 /TestRun/Results/WebTestResultOutput/ErrorInfo/Message.InnerText or /TestRun/Results/TestResultAggregation/Output/errorInfo/Message.InnerText
堆栈跟踪 /TestRun/Results/UnitTestResult/Output/ErrorInfo/StackTrace.InnerText 或 /TestRun/Results/WebTestResultOutput/ErrorInfo/StackTrace.InnerText 或 /TestRun/Results/TestResultAggregation/Output/ErrorInfo/StackTrace.InnerText
附件 请参阅下面的 附件支持 部分
控制台日志 /TestRun/Results/UnitTestResult/Output/stdOut.InnerText 或 /TestRun/results/webTestResultOutput/output/stdOut.innerText 或 /TestRun/results/TestResultAggregation/Output/stdOut.InnerText
控制台错误日志 /TestRun/Results/UnitTestResult/Output/stdErr.InnerText 或 /TestRun/Results/WebTestResultOutput/Output/stdErr.InnerText 或 /TestRun/results/TestResultAggregation/Output/stdErr.InnerText
代理名称 /TestRun/Results/UnitTestResult.Attributes[“computerName”]。值或 /TestRun/Results/WebTestResult.Attributes[“computerName”]。值或 /TestRun/Results/TestResultAggregation.Attributes[“computerName”]。价值
测试文件 /TestRun/TestDefinitions/UnitTest.Attributes[“存储”]。价值
优先权 /TestRun/TestDefinitions/UnitTest.Attributes[“priority”].价值

注释

持续时间 仅在 日期开始日期完成 不可用时使用。

testName 的完全限定名称格式 Namespace.Testclass.Methodname,字符限制为 512。 如果测试是数据驱动且具有参数,字符限制将包括参数。

发布测试结果时,可能会收到此错误:无法发布测试结果:指定的优先级无效

如果任何测试方法的优先级都设置为 255 以上,请修复代码中的测试方法优先级,然后再次执行测试,则会发生此错误。 可以查看生成的 trx 文件,以查看优先级大于 255 的所有测试。

附件支持

发布测试结果任务为以下格式的测试运行和测试结果提供附件支持。 对于公共项目,我们支持 2GB 的总附件。

Visual Studio 测试 (TRX)

范围 类型 路径
测试运行 数据收集器 /TestRun/ResultSummary/CollectorDataEntries/Collector/UriAttachments/UriAttachment/A.Attributes[“href”]。价值
测试结果 /TestRun/ResultSummary/ResultFiles/ResultFile.Attributes[“路径”]。价值
代码覆盖率 /TestRun/TestSettings/Execution/AgentRule/DataCollectors/DataCollector/Configuration/CodeCoverage/Regular/CodeCoverageItem.Attributes[“binaryFile”]。值和 /TestRun/TestSettings/Execution/AgentRule/DataCollectors/DataCollector/Configuration/CodeCoverage/Regular/CodeCoverageItem.Attributes[“pdbFile”]。价值
测试结果 数据收集器 /TestRun/Results/UnitTestResult/CollectorDataEntries/Collector/UriAttachments/UriAttachment/A.Attributes[“href”]。值或 /TestRun/Results/WebTestResult/CollectorDataEntries/Collector/UriAttachments/UriAttachments/A.Attributes[“href”]。值或 /TestRun/Results/TestResultAggregation/CollectorDataEntries/Collector/UriAttachments/UriAttachment/A.Attributes[“href”]。价值
测试结果 /TestRun/Results/UnitTestResult/ResultFiles/ResultFile.Attributes[“路径”]。值或 /TestRun/Results/WebTestResult/ResultFiles/ResultFile.Attributes[“路径”]。值或 /TestRun/Results/TestResultAggregation/ResultFiles/ResultFile.Attributes[“路径”]。价值

注释

将测试结果文件作为附件上传的选项是任务中的默认选项,适用于所有格式。

例子

Docker

对于基于 Docker 的应用,可以通过多种方式生成应用程序和运行测试:

  • 生成管道中生成和测试:在管道中执行生成和测试,并使用 发布测试结果 任务发布测试结果。
  • 使用多阶段 Dockerfile 进行生成和测试:使用多阶段 Docker 文件在容器内执行生成和测试,例如,测试结果不会发布回管道。
  • 使用 Dockerfile生成、测试和发布结果:生成和测试在容器内执行,结果将发布回管道。 请参阅下面的示例。

使用 Docker 文件生成、测试和发布结果

在此方法中,你将使用 Docker 文件生成代码并在容器中运行测试。 然后将测试结果复制到要发布到管道的主机。 若要将测试结果发布到 Azure Pipelines,可以使用 发布测试结果 任务。 最终映像将发布到 Docker 或 Azure 容器注册表。

获取代码
  1. 使用以下命令在项目目录的根目录中创建 Dockerfile.build 文件:

    # 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
    

    此文件包含生成代码和运行测试的说明。 然后将测试复制到容器内 testresults.trx 的文件。

  2. 若要使最终映像尽可能小(仅包含运行时和部署项目),请将现有 Dockerfile 的内容替换为以下内容:

    # 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"]
    
定义生成管道
  1. 如果有 Docker 中心帐户,并且想要将映像推送到 Docker 注册表,请将 .vsts-ci.docker.yml 文件的内容替换为以下内容:

    # Build Docker image for this app, to be published to Docker Registry
    pool:
      vmImage: 'ubuntu-latest'
    variables:
      buildConfiguration: 'Release'
    steps:
    - script: |
        docker build -f Dockerfile.build -t $(dockerId)/dotnetcore-build:$BUILD_BUILDID .
        docker run --name dotnetcoreapp --rm -d $(dockerId)/dotnetcore-build:$BUILD_BUILDID
        docker cp dotnetcoreapp:app/dotnetcore-tests/TestResults $(System.DefaultWorkingDirectory)
        docker cp dotnetcoreapp:app/dotnetcore-sample/out $(System.DefaultWorkingDirectory)
        docker stop dotnetcoreapp
    
    - task: PublishTestResults@2
      inputs:
        testRunner: VSTest
        testResultsFiles: '**/*.trx'
        failTaskOnFailedTests: true
    
    - script: |
        docker build -f Dockerfile -t $(dockerId)/dotnetcore-sample:$BUILD_BUILDID .
        docker login -u $(dockerId) -p $pswd
        docker push $(dockerId)/dotnetcore-sample:$BUILD_BUILDID
      env:
        pswd: $(dockerPassword)
    

    或者,如果配置 Azure 容器注册表并想要将映像推送到该注册表,请将 .vsts-ci.yml 文件的内容替换为以下内容:

    # Build Docker image for this app to be published to Azure Container Registry
    pool:
      vmImage: 'ubuntu-latest'
    variables:
      buildConfiguration: 'Release'
    
    steps:
    - script: |
        docker build -f Dockerfile.build -t $(dockerId)/dotnetcore-build:$BUILD_BUILDID .
        docker run --name dotnetcoreapp --rm -d $(dockerId)/dotnetcore-build:$BUILD_BUILDID
        docker cp dotnetcoreapp:app/dotnetcore-tests/TestResults $(System.DefaultWorkingDirectory)
        docker cp dotnetcoreapp:app/dotnetcore-sample/out $(System.DefaultWorkingDirectory)
        docker stop dotnetcoreapp
    
    - task: PublishTestResults@2
      inputs:
        testRunner: VSTest
        testResultsFiles: '**/*.trx'
        failTaskOnFailedTests: true
    
    - script: |
        docker build -f Dockerfile -t $(dockerId).azurecr.io/dotnetcore-sample:$BUILD_BUILDID .
        docker login -u $(dockerId) -p $pswd $(dockerid).azurecr.io
        docker push $(dockerId).azurecr.io/dotnetcore-sample:$BUILD_BUILDID 
      env:
        pswd: $(dockerPassword)
    
  2. 将更改推送到存储库中的主分支。

  3. 如果使用 Azure 容器注册表,请确保已在 Azure 门户中 预先创建了注册表。 复制 Azure 门户中注册表设置 部分中 访问密钥中显示的管理员用户名和密码。

  4. 使用以下项更新生成管道

    • 代理池Hosted Ubuntu 1604
      • dockerId:将值设置为 DockerHub 的 Docker ID 或 Azure 容器注册表的管理员用户名。
      • dockerPassword:将值设置为 DockerHub 的密码或管理员密码 Azure 容器注册表。
    • YAML 文件路径/.vsts-ci.docker.yml
  5. 将新生成排入队列,并监视它创建 Docker 映像并将其推送到注册表,并将测试结果推送到 Azure DevOps。

要求

要求 说明
管道类型 YAML,经典版本,经典版本
运行时间 代理,DeploymentGroup
需求 没有
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任何
Settable 变量 任何
代理版本 2.0.0 或更高版本
任务类别 测试