Add a managed Git implementation

azure-pipelines.yml

@@ -107,8 +107,8 @@ stages:
         --filter "TestCategory!=FailsOnAzurePipelines"
         --logger "trx;LogFileName=$(Build.ArtifactStagingDirectory)/TestLogs/TestResults.trx"
         --results-directory $(Build.ArtifactStagingDirectory)/CodeCoverage/
-        --collect:"XPlat Code Coverage" 
-        -- 
+        --collect:"XPlat Code Coverage"
+        --
         RunConfiguration.DisableAppDomain=true
       displayName: Run tests
       workingDirectory: src
@@ -196,6 +196,78 @@ stages:
       displayName: npm publish to PublicCI feed
       condition: and(succeeded(), eq(variables['Agent.OS'], 'Windows_NT'), eq(variables['System.TeamFoundationCollectionUri'], 'https://dev.azure.com/andrewarnott/'), ne(variables['Build.Reason'], 'PullRequest'))
 
+  - job: PerfTest
+    strategy:
+      matrix:
+        ubuntu:
+          imageName: ubuntu-18.04
+          repoDir: '~/git'
+        windows:
+          imageName: windows-2019
+          repoDir: '${USERPROFILE}/source/repos'
+        macOS:
+          imageName: macOS-10.15
+          repoDir: '~/git'
+    pool:
+      vmImage: $(imageName)
+    steps:
+    - task: UseDotNet@2
+      displayName: Install .NET Core SDK 2.1.811
+      inputs:
+        packageType: sdk
+        version: 2.1.811
+    - task: UseDotNet@2
+      displayName: Install .NET Core SDK 3.1.100
+      inputs:
+        packageType: sdk
+        version: 3.1.100
+    - task: UseDotNet@2
+      displayName: Install .NET Core SDK 5.0.100
+      inputs:
+        packageType: sdk
+        version: 5.0.100
+    - script: dotnet --info
+      displayName: Show dotnet SDK info
+    - bash: |
+        mkdir -p $(repoDir)
+        git clone https://github.com/xunit/xunit $(repoDir)/xunit
+        git clone https://github.com/gimlichael/Cuemon $(repoDir)/Cuemon
+        git clone https://github.com/kerryjiang/SuperSocket $(repoDir)/SuperSocket
+        git clone https://github.com/dotnet/NerdBank.GitVersioning $(repoDir)/NerdBank.GitVersioning
+      displayName: Clone test repositories
+    - script: |
+        dotnet build -c Release
+      workingDirectory: src/
+      displayName: Build in Release mode
+    - script: |
+        dotnet run -c Release -f netcoreapp3.1 -- --filter GetVersionBenchmarks --artifacts $(Build.ArtifactStagingDirectory)/benchmarks/packed/$(imageName)
+      workingDirectory: src/NerdBank.GitVersioning.Benchmarks
+      displayName: Run benchmarks (packed)
+    - bash: |
+        cd $(repoDir)/xunit
+        git unpack-objects < .git/objects/pack/*.pack
+
+        cd $(repoDir)/Cuemon
+        git unpack-objects < .git/objects/pack/*.pack
+
+        cd $(repoDir)/SuperSocket
+        git unpack-objects < .git/objects/pack/*.pack
+
+        cd $(repoDir)/NerdBank.GitVersioning
+        git unpack-objects < .git/objects/pack/*.pack
+      displayName: Unpack Git repositories
+    - script: |
+        dotnet run -c Release -f netcoreapp3.1 -- --filter GetVersionBenchmarks --artifacts $(Build.ArtifactStagingDirectory)/benchmarks/unpacked/$(imageName)
+      workingDirectory: src/NerdBank.GitVersioning.Benchmarks
+      displayName: Run benchmarks (unpacked)
+    - task: PublishBuildArtifacts@1
+      inputs:
+        PathtoPublish: $(Build.ArtifactStagingDirectory)/benchmarks
+        ArtifactName: benchmarks
+        ArtifactType: Container
+      displayName: Publish benchmarks artifacts
+      condition: succeededOrFailed()
+
 - stage: Test
   jobs:
   - job: linux

doc/nuget-acquisition.md

@@ -14,9 +14,10 @@ If in a project that uses PackageReference for this package reference, you shoul
 After installing this NuGet package, you may need to configure the version generation logic
 in order for it to work properly.
 
-When using packages.config, the configuration is handled automatically via the tools\Install.ps1 script.
-When using project.json or PackageReference, you can run the script tools\Create-VersionFile.ps1 to help
-you create the version.json file and remove the old assembly attributes.
+We recommend installing the `nbgv` tool using `dotnet tool install -g nbgv`.
+Then use `nbgv install` to add the package reference and `version.json` file to your repo.
+But you can simply add the package reference yourself, and create the `version.json` in your repo
+with content conforming to [this doc](versionJson.md).
 
 The scripts will look for the presence of a version.json or version.txt file.
 If one already exists, nothing happens. If the version file does not exist,

src/Cake.GitVersioning/GitVersioningAliases.cs

@@ -27,11 +27,11 @@ public static class GitVersioningAliases
         ///     Information(GetVersioningGetVersion().SemVer2)
         /// });
         /// </example>
-        /// <param name="context">The context.</param>
+        /// <param name="cakeContext">The context.</param>
         /// <param name="projectDirectory">Directory to start the search for version.json.</param>
         /// <returns>The version information from Git Versioning.</returns>
         [CakeMethodAlias]
-        public static VersionOracle GitVersioningGetVersion(this ICakeContext context, string projectDirectory = ".")
+        public static VersionOracle GitVersioningGetVersion(this ICakeContext cakeContext, string projectDirectory = ".")
         {
             var fullProjectDirectory = (new DirectoryInfo(projectDirectory)).FullName;
 
@@ -42,30 +42,8 @@ public static VersionOracle GitVersioningGetVersion(this ICakeContext context, s
                 throw new InvalidOperationException("Could not locate the Cake.GitVersioning library");
             }
 
-            // Even after adding the folder containing the native libgit2 DLL to the PATH, DllNotFoundException is still thrown
-            // Workaround this by copying the contents of the found folder to the current directory
-            GitExtensions.HelpFindLibGit2NativeBinaries(directoryName, out var attemptedDirectory);
-
-            // The HelpFindLibGit2NativeBinaries method throws if the directory does not exist
-            var directoryInfo = new DirectoryInfo(attemptedDirectory);
-
-            // There should only be a single file in the directory, but we do not know its extension
-            // So, we will just get a list of all files rather than trying to determine the correct name and extension
-            // If there are other files there for some reason, it should not matter as long as we don't overwrite anything in the current directory
-            var fileInfos = directoryInfo.GetFiles();
-
-            foreach (var fileInfo in fileInfos)
-            {
-                // Copy the file to the Cake.GitVersioning DLL directory, without overwriting anything
-                string destFileName = Path.Combine(directoryName, fileInfo.Name);
-
-                if (!File.Exists(destFileName))
-                {
-                    File.Copy(fileInfo.FullName, destFileName);
-                }
-            }
-
-            return VersionOracle.Create(fullProjectDirectory, null, CloudBuild.Active);
+            var gitContext = GitContext.Create(fullProjectDirectory);
+            return new VersionOracle(gitContext, cloudBuild: CloudBuild.Active);
         }
     }
 }

src/Directory.Build.props

@@ -4,7 +4,7 @@
     <BaseIntermediateOutputPath>$(MSBuildThisFileDirectory)..\obj\$(MSBuildProjectName)\</BaseIntermediateOutputPath>
     <OutputPath>$(MSBuildThisFileDirectory)..\bin\$(MSBuildProjectName)\$(Configuration)\</OutputPath>
     <DocumentationRootFolder>$(MSBuildThisFileDirectory)..\wiki\api</DocumentationRootFolder>
-    <LangVersion>7.3</LangVersion>
+    <LangVersion>8.0</LangVersion>
 
     <SignAssembly>true</SignAssembly>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)strongname.snk</AssemblyOriginatorKeyFile>
@@ -24,6 +24,7 @@
     <LibGit2SharpNativeVersion>2.0.306</LibGit2SharpNativeVersion>
   </PropertyGroup>
   <ItemGroup>
+    <PackageReference Include="Microsoft.Net.Compilers.Toolset" Version="3.8.0-5.final" PrivateAssets="all" />
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" PrivateAssets="All" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
   </ItemGroup>

src/NerdBank.GitVersioning.Benchmarks/GetVersionBenchmarks.cs

@@ -0,0 +1,70 @@
+using System;
+using System.IO;
+using System.Runtime.InteropServices;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Jobs;
+
+namespace Nerdbank.GitVersioning.Benchmarks
+{
+    [SimpleJob(RuntimeMoniker.NetCoreApp31, baseline: true)]
+    [SimpleJob(RuntimeMoniker.NetCoreApp21)]
+    [SimpleJob(RuntimeMoniker.NetCoreApp50)]
+    [SimpleJob(RuntimeMoniker.Net461)]
+    public class GetVersionBenchmarks
+    {
+        // You must manually clone these repositories:
+        // - On Windows, to %USERPROFILE%\Source\Repose
+        // - On Unix, to ~/git/
+        [Params(
+            "xunit",
+            "Cuemon",
+            "SuperSocket",
+            "NerdBank.GitVersioning")]
+        public string ProjectDirectory;
+
+        public Version Version { get; set; }
+
+        [Benchmark(Baseline = true)]
+        public void GetVersionLibGit2()
+        {
+            using var context = GitContext.Create(GetPath(this.ProjectDirectory), writable: true);
+            var oracle = new VersionOracle(context, cloudBuild: null);
+            this.Version = oracle.Version;
+        }
+
+        [Benchmark]
+        public void GetVersionManaged()
+        {
+            using var context = GitContext.Create(GetPath(this.ProjectDirectory), writable: false);
+            var oracle = new VersionOracle(context, cloudBuild: null);
+            this.Version = oracle.Version;
+        }
+
+        private static string GetPath(string repositoryName)
+        {
+            string path = null;
+
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+            {
+                path = Path.Combine(
+                    Environment.GetFolderPath(Environment.SpecialFolder.UserProfile),
+                    @"Source\Repos",
+                    repositoryName);
+            }
+            else
+            {
+                path = Path.Combine(
+                    Environment.GetFolderPath(Environment.SpecialFolder.UserProfile),
+                    @"git",
+                    repositoryName);
+            }
+
+            if (!Directory.Exists(path))
+            {
+                throw new DirectoryNotFoundException($"The directory '{path}' could not be found");
+            }
+
+            return path;
+        }
+    }
+}

src/NerdBank.GitVersioning.Benchmarks/Nerdbank.GitVersioning.Benchmarks.csproj

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>netcoreapp3.1;netcoreapp2.1</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' == 'Windows_NT'">$(TargetFrameworks);net461</TargetFrameworks>
+    <OutputType>Exe</OutputType>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.12.1" />
+    <PackageReference Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.12.0" />
+    <PackageReference Include="Nerdbank.GitVersioning.LKG" Version="3.1.93" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../NerdBank.GitVersioning/NerdBank.GitVersioning.csproj" />
+  </ItemGroup>
+
+</Project>

src/NerdBank.GitVersioning.Benchmarks/Program.cs

@@ -0,0 +1,11 @@
+using System;
+using BenchmarkDotNet.Running;
+
+namespace Nerdbank.GitVersioning.Benchmarks
+{
+    class Program
+    {
+        static void Main(string[] args) =>
+                   BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args);
+    }
+}