remove IsBranch method in favor of IBranch.Equals

Author: arturcic

src/GitVersionCore.Tests/Extensions/ExtensionMethodsTests.cs

@@ -17,7 +17,7 @@ public interface IRepositoryMetadataProvider
         IEnumerable<ICommit> GetMainlineCommitLog(ICommit baseVersionSource, ICommit mainlineTip);
         IEnumerable<ICommit> GetMergeBaseCommits(ICommit mergeCommit, ICommit mergedHead, ICommit findMergeBase);
 
-        IBranch GetTargetBranch(string targetBranch);
+        IBranch GetTargetBranch(string targetBranchName);
         IBranch FindBranch(string branchName);
         IBranch GetChosenBranch(Config configuration);
         IEnumerable<IBranch> GetBranchesForCommit(ICommit commit);

src/GitVersionCore/Core/Abstractions/IRepositoryMetadataProvider.cs

@@ -1,6 +1,7 @@
 using System;
 using System.IO;
 using System.Linq;
+using GitVersion.Common;
 using GitVersion.Extensions;
 using GitVersion.Logging;
 using GitVersion.Model.Configuration;
@@ -15,18 +16,20 @@ public class GitPreparer : IGitPreparer
         private readonly IGitRepository repository;
         private readonly IOptions<GitVersionOptions> options;
         private readonly IGitRepositoryInfo repositoryInfo;
+        private readonly IRepositoryMetadataProvider repositoryMetadataProvider;
         private readonly ICurrentBuildAgent buildAgent;
 
         private const string DefaultRemoteName = "origin";
 
-        public GitPreparer(ILog log, IEnvironment environment, ICurrentBuildAgent buildAgent,
-            IOptions<GitVersionOptions> options, IGitRepository repository, IGitRepositoryInfo repositoryInfo)
+        public GitPreparer(ILog log, IEnvironment environment, ICurrentBuildAgent buildAgent, IOptions<GitVersionOptions> options,
+            IGitRepository repository, IGitRepositoryInfo repositoryInfo, IRepositoryMetadataProvider repositoryMetadataProvider)
         {
             this.log = log ?? throw new ArgumentNullException(nameof(log));
             this.environment = environment ?? throw new ArgumentNullException(nameof(environment));
             this.repository = repository ?? throw new ArgumentNullException(nameof(repository));
             this.options = options ?? throw new ArgumentNullException(nameof(options));
             this.repositoryInfo = repositoryInfo ?? throw new ArgumentNullException(nameof(repositoryInfo));
+            this.repositoryMetadataProvider = repositoryMetadataProvider ?? throw new ArgumentNullException(nameof(repositoryMetadataProvider));
             this.buildAgent = buildAgent;
         }
 
