Refactor: Add IRepoInspector.GetParents(), deprecating GetParent().

This is required for #40, as fixing that issue will require walking all parents, not just the first parent.

The `GitRepoInspector`'s implementation of `GetParents()` matches the current behavior of only using the first parent. This will be fixed in 2.0.0.

Author: AshleighAdams

Directory.Build.props

@@ -46,7 +46,7 @@
     <MinVerTagPrefix>v</MinVerTagPrefix>
     <!-- delete/set to patch the line below once almost out of v0.x.y (preferably once on a beta or rc). -->
     <MinVerAutoIncrement>patch</MinVerAutoIncrement>
-    <MinVerMinimumMajorMinor>1.1</MinVerMinimumMajorMinor>
+    <MinVerMinimumMajorMinor>1.2</MinVerMinimumMajorMinor>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="MinVer" Version="2.5.0">

src/Verlite.Core/GitRepoInspector.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Linq;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 
@@ -226,9 +227,18 @@ private async Task CacheParents()
 
 		/// <inheritdoc/>
 		public async Task<Commit?> GetParent(Commit commit)
+		{
+			var parents = await GetParents(commit);
+			return parents
+				.Select(p => (Commit?)p)
+				.FirstOrDefault();
+		}
+
+		/// <inheritdoc/>
+		public async Task<IReadOnlyList<Commit>> GetParents(Commit commit)
 		{
 			if (CachedParents.TryGetValue(commit, out Commit ret))
-				return ret;
+				return new[] { ret };
 
 			var contents = await GetCommitObject(commit);
 			var parent = ParseCommitObjectParent(contents);
@@ -237,7 +247,7 @@ private async Task CacheParents()
 				CachedParents[commit] = parent.Value;
 
 			Log?.Verbatim($"GetParent() -> {parent}");
-			return parent;
+			return parent is not null ? new Commit[] { parent.Value } : Array.Empty<Commit>();
 		}
 
 		private static readonly Regex RefsTagRegex = new Regex(

src/Verlite.Core/IRepoInspector.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.Serialization;
 using System.Threading.Tasks;
@@ -74,8 +75,15 @@ public interface IRepoInspector
 		/// </summary>
 		/// <param name="commit">The commit.</param>
 		/// <returns>A task containing the primary parent commit, or <c>null</c> if it has none.</returns>
+		[Obsolete("Deprecated in favor of GetParents(). See GitHub issue #40.", error: false)]
 		Task<Commit?> GetParent(Commit commit);
 		/// <summary>
+		/// Gets all parents of the specified commit.
+		/// </summary>
+		/// <param name="commit">The commit.</param>
+		/// <returns>A task containing a list of parent commits.</returns>
+		Task<IReadOnlyList<Commit>> GetParents(Commit commit);
+		/// <summary>
 		/// Query tags from a desired target.
 		/// </summary>
 		/// <param name="queryTarget">The target to query.</param>

src/Verlite.Core/PublicAPI.Shipped.txt

@@ -60,6 +60,7 @@ Verlite.GitRepoInspector.CanDeepen.set -> void
 Verlite.GitRepoInspector.FetchTag(Verlite.Tag tag, string! remote) -> System.Threading.Tasks.Task!
 Verlite.GitRepoInspector.GetHead() -> System.Threading.Tasks.Task<Verlite.Commit?>!
 Verlite.GitRepoInspector.GetParent(Verlite.Commit commit) -> System.Threading.Tasks.Task<Verlite.Commit?>!
+Verlite.GitRepoInspector.GetParents(Verlite.Commit commit) -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Verlite.Commit>!>!
 Verlite.GitRepoInspector.GetTags(Verlite.QueryTarget queryTarget) -> System.Threading.Tasks.Task<Verlite.TagContainer!>!
 Verlite.GitRepoInspector.Root.get -> string!
 Verlite.HeightCalculator
@@ -73,6 +74,7 @@ Verlite.IRepoInspector
 Verlite.IRepoInspector.FetchTag(Verlite.Tag tag, string! remote) -> System.Threading.Tasks.Task!
 Verlite.IRepoInspector.GetHead() -> System.Threading.Tasks.Task<Verlite.Commit?>!
 Verlite.IRepoInspector.GetParent(Verlite.Commit commit) -> System.Threading.Tasks.Task<Verlite.Commit?>!
+Verlite.IRepoInspector.GetParents(Verlite.Commit commit) -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Verlite.Commit>!>!
 Verlite.IRepoInspector.GetTags(Verlite.QueryTarget queryTarget) -> System.Threading.Tasks.Task<Verlite.TagContainer!>!
 Verlite.ITagFilter
 Verlite.ITagFilter.PassesFilter(Verlite.TaggedVersion! taggedVersion) -> System.Threading.Tasks.Task<bool>!

tests/UnitTests/HeightCalculationTests.cs

@@ -18,8 +18,8 @@ public async Task HeadOnTagReturnsIt()
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "v1.0.0"),
-				new("commit_b", "v1.0.0-alpha.1"),
+				new("commit_a") { Tags = new[]{ "v1.0.0" } },
+				new("commit_b") { Tags = new[]{ "v1.0.0-alpha.1" } },
 				new("commit_c"),
 			});
 
