[BUG] Inconsistent paths in cobertura reports

[rivnakm]

Describe the bug

When producing coverage reports in cobertura format, the way the path is split between the <source> tag and the filename attribute on class tags is inconsistent across test projects. Sometimes the source tag is the path to the project directory, sometimes it's my home directory, and sometimes it's my root directory. Combining the two parts of the path is always correct, but the way they are split is inconsistent.

Other report formats don't split the path like cobertura, so the issue is not present there.

To Reproduce
Generate coverage reports for a solution with multiple test projects, using the cobertura format, with source link disabled.

Expected behavior
I'm not sure exactly what the expected root should be, I would expect it to be the test project directory, with class files being relative to that. Overall it should be consistent across projects.

Actual behavior
Coverage source directories are inconsistent between multiple test projects within the same solution.

  <sources>
    <source>/home/michael/Code/anna/Anna.Index/</source>
  </sources>
  <packages>
    <package name="Anna.Index" line-rate="0.9764" branch-rate="1" complexity="39">
      <classes>
        <class name="Anna.Index.PackageIndex" filename="PackageIndex.cs" line-rate="1" branch-rate="1" complexity="1">

  <sources>
    <source>/</source>
  </sources>
  <packages>
    <package name="Anna.Storage" line-rate="0.9823999999999999" branch-rate="1" complexity="16">
      <classes>
        <class name="Anna.Storage.PackageStorage" filename="home/michael/Code/anna/Anna.Storage/PackageStorage.cs" line-rate="0.9761" branch-rate="1" complexity="12">

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

Coverlet: v6.0.2
.NET 8.0 (8.0.111)
OS: Fedora Linux 41 x64

The same behavior is observed in my ubuntu github actions runners.

Additional context
Add any other context about the problem here.

❗ Please also read Known Issues

[Bertk]

Please provide more information why this is a problem.

• Coverlet code coverage reports formats are created using ReportGenerator.Core
• Source file paths might be different by used package (coverlet.collector, coverlet.console, coverlet.msbuild.tasks)

e.g. are you using file link for source files?

<ItemGroup>
  <Compile Include="..\OtherFolder\MySharedClass.cs" Link="MySharedClass.cs" />
</ItemGroup>

[rivnakm]

The problem I see with it is that the <source> path is used by coverage reporting tools to determine the project root and display source file paths relative to that, rather than absolute paths. My configuration between projects is all identical, I set everything up at once, and the project files themselves are essentially bare minimum configurations. I'll see if I can do some testing to figure out where the issue stems from.

Anna.Index.csproj

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <TargetFramework>net8.0</TargetFramework>
        <Nullable>enable</Nullable>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="Microsoft.EntityFrameworkCore"/>
        <PackageReference Include="Microsoft.EntityFrameworkCore.Design">
            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
            <PrivateAssets>all</PrivateAssets>
        </PackageReference>
        <PackageReference Include="Microsoft.Extensions.Configuration"/>
        <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables"/>
        <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets"/>
        <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL"/>
        <PackageReference Include="NuGet.Versioning"/>
        <PackageReference Include="System.Linq.Async"/>
    </ItemGroup>

</Project>

Anna.Index.Test.csproj

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <TargetFramework>net8.0</TargetFramework>
        <Nullable>enable</Nullable>
        <IsPackable>false</IsPackable>
        <IsTestProject>true</IsTestProject>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="Microsoft.NET.Test.Sdk"/>
        <PackageReference Include="Shouldly"/>
        <PackageReference Include="TestContainers.PostgreSQL"/>
        <PackageReference Include="xunit"/>
        <PackageReference Include="xunit.runner.visualstudio">
            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
            <PrivateAssets>all</PrivateAssets>
        </PackageReference>
        <PackageReference Include="coverlet.collector">
            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
            <PrivateAssets>all</PrivateAssets>
        </PackageReference>
    </ItemGroup>

    <ItemGroup>
        <ProjectReference Include="..\Anna.Index\Anna.Index.csproj"/>
        <ProjectReference Include="..\Anna.Test.Common\Anna.Test.Common.csproj"/>
    </ItemGroup>

</Project>

Anna.Storage.csproj

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <TargetFramework>net8.0</TargetFramework>
        <Nullable>enable</Nullable>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="NuGet.Versioning"/>
        <PackageReference Include="TestableIO.System.IO.Abstractions.Wrappers"/>
    </ItemGroup>

</Project>

Anna.Storage.Test.csproj

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <TargetFramework>net8.0</TargetFramework>
        <Nullable>enable</Nullable>
        <IsPackable>false</IsPackable>
        <IsTestProject>true</IsTestProject>
    </PropertyGroup>

    <ItemGroup>
        <PackageReference Include="Microsoft.NET.Test.Sdk"/>
        <PackageReference Include="Shouldly"/>
        <PackageReference Include="TestableIO.System.IO.Abstractions.TestingHelpers"/>
        <PackageReference Include="xunit"/>
        <PackageReference Include="xunit.runner.visualstudio">
            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
            <PrivateAssets>all</PrivateAssets>
        </PackageReference>
        <PackageReference Include="coverlet.collector">
            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
            <PrivateAssets>all</PrivateAssets>
        </PackageReference>
    </ItemGroup>

    <ItemGroup>
        <ProjectReference Include="..\Anna.Storage\Anna.Storage.csproj"/>
    </ItemGroup>

</Project>

[Bertk]

Thank you for the feedback.

I found some related information. Please check.

https://stackoverflow.com/questions/71632630/coverlet-generated-coverage-cobertura-xml-empty-source-full-path-in-filename

Switch to use relative paths in OpenCover report #1315