Reroute GitExtensions.GetIdAsVersion calls to VersionOracle

Author: qmfrederik

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -190,7 +190,7 @@ public async Task GetBuildVersion_In_Git_But_Head_Lacks_VersionFile()
         this.WriteVersionFile("3.4");
         Assumes.True(repo.Index[VersionFile.JsonFileName] == null);
         var buildResult = await this.BuildAsync();
-        Assert.Equal("3.4.0." + repo.Head.Tip.GetIdAsVersion().Revision, buildResult.BuildVersion);
+        Assert.Equal("3.4.0." + GetIdAsVersion(repo, repo.Head.Tip).Revision, buildResult.BuildVersion);
         Assert.Equal("3.4.0+" + repo.Head.Tip.Id.Sha.Substring(0, VersionOptions.DefaultGitCommitIdShortFixedLength), buildResult.AssemblyInformationalVersion);
     }
 
@@ -215,7 +215,7 @@ public async Task GetBuildVersion_In_Git_No_VersionFile_At_All()
         var repo = new Repository(this.RepoPath); // do not assign Repo property to avoid commits being generated later
         repo.Commit("empty", this.Signer, this.Signer, new CommitOptions { AllowEmptyCommit = true });
         var buildResult = await this.BuildAsync();
-        Assert.Equal("0.0.0." + repo.Head.Tip.GetIdAsVersion().Revision, buildResult.BuildVersion);
+        Assert.Equal("0.0.0." + GetIdAsVersion(repo, repo.Head.Tip).Revision, buildResult.BuildVersion);
         Assert.Equal("0.0.0+" + repo.Head.Tip.Id.Sha.Substring(0, VersionOptions.DefaultGitCommitIdShortFixedLength), buildResult.AssemblyInformationalVersion);
     }
 
@@ -295,7 +295,7 @@ public async Task GetBuildVersion_StableRelease()
         var buildResult = await this.BuildAsync();
         this.AssertStandardProperties(VersionOptions.FromVersion(new Version(majorMinorVersion)), buildResult);
 
-        Version version = this.Repo.Head.Tip.GetIdAsVersion();
+        Version version = this.GetIdAsVersion(this.Repo.Head.Tip);
         Assert.Equal($"{version.Major}.{version.Minor}.{buildResult.GitVersionHeight}", buildResult.NuGetPackageVersion);
     }
 
@@ -1002,9 +1002,9 @@ private static RestoreEnvironmentVariables ApplyEnvironmentVariables(IReadOnlyDi
     private void AssertStandardProperties(VersionOptions versionOptions, BuildResults buildResult, string relativeProjectDirectory = null)
     {
         int versionHeight = this.GetVersionHeight(relativeProjectDirectory);
-        Version idAsVersion = this.Repo.GetIdAsVersion(relativeProjectDirectory);
+        Version idAsVersion = this.GetIdAsVersion(relativeProjectDirectory);
         string commitIdShort = this.CommitIdShort;
-        Version version = this.Repo.GetIdAsVersion(relativeProjectDirectory);
+        Version version = this.GetIdAsVersion(relativeProjectDirectory);
         Version assemblyVersion = GetExpectedAssemblyVersion(versionOptions, version);
         var additionalBuildMetadata = from item in buildResult.BuildResult.ProjectStateAfterBuild.GetItems("BuildMetadata")
                                       select item.EvaluatedInclude;

src/NerdBank.GitVersioning.Tests/GitExtensionsTests.cs

@@ -521,7 +521,7 @@ public void GetIdAsVersion_ReadsMajorMinorFromVersionTxt()
         this.WriteVersionFile("4.8");
         var firstCommit = this.Repo.Commits.First();
 
-        Version v1 = firstCommit.GetIdAsVersion();
+        Version v1 = this.GetIdAsVersion(firstCommit);
         Assert.Equal(4, v1.Major);
         Assert.Equal(8, v1.Minor);
     }
@@ -532,7 +532,7 @@ public void GetIdAsVersion_ReadsMajorMinorFromVersionTxtInSubdirectory()
         this.WriteVersionFile("4.8", relativeDirectory: "foo/bar");
         var firstCommit = this.Repo.Commits.First();
 
-        Version v1 = firstCommit.GetIdAsVersion("foo/bar");
+        Version v1 = this.GetIdAsVersion(firstCommit, "foo/bar");
         Assert.Equal(4, v1.Major);
         Assert.Equal(8, v1.Minor);
     }
@@ -543,7 +543,7 @@ public void GetIdAsVersion_MissingVersionTxt()
         this.AddCommits();
         var firstCommit = this.Repo.Commits.First();
 
-        Version v1 = firstCommit.GetIdAsVersion();
+        Version v1 = this.GetIdAsVersion(firstCommit);
         Assert.Equal(0, v1.Major);
         Assert.Equal(0, v1.Minor);
     }
@@ -555,7 +555,7 @@ public void GetIdAsVersion_VersionFileNeverCheckedIn_3Ints()
         var expectedVersion = new Version(1, 1, 0);
         var unstagedVersionData = VersionOptions.FromVersion(expectedVersion);
         string versionFilePath = VersionFile.SetVersion(this.RepoPath, unstagedVersionData);
-        Version actualVersion = this.Repo.GetIdAsVersion();
+        Version actualVersion = this.GetIdAsVersion();
         Assert.Equal(expectedVersion.Major, actualVersion.Major);
         Assert.Equal(expectedVersion.Minor, actualVersion.Minor);
         Assert.Equal(expectedVersion.Build, actualVersion.Build);
@@ -572,7 +572,7 @@ public void GetIdAsVersion_VersionFileNeverCheckedIn_2Ints()
         var expectedVersion = new Version(1, 1);
         var unstagedVersionData = VersionOptions.FromVersion(expectedVersion);
         string versionFilePath = VersionFile.SetVersion(this.RepoPath, unstagedVersionData);
-        Version actualVersion = this.Repo.GetIdAsVersion();
+        Version actualVersion = this.GetIdAsVersion();
         Assert.Equal(expectedVersion.Major, actualVersion.Major);
         Assert.Equal(expectedVersion.Minor, actualVersion.Minor);
         Assert.Equal(0, actualVersion.Build); // height is 0 since the change hasn't been committed.
@@ -587,7 +587,7 @@ public void GetIdAsVersion_VersionFileChangedOnDisk()
         this.AddCommits();
 
         // Verify that we're seeing the original version.
-        Version actualVersion = this.Repo.GetIdAsVersion();
+        Version actualVersion = this.GetIdAsVersion();
         Assert.Equal(1, actualVersion.Major);
         Assert.Equal(2, actualVersion.Minor);
         Assert.Equal(2, actualVersion.Build);
@@ -597,15 +597,15 @@ public void GetIdAsVersion_VersionFileChangedOnDisk()
         string versionFile = VersionFile.SetVersion(this.RepoPath, new Version("1.3"));
 
         // Verify that HEAD reports whatever is on disk at the time.
-        actualVersion = this.Repo.GetIdAsVersion();
+        actualVersion = this.GetIdAsVersion();
         Assert.Equal(1, actualVersion.Major);
         Assert.Equal(3, actualVersion.Minor);
         Assert.Equal(0, actualVersion.Build);
         Assert.Equal(this.Repo.Head.Commits.First().GetTruncatedCommitIdAsUInt16(), actualVersion.Revision);
 
         // Now commit it and verify the height advances 0->1
         this.CommitVersionFile(versionFile, "1.3");
-        actualVersion = this.Repo.GetIdAsVersion();
+        actualVersion = this.GetIdAsVersion();
         Assert.Equal(1, actualVersion.Major);
         Assert.Equal(3, actualVersion.Minor);
         Assert.Equal(1, actualVersion.Build);