@@ -80,7 +80,7 @@ public async Task NoSemVerTagReturnsNoTag()
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "v1.0.0.0"),
+				new("commit_a") { Tags = new[]{ "v1.0.0.0" } },
 				new("commit_b"),
 				new("commit_c"),
 			});
@@ -97,9 +97,9 @@ public async Task MatchingPrefixNonVersionTagsIgnored()
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "vast-tag"),
-				new("commit_b", "very-nice-tag"),
-				new("commit_c", "v"),
+				new("commit_a") { Tags = new[]{ "vast-tag" } },
+				new("commit_b") { Tags = new[]{ "very-nice-tag" } },
+				new("commit_c") { Tags = new[]{ "v" } },
 			});
 
 			var (height, tag) = await HeightCalculator.FromRepository(repo, "v", true);
@@ -113,7 +113,7 @@ public async Task MultipleTagsReturnsHighestTag()
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "v1.0.0-alpha.1", "v1.0.0", "v1.0.0-rc.1"),
+				new("commit_a") { Tags = new[]{ "v1.0.0-alpha.1", "v1.0.0", "v1.0.0-rc.1" } },
 				new("commit_b"),
 				new("commit_c"),
 			});
@@ -135,7 +135,7 @@ public async Task MultipleTagsReturnsHighestTagWhenAutoVersioning()
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
 				new("commit_a"),
-				new("commit_b", "v1.0.0-alpha.1", "v1.0.0-rc.2", "v1.0.0-rc.10"),
+				new("commit_b") { Tags = new[]{ "v1.0.0-alpha.1", "v1.0.0-rc.2", "v1.0.0-rc.10" } },
 				new("commit_c"),
 			});
 
@@ -158,7 +158,7 @@ public async Task QueryRemoteTagsDoesNotFetchTag()
 			{
 				new("commit_a"),
 				new("commit_b"),
-				new("commit_c", "v1.0.0-alpha.1"),
+				new("commit_c") { Tags = new[]{ "v1.0.0-alpha.1" } },
 			});
 
 			(_, _) = await HeightCalculator.FromRepository(repo, "v", true);
@@ -176,9 +176,9 @@ public async Task FindsCommitsWithPrefixesOnly(string prefix, int resultHeight,
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "abc/version/2.0.0"),
-				new("commit_b", "version/3.0.0"),
-				new("commit_c", "4.0.0"),
+				new("commit_a") { Tags = new[]{ "abc/version/2.0.0" } },
+				new("commit_b") { Tags = new[]{ "version/3.0.0" } },
+				new("commit_c") { Tags = new[]{ "4.0.0" } },
 				new("commit_d"),
 			});
 
@@ -209,8 +209,8 @@ public async Task FilterCanIgnoreTags()
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "v1.0.0"),
-				new("commit_b", "v1.0.0-alpha.1"),
+				new("commit_a") { Tags = new[]{ "v1.0.0" } },
+				new("commit_b") { Tags = new[]{ "v1.0.0-alpha.1" } },
 				new("commit_c"),
 			});
 
@@ -232,8 +232,8 @@ public async Task FilterDoesntIgnoreOtherTagsOnSameCommit()
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "v1.0.0", "v1.0.1"),
-				new("commit_b", "v1.0.0-alpha.1"),
+				new("commit_a") { Tags = new[]{ "v1.0.0", "v1.0.1" } },
+				new("commit_b") { Tags = new[]{ "v1.0.0-alpha.1" } },
 				new("commit_c"),
 			});
 

tests/UnitTests/Mocks/MockRepoInspector.cs

