Merge pull request #107 from asherber/submodules

Handle .git files, for submodules

Author: AArnott

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

@@ -56,6 +56,7 @@
     <Compile Include="VersionExtensionsTests.cs" />
     <Compile Include="VersionFileTests.cs" />
     <Compile Include="VersionOptionsTests.cs" />
+    <Compile Include="VersionOracleTests.cs" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="..\Nerdbank.GitVersioning.NuGet\build\*.targets">
@@ -82,6 +83,7 @@
     <EmbeddedResource Include="Keys\protectedPair.pfx" />
     <None Include="project.json" />
     <EmbeddedResource Include="test.proj" />
+    <EmbeddedResource Include="repos\submodules.7z" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 

src/NerdBank.GitVersioning.Tests/TestUtilities.cs

@@ -1,4 +1,6 @@
-using Validation;
+using SevenZipNET;
+using Validation;
+
 namespace Nerdbank.GitVersioning.Tests
 {
     using System;
@@ -54,5 +56,45 @@ internal static void ExtractEmbeddedResource(string resourcePath, string extract
                 }
             }
         }
+
+        internal static ExpandedRepo ExtractRepoArchive(string repoArchiveName)
+        {
+            string archiveFilePath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+            string expandedFolderPath = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+
+            ExtractEmbeddedResource($"repos.{repoArchiveName}.7z", archiveFilePath);
+            try
+            {
+                var extractor = new SevenZipExtractor(archiveFilePath);
+                extractor.ExtractAll(expandedFolderPath);
+                return new ExpandedRepo(expandedFolderPath);
+            }
+            finally
+            {
+                if (File.Exists(archiveFilePath))
+                {
+                    File.Delete(archiveFilePath);
+                }
+            }
+        }
+
+        internal class ExpandedRepo : IDisposable
+        {
+            internal ExpandedRepo(string repoPath)
+            {
+                Requires.NotNullOrEmpty(repoPath, nameof(repoPath));
+                this.RepoPath = repoPath;
+            }
+
+            public string RepoPath { get; private set; }
+
+            public void Dispose()
+            {
+                if (Directory.Exists(this.RepoPath))
+                {
+                    DeleteDirectory(this.RepoPath);
+                }
+            }
+        }
     }
 }

src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs

@@ -0,0 +1,31 @@
+using System.IO;
+using LibGit2Sharp;
+using Nerdbank.GitVersioning;
+using Nerdbank.GitVersioning.Tests;
+using Xunit;
+using Xunit.Abstractions;
+
+public class VersionOracleTests : RepoTestBase
+{
+    public VersionOracleTests(ITestOutputHelper logger)
+        : base(logger)
+    {
+    }
+
+    [Fact]
+    public void Submodule_RecognizedWithCorrectVersion()
+    {
+        using (var expandedRepo = TestUtilities.ExtractRepoArchive("submodules"))
+        {
+            this.Repo = new Repository(expandedRepo.RepoPath);
+
+            var oracleA = VersionOracle.Create(Path.Combine(expandedRepo.RepoPath, "a"));
+            Assert.Equal("1.3.1", oracleA.SimpleVersion.ToString());
+            Assert.Equal("e238b03e75", oracleA.GitCommitIdShort);
+
+            var oracleB = VersionOracle.Create(Path.Combine(expandedRepo.RepoPath, "b", "projB"));
+            Assert.Equal("2.5.2", oracleB.SimpleVersion.ToString());
+            Assert.Equal("3ea7f010c3", oracleB.GitCommitIdShort);
+        }
+    }
+}

src/NerdBank.GitVersioning.Tests/project.json

@@ -1,5 +1,6 @@
 {
   "dependencies": {
+    "7z.NET":  "1.0.3",
     "Microsoft.CodeAnalysis.CSharp": "1.1.1",
     "System.Collections.Immutable": "1.1.37",
     "xunit": "2.1.0",

src/NerdBank.GitVersioning.Tests/repos/submodules.7z

@@ -264,16 +264,48 @@ private static string FormatBuildMetadataSemVerV1(IEnumerable<string> identifier
         private static LibGit2Sharp.Repository OpenGitRepo(string repoRoot)
         {
             Requires.NotNullOrEmpty(repoRoot, nameof(repoRoot));
-            while (!Directory.Exists(Path.Combine(repoRoot, ".git")))
+            var gitDir = FindGitDir(repoRoot);
+            return gitDir == null ? null : new LibGit2Sharp.Repository(gitDir);
+        }
+
+        private static string FindGitDir(string startingDir)
+        {
+            while (startingDir != null)
             {
-                repoRoot = Path.GetDirectoryName(repoRoot);
-                if (repoRoot == null)
+                var dirOrFilePath = Path.Combine(startingDir, ".git");
+                if (Directory.Exists(dirOrFilePath))
                 {
-                    return null;
+                    return dirOrFilePath;
                 }
+                else if (File.Exists(dirOrFilePath))
+                {
+                    var relativeGitDirPath = ReadGitDirFromFile(dirOrFilePath);
+                    if (!string.IsNullOrWhiteSpace(relativeGitDirPath))
+                    {
+                        var fullGitDirPath = Path.GetFullPath(Path.Combine(startingDir, relativeGitDirPath));
+                        if (Directory.Exists(fullGitDirPath))
+                        {
+                            return fullGitDirPath;
+                        }
+                    }
+                }
+
+                startingDir = Path.GetDirectoryName(startingDir);
+            }
+
+            return null;
+        }
+
+        private static string ReadGitDirFromFile(string fileName)
+        {
+            const string expectedPrefix = "gitdir: ";
+            var firstLineOfFile = File.ReadLines(fileName).FirstOrDefault();
+            if (firstLineOfFile?.StartsWith(expectedPrefix) ?? false)
+            {
+                return firstLineOfFile.Substring(expectedPrefix.Length); // strip off the prefix, leaving just the path
             }
 
-            return new LibGit2Sharp.Repository(repoRoot);
+            return null;
         }
 
         private static Version GetAssemblyVersion(Version version, VersionOptions versionOptions)