@@ -650,7 +650,7 @@ public void GetIdAsVersion_Roundtrip(string version, string assemblyVersion, int
         for (int i = 0; i < commits.Length; i++)
         {
             commits[i] = this.Repo.Commit($"Commit {i + 1}", this.Signer, this.Signer, new CommitOptions { AllowEmptyCommit = true });
-            versions[i] = commits[i].GetIdAsVersion(repoRelativeSubDirectory);
+            versions[i] = this.GetIdAsVersion(commits[i], repoRelativeSubDirectory);
             this.Logger.WriteLine($"Commit {commits[i].Id.Sha.Substring(0, 8)} as version: {versions[i]}");
         }
 
@@ -689,10 +689,10 @@ public void GetIdAsVersion_Roundtrip_UnstableOffset(int startingOffset, int offs
         {
             versionOptions.VersionHeightOffset += offsetStepChange;
             commits[i] = this.WriteVersionFile(versionOptions);
-            versions[i] = commits[i].GetIdAsVersion();
+            versions[i] = this.GetIdAsVersion(commits[i]);
 
             commits[i + 1] = this.Repo.Commit($"Commit {i + 1}", this.Signer, this.Signer, new CommitOptions { AllowEmptyCommit = true });
-            versions[i + 1] = commits[i + 1].GetIdAsVersion();
+            versions[i + 1] = this.GetIdAsVersion(commits[i + 1]);
 
             this.Logger.WriteLine($"Commit {commits[i].Id.Sha.Substring(0, 8)} as version: {versions[i]}");
             this.Logger.WriteLine($"Commit {commits[i + 1].Id.Sha.Substring(0, 8)} as version: {versions[i + 1]}");
@@ -731,8 +731,8 @@ public void GetIdAsVersion_Roundtrip_WithSubdirectoryVersionFiles()
         this.InitializeSourceControl();
 
         Commit head = this.Repo.Head.Commits.First();
-        Version rootVersionActual = head.GetIdAsVersion();
-        Version subPathVersionActual = head.GetIdAsVersion(subPathRelative);
+        Version rootVersionActual = this.GetIdAsVersion(head);
+        Version subPathVersionActual = this.GetIdAsVersion(head, subPathRelative);
 
         // Verify that the versions calculated took the path into account.
         Assert.Equal(rootVersionExpected.Version.Version.Minor, rootVersionActual?.Minor);
@@ -753,7 +753,7 @@ public void GetIdAsVersion_FitsInsideCompilerConstraints()
         this.WriteVersionFile("2.5");
         var firstCommit = this.Repo.Commits.First();
 
-        Version version = firstCommit.GetIdAsVersion();
+        Version version = this.GetIdAsVersion(firstCommit);
         this.Logger.WriteLine(version.ToString());
 
         // The C# compiler produces a build warning and truncates the version number if it exceeds 0xfffe,
@@ -772,12 +772,12 @@ public void GetIdAsVersion_MigrationFromVersionTxtToJson()
         var jsonCommit = this.WriteVersionFile("4.8");
         Assert.True(File.Exists(Path.Combine(this.RepoPath, "version.json")));
 
-        Version v1 = txtCommit.GetIdAsVersion();
+        Version v1 = this.GetIdAsVersion(txtCommit);
         Assert.Equal(4, v1.Major);
         Assert.Equal(8, v1.Minor);
         Assert.Equal(1, v1.Build);
 
-        Version v2 = jsonCommit.GetIdAsVersion();
+        Version v2 = this.GetIdAsVersion(jsonCommit);
         Assert.Equal(4, v2.Major);
         Assert.Equal(8, v2.Minor);
         Assert.Equal(2, v2.Build);
@@ -793,7 +793,7 @@ public void TestBiggerRepo()
         {
             foreach (var commit in this.Repo.Head.Commits)
             {
-                var version = commit.GetIdAsVersion("src");
+                var version = this.GetIdAsVersion(commit, "src");
                 this.Logger.WriteLine($"commit {commit.Id} got version {version}");
                 var backAgain = this.Repo.GetCommitFromVersion(version, "src");
                 Assert.Equal(commit, backAgain);
@@ -820,7 +820,7 @@ private void VerifyCommitsWithVersion(Commit[] commits)
 
         for (int i = 0; i < commits.Length; i++)
         {
-            Version encodedVersion = commits[i].GetIdAsVersion();
+            Version encodedVersion = this.GetIdAsVersion(commits[i]);
             Assert.Equal(i + 1, encodedVersion.Build);
             Assert.Equal(commits[i], this.Repo.GetCommitFromVersion(encodedVersion));
         }

src/NerdBank.GitVersioning.Tests/RepoTestBase.Helpers.cs

@@ -51,4 +51,44 @@ protected static int GetVersionHeight(Repository repository, string repoRelative
         VersionOracle oracle = new VersionOracle(repoRelativeProjectDirectory == null ? repository.Info.WorkingDirectory : Path.Combine(repository.Info.WorkingDirectory, repoRelativeProjectDirectory), repository, null);
         return oracle.VersionHeight;
     }
+
+    /// <summary>
+    /// Encodes HEAD (or a modified working copy) from history in a <see cref="Version"/>
+    /// so that the original commit can be found later.
+    /// </summary>
+    /// <param name="repoRelativeProjectDirectory">The repo-relative project directory for which to calculate the version.</param>
+    /// <returns>
+    /// A version whose <see cref="Version.Build"/> and
+    /// <see cref="Version.Revision"/> components are calculated based on the commit.
+    /// </returns>
+    /// <remarks>
+    /// In the returned version, the <see cref="Version.Build"/> component is
+    /// the height of the git commit while the <see cref="Version.Revision"/>
+    /// component is the first four bytes of the git commit id (forced to be a positive integer).
+    /// </remarks>
+    protected System.Version GetIdAsVersion(string repoRelativeProjectDirectory = null)
+    {
+        VersionOracle oracle = new VersionOracle(
+            repoRelativeProjectDirectory == null ? this.Repo.Info.WorkingDirectory : Path.Combine(this.Repo.Info.WorkingDirectory, repoRelativeProjectDirectory),
+            this.Repo,
+            null);
+
+        return oracle.Version;
+    }
+
+    protected System.Version GetIdAsVersion(Commit commit, string repoRelativeProjectDirectory = null)
+    {
+        return GetIdAsVersion(this.Repo, commit, repoRelativeProjectDirectory);
+    }
+
+    protected static System.Version GetIdAsVersion(Repository repository, Commit commit, string repoRelativeProjectDirectory = null)
+    {
+        VersionOracle oracle = new VersionOracle(
+            repoRelativeProjectDirectory == null ? repository.Info.WorkingDirectory : Path.Combine(repository.Info.WorkingDirectory, repoRelativeProjectDirectory),
+            repository,
+            commit,
+            null);
+
+        return oracle.Version;
+    }
 }

src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs

@@ -112,7 +112,7 @@ public void VersionHeightResetsWithVersionSpecChanges(string initial, string nex
 
         foreach (var commit in this.Repo.Head.Commits)
         {
-            var versionFromId = commit.GetIdAsVersion();
+            var versionFromId = this.GetIdAsVersion(commit);
             Assert.Contains(commit, this.Repo.GetCommitsFromVersion(versionFromId));
         }
     }

src/NerdBank.GitVersioning/GitExtensions.cs

@@ -212,7 +212,7 @@ private static IRepository GetRepository(this IBelongToARepository repositoryMem
         /// the height of the git commit while the <see cref="Version.Revision"/>
         /// component is the first four bytes of the git commit id (forced to be a positive integer).
         /// </remarks>
-        public static Version GetIdAsVersion(this Commit commit, string repoRelativeProjectDirectory = null, int? versionHeight = null)
+        internal static Version GetIdAsVersion(this Commit commit, string repoRelativeProjectDirectory = null, int? versionHeight = null)
         {
             Requires.NotNull(commit, nameof(commit));
             Requires.Argument(repoRelativeProjectDirectory == null || !Path.IsPathRooted(repoRelativeProjectDirectory), nameof(repoRelativeProjectDirectory), "Path should be relative to repo root.");
@@ -227,47 +227,6 @@ public static Version GetIdAsVersion(this Commit commit, string repoRelativeProj
             return GetIdAsVersionHelper(commit, versionOptions, versionHeight.Value);
         }
 
-        /// <summary>
-        /// Encodes HEAD (or a modified working copy) from history in a <see cref="Version"/>
-        /// so that the original commit can be found later.
-        /// </summary>
-        /// <param name="repo">The repo whose ID and position in history is to be encoded.</param>
-        /// <param name="repoRelativeProjectDirectory">The repo-relative project directory for which to calculate the version.</param>
-        /// <param name="versionHeight">
-        /// The version height, previously calculated by a call to <see cref="GetVersionHeight(Commit, string, Version)"/>
-        /// with the same value for <paramref name="repoRelativeProjectDirectory"/>.
-        /// </param>
-        /// <returns>
-        /// A version whose <see cref="Version.Build"/> and
-        /// <see cref="Version.Revision"/> components are calculated based on the commit.
-        /// </returns>
-        /// <remarks>
-        /// In the returned version, the <see cref="Version.Build"/> component is
-        /// the height of the git commit while the <see cref="Version.Revision"/>
-        /// component is the first four bytes of the git commit id (forced to be a positive integer).
-        /// </remarks>
-        public static Version GetIdAsVersion(this Repository repo, string repoRelativeProjectDirectory = null, int? versionHeight = null)
-        {
-            Requires.NotNull(repo, nameof(repo));
-
-            var headCommit = repo.Head.Tip;
-            VersionOptions workingCopyVersionOptions, committedVersionOptions;
-            if (IsVersionFileChangedInWorkingCopy(repo, repoRelativeProjectDirectory, out committedVersionOptions, out workingCopyVersionOptions))
-            {
-                // Apply ordinary logic, but to the working copy version info.
-                if (!versionHeight.HasValue)
-                {
-                    var baseVersion = workingCopyVersionOptions?.Version?.Version;
-                    versionHeight = GetVersionHeight(headCommit, repoRelativeProjectDirectory, baseVersion);
-                }
-
-                Version result = GetIdAsVersionHelper(headCommit, workingCopyVersionOptions, versionHeight.Value);
-                return result;
-            }
-
-            return GetIdAsVersion(headCommit, repoRelativeProjectDirectory);
-        }
-
         /// <summary>
         /// Looks up the commit that matches a specified version number.
         /// </summary>