@@ -10,21 +10,13 @@ namespace UnitTests
 {
 	public class MockRepoCommit
 	{
-		public Commit Id { get; }
-		public IReadOnlyList<Tag> Tags { get; }
+		public Commit Id { get; init; }
+		public IReadOnlyList<Commit>? Parents { get; init; }
+		public IReadOnlyList<string> Tags { get; init; } = Array.Empty<string>();
 
-		public MockRepoCommit(string commitId, params string[] tags)
+		public MockRepoCommit(string commitId)
 		{
 			Id = new Commit(commitId);
-			if (tags.Length == 0)
-				Tags = Array.Empty<Tag>();
-			else
-			{
-				var tagsList = new List<Tag>();
-				foreach (string tag in tags)
-					tagsList.Add(new Tag(tag, Id));
-				Tags = tagsList;
-			}
 		}
 	}
 
@@ -33,7 +25,7 @@ public sealed class MockRepoInspector : IRepoInspector
 		private class InternalCommit
 		{
 			public Commit Id { get; set; }
-			public Commit? ParentId { get; set; }
+			public IReadOnlyList<Commit> Parents { get; set; } = Array.Empty<Commit>();
 		}
 		private List<InternalCommit> Commits { get; } = new();
 		internal List<Tag> LocalTags { get; } = new();
@@ -49,15 +41,18 @@ public MockRepoInspector(IReadOnlyList<MockRepoCommit> commits)
 				Commits.Add(new InternalCommit()
 				{
 					Id = commit.Id,
-					ParentId = parent,
+					Parents = commit.Parents ??
+						(parent is not null
+							? new Commit[] { parent!.Value }
+							: Array.Empty<Commit>()),
 				});
 
 				foreach (var tag in commit.Tags)
 				{
-					if (!addedTags.Add(tag.Name))
+					if (!addedTags.Add(tag))
 						throw new ArgumentException("Commits contained duplicate tag!", nameof(commits));
 				}
-				RemoteTags.AddRange(commit.Tags);
+				RemoteTags.AddRange(commit.Tags.Select(t => new Tag(t, commit.Id)));
 
 				parent = commit.Id;
 			}
@@ -78,7 +73,18 @@ async Task IRepoInspector.FetchTag(Tag tag, string remote)
 
 		async Task<Commit?> IRepoInspector.GetParent(Commit commit)
 		{
-			return Commits.Where(ic => ic.Id == commit).FirstOrDefault()?.ParentId;
+			var parents = await (this as IRepoInspector).GetParents(commit);
+			return parents
+				.Select(p => (Commit?)p)
+				.FirstOrDefault();
+		}
+
+		async Task<IReadOnlyList<Commit>> IRepoInspector.GetParents(Commit commit)
+		{
+			return Commits
+				.Where(ic => ic.Id == commit)
+				.First()
+				.Parents;
 		}
 
 		async Task<TagContainer> IRepoInspector.GetTags(QueryTarget queryTarget)

tests/UnitTests/UnitTests.csproj

@@ -10,8 +10,11 @@
 
 
   <ItemGroup>
+    <Compile Remove="StrykerOutput\**" />
     <Compile Remove="TestResults\**" />
+    <EmbeddedResource Remove="StrykerOutput\**" />
     <EmbeddedResource Remove="TestResults\**" />
+    <None Remove="StrykerOutput\**" />
     <None Remove="TestResults\**" />
   </ItemGroup>
 

tests/UnitTests/VersionCalculationTests.cs

@@ -131,7 +131,7 @@ public async Task FirstCommitTaggedHasExactVersion()
 		{
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
-				new("commit_a", "v5.4.3-rc.2.1"),
+				new("commit_a") { Tags = new[] { "v5.4.3-rc.2.1" } },
 			});
 
 			var semver = await VersionCalculator.FromRepository(repo, new() { QueryRemoteTags = true });
@@ -145,7 +145,7 @@ public async Task CommitAfterPrereleaseTagAppendsHeight()
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
 				new("commit_b"),
-				new("commit_a", "v4.3.2-rc.1"),
+				new("commit_a") { Tags = new[] { "v4.3.2-rc.1" } },
 			});
 
 			var semver = await VersionCalculator.FromRepository(repo, new() { QueryRemoteTags = true });
@@ -159,7 +159,7 @@ public async Task CommitAfterRtmTagAppendsHeightAndBumpsMinor()
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
 				new("commit_b"),
-				new("commit_a", "v3.2.1"),
+				new("commit_a") { Tags = new[] { "v3.2.1" } },
 			});
 
 			var semver = await VersionCalculator.FromRepository(repo, new() { QueryRemoteTags = true });
@@ -173,8 +173,8 @@ public async Task LatestTagIsFetchedWithQueryRemoteTags()
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
 				new("commit_c"),
-				new("commit_b", "v3.2.1"),
-				new("commit_a", "v3.2.0"),
+				new("commit_b") { Tags = new[] { "v3.2.1" } },
+				new("commit_a") { Tags = new[] { "v3.2.0" } },
 			});
 
 			_ = await VersionCalculator.FromRepository(repo, new() { QueryRemoteTags = true });
@@ -188,8 +188,8 @@ public async Task LatestTagIsNotFetchedWithoutQueryRemoteTags()
 			var repo = new MockRepoInspector(new MockRepoCommit[]
 			{
 				new("commit_c"),
-				new("commit_b", "v3.2.1"),
-				new("commit_a", "v3.2.0"),
+				new("commit_b") { Tags = new[] { "v3.2.1" } },
+				new("commit_a") { Tags = new[] { "v3.2.0" } },
 			});
 
 			_ = await VersionCalculator.FromRepository(repo, new() { QueryRemoteTags = false });