Deprecate FetchTag(tag, remote) in favor of a ctor injected remote.

Author: AshleighAdams

src/Verlite.Core/GitRepoInspector.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
@@ -21,23 +22,43 @@ public class GitMissingOrNotGitRepoException : RepoInspectionException
 	/// <seealso cref="IRepoInspector"/>
 	public sealed class GitRepoInspector : IRepoInspector
 	{
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+		// TODO: Remove all of these enumerated permutations of the old optional args in 2.0.0
+		[ExcludeFromCodeCoverage]
+		[Obsolete("Use FromPath(path, remote, log, commandRunner)", error: false)]
+		public static Task<GitRepoInspector> FromPath(string path, ILogger? log, ICommandRunner? commandRunner)
+			=> FromPath(path, "origin", log, commandRunner ?? new SystemCommandRunner());
+		[ExcludeFromCodeCoverage]
+		[Obsolete("Use FromPath(path, remote, log, commandRunner)", error: false)]
+		public static Task<GitRepoInspector> FromPath(string path, ILogger? log)
+			=> FromPath(path, "origin", log, new SystemCommandRunner());
+		[ExcludeFromCodeCoverage]
+		[Obsolete("Use FromPath(path, remote, log, commandRunner)", error: false)]
+		public static Task<GitRepoInspector> FromPath(string path, ICommandRunner? commandRunner)
+			=> FromPath(path, "origin", null, commandRunner?? new SystemCommandRunner());
+		[ExcludeFromCodeCoverage]
+		[Obsolete("Use FromPath(path, remote, log, commandRunner)", error: false)]
+		public static Task<GitRepoInspector> FromPath(string path)
+			=> FromPath(path, "origin", null, new SystemCommandRunner());
+#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
+
 		/// <summary>
 		/// Creates an inspector from the specified path.
 		/// </summary>
 		/// <param name="path">The path of the Git repository.</param>
+		/// <param name="remote">The remote endpoint.</param>
 		/// <param name="log">A logger for diagnostics.</param>
-		/// <param name="commandRunner">A command runner to use. Defaults to <see cref="SystemCommandRunner"/> if null is given.</param>
+		/// <param name="commandRunner">A command runner to use.</param>
 		/// <exception cref="GitMissingOrNotGitRepoException">Thrown if the path is not a Git repository.</exception>
 		/// <returns>A task containing the Git repo inspector.</returns>
-		public static async Task<GitRepoInspector> FromPath(string path, ILogger? log = null, ICommandRunner? commandRunner = null)
+		public static async Task<GitRepoInspector> FromPath(string path, string remote, ILogger? log, ICommandRunner commandRunner)
 		{
-			commandRunner ??= new SystemCommandRunner();
-
 			try
 			{
 				var (root, _) = await commandRunner.Run(path, "git", new string[] { "rev-parse", "--show-toplevel" });
 				var ret = new GitRepoInspector(
 					root,
+					remote,
 					log,
 					commandRunner);
 				await ret.CacheParents();
@@ -61,10 +82,12 @@ public static async Task<GitRepoInspector> FromPath(string path, ILogger? log =
 		public string Root { get; }
 		private Dictionary<Commit, Commit> CachedParents { get; } = new();
 		private (int depth, bool shallow, Commit deepest)? FetchDepth { get; set; }
+		public string Remote { get; }
 
-		private GitRepoInspector(string root, ILogger? log, ICommandRunner commandRunner)
+		private GitRepoInspector(string root, string remote, ILogger? log, ICommandRunner commandRunner)
 		{
 			Root = root;
+			Remote = remote;
 			Log = log;
 			CommandRunner = commandRunner;
 		}
@@ -170,11 +193,9 @@ private async Task Deepen()
 			try
 			{
 				if (DeepenFromCommitSupported)
-					_ = await Git("fetch", "origin", FetchDepth.Value.deepest.Id, $"--depth={deltaDepth}");
+					_ = await Git("fetch", Remote, FetchDepth.Value.deepest.Id, $"--depth={deltaDepth}");
 				else
-					_ = await Git("fetch", $"--depth={newDepth}");
-
-				await CacheParents();
+					_ = await Git("fetch", Remote, $"--depth={newDepth}");
 			}
 			catch (CommandException ex)
 				when (
@@ -275,7 +296,7 @@ public async Task<TagContainer> GetTags(QueryTarget queryTarget)
 				try
 				{
 					Log?.Verbatim($"GetTags(): Reading remote tags.");
-					var (response, _) = await Git("ls-remote", "--tags");
+					var (response, _) = await Git("ls-remote", "--tags", Remote, "*");
 
 					foreach (Tag tag in MatchTags(response))
 					{
@@ -318,5 +339,11 @@ public async Task FetchTag(Tag tag, string remote)
 			else
 				await Git("fetch", remote, $"refs/tags/{tag.Name}:refs/tags/{tag.Name}");
 		}
+
+		/// <inheritdoc/>
+		public Task FetchTag(Tag tag)
+		{
+			return FetchTag(tag, Remote);
+		}
 	}
 }

src/Verlite.Core/IRepoInspector.cs

@@ -94,6 +94,12 @@ public interface IRepoInspector
 		/// </summary>
 		/// <param name="tag">The tag to fetch.</param>
 		/// <param name="remote">Which remote to fetch the tag from.</param>
+		[Obsolete("Use FetchTag(tag)", error: false)]
 		Task FetchTag(Tag tag, string remote);
+		/// <summary>
+		/// Fetches the specified tag from the remote.
+		/// </summary>
+		/// <param name="tag">The tag to fetch.</param>
+		Task FetchTag(Tag tag);
 	}
 }

src/Verlite.Core/PublicAPI.Shipped.txt

@@ -14,7 +14,11 @@ static Verlite.Command.ParseCommandLine(string! cmdLine) -> System.Collections.G
 static Verlite.Command.Run(string! directory, string! command, string![]! args, System.Collections.Generic.IDictionary<string!, string!>? envVars = null) -> System.Threading.Tasks.Task<(string! stdout, string! stderr)>!
 static Verlite.Commit.operator !=(Verlite.Commit left, Verlite.Commit right) -> bool
 static Verlite.Commit.operator ==(Verlite.Commit left, Verlite.Commit right) -> bool
-static Verlite.GitRepoInspector.FromPath(string! path, Verlite.ILogger? log = null, Verlite.ICommandRunner? commandRunner = null) -> System.Threading.Tasks.Task<Verlite.GitRepoInspector!>!
+static Verlite.GitRepoInspector.FromPath(string! path) -> System.Threading.Tasks.Task<Verlite.GitRepoInspector!>!
+static Verlite.GitRepoInspector.FromPath(string! path, string! remote, Verlite.ILogger? log, Verlite.ICommandRunner! commandRunner) -> System.Threading.Tasks.Task<Verlite.GitRepoInspector!>!
+static Verlite.GitRepoInspector.FromPath(string! path, Verlite.ICommandRunner? commandRunner) -> System.Threading.Tasks.Task<Verlite.GitRepoInspector!>!
+static Verlite.GitRepoInspector.FromPath(string! path, Verlite.ILogger? log) -> System.Threading.Tasks.Task<Verlite.GitRepoInspector!>!
+static Verlite.GitRepoInspector.FromPath(string! path, Verlite.ILogger? log, Verlite.ICommandRunner? commandRunner) -> System.Threading.Tasks.Task<Verlite.GitRepoInspector!>!
 static Verlite.HeightCalculator.FromRepository(Verlite.IRepoInspector! repo, string! tagPrefix, bool queryRemoteTags, Verlite.ILogger? log = null, Verlite.ITagFilter? tagFilter = null) -> System.Threading.Tasks.Task<(int height, Verlite.TaggedVersion?)>!
 static Verlite.SemVer.ComparePrerelease(string! left, string! right) -> int
 static Verlite.SemVer.IsValidIdentifierCharacter(char input) -> bool
@@ -57,6 +61,7 @@ Verlite.GitMissingOrNotGitRepoException.GitMissingOrNotGitRepoException() -> voi
 Verlite.GitRepoInspector
 Verlite.GitRepoInspector.CanDeepen.get -> bool
 Verlite.GitRepoInspector.CanDeepen.set -> void
+Verlite.GitRepoInspector.FetchTag(Verlite.Tag tag) -> System.Threading.Tasks.Task!
 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?>!
@@ -71,6 +76,7 @@ Verlite.ILogger.Normal(string! message) -> void
 Verlite.ILogger.Verbatim(string! message) -> void
 Verlite.ILogger.Verbose(string! message) -> void
 Verlite.IRepoInspector
+Verlite.IRepoInspector.FetchTag(Verlite.Tag tag) -> System.Threading.Tasks.Task!
 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?>!

src/Verlite.Core/mark-shipped.sh

@@ -5,6 +5,7 @@ cd "$(dirname "$0")"
 
 shipped="$(cat PublicAPI.Shipped.txt PublicAPI.Unshipped.txt \
 	| sort --ignore-case \
+	| awk '{$1=$1};1' \
 	| uniq)"
 
 echo "$shipped" > PublicAPI.Shipped.txt

tests/UnitTests/GitRepoInspectorTests.cs

@@ -244,7 +244,7 @@ public async Task FetchTagFetchesRemoteTagOnly()
 			firstTags.Should().ContainSingle();
 			var firstTag = firstTags[0];
 
-			await repo.FetchTag(firstTag, "origin");
+			await repo.FetchTag(firstTag);
 
 			var localTags = await repo.GetTags(QueryTarget.Local);
 			localTags.Should().Contain(new Tag[]
@@ -347,7 +347,7 @@ public async Task FetchingTagInShallowCloneDoesNotDeepenBeyondTag()
 				.Where(tag => tag.Name == "tag-two")
 				.First();
 
-			await repo.FetchTag(desiredTag, "origin");
+			await repo.FetchTag(desiredTag);
 
 			var desiredParent = await repo.GetParent(desiredTag.PointsTo);
 			desiredParent.Should().Be(deeperTag.PointsTo);
@@ -384,7 +384,7 @@ public async Task FetchingTagInDeepCloneDoesNotMakeShallow()
 				.Where(tag => tag.Name == "tag-two")
 				.First();
 
-			await repo.FetchTag(desiredTag, "origin");
+			await repo.FetchTag(desiredTag);
 			repo = null; // repo modified invalidating internal cache, so remake inspector
 			repo = await clone.MakeInspector();
 
@@ -422,7 +422,7 @@ public async Task ShallowGitFetchFromCommitCanFallBack()
 			var filteredHistory = mockCommandRunner.CommandHistory
 				.Where(cmd => cmd.Contains("git fetch", StringComparison.Ordinal))
 				.Select(cmd =>
-					cmd.Contains("origin", StringComparison.Ordinal) ?
+					!cmd.Contains("origin --depth", StringComparison.Ordinal) ?
 						"normal fetch" :
 						"legacy fetch");
 

tests/UnitTests/Mocks/MockCommandRunnerWithOldRemoteGitVersion.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
@@ -30,12 +31,15 @@ public MockCommandRunnerWithOldRemoteGitVersion(ICommandRunner baseRunner)
 			else
 				commandHistory.Add($"{command} {string.Join(' ', args)}");
 
-			return (command, firstArg, args) switch
+			if (firstArg == "fetch")
 			{
-				("git", "fetch", _) when args.Contains("origin") =>
-					throw new CommandException(128, "", "error: Server does not allow request for unadvertised object a1b2c3"),
-				_ => BaseRunner.Run(directory, command, args, envVars),
-			};
+				if (args.Length is not 3 and not 4)
+					throw new NotSupportedException();
+				if (args.Length == 4 && !args[2].StartsWith("--depth", StringComparison.Ordinal))
+					throw new CommandException(128, "", "error: Server does not allow request for unadvertised object a1b2c3");
+			}
+
+			return BaseRunner.Run(directory, command, args, envVars);
 		}
 	}
 }

tests/UnitTests/Mocks/MockRepoInspector.cs

@@ -59,7 +59,12 @@ public MockRepoInspector(IReadOnlyList<MockRepoCommit> commits)
 			Commits.Reverse(); // reverse it to make First the HEAD.
 		}
 
-		async Task IRepoInspector.FetchTag(Tag tag, string remote)
+		Task IRepoInspector.FetchTag(Tag tag, string remote)
+		{
+			return (this as IRepoInspector).FetchTag(tag);
+		}
+
+		async Task IRepoInspector.FetchTag(Tag tag)
 		{
 			if (LocalTags.Contains(tag))
 				return;