@@ -141,7 +144,7 @@ private void CloneRepository(string repositoryUrl, string gitDirectory, Authenti
         /// Normalization of a git directory turns all remote branches into local branches, turns pull request refs into a real branch and a few other things. This is designed to be run *only on the build server* which checks out repositories in different ways.
         /// It is not recommended to run normalization against a local repository
         /// </summary>
-        private void NormalizeGitDirectory(string gitDirectory, bool noFetch, string currentBranch, bool isDynamicRepository)
+        private void NormalizeGitDirectory(string gitDirectory, bool noFetch, string currentBranchName, bool isDynamicRepository)
         {
             var authentication = options.Value.Authentication;
             using var repository = this.repository.CreateNew(gitDirectory);
@@ -164,13 +167,15 @@ private void NormalizeGitDirectory(string gitDirectory, bool noFetch, string cur
                     repository.Fetch(remote.Name, new string[0], authentication, null);
                 }
 
-                EnsureLocalBranchExistsForCurrentBranch(repository, log, remote, currentBranch);
+                EnsureLocalBranchExistsForCurrentBranch(repository, log, remote, currentBranchName);
                 CreateOrUpdateLocalBranchesFromRemoteTrackingOnes(repository, log, remote.Name);
 
+                var currentBranch = repositoryMetadataProvider.FindBranch(currentBranchName);
                 // Bug fix for https://github.com/GitTools/GitVersion/issues/1754, head maybe have been changed
                 // if this is a dynamic repository. But only allow this in case the branches are different (branch switch)
                 if (expectedSha != repository.Head.Tip.Sha &&
-                    (isDynamicRepository || !expectedBranchName.IsBranch(currentBranch)))
+                    (isDynamicRepository || currentBranch is null
+                     || !repository.Head.Equals(currentBranch)))
                 {
                     var newExpectedSha = repository.Head.Tip.Sha;
                     var newExpectedBranchName = repository.Head.CanonicalName;
@@ -196,12 +201,12 @@ private void NormalizeGitDirectory(string gitDirectory, bool noFetch, string cur
                 // If no, go ahead and check out a new branch, using the known commit SHA as the pointer
                 var localBranchesWhereCommitShaIsHead = repository.Branches.Where(b => !b.IsRemote && b.Tip.Sha == headSha).ToList();
 
-                var matchingCurrentBranch = !string.IsNullOrEmpty(currentBranch)
-                    ? localBranchesWhereCommitShaIsHead.SingleOrDefault(b => b.CanonicalName.Replace("/heads/", "/") == currentBranch.Replace("/heads/", "/"))
+                var matchingCurrentBranch = !string.IsNullOrEmpty(currentBranchName)
+                    ? localBranchesWhereCommitShaIsHead.SingleOrDefault(b => b.CanonicalName.Replace("/heads/", "/") == currentBranchName.Replace("/heads/", "/"))
                     : null;
                 if (matchingCurrentBranch != null)
                 {
-                    log.Info($"Checking out local branch '{currentBranch}'.");
+                    log.Info($"Checking out local branch '{currentBranchName}'.");
                     repository.Checkout(matchingCurrentBranch);
                 }
                 else if (localBranchesWhereCommitShaIsHead.Count > 1)

src/GitVersionCore/Core/GitPreparer.cs

@@ -139,26 +139,27 @@ public IEnumerable<ICommit> GetMergeBaseCommits(ICommit mergeCommit, ICommit mer
             return repository.GetMergeBaseCommits(mergeCommit, mergedHead, findMergeBase);
         }
 
-        public IBranch GetTargetBranch(string targetBranch)
+        public IBranch GetTargetBranch(string targetBranchName)
         {
             // By default, we assume HEAD is pointing to the desired branch
             var desiredBranch = repository.Head;
+            var targetBranch = FindBranch(targetBranchName);
 
             // Make sure the desired branch has been specified
-            if (!string.IsNullOrEmpty(targetBranch))
+            if (!string.IsNullOrEmpty(targetBranchName))
             {
                 // There are some edge cases where HEAD is not pointing to the desired branch.
                 // Therefore it's important to verify if 'currentBranch' is indeed the desired branch.
 
                 // CanonicalName can be "refs/heads/develop", so we need to check for "/{TargetBranch}" as well
-                if (!desiredBranch.CanonicalName.IsBranch(targetBranch))
+                if (!desiredBranch.Equals(targetBranch))
                 {
                     // In the case where HEAD is not the desired branch, try to find the branch with matching name
                     desiredBranch = repository.Branches?
                         .Where(b =>
-                            b.CanonicalName.IsEquivalentTo(targetBranch) ||
-                            b.FriendlyName.IsEquivalentTo(targetBranch) ||
-                            b.NameWithoutRemote.IsEquivalentTo(targetBranch))
+                            b.CanonicalName.IsEquivalentTo(targetBranchName) ||
+                            b.FriendlyName.IsEquivalentTo(targetBranchName) ||
+                            b.NameWithoutRemote.IsEquivalentTo(targetBranchName))
                         .OrderBy(b => b.IsRemote)
                         .FirstOrDefault();
 
@@ -172,7 +173,8 @@ public IBranch GetTargetBranch(string targetBranch)
 
         public IBranch FindBranch(string branchName)
         {
-            return repository.Branches.FirstOrDefault(x => x.NameWithoutRemote == branchName);
+            return repository.Branches.FirstOrDefault(x => x.CanonicalName.IsEquivalentTo(branchName)
+                                                           || x.NameWithoutRemote.IsEquivalentTo(branchName));
         }
 
         public IBranch GetChosenBranch(Config configuration)

src/GitVersionCore/Core/RepositoryMetadataProvider.cs

@@ -41,15 +41,6 @@ public static void DumpGraph(string workingDirectory, Action<string> writer = nu
             }
         }
 
-        public static bool IsBranch(this string branchName, string branchNameToCompare)
-        {
-            // "develop" == "develop"
-            // "refs/head/develop" == "develop"
-            return string.Equals(branchName, branchNameToCompare, StringComparison.OrdinalIgnoreCase)
-                   || branchName.EndsWith($"/{branchNameToCompare}", StringComparison.OrdinalIgnoreCase);
-
-        }
-
         public static string CreateGitLogArgs(int? maxCommits)
         {
             var commits = maxCommits != null ? $" -n {maxCommits}" : null;