Skip to content

[BUG] coverlet.msbuild Support for Microsoft.Testing.Platform (not to be confused with VSTest Platform) #1715

Open
@Arthri

Description

@Arthri

Describe the bug
coverlet.msbuild does not work with the new testing platform server mode

To Reproduce
Create a new unit tests project using TUnit. Add coverlet.msbuild as a dependency to the project. Run with the command dotnet test -p:CollectCoverage=true -p:CoverletOutputFormat=opencover

Expected behavior
A code coverage report is generated somewhere, anywhere.

Actual behavior
No code coverage report is generated.

Configuration (please complete the following information):
Please provide more information on your .NET configuration:
* Which coverlet package and version was used? coverlet.msbuild and 6.0.2
* Which version of .NET is the code running on? 9.0.100
* What OS and version, and what distro if applicable? Windows 10 22H2
* What is the architecture (x64, x86, ARM, ARM64)? x64
* Do you know whether it is specific to that configuration? Uncertain.

Additional context
One of the two instrumentation targets, InstrumentModulesAfterBuild, depends on(runs after) the BuildProject target, which no longer exists under the new Microsoft Testing Platform. Therefore, instrumentation is not ran regardless of what happens.

I've found two solutions to the problem, but neither of which are extensively tested.

  1. Recreate BuildProject, so that the instrumentation target has something to hook onto and is able to run.
    Add a Directory.Build.targets in the same directory as the project, then set its contents to the following,
    <Project>
      <Target Name="BuildProject" BeforeTargets="InvokeTestingPlatform" />
    </Project>
    It doesn't matter that BuildProject is empty and does nothing, because the project build is handled by the _BuildAndInvokeTestingPlatform target.
  2. Pass the --no-build option to dotnet test, for example, dotnet test -p:CollectCoverage=true -p:CoverletOutputFormat=opencover --no-build. This solution depends on the other instrumentation target, InstrumentModulesNoBuild, which depends on(runs before) the VSTest target. The aforementioned target still exists on the new testing platform.

coverlet.console works, from prior testing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions