Merge pull request #522 from qmfrederik/features/unit-test-netcoreapp-3.1

Support unit testing NB.GV on Ubuntu 20.04/.NET 3.1

Author: AArnott

azure-pipelines.yml

@@ -14,11 +14,13 @@ resources:
   containers:
   - container: xenial
     image: andrewarnott/linux-buildagent
-  - container: bionic
+  - container: bionic-2.1
     image: microsoft/dotnet:2.1-sdk-bionic
-  - container: bionic-3.0
-    image: mcr.microsoft.com/dotnet/core/sdk:3.0-bionic
-  - container: disco
+  - container: bionic
+    image: mcr.microsoft.com/dotnet/core/sdk:3.1-bionic
+  - container: focal
+    image: mcr.microsoft.com/dotnet/core/sdk:3.1-focal
+  - container: disco-3.0
     image: mcr.microsoft.com/dotnet/core/sdk:3.0-disco
   - container: archlinux
     image: andrewarnott/archlinux
@@ -32,10 +34,20 @@ variables:
 stages:
 - stage: Build
   jobs:
-  - job: Windows
-    pool: Hosted Windows 2019 with VS2019
+  - job: Build
+    strategy:
+      matrix:
+        linux:
+          imageName: 'ubuntu-20.04'
+          testModifier: -f netcoreapp3.1
+        windows:
+          imageName: 'windows-2019'
+          testModifier:
     variables:
-    - group: dotnetfoundation code signing
+    - ${{ if eq(variables['System.TeamFoundationCollectionUri'], 'https://dev.azure.com/andrewarnott/') }}:
+      - group: dotnetfoundation code signing
+    pool:
+      vmImage: $(imageName)
     steps:
     - checkout: self
       clean: true
@@ -53,9 +65,9 @@ stages:
     - script: dotnet --info
       displayName: Show dotnet SDK info
 
-    - script: |
+    - pwsh: |
         dotnet tool install --tool-path . nbgv
-        .\nbgv cloud -a
+        ./nbgv cloud -a
       displayName: Set build number
 
     - task: DotNetCoreCLI@2
@@ -68,27 +80,27 @@ stages:
         nugetConfigPath: src/nuget.config
         workingDirectory: src
 
-    - task: geeklearningio.gl-vsts-tasks-yarn.yarn-installer-task.YarnInstaller@2
+    - task: YarnInstaller@3
       displayName: 'Use Yarn 1.x'
-    - task: geeklearningio.gl-vsts-tasks-yarn.yarn-task.Yarn@2
+    - task: Yarn@3
       displayName: 'Yarn install'
       inputs:
-        ProjectDirectory: 'src/nerdbank-gitversioning.npm'
+        projectDirectory: 'src/nerdbank-gitversioning.npm'
 
     - script: dotnet build -c $(BuildConfiguration) --no-restore /t:build,pack /bl:"$(Build.ArtifactStagingDirectory)/build_logs/msbuild.binlog"
       displayName: Build NuGet package and tests
       workingDirectory: src
 
-    - script: dotnet publish -c $(BuildConfiguration) -o ..\nerdbank-gitversioning.npm\out\nbgv.cli\tools\netcoreapp2.1\any /bl:"$(Build.ArtifactStagingDirectory)/build_logs/nbgv_publish.binlog"
+    - script: dotnet publish -c $(BuildConfiguration) -o ../nerdbank-gitversioning.npm/out/nbgv.cli/tools/netcoreapp2.1/any /bl:"$(Build.ArtifactStagingDirectory)/build_logs/nbgv_publish.binlog"
       displayName: Publish nbgv tool
-      workingDirectory: src\nbgv
+      workingDirectory: src/nbgv
 
     - task: gulp@0
       displayName: Build nerdbank-gitversioning NPM package
       inputs:
-        gulpfile: src\nerdbank-gitversioning.npm\gulpfile.js
+        gulpfile: src/nerdbank-gitversioning.npm/gulpfile.js
 
-    - script: dotnet test Nerdbank.GitVersioning.Tests --no-build -c $(BuildConfiguration) --filter "TestCategory!=FailsOnAzurePipelines" --logger "trx;LogFileName=$(Build.ArtifactStagingDirectory)\TestLogs\TestResults.trx"
+    - script: dotnet test NerdBank.GitVersioning.Tests --no-build $(testModifier) -c $(BuildConfiguration) --filter "TestCategory!=FailsOnAzurePipelines" --logger "trx;LogFileName=$(Build.ArtifactStagingDirectory)/TestLogs/TestResults.trx"
       displayName: Run tests
       workingDirectory: src
 
@@ -97,7 +109,7 @@ stages:
       inputs:
         testResultsFormat: VSTest
         testResultsFiles: '*.trx'
-        searchFolder: $(Build.ArtifactStagingDirectory)\TestLogs
+        searchFolder: $(Build.ArtifactStagingDirectory)/TestLogs
         buildPlatform: $(BuildPlatform)
         buildConfiguration: $(BuildConfiguration)
       condition: always()
@@ -125,14 +137,17 @@ stages:
         --name 'Nerdbank.GitVersioning'
         --descriptionUrl 'https://github.com/dotnet/Nerdbank.GitVersioning'
       displayName: Code sign
-      condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))
+      condition: and(succeeded(), eq(variables['System.TeamFoundationCollectionUri'], 'https://dev.azure.com/andrewarnott/'), eq(variables['Agent.OS'], 'Windows_NT'), ne(variables['Build.Reason'], 'PullRequest'))
 
     - task: PublishBuildArtifacts@1
       inputs:
         PathtoPublish: $(Build.ArtifactStagingDirectory)/deployables
         ArtifactName: deployables
         ArtifactType: Container
       displayName: Publish deployables artifacts
+      # Only deploy when from a single build in the build matrix
+      condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'))
+
     - task: PublishBuildArtifacts@1
       inputs:
         PathtoPublish: $(Build.ArtifactStagingDirectory)/build_logs
@@ -148,23 +163,23 @@ stages:
         nuGetFeedType: internal
         publishVstsFeed: OSS/PublicCI
         allowPackageConflicts: true
-      condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))
+      condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['System.TeamFoundationCollectionUri'], 'https://dev.azure.com/andrewarnott/'), ne(variables['Build.Reason'], 'PullRequest'))
 
     - pwsh: Set-Content -Path "$(Agent.TempDirectory)/.npmrc" -Value "registry=https://pkgs.dev.azure.com/andrewarnott/OSS/_packaging/PublicCI/npm/registry/`nalways-auth=true"
       displayName: Prepare to push to PublicCI
-      condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))
+      condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['System.TeamFoundationCollectionUri'], 'https://dev.azure.com/andrewarnott/'), ne(variables['Build.Reason'], 'PullRequest'))
     - task: npmAuthenticate@0
       displayName: Authenticate to PublicCI
       inputs:
         workingFile: $(Agent.TempDirectory)/.npmrc
-      condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))
+      condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['System.TeamFoundationCollectionUri'], 'https://dev.azure.com/andrewarnott/'), ne(variables['Build.Reason'], 'PullRequest'))
     - pwsh: |
         $tgz = (Get-ChildItem "$(Build.ArtifactStagingDirectory)/deployables/*.tgz")[0].FullName
         Write-Host "Will publish $tgz"
         npm publish $tgz
       workingDirectory: $(Agent.TempDirectory)
       displayName: npm publish to PublicCI feed
-      condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest'))
+      condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['System.TeamFoundationCollectionUri'], 'https://dev.azure.com/andrewarnott/'), ne(variables['Build.Reason'], 'PullRequest'))
 
 - stage: Test
   jobs:
@@ -177,24 +192,31 @@ stages:
       displayName: Install git
     - template: azure-pipelines/xplattest-pipeline.yml
 
+  - job: Ubuntu_Bionic_2_1
+    pool:
+      vmImage: Ubuntu 16.04 # not a bug. we always use this pool, but use containers for the specific version
+    container: bionic-2.1
+    steps:
+    - template: azure-pipelines/xplattest-pipeline.yml
+
   - job: Ubuntu_Bionic
     pool:
       vmImage: Ubuntu 16.04 # not a bug. we always use this pool, but use containers for the specific version
     container: bionic
     steps:
     - template: azure-pipelines/xplattest-pipeline.yml
 
-  - job: Ubuntu_Bionic_3_0
+  - job: Ubuntu_Focal
     pool:
       vmImage: Ubuntu 16.04 # not a bug. we always use this pool, but use containers for the specific version
-    container: bionic-3.0
+    container: focal
     steps:
     - template: azure-pipelines/xplattest-pipeline.yml
 
-  - job: Ubuntu_Disco
+  - job: Ubuntu_Disco_3_0
     pool:
       vmImage: Ubuntu 16.04 # not a bug. we always use this pool, but use containers for the specific version
-    container: disco
+    container: disco-3.0
     steps:
     - template: azure-pipelines/xplattest-pipeline.yml
 

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -742,7 +742,9 @@ public async Task PublicRelease_RegEx_SatisfiedByCheckedOutBranch()
         }
     }
 
