Embed pdb instead of using snupkg (#82)

Author: meziantou

src/build/Workleap.DotNet.CodingStandards.props

@@ -6,8 +6,9 @@
     <EnableNETAnalyzers Condition="'$(EnableNETAnalyzers)' == ''">true</EnableNETAnalyzers>
     <AnalysisLevel Condition="'$(AnalysisLevel)' == ''">latest-all</AnalysisLevel>
     <EnforceCodeStyleInBuild Condition="'$(EnforceCodeStyleInBuild)' == ''">true</EnforceCodeStyleInBuild>
-    <IncludeSymbols Condition="'$(IncludeSymbols)' == ''">true</IncludeSymbols>
-    <SymbolPackageFormat Condition="'$(SymbolPackageFormat)' == ''">snupkg</SymbolPackageFormat>
+
+    <EmbedUntrackedSources Condition="'$(EmbedUntrackedSources)' == ''">true</EmbedUntrackedSources>
+    <DebugType Condition="'$(DebugType)' == ''">embedded</DebugType>
 
     <!-- Prevent warning when the .NET SDK version and the Microsoft.CodeAnalysis.NetAnalyzers version mismatch -->
     <_SkipUpgradeNetAnalyzersNuGetWarning>true</_SkipUpgradeNetAnalyzersNuGetWarning>

tests/Workleap.DotNet.CodingStandards.Tests/CodingStandardTests.cs

@@ -1,3 +1,5 @@
+using System.IO.Compression;
+using System.Reflection.PortableExecutable;
 using Workleap.DotNet.CodingStandards.Tests.Helpers;
 using Xunit.Abstractions;
 
@@ -142,6 +144,7 @@ public async Task ReportVulnerablePackage_Debug_ShouldReportWarning()
         Assert.False(data.HasError("NU1903"));
         Assert.True(data.HasWarning("NU1903"));
     }
+
     [Fact]
     public async Task ReportVulnerablePackage_DisabledWarningOnPackage()
     {
@@ -170,4 +173,80 @@ public async Task ReportVulnerablePackage_DisabledWarningOnPackage()
         Assert.False(data.HasError("NU1903"));
         Assert.False(data.HasWarning("NU1903"));
     }
+
+    [Fact]
+    public async Task PdbShouldBeEmbedded_Dotnet_Build()
+    {
+        using var project = new ProjectBuilder(fixture, testOutputHelper);
+        project.AddFile("test.csproj", $"""
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>net8.0</TargetFramework>
+                    <ImplicitUsings>enable</ImplicitUsings>
+                    <Nullable>enable</Nullable>
+                    <ErrorLog>{ProjectBuilder.SarifFileName},version=2.1</ErrorLog>
+                    <RootNamespace>Foo</RootNamespace>
+                  </PropertyGroup>
+                  
+                  <ItemGroup>
+                    <PackageReference Include="Workleap.DotNet.CodingStandards" Version="*" />
+                  </ItemGroup>
+                </Project>
+                """);
+
+        project.AddFile("Sample.cs", """
+            namespace Foo;
+            public static class Sample { }
+            """);
+        var data = await project.BuildAndGetOutput(["--configuration", "Release"]);
+
+        var outputFiles = Directory.GetFiles(Path.Combine(project.RootFolder, "bin", "Release", "net8.0"));
+        await AssertPdbIsEmbedded(outputFiles);
+    }
+
+    [Fact]
+    public async Task PdbShouldBeEmbedded_Dotnet_Pack()
+    {
+        using var project = new ProjectBuilder(fixture, testOutputHelper);
+        project.AddFile("test.csproj", $"""
+                <Project Sdk="Microsoft.NET.Sdk">
+                  <PropertyGroup>
+                    <TargetFramework>net8.0</TargetFramework>
+                    <ImplicitUsings>enable</ImplicitUsings>
+                    <Nullable>enable</Nullable>
+                    <ErrorLog>{ProjectBuilder.SarifFileName},version=2.1</ErrorLog>
+                    <RootNamespace>Foo</RootNamespace>
+                  </PropertyGroup>
+                  
+                  <ItemGroup>
+                    <PackageReference Include="Workleap.DotNet.CodingStandards" Version="*" />
+                  </ItemGroup>
+                </Project>
+                """);
+
+        project.AddFile("Sample.cs", """
+            namespace Foo;
+            public static class Sample { }
+            """);
+        var data = await project.PackAndGetOutput(["--configuration", "Release"]);
+
+        var extractedPath = Path.Combine(project.RootFolder, "extracted");
+        var files = Directory.GetFiles(Path.Combine(project.RootFolder, "bin", "Release"));
+        Assert.Single(files); // Only the .nupkg should be generated
+        var nupkg = files.Single(f => f.EndsWith(".nupkg", StringComparison.OrdinalIgnoreCase));
+        ZipFile.ExtractToDirectory(nupkg, extractedPath);
+
+        var outputFiles = Directory.GetFiles(extractedPath, "*", SearchOption.AllDirectories);
+        await AssertPdbIsEmbedded(outputFiles);
+    }
+
+    private static async Task AssertPdbIsEmbedded(string[] outputFiles)
+    {
+        Assert.DoesNotContain(outputFiles, f => f.EndsWith(".pdb", StringComparison.OrdinalIgnoreCase));
+        var dllPath = outputFiles.Single(f => f.EndsWith(".dll", StringComparison.OrdinalIgnoreCase));
+        await using var stream = File.OpenRead(dllPath);
+        var peReader = new PEReader(stream);
+        var debug = peReader.ReadDebugDirectory();
+        Assert.Contains(debug, entry => entry.Type == DebugDirectoryEntryType.EmbeddedPortablePdb);
+    }
 }

tests/Workleap.DotNet.CodingStandards.Tests/Helpers/ProjectBuilder.cs

@@ -13,6 +13,8 @@ internal sealed class ProjectBuilder : IDisposable
     private readonly TemporaryDirectory _directory;
     private readonly ITestOutputHelper _testOutputHelper;
 
+    public string RootFolder => this._directory.FullPath;
+
     public ProjectBuilder(PackageFixture fixture, ITestOutputHelper testOutputHelper)
     {
         this._testOutputHelper = testOutputHelper;
@@ -92,11 +94,21 @@ public void AddCsprojFile(Dictionary<string, string>? properties = null, Diction
         File.WriteAllText(this._directory.GetPath("test.csproj"), content);
     }
 
-    public async Task<SarifFile> BuildAndGetOutput(string[]? buildArguments = null)
+    public Task<SarifFile> BuildAndGetOutput(string[]? buildArguments = null)
+    {
+        return this.ExecuteDotnetCommandAndGetOutput("build", buildArguments);
+    }
+
+    public Task<SarifFile> PackAndGetOutput(string[]? buildArguments = null)
+    {
+        return this.ExecuteDotnetCommandAndGetOutput("pack", buildArguments);
+    }
+
+    private async Task<SarifFile> ExecuteDotnetCommandAndGetOutput(string command, string[]? buildArguments = null)
     {
         var result = await Cli.Wrap("dotnet")
             .WithWorkingDirectory(this._directory.FullPath)
-            .WithArguments(["build", .. (buildArguments ?? [])])
+            .WithArguments([command, .. (buildArguments ?? [])])
             .WithEnvironmentVariables(env => env.Set("CI", null).Set("GITHUB_ACTIONS", null))
             .WithStandardOutputPipe(PipeTarget.ToDelegate(this._testOutputHelper.WriteLine))
             .WithStandardErrorPipe(PipeTarget.ToDelegate(this._testOutputHelper.WriteLine))