CommitFilter proxy

Author: arturcic

src/GitVersionCore.Tests/Mocks/MockCommitCollection.cs

@@ -1,8 +1,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using GitVersion;
-using LibGit2Sharp;
-using Commit = GitVersion.Commit;
 
 namespace GitVersionCore.Tests.Mocks
 {
@@ -48,6 +46,7 @@ public bool Remove(Commit item)
 
         public bool IsReadOnly => false;
 
+
         public override CommitCollection QueryBy(CommitFilter commitFilter)
         {
             return this;

src/GitVersionCore.Tests/Mocks/MockRepository.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Collections.Generic;
+using System.Linq;
 using GitVersion;
 using GitVersion.Logging;
 namespace GitVersionCore.Tests.Mocks
@@ -33,6 +35,46 @@ public CommitCollection Commits
         public void CreateBranchForPullRequestBranch(ILog log, AuthenticationInfo auth) => throw new NotImplementedException();
         public bool GitRepoHasMatchingRemote(string targetUrl) => throw new NotImplementedException();
         public void CleanupDuplicateOrigin(string defaultRemoteName) => throw new NotImplementedException();
+        public bool GetMatchingCommitBranch(Commit baseVersionSource, Branch branch, Commit firstMatchingCommit)
+        {
+            throw new NotImplementedException();
+        }
+        public IEnumerable<Commit> GetCommitsReacheableFrom(Commit commit, Branch branch)
+        {
+            throw new NotImplementedException();
+        }
+        public List<Commit> GetCommitsReacheableFromHead(Commit headCommit)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = headCommit,
+                SortBy = CommitSortStrategies.Topological | CommitSortStrategies.Reverse
+            };
+
+            var commitCollection = Commits.QueryBy(filter);
+
+            return commitCollection.ToList();
+        }
+        public Commit GetForwardMerge(Commit commitToFindCommonBase, Commit findMergeBase)
+        {
+            throw new NotImplementedException();
+        }
+        public IEnumerable<Commit> GetMergeBaseCommits(Commit mergeCommit, Commit mergedHead, Commit findMergeBase)
+        {
+            throw new NotImplementedException();
+        }
+        public Commit GetBaseVersionSource(Commit currentBranchTip)
+        {
+            throw new NotImplementedException();
+        }
+        public List<Commit> GetMainlineCommitLog(Commit baseVersionSource, Commit mainlineTip)
+        {
+            throw new NotImplementedException();
+        }
+        public CommitCollection GetCommitLog(Commit baseVersionSource, Commit currentCommit)
+        {
+            throw new NotImplementedException();
+        }
         public Remote EnsureOnlyOneRemoteIsDefined(ILog log) => throw new NotImplementedException();
         public void Dispose() => throw new NotImplementedException();
     }

src/GitVersionCore/Core/Abstractions/IGitRepository.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using GitVersion.Logging;
 
 namespace GitVersion
@@ -22,5 +23,13 @@ public interface IGitRepository : IDisposable
         Remote EnsureOnlyOneRemoteIsDefined(ILog log);
         bool GitRepoHasMatchingRemote(string targetUrl);
         void CleanupDuplicateOrigin(string defaultRemoteName);
+        bool GetMatchingCommitBranch(Commit baseVersionSource, Branch branch, Commit firstMatchingCommit);
+        IEnumerable<Commit> GetCommitsReacheableFrom(Commit commit, Branch branch);
+        List<Commit> GetCommitsReacheableFromHead(Commit headCommit);
+        Commit GetForwardMerge(Commit commitToFindCommonBase, Commit findMergeBase);
+        IEnumerable<Commit> GetMergeBaseCommits(Commit mergeCommit, Commit mergedHead, Commit findMergeBase);
+        Commit GetBaseVersionSource(Commit currentBranchTip);
+        List<Commit> GetMainlineCommitLog(Commit baseVersionSource, Commit mainlineTip);
+        CommitCollection GetCommitLog(Commit baseVersionSource, Commit currentCommit);
     }
 }

src/GitVersionCore/Core/GitModel.cs

@@ -336,8 +336,71 @@ public virtual IEnumerator<Commit> GetEnumerator()
 
         public virtual CommitCollection QueryBy(CommitFilter commitFilter)
         {
-            var commitLog = ((IQueryableCommitLog)innerCollection).QueryBy(commitFilter);
+            static object GetReacheableFrom(object item)
+            {
+                return item switch
+                {
+                    Commit c => (LibGit2Sharp.Commit)c,
+                    Branch b => (LibGit2Sharp.Branch)b,
+                    _ => null
+                };
+            }
+
+            var includeReachableFrom = GetReacheableFrom(commitFilter.IncludeReachableFrom);
+            var excludeReachableFrom = GetReacheableFrom(commitFilter.ExcludeReachableFrom);
+            var filter = new LibGit2Sharp.CommitFilter
+            {
+                IncludeReachableFrom = includeReachableFrom,
+                ExcludeReachableFrom = excludeReachableFrom,
+                FirstParentOnly = commitFilter.FirstParentOnly,
+                SortBy = (LibGit2Sharp.CommitSortStrategies)commitFilter.SortBy,
+            };
+            var commitLog = ((IQueryableCommitLog)innerCollection).QueryBy(filter);
             return FromCommitLog(commitLog);
         }
     }