-    [Theory]
+    // This test builds projects using 'classic' MSBuild projects, which target net45.
+    // This is not supported on Linux.
+    [WindowsTheory]
     [PairwiseData]
     public async Task AssemblyInfo(bool isVB, bool includeNonVersionAttributes, bool gitRepo, bool isPrerelease, bool isPublicRelease)
     {
@@ -844,7 +846,11 @@ public async Task AssemblyInfo_HasKeyData(string keyFile, bool delaySigned)
 
         this.WriteVersionFile();
         var result = await this.BuildAsync(Targets.GenerateAssemblyVersionInfo, logVerbosity: LoggerVerbosity.Minimal);
-        string versionCsContent = File.ReadAllText(Path.Combine(this.projectDirectory, result.BuildResult.ProjectStateAfterBuild.GetPropertyValue("VersionSourceFile")));
+        string versionCsContent = File.ReadAllText(
+            Path.GetFullPath(
+                Path.Combine(
+                    this.projectDirectory,
+                    result.BuildResult.ProjectStateAfterBuild.GetPropertyValue("VersionSourceFile"))));
         this.Logger.WriteLine(versionCsContent);
 
         var sourceFile = CSharpSyntaxTree.ParseText(versionCsContent);
@@ -1152,7 +1158,7 @@ private ProjectRootElement CreateProjectRootElement(string projectDirectory, str
     private void MakeItAVBProject()
     {
         var csharpImport = this.testProject.Imports.Single(i => i.Project.Contains("CSharp"));
-        csharpImport.Project = @"$(MSBuildToolsPath)\Microsoft.VisualBasic.targets";
+        csharpImport.Project = "$(MSBuildToolsPath)/Microsoft.VisualBasic.targets";
         var isVbProperty = this.testProject.Properties.Single(p => p.Name == "IsVB");
         isVbProperty.Value = "true";
     }

src/NerdBank.GitVersioning.Tests/FilterPathTests.cs

@@ -14,24 +14,30 @@ public class FilterPathTests
     [InlineData("../../some/dir/here", "foo/multi/wow", "foo/some/dir/here")]
     [InlineData("relativepath.txt", "foo", "foo/relativepath.txt")]
     [InlineData("./relativepath.txt", "foo", "foo/relativepath.txt")]
-    [InlineData("./dir\\hi/relativepath.txt", "foo", "foo/dir/hi/relativepath.txt")]
-    [InlineData(".\\relativepath.txt", "foo", "foo/relativepath.txt")]
     [InlineData(":^relativepath.txt", "foo", "foo/relativepath.txt")]
     [InlineData(":!relativepath.txt", "foo", "foo/relativepath.txt")]
     [InlineData(":!/absolutepath.txt", "foo", "absolutepath.txt")]
-    [InlineData(":!\\absolutepath.txt", "foo", "absolutepath.txt")]
     [InlineData("../bar/relativepath.txt", "foo", "bar/relativepath.txt")]
     [InlineData("/", "foo", "")]
     [InlineData("/absolute/file.txt", "foo", "absolute/file.txt")]
     [InlineData(":/", "foo", "")]
     [InlineData(":/absolutepath.txt", "foo", "absolutepath.txt")]
     [InlineData(":/bar/absolutepath.txt", "foo", "bar/absolutepath.txt")]
-    [InlineData(":\\bar\\absolutepath.txt", "foo", "bar/absolutepath.txt")]
     public void CanBeParsedToRepoRelativePath(string pathSpec, string relativeTo, string expected)
     {
         Assert.Equal(expected, new FilterPath(pathSpec, relativeTo).RepoRelativePath);
     }
 
+    [WindowsTheory]
+    [InlineData("./dir\\hi/relativepath.txt", "foo", "foo/dir/hi/relativepath.txt")]
+    [InlineData(".\\relativepath.txt", "foo", "foo/relativepath.txt")]
+    [InlineData(":!\\absolutepath.txt", "foo", "absolutepath.txt")]
+    [InlineData(":\\bar\\absolutepath.txt", "foo", "bar/absolutepath.txt")]
+    public void CanBeParsedToRepoRelativePath_WindowsOnly(string pathSpec, string relativeTo, string expected)
+    {
+        Assert.Equal(expected, new FilterPath(pathSpec, relativeTo).RepoRelativePath);
+    }
+
     [Theory]
     [InlineData(":!.", "foo", "foo")]
     [InlineData(":!.", "foo", "foo/")]

src/NerdBank.GitVersioning.Tests/GitExtensionsTests.cs

@@ -529,10 +529,10 @@ public void GetIdAsVersion_ReadsMajorMinorFromVersionTxt()
     [Fact]
     public void GetIdAsVersion_ReadsMajorMinorFromVersionTxtInSubdirectory()
     {
-        this.WriteVersionFile("4.8", relativeDirectory: @"foo\bar");
+        this.WriteVersionFile("4.8", relativeDirectory: "foo/bar");
         var firstCommit = this.Repo.Commits.First();
 
-        Version v1 = firstCommit.GetIdAsVersion(@"foo\bar");
+        Version v1 = firstCommit.GetIdAsVersion("foo/bar");
         Assert.Equal(4, v1.Major);
         Assert.Equal(8, v1.Minor);
     }

src/NerdBank.GitVersioning.Tests/LibGit2Loader.cs

@@ -0,0 +1,80 @@
+#if NETCOREAPP
+using System;
+using System.IO;
+using System.Reflection;
+using System.Runtime.InteropServices;
+using LibGit2Sharp;
+using Nerdbank.GitVersioning;
+using RuntimeEnvironment = Microsoft.DotNet.PlatformAbstractions.RuntimeEnvironment;
+
+public static class LibGit2Loader
+{
+    public static string RuntimePath = "./runtimes";
+
+    static LibGit2Loader()
+    {
+        NativeLibrary.SetDllImportResolver(typeof(Repository).Assembly, ImportResolver);
+    }
+
+    public static void EnsureRegistered()
+    {
+        // No-op, only here to ensure the static constructor is triggered
+    }
+
+    private static IntPtr ImportResolver(string libraryName, Assembly assembly, DllImportSearchPath? searchPath)
+    {
+        IntPtr handle = IntPtr.Zero;
+
+        if (libraryName.StartsWith("git2-", StringComparison.Ordinal) ||
+            libraryName.StartsWith("libgit2-", StringComparison.Ordinal))
+        {
+            var directory = GetNativeLibraryDirectory();
+            var extension = GetNativeLibraryExtension();
+
+            if (!libraryName.EndsWith(extension, StringComparison.Ordinal))
+            {
+                libraryName += extension;
+            }
+
+            var nativeLibraryPath = Path.Combine(directory, libraryName);
+            if (!File.Exists(nativeLibraryPath))
+            {
+                nativeLibraryPath = Path.Combine(directory, "lib" + libraryName);
+            }
+
+            if (!NativeLibrary.TryLoad(nativeLibraryPath, assembly, DllImportSearchPath.System32, out handle))
+            {
+                throw new NotImplementedException($"No support for loading {libraryName} at {nativeLibraryPath}");
+            }
+        }
+
+        return handle;
+    }
+
+    private static string GetNativeLibraryDirectory()
+    {
+        var dir = Path.GetDirectoryName(typeof(Repository).Assembly.Location);
+        return Path.Combine(dir, RuntimePath, RuntimeIdMap.GetNativeLibraryDirectoryName(RuntimeEnvironment.GetRuntimeIdentifier()), "native");
+    }
+
+    private static string GetNativeLibraryExtension()
+    {
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+        {
+            return ".dll";
+        }
+
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+        {
+            return ".dylib";
+        }
+
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+        {
+            return ".so";
+        }
+
+        throw new PlatformNotSupportedException();
+    }
+}
+#endif

src/NerdBank.GitVersioning.Tests/NerdBank.GitVersioning.Tests.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net461;netcoreapp3.1</TargetFrameworks>
+    <TargetFrameworks>netcoreapp3.1;net461</TargetFrameworks>
     <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
     <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
     <DebugType>full</DebugType>
@@ -47,7 +47,4 @@
     </PackageReference>
     <PackageReference Include="Xunit.SkippableFact" Version="1.3.12" />
   </ItemGroup>
-  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp2.0'">
-    <PackageReference Include="System.Runtime.Loader" Version="4.3.0" />
-  </ItemGroup>
 </Project>

src/NerdBank.GitVersioning.Tests/RepoTestBase.cs

@@ -1,10 +1,6 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.IO;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 using LibGit2Sharp;
 using Nerdbank.GitVersioning;
 using Validation;
@@ -16,6 +12,10 @@ public abstract class RepoTestBase : IDisposable
 
     public RepoTestBase(ITestOutputHelper logger)
     {
+#if NETCOREAPP
+        LibGit2Loader.EnsureRegistered();
+#endif
+
         Requires.NotNull(logger, nameof(logger));
 
         this.Logger = logger;