CSHARP-2088: Publish PDBs and sources on symbolsource. (#694)

CSHARP-2088: Publish PDBs and sources on symbolsource.

Author: DmitryLukyanov

build.cake

@@ -8,6 +8,7 @@ using System;
 using System.Text.RegularExpressions;
 using System.Linq;
 using Cake.Common.Tools.DotNetCore.DotNetCoreVerbosity;
+using Path = Cake.Core.IO.Path;
 
 const string defaultTarget = "Default";
 var target = Argument("target", defaultTarget);
@@ -65,7 +66,7 @@ Task("Restore")
 
 Task("Build")
     .IsDependentOn("Restore")
-    .Does(() =>
+    .Does<BuildConfig>((buildConfig) =>
     {
        var settings = new DotNetCoreBuildSettings
        {
@@ -77,6 +78,14 @@ Task("Build")
                { "SourceRevisionId", gitVersion.Sha }
            }
         };
+
+        if (buildConfig.IsReleaseMode)
+        {
+            Console.WriteLine("Build continuousIntegration is enabled");
+            settings.MSBuildSettings = new DotNetCoreMSBuildSettings();
+            // configure deterministic build for better compatibility with debug symbols (used in Package/Build tasks). Affects: *.nupkg
+            settings.MSBuildSettings.SetContinuousIntegrationBuild(continuousIntegrationBuild: true);
+        }
         DotNetCoreBuild(solutionFullPath, settings);
     });
 
@@ -122,9 +131,8 @@ Task("BuildArtifacts")
 Task("Test")
     .IsDependentOn("Build")
     .DoesForEach(
-        GetFiles("./**/*.Tests.csproj")
-        .Where(name => !name.ToString().Contains("Atlas")),
-        testProject =>
+        items: GetFiles("./**/*.Tests.csproj").Where(name => !name.ToString().Contains("Atlas")),
+        action: (BuildConfig buildConfig, Path testProject) =>
     {
         if (Environment.GetEnvironmentVariable("MONGODB_API_VERSION") != null &&
             testProject.ToString().Contains("Legacy"))
@@ -159,14 +167,10 @@ Task("Test")
             NoRestore = true,
             Configuration = configuration,
             Loggers = CreateLoggers(),
-            ArgumentCustomization = args => args.Append("-- RunConfiguration.TargetPlatform=x64")
+            ArgumentCustomization = args => args.Append("-- RunConfiguration.TargetPlatform=x64"),
+            Framework = buildConfig.Framework
         };
-        switch (target.ToLowerInvariant()) // target can be not only moniker related
-        {
-            case "testnet472": settings.Framework = "net472"; break;
-            case "testnetstandard20": settings.Framework = "netcoreapp2.1"; break;
-            case "testnetstandard21": settings.Framework = "netcoreapp3.1"; break;
-        }
+
         DotNetCoreTest(
             testProject.FullPath,
             settings
@@ -315,24 +319,19 @@ Task("TestOcsp")
 Task("TestGssapi")
     .IsDependentOn("Build")
     .DoesForEach(
-        GetFiles("./**/MongoDB.Driver.Tests.csproj"),
-        testProject =>
+        items: GetFiles("./**/MongoDB.Driver.Tests.csproj"),
+        action: (BuildConfig buildConfig, Path testProject) =>
     {
         var settings = new DotNetCoreTestSettings
         {
             NoBuild = true,
             NoRestore = true,
             Configuration = configuration,
             ArgumentCustomization = args => args.Append("-- RunConfiguration.TargetPlatform=x64"),
-            Filter = "Category=\"GssapiMechanism\""
+            Filter = "Category=\"GssapiMechanism\"",
+            Framework = buildConfig.Framework
         };
 
-        switch (target.ToLowerInvariant()) // target can be not only moniker related
-        {
-            case "testgssapinet472": settings.Framework = "net472"; break;
-            case "testgssapinetstandard20": settings.Framework = "netcoreapp2.1"; break;
-            case "testgssapinetstandard21": settings.Framework = "netcoreapp3.1"; break;
-        }
         DotNetCoreTest(
             testProject.FullPath,
             settings
@@ -346,23 +345,19 @@ Task("TestGssapiNetStandard21").IsDependentOn("TestGssapi");
 Task("TestServerless")
     .IsDependentOn("Build")
     .DoesForEach(
-        GetFiles("./**/MongoDB.Driver.Tests.csproj"),
-        testProject =>
+        items: GetFiles("./**/MongoDB.Driver.Tests.csproj"),
+        action: (BuildConfig buildConfig, Path testProject) =>
         {
             var settings = new DotNetCoreTestSettings
             {
                 NoBuild = true,
                 NoRestore = true,
                 Configuration = configuration,
                 ArgumentCustomization = args => args.Append("-- RunConfiguration.TargetPlatform=x64"),
-                Filter = "Category=\"Serverless\""
+                Filter = "Category=\"Serverless\"",
+                Framework = buildConfig.Framework
             };
-            switch (target.ToLowerInvariant()) // target can be not only moniker related
-            {
-                case "testserverlessnet472": settings.Framework = "net472"; break;
-                case "testserverlessnetstandard20": settings.Framework = "netcoreapp2.1"; break;
-                case "testserverlessnetstandard21": settings.Framework = "netcoreapp3.1"; break;
-            }
+
             DotNetCoreTest(
                 testProject.FullPath,
                 settings
@@ -376,24 +371,19 @@ Task("TestServerlessNetStandard21").IsDependentOn("TestServerless");
 Task("TestLoadBalanced")
     .IsDependentOn("Build")
     .DoesForEach(
-        GetFiles("./**/*.Tests.csproj"),
-        testProject =>
+        items: GetFiles("./**/*.Tests.csproj"),
+        action: (BuildConfig buildConfig, Path testProject) =>
      {
         var settings = new DotNetCoreTestSettings
         {
             NoBuild = true,
             NoRestore = true,
             Configuration = configuration,
             ArgumentCustomization = args => args.Append("-- RunConfiguration.TargetPlatform=x64"),
-            Filter = "Category=\"SupportLoadBalancing\""
+            Filter = "Category=\"SupportLoadBalancing\"",
+            Framework = buildConfig.Framework
         };
 
-        switch (target.ToLowerInvariant()) // target can be not only moniker related
-        {
-            case "testloadbalancednetstandard20": settings.Framework = "netcoreapp2.1"; break;
-            case "testloadbalancednetstandard21": settings.Framework = "netcoreapp3.1"; break;
-        }
-
         DotNetCoreTest(
             testProject.FullPath,
             settings
@@ -406,8 +396,8 @@ Task("TestLoadBalancedNetStandard21").IsDependentOn("TestLoadBalanced");
 Task("TestCsfleWithMockedKms")
     .IsDependentOn("Build")
     .DoesForEach(
-        GetFiles("./**/*.Tests.csproj"),
-        testProject =>
+        items: GetFiles("./**/*.Tests.csproj"),
+        action: (BuildConfig buildConfig, Path testProject) =>
     {
         var settings = new DotNetCoreTestSettings
         {
@@ -416,16 +406,10 @@ Task("TestCsfleWithMockedKms")
             Configuration = configuration,
             Loggers = CreateLoggers(),
             ArgumentCustomization = args => args.Append("-- RunConfiguration.TargetPlatform=x64"),
-            Filter = "Category=\"CSFLE\""
+            Filter = "Category=\"CSFLE\"",
+            Framework = buildConfig.Framework
         };
 
-        switch (target.ToLowerInvariant()) // target can be not only moniker related
-        {
-            case "testcsflewithmockedkmsnet472": settings.Framework = "net472"; break;
-            case "testcsflewithmockedkmsnetstandard20": settings.Framework = "netcoreapp2.1"; break;
-            case "testcsflewithmockedkmsnetstandard21": settings.Framework = "netcoreapp3.1"; break;
-        }
-
         DotNetCoreTest(
             testProject.FullPath,
             settings
@@ -535,9 +519,11 @@ Task("PackageNugetPackages")
             {
                 Configuration = configuration,
                 OutputDirectory = artifactsPackagesDirectory,
-                NoBuild = true,
+                NoBuild = true, // SetContinuousIntegrationBuild is enabled for nupkg on the Build step
                 IncludeSymbols = true,
                 MSBuildSettings = new DotNetCoreMSBuildSettings()
+                    // configure deterministic build for better compatibility with debug symbols (used in Package/Build tasks). Affects: *.snupkg
+                    .SetContinuousIntegrationBuild(continuousIntegrationBuild: true) 
                     .WithProperty("PackageVersion", gitVersion.LegacySemVer)
             };
             DotNetCorePack(projectPath, settings);
@@ -798,8 +784,36 @@ Task("TestsPackaging")
     })
     .DeferOnError();
 
+Setup<BuildConfig>(
+    setupContext => 
+    {
+        var lowerTarget = target.ToLowerInvariant();
+        var framework = lowerTarget switch
+        {
+            string s when s.StartsWith("test") && s.EndsWith("net472") => "net472",
+            string s when s.StartsWith("test") && s.EndsWith("netstandard20") => "netcoreapp2.1",
+            string s when s.StartsWith("test") && s.EndsWith("netstandard21") => "netcoreapp3.1",
+            _ => null
+        };
+        var isReleaseMode = lowerTarget.StartsWith("package") || lowerTarget == "release";
+        Console.WriteLine($"Framework: {framework ?? "null (not set)"}, IsReleaseMode: {isReleaseMode}");
+        return new BuildConfig(isReleaseMode, framework);
+    });
+
 RunTarget(target);
 
+public class BuildConfig
+{
+    public bool IsReleaseMode { get; }
+    public string Framework { get; }
+
+    public BuildConfig(bool isReleaseMode, string framework)
+    {
+        IsReleaseMode = isReleaseMode;
+        Framework = framework;
+    }
+}
+
 string[] CreateLoggers()
 {
     var testResultsFile = outputDirectory.Combine("test-results").Combine($"TEST-{target.ToLowerInvariant()}-{DateTimeOffset.UtcNow.ToUnixTimeMilliseconds()}.xml");

build.config

@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
-CAKE_VERSION=1.2.0
+CAKE_VERSION=1.3.0
 DOTNET_VERSION=5.0.401

src/MongoDB.Bson/MongoDB.Bson.csproj

@@ -27,6 +27,8 @@
     <PackageTags>mongodb;mongo;nosql;bson</PackageTags>
     <PackageLanguage>en-US</PackageLanguage>
     <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Version)'==''">
@@ -48,6 +50,10 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.2" PrivateAssets="All" />
     <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="5.0.0" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <ItemGroup>

src/MongoDB.Driver.Core/MongoDB.Driver.Core.csproj

@@ -28,6 +28,8 @@
     <PackageTags>mongodb;mongo;nosql</PackageTags>
     <PackageLanguage>en-US</PackageLanguage>
     <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
   </PropertyGroup>
 
   <ItemGroup>
@@ -178,6 +180,10 @@
     <PackageReference Include="MongoDB.Libmongocrypt" Version="1.3.0" />
     <PackageReference Include="SharpCompress" Version="0.30.1" />
     <PackageReference Include="System.Buffers" Version="4.5.1" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net472'">

src/MongoDB.Driver.GridFS/MongoDB.Driver.GridFS.csproj

@@ -27,6 +27,8 @@
     <PackageTags>mongodb;mongo;nosql;gridfs</PackageTags>
     <PackageLanguage>en-US</PackageLanguage>
     <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Version)'==''">
@@ -47,6 +49,10 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.2" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <ItemGroup>

src/MongoDB.Driver.Legacy/MongoDB.Driver.Legacy.csproj

@@ -28,6 +28,8 @@
     <PackageTags></PackageTags>
     <PackageLanguage>en-US</PackageLanguage>
     <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Version)'==''">
@@ -36,6 +38,10 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" PrivateAssets="All" Version="1.0.0" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <PropertyGroup>

src/MongoDB.Driver/MongoDB.Driver.csproj

@@ -27,6 +27,8 @@
     <PackageTags>mongodb;mongo;nosql</PackageTags>
     <PackageLanguage>en-US</PackageLanguage>
     <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Version)'==''">
@@ -47,6 +49,10 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.6.2" PrivateAssets="All" />
     <PackageReference Include="MongoDB.Libmongocrypt" Version="1.3.0" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
 
   <ItemGroup>

tools/packages.config

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-    <package id="Cake" version="1.1.0" />
+    <package id="Cake" version="1.3.0" />
 </packages>