[Bug]: SourceRoot items added in .nuget.g.props files do not take NuGetPackageFolders property in consideration

[tmat]

NuGet Product Used

dotnet.exe

Product Version

6.0.100

Worked before?

Yes

Impact

It's more difficult to complete my work

Repro Steps & Context

Below is the relevant part of the generated props file. Setting NuGetPackageFolders will not have any effect on the generated SourceRoot items. Shouldn't these be consistent?

  <PropertyGroup Condition=" '$(ExcludeRestorePackageImports)' != 'true' ">
    <NuGetPackageFolders Condition=" '$(NuGetPackageFolders)' == '' ">C:\Test\.packages;C:\Program Files (x86)\Microsoft Visual Studio\Shared\NuGetPackages;C:\Program Files (x86)\Microsoft\Xamarin\NuGet\;C:\Program Files\dotnet\sdk\NuGetFallbackFolder</NuGetPackageFolders>
  </PropertyGroup>
  <ItemGroup Condition=" '$(ExcludeRestorePackageImports)' != 'true' ">
    <SourceRoot Include="C:\Test\.packages\" />
    <SourceRoot Include="C:\Program Files (x86)\Microsoft Visual Studio\Shared\NuGetPackages\" />
    <SourceRoot Include="C:\Program Files (x86)\Microsoft\Xamarin\NuGet\" />
    <SourceRoot Include="C:\Program Files\dotnet\sdk\NuGetFallbackFolder\" />
  </ItemGroup>

Verbose Logs

No response

[nkolev92]

NuGetPackageFolders is not something you should be setting, it's something that only NuGet sets.

I think this is by design.

[tmat]

I need to set it to establish deterministic test environment. If NuGet sets NuGetPackageFolders then it will still be inconsistent with SourceRoots, no?

[tmat]

Why not generate a simpler XML (note that the items in NuGetPackageFolders must have trailing \ to be valid SourceRoot entries)?

  <PropertyGroup Condition=" '$(ExcludeRestorePackageImports)' != 'true' ">
    <NuGetPackageFolders Condition=" '$(NuGetPackageFolders)' == '' ">C:\Test\.packages\;C:\Program Files (x86)\Microsoft Visual Studio\Shared\NuGetPackages\;C:\Program Files (x86)\Microsoft\Xamarin\NuGet\;C:\Program Files\dotnet\sdk\NuGetFallbackFolder\</NuGetPackageFolders>
  </PropertyGroup>
  <ItemGroup Condition=" '$(ExcludeRestorePackageImports)' != 'true' ">
    <SourceRoot Include="@(NuGetPackageFolders)" />
  </ItemGroup>

[nkolev92]

I need to set it to establish deterministic test environment. If NuGet sets NuGetPackageFolders then it will still be inconsistent with SourceRoots, no?

NuGet sets those 2 based on the global packages folder and fallback folders passed into that environment.

Why not generate a simpler XML (note that the items in NuGetPackageFolders must have trailing \ to be valid SourceRoot entries)?

It's not done because of #7968.

When the original implementation was done to avoid the lack of trailing slashes cause issues in SourceRoot.

[tmat]

NuGet sets those 2 based on the global packages folder and fallback folders passed into that environment.

Which environment variables/msbuild properties can I set to control all these directories?

When the original implementation was done to avoid the lack of trailing slashes cause issues in SourceRoot.

This should work if paths in NuGetPackageFolders don't have normalized trailing slash:

<SourceRoot Include="@(NuGetPackageFolders->'$([MSBuild]::EnsureTrailingSlash(`%(NuGetPackageFolders)`))')" />