在 macOS DevOps 管道中运行封面和报告生成器

Question

我有一个用dotnet core 2.1编写的C#项目，我正在尝试为其设置Azure管道，以便在macOS代理上运行时可以获得代码覆盖率(我可以更改为其他代理，但理想情况下管道将与系统无关(。到目前为止，我一直在尝试让被套和报告生成器一起工作，但我不断遇到问题，例如Could not find data collector 'XPlat Code Coverage'。

我想发生的是确定代码覆盖率(封面似乎正在执行(，并以某种方式在 Azure 管道中生成和显示代码覆盖率报告。

这是我到目前为止的管道：

pool:
vmImage: macOS-latest
variables:
solution: 'src/MySolution.sln'
buildPlatform: 'Any CPU'
buildConfiguration: 'Debug'
steps:
- task: DotNetCoreInstaller@1
displayName: 'Use .NET Core sdk 2.2.103'
inputs:
version: 2.2.103
- task: DotNetCoreCLI@2
displayName: 'Restore NuGet packages for $(solution)'
inputs:
command: 'restore'
projects: '$(solution)'
- task: DotNetCoreCLI@2
displayName: 'Build $(solution)'
inputs:
command: 'build'
projects: '$(solution)'
arguments: '-c $(buildConfiguration)'
- task: DotNetCoreCLI@2
continueOnError: true
inputs:
command: custom
custom: tool
arguments: install -g coverlet.console
displayName: Install Coverlet tool. This task will continue on error.
- task: DotNetCoreCLI@2
displayName: 'Run tests for $(solution) collecting code coverage result'
inputs:
command: test
projects: 'src/MySolution.SomeProject.Tests/*.csproj'
arguments: -c $(buildConfiguration) --collect:"XPlat Code Coverage"
- script: coverlet src/MySolution.SomeProject.Tests/bin/$(buildConfiguration)/netcoreapp2.1/MySolution.SomeProject.Tests.dll --target "dotnet" --targetargs "test src/MySolution.SomeProject.Tests --no-build"
displayName: Run Coverlet to get code coverage.
- task: DotNetCoreCLI@2
continueOnError: true
inputs:
command: custom
custom: tool
arguments: install -g dotnet-reportgenerator-globaltool
displayName: Install ReportGenerator tool
# This outputs Analyzing 0 classes, and an index.htm file is created, but not sure how to access it
- script: reportgenerator -reports:$(Build.SourcesDirectory)/coverage.json -targetdir:$(Build.SourcesDirectory)/coverlet/reports -reporttypes:HtmlInline_AzurePipelines
displayName: 'Create reports.'
# Not sure what this should be
- task: PublishCodeCoverageResults@1
displayName: 'Publish code coverage'
inputs:
codeCoverageTool: Cobertura
summaryFileLocation: $(Build.SourcesDirectory)/coverlet/reports/Cobertura.xml

Answer 1

所以我让它工作了。我错过了一些您可以指定coverlet使用的格式。默认情况下，它输出coverage.json，但通过将格式指定为cobertura，它会输出coverage.cobertura.xml。所以这个 yaml 脚本有效：

pool:
vmImage: macOS-latest
variables:
solution: 'src/MySolution.sln'
buildPlatform: 'Any CPU'
buildConfiguration: 'Debug'
steps:
- task: DotNetCoreInstaller@1
displayName: 'Use .NET Core sdk 2.2.103'
inputs:
version: 2.2.103
- task: DotNetCoreCLI@2
displayName: 'Restore NuGet packages for $(solution)'
inputs:
command: 'restore'
projects: '$(solution)'
- task: DotNetCoreCLI@2
displayName: 'Build $(solution)'
inputs:
command: 'build'
projects: '$(solution)'
arguments: '-c $(buildConfiguration)'
- task: DotNetCoreCLI@2
displayName: 'Run tests for $(solution) collecting code coverage result'
inputs:
command: test
projects: 'src/MySolution.SomeProject.Tests/*.csproj'
arguments: -c $(buildConfiguration)
- task: DotNetCoreCLI@2
continueOnError: true
inputs:
command: custom
custom: tool
arguments: install -g coverlet.console
displayName: Install Coverlet tool. This task will continue on error.
- script: coverlet src/MySolution.SomeProject.Tests/bin/$(buildConfiguration)/netcoreapp2.1/MySolution.SomeProject.Tests.dll --target "dotnet" --targetargs "test src/MySolution.SomeProject.Tests --no-build" --format cobertura
displayName: Run Coverlet to get code coverage.
- task: DotNetCoreCLI@2
continueOnError: true
inputs:
command: custom
custom: tool
arguments: install -g dotnet-reportgenerator-globaltool
displayName: Install ReportGenerator tool
- script: reportgenerator -reports:$(Build.SourcesDirectory)/coverage.cobertura.xml -targetdir:$(Build.SourcesDirectory)/coverlet/reports -reporttypes:HtmlInline_AzurePipelines
displayName: 'Create reports.'
- task: PublishCodeCoverageResults@1
displayName: 'Publish code coverage'
inputs:
codeCoverageTool: Cobertura
summaryFileLocation: $(Build.SourcesDirectory)/coverage.cobertura.xml

Answer 2

应将以下 NuGet 包引用添加到项目 .csproj 文件

<PackageReference Include="coverlet.collector" Version="1.1.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

您可以点击此链接设置管道