Fix ps1 scripts to find native libgit2 binaries

Author: AArnott

src/NerdBank.GitVersioning/GitExtensions.cs

@@ -4,8 +4,8 @@
     using System.Collections.Generic;
     using System.IO;
     using System.Linq;
+    using System.Runtime.InteropServices;
     using System.Text;
-    using System.Threading.Tasks;
     using LibGit2Sharp;
     using Validation;
     using Version = System.Version;
@@ -15,6 +15,11 @@
     /// </summary>
     public static class GitExtensions
     {
+        /// <summary>
+        /// An AppDomain-wide variable used on 
+        /// </summary>
+        private static bool libgit2PathInitialized;
+
         /// <summary>
         /// The 0.0 version.
         /// </summary>
@@ -272,6 +277,61 @@ public static IEnumerable<Commit> GetCommitsFromVersion(this Repository repo, Ve
             return possibleCommits;
         }
 
+        /// <summary>
+        /// Assists the operating system in finding the appropriate native libgit2 module.
+        /// </summary>
+        /// <param name="basePath">The path to the directory that contains the lib folder.</param>
+        /// <exception cref="ArgumentException">Thrown if the provided path does not lead to an existing directory.</exception>
+        public static void HelpFindLibGit2NativeBinaries(string basePath)
+        {
+            if (!TryHelpFindLibGit2NativeBinaries(basePath, out string attemptedDirectory))
+            {
+                throw new ArgumentException($"Unable to find native binaries under directory: \"{attemptedDirectory}\".");
+            }
+        }
+
+        /// <summary>
+        /// Assists the operating system in finding the appropriate native libgit2 module.
+        /// </summary>
+        /// <param name="basePath">The path to the directory that contains the lib folder.</param>
+        /// <returns><c>true</c> if the libgit2 native binaries have been found; <c>false</c> otherwise.</returns>
+        public static bool TryHelpFindLibGit2NativeBinaries(string basePath)
+        {
+            return TryHelpFindLibGit2NativeBinaries(basePath, out string attemptedDirectory);
+        }
+
+        /// <summary>
+        /// Assists the operating system in finding the appropriate native libgit2 module.
+        /// </summary>
+        /// <param name="basePath">The path to the directory that contains the lib folder.</param>
+        /// <param name="attemptedDirectory">Receives the directory that native binaries are expected.</param>
+        /// <returns><c>true</c> if the libgit2 native binaries have been found; <c>false</c> otherwise.</returns>
+        public static bool TryHelpFindLibGit2NativeBinaries(string basePath, out string attemptedDirectory)
+        {
+            attemptedDirectory = null;
+            if (!libgit2PathInitialized)
+            {
+#if !NET45
+                if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+#endif
+                {
+                    attemptedDirectory = Path.Combine(basePath, "lib", "win32", IntPtr.Size == 4 ? "x86" : "x64");
+                    if (Directory.Exists(attemptedDirectory))
+                    {
+                        Environment.SetEnvironmentVariable("PATH", Environment.GetEnvironmentVariable("PATH") + Path.PathSeparator + attemptedDirectory);
+                    }
+                    else
+                    {
+                        return false;
+                    }
+                }
+
+                libgit2PathInitialized = true;
+            }
+
+            return libgit2PathInitialized;
+        }
+
         /// <summary>
         /// Tests whether a commit is of a specified version, comparing major and minor components
         /// with the version.txt file defined by that commit.
@@ -438,7 +498,7 @@ private static Version GetIdAsVersionHelper(Commit commit, VersionOptions versio
                     : 0;
             }
 
-            int build =  versionHeight.Value == 0 ? 0 : versionHeight.Value + (versionOptions?.BuildNumberOffset ?? 0);
+            int build = versionHeight.Value == 0 ? 0 : versionHeight.Value + (versionOptions?.BuildNumberOffset ?? 0);
             Verify.Operation(build <= MaximumBuildNumberOrRevisionComponent, "Git height is {0}, which is greater than the maximum allowed {0}.", build, MaximumBuildNumberOrRevisionComponent);
             int revision = commit != null
                 ? Math.Min(MaximumBuildNumberOrRevisionComponent, commit.GetTruncatedCommitIdAsUInt16())

src/Nerdbank.GitVersioning.NuGet/tools/Get-CommitId.ps1

@@ -27,6 +27,7 @@ $null = [Reflection.Assembly]::LoadFile((Resolve-Path "$DependencyBasePath\Valid
 $null = [Reflection.Assembly]::LoadFile((Resolve-Path "$DependencyBasePath\NerdBank.GitVersioning.dll"))
 $null = [Reflection.Assembly]::LoadFile((Resolve-Path "$DependencyBasePath\LibGit2Sharp.dll"))
 $null = [Reflection.Assembly]::LoadFile((Resolve-Path "$DependencyBasePath\Newtonsoft.Json.dll"))
+[Nerdbank.GitVersioning.GitExtensions]::HelpFindLibGit2NativeBinaries("$DependencyBasePath\..")
 
 $ProjectDirectory = (Resolve-Path $ProjectDirectory).ProviderPath
 $GitPath = $ProjectDirectory

src/Nerdbank.GitVersioning.NuGet/tools/Get-Version.ps1

@@ -19,6 +19,7 @@ $null = [Reflection.Assembly]::LoadFile((Resolve-Path "$DependencyBasePath\Newto
 $ProjectDirectory = (Resolve-Path $ProjectDirectory).ProviderPath
 
 try {
+    [Nerdbank.GitVersioning.GitExtensions]::HelpFindLibGit2NativeBinaries("$DependencyBasePath\..")
     $CloudBuild = [Nerdbank.GitVersioning.CloudBuild]::Active
     $VersionOracle = [Nerdbank.GitVersioning.VersionOracle]::Create($ProjectDirectory, $null, $CloudBuild)
     $VersionOracle

src/Nerdbank.GitVersioning.Tasks/GetBuildVersion.cs

@@ -15,11 +15,6 @@
 
     public class GetBuildVersion : Task
     {
-        /// <summary>
-        /// An AppDomain-wide variable used on 
-        /// </summary>
-        private static bool libgit2PathInitialized;
-
         /// <summary>
         /// Initializes a new instance of the <see cref="GetBuildVersion"/> class.
         /// </summary>
@@ -162,7 +157,7 @@ public override bool Execute()
         {
             try
             {
-                this.HelpFindLibGit2NativeBinaries();
+                GitExtensions.TryHelpFindLibGit2NativeBinaries(this.TargetsPath);
 
                 var cloudBuild = CloudBuild.Active;
                 var oracle = VersionOracle.Create(Directory.GetCurrentDirectory(), this.GitRepoRoot, cloudBuild);
@@ -208,26 +203,5 @@ public override bool Execute()
 
             return true;
         }
-
-        private void HelpFindLibGit2NativeBinaries()
-        {
-            if (!libgit2PathInitialized)
-            {
-                string nativeDllPath = null;
-#if !NET45
-                if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
-#endif
-                {
-                    nativeDllPath = Path.Combine(this.TargetsPath, "lib", "win32", IntPtr.Size == 4 ? "x86" : "x64");
-                }
-
-                if (nativeDllPath != null)
-                {
-                    Environment.SetEnvironmentVariable("PATH", Environment.GetEnvironmentVariable("PATH") + Path.PathSeparator + nativeDllPath);
-                }
-
-                libgit2PathInitialized = true;
-            }
-        }
     }
 }

src/Nerdbank.GitVersioning.sln

@@ -1,14 +1,15 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio 15
-VisualStudioVersion = 15.0.26210.2
+VisualStudioVersion = 15.0.26215.1
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FF286327-C783-4F7A-AB73-9BCBAD0D4460}") = "Nerdbank.GitVersioning.NuGet", "Nerdbank.GitVersioning.NuGet\Nerdbank.GitVersioning.NuGet.nuproj", "{B7DE4122-9E90-43DE-BE44-454315CFAE99}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{4BD1A7CD-6F52-4F5A-825B-50E4D8C3ECFF}"
 	ProjectSection(SolutionItems) = preProject
 		..\.gitignore = ..\.gitignore
 		..\appveyor.yml = ..\appveyor.yml
+		..\build.ps1 = ..\build.ps1
 		..\init.ps1 = ..\init.ps1
 		..\nuget.config = ..\nuget.config
 		..\readme.md = ..\readme.md