+
+    public class CommitFilter
+    {
+
+        public bool FirstParentOnly { get; set; }
+        public object IncludeReachableFrom { get; set; }
+        public object ExcludeReachableFrom { get; set; }
+        public CommitSortStrategies SortBy { get; set; }
+    }
+
+    /// <summary>
+    /// Determines the sorting strategy when iterating through the commits of the repository
+    /// </summary>
+    [Flags]
+    public enum CommitSortStrategies
+    {
+        /// <summary>
+        /// Sort the commits in no particular ordering;
+        /// this sorting is arbitrary, implementation-specific
+        /// and subject to change at any time.
+        /// </summary>
+        None = 0,
+
+        /// <summary>
+        /// Sort the commits in topological order
+        /// (parents before children); this sorting mode
+        /// can be combined with time sorting.
+        /// </summary>
+        Topological = (1 << 0),
+
+        /// <summary>
+        /// Sort the commits by commit time;
+        /// this sorting mode can be combined with
+        /// topological sorting.
+        /// </summary>
+        Time = (1 << 1),
+
+        /// <summary>
+        /// Iterate through the commits in reverse
+        /// order; this sorting mode can be combined with
+        /// any of the above.
+        /// </summary>
+        Reverse = (1 << 2)
+    }
 }

src/GitVersionCore/Core/GitRepository.cs

@@ -1,7 +1,9 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using GitVersion.Logging;
 using LibGit2Sharp;
+using LibGit2Sharp.Handlers;
 using Microsoft.Extensions.Options;
 
 namespace GitVersion
@@ -222,5 +224,115 @@ private void AddMissingRefSpecs(ILog log, LibGit2Sharp.Remote remote)
             log.Info($"Adding refspec: {allBranchesFetchRefSpec}");
             repositoryInstance.Network.Remotes.Update(remote.Name, r => r.FetchRefSpecs.Add(allBranchesFetchRefSpec));
         }
+
+        public bool GetMatchingCommitBranch(Commit baseVersionSource, Branch branch, Commit firstMatchingCommit)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = branch,
+                ExcludeReachableFrom = baseVersionSource,
+                FirstParentOnly = true,
+            };
+            var commitCollection = Commits.QueryBy(filter);
+
+            return commitCollection.Contains(firstMatchingCommit);
+        }
+        public IEnumerable<Commit> GetCommitsReacheableFrom(Commit commit, Branch branch)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = branch
+            };
+            var commitCollection = Commits.QueryBy(filter);
+
+            return commitCollection.Where(c => c.Sha == commit.Sha);
+        }
+        public List<Commit> GetCommitsReacheableFromHead(Commit headCommit)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = headCommit,
+                SortBy = CommitSortStrategies.Topological | CommitSortStrategies.Reverse
+            };
+
+            var commitCollection = Commits.QueryBy(filter);
+
+            return commitCollection.ToList();
+        }
+        public Commit GetForwardMerge(Commit commitToFindCommonBase, Commit findMergeBase)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = commitToFindCommonBase,
+                ExcludeReachableFrom = findMergeBase
+            };
+            var commitCollection = Commits.QueryBy(filter);
+
+            var forwardMerge = commitCollection
+                .FirstOrDefault(c => c.Parents.Contains(findMergeBase));
+            return forwardMerge;
+        }
+        public IEnumerable<Commit> GetMergeBaseCommits(Commit mergeCommit, Commit mergedHead, Commit findMergeBase)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = mergedHead,
+                ExcludeReachableFrom = findMergeBase
+            };
+            var commitCollection = Commits.QueryBy(filter);
+
+            var commits = mergeCommit != null
+                ? new[]
+                {
+                    mergeCommit
+                }.Union(commitCollection)
+                : commitCollection;
+            return commits.ToList();
+        }
+        public Commit GetBaseVersionSource(Commit currentBranchTip)
+        {
+            try
+            {
+                var filter = new CommitFilter
+                {
+                    IncludeReachableFrom = currentBranchTip
+                };
+                var commitCollection = Commits.QueryBy(filter);
+
+                var baseVersionSource = commitCollection.First(c => !c.Parents.Any());
+                return baseVersionSource;
+            }
+            catch (NotFoundException exception)
+            {
+                throw new GitVersionException($"Cannot find commit {currentBranchTip.Sha}. Please ensure that the repository is an unshallow clone with `git fetch --unshallow`.", exception);
+            }
+        }
+        public List<Commit> GetMainlineCommitLog(Commit baseVersionSource, Commit mainlineTip)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = mainlineTip,
+                ExcludeReachableFrom = baseVersionSource,
+                SortBy = CommitSortStrategies.Reverse,
+                FirstParentOnly = true
+            };
+            var commitCollection = Commits.QueryBy(filter);
+
+            var mainlineCommitLog = commitCollection.ToList();
+            return mainlineCommitLog;
+        }
+        public CommitCollection GetCommitLog(Commit baseVersionSource, Commit currentCommit)
+        {
+            var filter = new CommitFilter
+            {
+                IncludeReachableFrom = currentCommit,
+                ExcludeReachableFrom = baseVersionSource,
+                SortBy = CommitSortStrategies.Topological | CommitSortStrategies.Time
+            };
+
+            var commitCollection = Commits.QueryBy(filter);
+
+            return commitCollection;
+        }
     }
 }