/// List of additional repository hosts for which the task produces SourceLink URLs. /// Each item maps a domain of a repository host (stored in the item identity) to a URL of the server that provides source file content (stored in ContentUrl metadata). /// ContentUrl is optional. ///

- public ITaskItem[] Hosts { get; set; } + public ITaskItem[]? Hosts { get; set; } - public string RepositoryUrl { get; set; } + public string? RepositoryUrl { get; set; } public bool IsSingleProvider { get; set; } [Output] - public string SourceLinkUrl { get; set; } + public string? SourceLinkUrl { get; set; } internal GetSourceLinkUrlGitTask() { } @@ -52,7 +53,7 @@ protected virtual Uri GetDefaultContentUriFromHostUri(string authority, Uri gitU protected virtual Uri GetDefaultContentUriFromRepositoryUri(Uri repositoryUri) => GetDefaultContentUriFromHostUri(repositoryUri.GetAuthority(), repositoryUri); - protected abstract string BuildSourceLinkUrl(Uri contentUrl, Uri gitUri, string relativeUrl, string revisionId, ITaskItem hostItem); + protected abstract string? BuildSourceLinkUrl(Uri contentUrl, Uri gitUri, string relativeUrl, string revisionId, ITaskItem? hostItem); public override bool Execute() { @@ -96,18 +97,17 @@ private void ExecuteImpl() return; } - var contentUri = GetMatchingContentUri(mappings, gitUri, out var hostItem); - if (contentUri == null) + if (!TryGetMatchingContentUri(mappings, gitUri, out var contentUri, out var hostItem)) { SourceLinkUrl = NotApplicableValue; return; } - static bool IsHexDigit(char c) + static bool isHexDigit(char c) => c >= '0' && c <= '9' || c >= 'a' && c <= 'f' || c >= 'A' && c <= 'F'; string revisionId = SourceRoot.GetMetadata(Names.SourceRoot.RevisionId); - if (revisionId == null || revisionId.Length != 40 || !revisionId.All(IsHexDigit)) + if (revisionId == null || revisionId.Length != 40 || !revisionId.All(isHexDigit)) { Log.LogError(CommonResources.ValueOfWithIdentityIsNotValidCommitHash, Names.SourceRoot.RevisionIdFullName, SourceRoot.ItemSpec, revisionId); return; @@ -128,16 +128,16 @@ static bool IsHexDigit(char c) private readonly struct UrlMapping { public readonly string Host; - public readonly ITaskItem HostItem; + public readonly ITaskItem? HostItem; public readonly int Port; public readonly Uri ContentUri; public readonly bool HasDefaultContentUri; - public UrlMapping(string host, ITaskItem hostItem, int port, Uri contentUri, bool hasDefaultContentUri) + public UrlMapping(string host, ITaskItem? hostItem, int port, Uri contentUri, bool hasDefaultContentUri) { - Debug.Assert(port >= -1); - Debug.Assert(!string.IsNullOrEmpty(host)); - Debug.Assert(contentUri != null); + NullableDebug.Assert(port >= -1); + NullableDebug.Assert(!string.IsNullOrEmpty(host)); + NullableDebug.Assert(contentUri != null); Host = host; Port = port; @@ -204,7 +204,7 @@ static bool isValidContentUri(Uri uri) } } - private static Uri GetMatchingContentUri(UrlMapping[] mappings, Uri repoUri, out ITaskItem hostItem) + private static bool TryGetMatchingContentUri(UrlMapping[] mappings, Uri repoUri, [NotNullWhen(true)]out Uri? contentUri, out ITaskItem? hostItem) { UrlMapping? findMatch(bool exactHost) { @@ -235,12 +235,13 @@ private static Uri GetMatchingContentUri(UrlMapping[] mappings, Uri repoUri, out var result = findMatch(exactHost: true) ?? findMatch(exactHost: false); if (result == null) { + contentUri = null; hostItem = null; - return null; + return false; } var value = result.Value; - var contentUri = value.ContentUri; + contentUri = value.ContentUri; hostItem = value.HostItem; // If the mapping did not specify ContentUrl and did not specify port, @@ -250,7 +251,7 @@ private static Uri GetMatchingContentUri(UrlMapping[] mappings, Uri repoUri, out contentUri = new Uri($"{contentUri.Scheme}://{contentUri.Host}:{repoUri.Port}{contentUri.PathAndQuery}"); } - return contentUri; + return true; } } } diff --git a/src/Common/NullableAttributes.cs b/src/Common/NullableAttributes.cs new file mode 100644 index 00000000..8db4ab49 --- /dev/null +++ b/src/Common/NullableAttributes.cs @@ -0,0 +1,110 @@ +// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. + +using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; + +namespace System.Diagnostics.CodeAnalysis +{ + ///

Specifies that null is allowed as an input even if the corresponding type disallows it.

+ [AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property, Inherited = false)] + internal sealed class AllowNullAttribute : Attribute { } + + ///

Specifies that null is disallowed as an input even if the corresponding type allows it.

+ [AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property, Inherited = false)] + internal sealed class DisallowNullAttribute : Attribute { } + + ///

Specifies that an output may be null even if the corresponding type disallows it.

+ [AttributeUsage(AttributeTargets.Field | AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, Inherited = false)] + internal sealed class MaybeNullAttribute : Attribute { } + + ///

Specifies that an output will not be null even if the corresponding type allows it.

Specifies that when a method returns , the parameter may be null even if the corresponding type disallows it.

+ [AttributeUsage(AttributeTargets.Parameter, Inherited = false)] + internal sealed class MaybeNullWhenAttribute : Attribute + { + ///

Initializes the attribute with the specified return value condition.

+ /// + /// The return value condition. If the method returns this value, the associated parameter may be null. + /// + public MaybeNullWhenAttribute(bool returnValue) => ReturnValue = returnValue; + + ///

Gets the return value condition.

+ public bool ReturnValue { get; } + } + + ///

Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it.

+ [AttributeUsage(AttributeTargets.Parameter, Inherited = false)] + internal sealed class NotNullWhenAttribute : Attribute + { + ///

Initializes the attribute with the specified return value condition.

+ /// + /// The return value condition. If the method returns this value, the associated parameter will not be null. + /// + public NotNullWhenAttribute(bool returnValue) => ReturnValue = returnValue; + + ///

Gets the return value condition.

+ public bool ReturnValue { get; } + } + + ///

Specifies that the output will be non-null if the named parameter is non-null.

+ [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.ReturnValue, AllowMultiple = true, Inherited = false)] + internal sealed class NotNullIfNotNullAttribute : Attribute + { + ///

Initializes the attribute with the associated parameter name.

+ /// + /// The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null. + /// + public NotNullIfNotNullAttribute(string parameterName) => ParameterName = parameterName; + + ///

Gets the associated parameter name.

+ public string ParameterName { get; } + } + + ///

Applied to a method that will never return under any circumstance.

+ [AttributeUsage(AttributeTargets.Method, Inherited = false)] + internal sealed class DoesNotReturnAttribute : Attribute { } + + ///

Specifies that the method will not return if the associated Boolean parameter is passed the specified value.

+ [AttributeUsage(AttributeTargets.Parameter, Inherited = false)] + internal sealed class DoesNotReturnIfAttribute : Attribute + { + ///

Initializes the attribute with the specified parameter value.

+ /// + /// The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to + /// the associated parameter matches this value. + /// + public DoesNotReturnIfAttribute(bool parameterValue) => ParameterValue = parameterValue; + + ///

Gets the condition parameter value.

- /// Test scenario where a local repository is cloned from another local repository that was cloned from a remote repository. + /// Test scenario where a local repository is cloned from another local repository that does not have remote URL specified. ///

[Fact] - public void GetRepositoryUrl_Local_NoRemote() + public void GetRepositoryUrl_Local_NoRemoteOriginUrl() { using var temp = new TempRoot(); @@ -257,11 +256,39 @@ public void GetRepositoryUrl_Local_NoRemote() new KeyValuePair>(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(mainWorkingDir.Path)), }))); - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); Assert.Equal(new Uri(mainWorkingDir.Path).AbsoluteUri, GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args)))); AssertEx.Equal(new[] { string.Format(Resources.RepositoryHasNoRemote, mainWorkingDir.Path) }, warnings.Select(TestUtilities.InspectDiagnostic)); } + ///

+ /// Test scenario where a local repository is cloned from another local repository that does not have a working directory. + ///

+ [Fact] + public void GetRepositoryUrl_Local_NoWorkingDirectory() + { + using var temp = new TempRoot(); + + var dir = temp.CreateDirectory(); + + var gitDir1 = dir.CreateDirectory("1"); + gitDir1.CreateFile("HEAD"); + gitDir1.CreateFile("config").WriteAllText(@"[remote ""origin""] url = http://github.com/repo"); + + var gitDir2 = dir.CreateDirectory("2"); + gitDir2.CreateFile("HEAD"); + gitDir2.CreateFile("config").WriteAllText(@"[remote ""origin""] url = ../1"); + + var repo = CreateRepository(config: new GitConfig(ImmutableDictionary.CreateRange(new[] + { + new KeyValuePair>(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(gitDir2.Path)), + }))); + + var warnings = new List<(string, object?[])>(); + Assert.Null(GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args)))); + AssertEx.Equal(new[] { string.Format(Resources.UnableToLocateRepository, gitDir2.Path) }, warnings.Select(TestUtilities.InspectDiagnostic)); + } + ///

/// Test scenario where a local repository is cloned from another local repository that was cloned from a remote repository. ///

@@ -278,7 +305,7 @@ public void GetRepositoryUrl_Local_BadRepo() new KeyValuePair>(new GitVariableName("remote", "origin", "url"), ImmutableArray.Create(mainWorkingDir.Path)), }))); - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); Assert.Equal(new Uri(mainWorkingDir.Path).AbsoluteUri, GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args)))); AssertEx.Equal(new[] { string.Format(Resources.RepositoryHasNoRemote, mainWorkingDir.Path) }, warnings.Select(TestUtilities.InspectDiagnostic)); } @@ -299,7 +326,7 @@ public void GetRepositoryUrl_LocalRecursion() ImmutableArray.Create(mainWorkingDir.Path)), }))); - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); Assert.Equal(new Uri(mainWorkingDir.Path).AbsoluteUri, GitOperations.GetRepositoryUrl(repo, remoteName: null, logWarning: (message, args) => warnings.Add((message, args)))); AssertEx.Equal(new[] { string.Format(Resources.RepositoryUrlEvaluationExceededMaximumAllowedDepth, "10") }, warnings.Select(TestUtilities.InspectDiagnostic)); } @@ -422,7 +449,7 @@ public void GetSourceRoots_RepoWithoutCommits() { var repo = CreateRepository(); - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); var items = GitOperations.GetSourceRoots(repo, remoteName: null, (message, args) => warnings.Add((message, args))); Assert.Empty(items); @@ -439,7 +466,7 @@ public void GetSourceRoots_RepoWithoutCommitsWithSubmodules() CreateSubmodule("1", "sub/1", "http://1.com", "1111111111111111111111111111111111111111"), CreateSubmodule("1", "sub/2", "http://2.com", "2222222222222222222222222222222222222222"))); ; - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); var items = GitOperations.GetSourceRoots(repo, remoteName: null, (message, args) => warnings.Add((message, args))); AssertEx.Equal(new[] @@ -460,7 +487,7 @@ public void GetSourceRoots_RepoWithCommitsWithSubmodules() CreateSubmodule("1", "sub/1", "http://1.com", headCommitSha: null), CreateSubmodule("1", "sub/2", "http://2.com", "2222222222222222222222222222222222222222"))); - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); var items = GitOperations.GetSourceRoots(repo, remoteName: null, (message, args) => warnings.Add((message, args))); AssertEx.Equal(new[] @@ -494,7 +521,7 @@ public void GetSourceRoots_RelativeSubmodulePaths() submodules: ImmutableArray.Create( CreateSubmodule("1", "sub/1", "../1", "1111111111111111111111111111111111111111", containingRepositoryWorkingDir: repoDir.Path))); - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); var items = GitOperations.GetSourceRoots(repo, remoteName: null, (message, args) => warnings.Add((message, args))); AssertEx.Equal(new[] @@ -515,7 +542,7 @@ public void GetSourceRoots_InvalidSubmoduleUrl() CreateSubmodule("1", "sub/1", "http:///", "1111111111111111111111111111111111111111"), CreateSubmodule("3", "sub/3", "http://3.com", "3333333333333333333333333333333333333333"))); - var warnings = new List<(string, object[])>(); + var warnings = new List<(string, object?[])>(); var items = GitOperations.GetSourceRoots(repo, remoteName: null, (message, args) => warnings.Add((message, args))); AssertEx.Equal(new[] @@ -530,84 +557,91 @@ public void GetSourceRoots_InvalidSubmoduleUrl() }, warnings.Select(TestUtilities.InspectDiagnostic)); } + private static GitOperations.DirectoryNode CreateNode(string name, string? submoduleWorkingDirectory, List? children = null) + => new GitOperations.DirectoryNode(name, children ?? new List()) + { + Matcher = (submoduleWorkingDirectory != null) ? new Lazy(() => + new GitIgnore.Matcher(new GitIgnore(null, submoduleWorkingDirectory, ignoreCase: false))) : null + }; + [ConditionalTheory(typeof(WindowsOnly))] [InlineData(@"C:\", null)] [InlineData(@"C:\x", null)] [InlineData(@"C:\x\y\z", null)] [InlineData(@"C:\src", null)] [InlineData(@"C:\src\", null)] - [InlineData(@"C:\src\a\x.cs", @"C:\src\a")] - [InlineData(@"C:\src\b\x.cs", @"C:\src")] - [InlineData(@"C:\src\ab\x.cs", @"C:\src")] - [InlineData(@"C:\src\a\b\x.cs", @"C:\src\a")] - [InlineData(@"C:\src\c\x.cs", @"C:\src\c")] - [InlineData(@"C:\src\c", @"C:\src")] - [InlineData(@"C:\src\c\", @"C:\src")] - [InlineData(@"C:\src\c.cs", @"C:\src")] - [InlineData(@"C:\src\c\x\x.cs", @"C:\src\c\x")] - [InlineData(@"C:\src\d\x.cs", @"C:\src")] - [InlineData(@"C:\src\e\x.cs", @"C:\src\e")] + [InlineData(@"C:\src\a\x.cs", "C:/src/a/")] + [InlineData(@"C:\src\b\x.cs", "C:/src/")] + [InlineData(@"C:\src\ab\x.cs", "C:/src/")] + [InlineData(@"C:\src\a\b\x.cs", "C:/src/a/")] + [InlineData(@"C:\src\c\x.cs", "C:/src/c/")] + [InlineData(@"C:\src\c", "C:/src/")] + [InlineData(@"C:\src\c\", "C:/src/")] + [InlineData(@"C:\src\c.cs", "C:/src/")] + [InlineData(@"C:\src\c\x\x.cs", "C:/src/c/x/")] + [InlineData(@"C:\src\d\x.cs", "C:/src/")] + [InlineData(@"C:\src\e\x.cs", "C:/src/e/")] public void GetContainingRepository_Windows(string path, string expectedDirectory) { - var actual = GitOperations.GetContainingRepository(path, - new GitOperations.DirectoryNode("", null, + var actual = GitOperations.GetContainingRepositoryMatcher(path, + CreateNode("", null, new List { - new GitOperations.DirectoryNode("C:", null, new List + CreateNode("C:", null, new List { - new GitOperations.DirectoryNode("src", @"C:\src", new List + CreateNode("src", @"C:\src", new List { - new GitOperations.DirectoryNode("a", @"C:\src\a"), - new GitOperations.DirectoryNode("c", @"C:\src\c", new List + CreateNode("a", @"C:\src\a"), + CreateNode("c", @"C:\src\c", new List { - new GitOperations.DirectoryNode("x", @"C:\src\c\x") + CreateNode("x", @"C:\src\c\x") }), - new GitOperations.DirectoryNode("e", @"C:\src\e") + CreateNode("e", @"C:\src\e") }), }) })); - Assert.Equal(expectedDirectory, actual?.WorkingDirectoryFullPath); + Assert.Equal(expectedDirectory, actual?.Ignore.WorkingDirectory); } [ConditionalTheory(typeof(UnixOnly))] - [InlineData(@"/", null)] - [InlineData(@"/x", null)] - [InlineData(@"/x/y/z", null)] - [InlineData(@"/src", null)] - [InlineData(@"/src/", null)] - [InlineData(@"/src/a/x.cs", @"/src/a")] - [InlineData(@"/src/b/x.cs", @"/src")] - [InlineData(@"/src/ab/x.cs", @"/src")] - [InlineData(@"/src/a/b/x.cs", @"/src/a")] - [InlineData(@"/src/c/x.cs", @"/src/c")] - [InlineData(@"/src/c", @"/src")] - [InlineData(@"/src/c/", @"/src")] - [InlineData(@"/src/c.cs", @"/src")] - [InlineData(@"/src/c/x/x.cs", @"/src/c/x")] - [InlineData(@"/src/d/x.cs", @"/src")] - [InlineData(@"/src/e/x.cs", @"/src/e")] + [InlineData("/", null)] + [InlineData("/x", null)] + [InlineData("/x/y/z", null)] + [InlineData("/src", null)] + [InlineData("/src/", null)] + [InlineData("/src/a/x.cs", "/src/a/")] + [InlineData("/src/b/x.cs", "/src/")] + [InlineData("/src/ab/x.cs", "/src/")] + [InlineData("/src/a/b/x.cs", "/src/a/")] + [InlineData("/src/c/x.cs", "/src/c/")] + [InlineData("/src/c", "/src/")] + [InlineData("/src/c/", "/src/")] + [InlineData("/src/c.cs", "/src/")] + [InlineData("/src/c/x/x.cs", "/src/c/x/")] + [InlineData("/src/d/x.cs", "/src/")] + [InlineData("/src/e/x.cs", "/src/e/")] public void GetContainingRepository_Unix(string path, string expectedDirectory) { - var actual = GitOperations.GetContainingRepository(path, - new GitOperations.DirectoryNode("", null, + var actual = GitOperations.GetContainingRepositoryMatcher(path, + CreateNode("", null, new List { - new GitOperations.DirectoryNode("/", null, new List + CreateNode("/", null, new List { - new GitOperations.DirectoryNode("src", "/src", new List + CreateNode("src", "/src", new List { - new GitOperations.DirectoryNode("a", "/src/a"), - new GitOperations.DirectoryNode("c", "/src/c", new List + CreateNode("a", "/src/a"), + CreateNode("c", "/src/c", new List { - new GitOperations.DirectoryNode("x", "/src/c/x"), + CreateNode("x", "/src/c/x"), }), - new GitOperations.DirectoryNode("e", "/src/e"), + CreateNode("e", "/src/e"), }), }) })); - Assert.Equal(expectedDirectory, actual?.WorkingDirectoryFullPath); + Assert.Equal(expectedDirectory, actual?.Ignore.WorkingDirectory); } [Fact] @@ -623,10 +657,10 @@ public void BuildDirectoryTree() CreateSubmodule("5", "c", "http://github.com/5", null), CreateSubmodule("6", "a/z", "http://github.com/6", null))); - var root = GitOperations.BuildDirectoryTree(repo); + var root = GitOperations.BuildDirectoryTree(repo, (e, d) => null); - string inspect(GitOperations.DirectoryNode node) - => node.Name + (node.WorkingDirectoryFullPath != null ? $"!" : "") + "{" + string.Join(",", node.OrderedChildren.Select(inspect)) + "}"; + static string inspect(GitOperations.DirectoryNode node) + => node.Name + (node.Matcher != null ? $"!" : "") + "{" + string.Join(",", node.OrderedChildren.Select(inspect)) + "}"; var expected = IsUnix ? "{/{usr{src!{a!{a{a{a!{}}},z!{}},c!{x!{}},e!{}}}}}" : @@ -665,7 +699,7 @@ public void GetUntrackedFiles_ProjectInMainRepoIncludesFilesInSubmodules() new MockItem(IsUnix ? "/d/w.cs" : @"D:\w.cs"), // outside of repo }, projectDirectory: Path.Combine(_workingDir, "p"), - root => subRepos[root]); + (_, root) => subRepos[root]); AssertEx.Equal(new[] { @@ -706,7 +740,7 @@ public void GetUntrackedFiles_ProjectInSubmodule() new MockItem(@"..\..\c.cs"), // ignored in main repo }, projectDirectory: subRoot1, - root => subRepos[root]); + (_, root) => subRepos[root]); AssertEx.Equal(new[] { diff --git a/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs b/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs index aa8db1b2..8d611bb4 100644 --- a/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs +++ b/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs @@ -159,7 +159,7 @@ public void OpenRepository() var src = workingDir.CreateDirectory("src"); - var repository = GitRepository.OpenRepository(src.Path, new GitEnvironment(homeDir.Path)); + var repository = GitRepository.OpenRepository(src.Path, new GitEnvironment(homeDir.Path))!; Assert.Equal(gitDir.Path, repository.CommonDirectory); Assert.Equal(gitDir.Path, repository.GitDirectory); @@ -218,7 +218,7 @@ public void Submodules() "); var repository = new GitRepository(GitEnvironment.Empty, GitConfig.Empty, gitDir.Path, gitDir.Path, workingDir.Path); - var submodules = GitRepository.EnumerateSubmoduleConfig(repository.ReadSubmoduleConfig()); + var submodules = GitRepository.EnumerateSubmoduleConfig(repository.ReadSubmoduleConfig()!); AssertEx.Equal(new[] { "S1: 'subs/s1' 'http://github.com/test1'", diff --git a/src/Microsoft.Build.Tasks.Git.UnitTests/GlobTests.cs b/src/Microsoft.Build.Tasks.Git.UnitTests/GlobTests.cs index f519c24c..13ff1f65 100644 --- a/src/Microsoft.Build.Tasks.Git.UnitTests/GlobTests.cs +++ b/src/Microsoft.Build.Tasks.Git.UnitTests/GlobTests.cs @@ -103,7 +103,7 @@ public void NonMatching(string pattern, string path) [InlineData("[^]", new char[0])] [InlineData("[]", new char[0])] [InlineData("[a-]]", new char[0])] - public void MatchingRange(string pattern, char[] matchingChars, char[] matchingCharsWildCardMatchesSeparator = null) + public void MatchingRange(string pattern, char[] matchingChars, char[]? matchingCharsWildCardMatchesSeparator = null) { for (int i = 0; i < 255; i++) { diff --git a/src/Microsoft.Build.Tasks.Git.UnitTests/TestUtilities.cs b/src/Microsoft.Build.Tasks.Git.UnitTests/TestUtilities.cs index 03254d58..6497485f 100644 --- a/src/Microsoft.Build.Tasks.Git.UnitTests/TestUtilities.cs +++ b/src/Microsoft.Build.Tasks.Git.UnitTests/TestUtilities.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. using System; -using System.IO; using Microsoft.Build.Framework; namespace Microsoft.Build.Tasks.Git.UnitTests @@ -26,10 +25,10 @@ public static string InspectSourceRoot(ITaskItem sourceRoot) (string.IsNullOrEmpty(sourceLinkUrl) ? "" : $" SourceLinkUrl='{sourceLinkUrl}'"); } - public static string InspectDiagnostic((string Message, object[] Args) warning) + public static string InspectDiagnostic((string Message, object?[] Args) warning) => string.Format(warning.Message, warning.Args); - public static string GetExceptionMessage(Action action) + public static string? GetExceptionMessage(Action action) { try { diff --git a/src/Microsoft.Build.Tasks.Git/AssemblyResolver.cs b/src/Microsoft.Build.Tasks.Git/AssemblyResolver.cs index 1430a7f1..9889bb54 100644 --- a/src/Microsoft.Build.Tasks.Git/AssemblyResolver.cs +++ b/src/Microsoft.Build.Tasks.Git/AssemblyResolver.cs @@ -8,7 +8,6 @@ using System.Collections.Generic; using System.IO; using System.Reflection; -using Microsoft.Build.Framework; namespace Microsoft.Build.Tasks.Git { @@ -38,7 +37,7 @@ internal static string[] GetLog() } } - private static Assembly AssemblyResolve(object sender, ResolveEventArgs args) + private static Assembly? AssemblyResolve(object sender, ResolveEventArgs args) { var name = new AssemblyName(args.Name); diff --git a/src/Microsoft.Build.Tasks.Git/GetUntrackedFiles.cs b/src/Microsoft.Build.Tasks.Git/GetUntrackedFiles.cs index ad213419..7465313b 100644 --- a/src/Microsoft.Build.Tasks.Git/GetUntrackedFiles.cs +++ b/src/Microsoft.Build.Tasks.Git/GetUntrackedFiles.cs @@ -1,5 +1,6 @@ // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. +using System.Diagnostics.CodeAnalysis; using Microsoft.Build.Framework; namespace Microsoft.Build.Tasks.Git @@ -9,24 +10,23 @@ namespace Microsoft.Build.Tasks.Git /// public sealed class GetUntrackedFiles : RepositoryTask { - public string RepositoryId { get; set; } + public string? RepositoryId { get; set; } - [Required] - public ITaskItem[] Files { get; set; } + [Required, NotNull] + public ITaskItem[]? Files { get; set; } - [Required] - public string ProjectDirectory { get; set; } + [Required, NotNull] + public string? ProjectDirectory { get; set; } [Output] - public ITaskItem[] UntrackedFiles { get; private set; } + public ITaskItem[]? UntrackedFiles { get; private set; } - protected override string GetRepositoryId() => RepositoryId; + protected override string? GetRepositoryId() => RepositoryId; protected override string GetInitialPath() => ProjectDirectory; private protected override void Execute(GitRepository repository) { - UntrackedFiles = GitOperations.GetUntrackedFiles( - repository, Files, ProjectDirectory, dir => GitRepository.OpenRepository(dir, repository.Environment)); + UntrackedFiles = GitOperations.GetUntrackedFiles(repository, Files, ProjectDirectory); } } } diff --git a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.Reader.cs b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.Reader.cs index 61507b04..34c28916 100644 --- a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.Reader.cs +++ b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.Reader.cs @@ -6,7 +6,6 @@ using System.Diagnostics; using System.IO; using System.Text; -using Microsoft.Build.Tasks.SourceControl; namespace Microsoft.Build.Tasks.Git { @@ -26,9 +25,9 @@ internal class Reader private readonly Func _fileOpener; private readonly GitEnvironment _environment; - public Reader(string gitDirectory, string commonDirectory, GitEnvironment environment, Func fileOpener = null) + public Reader(string gitDirectory, string commonDirectory, GitEnvironment environment, Func? fileOpener = null) { - Debug.Assert(environment != null); + NullableDebug.Assert(environment != null); _environment = environment; _gitDirectoryPosix = PathUtils.ToPosixDirectoryPath(gitDirectory); @@ -61,7 +60,7 @@ internal GitConfig LoadFrom(string path) return new GitConfig(variables.ToImmutableDictionary(kvp => kvp.Key, kvp => kvp.Value.ToImmutableArray())); } - private string GetXdgDirectory() + private string? GetXdgDirectory() { var xdgConfigHome = _environment.XdgConfigHomeDirectory; if (xdgConfigHome != null) @@ -132,7 +131,7 @@ internal IEnumerable EnumerateExistingConfigurationFiles() // worktree config } - private string GetSystemConfigurationDirectory() + private string? GetSystemConfigurationDirectory() { if (_environment.SystemDirectory == null) { diff --git a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.cs b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.cs index 9f930f52..d55cd02d 100644 --- a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.cs +++ b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitConfig.cs @@ -4,6 +4,7 @@ using System.Collections.Generic; using System.Collections.Immutable; using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; using System.IO; using System.Linq; using System.Text; @@ -18,7 +19,7 @@ internal sealed partial class GitConfig public GitConfig(ImmutableDictionary> variables) { - Debug.Assert(variables != null); + NullableDebug.Assert(variables != null); Variables = variables; } @@ -32,19 +33,19 @@ public ImmutableArray GetVariableValues(string section, string name) public ImmutableArray GetVariableValues(string section, string subsection, string name) => Variables.TryGetValue(new GitVariableName(section, subsection, name), out var multiValue) ? multiValue : default; - public string GetVariableValue(string section, string name) + public string? GetVariableValue(string section, string name) => GetVariableValue(section, "", name); - public string GetVariableValue(string section, string subsection, string name) + public string? GetVariableValue(string section, string subsection, string name) { var values = GetVariableValues(section, subsection, name); return values.IsDefault ? null : values[values.Length - 1]; } - public static bool ParseBooleanValue(string str, bool defaultValue = false) + public static bool ParseBooleanValue(string? str, bool defaultValue = false) => TryParseBooleanValue(str, out var value) ? value : defaultValue; - public static bool TryParseBooleanValue(string str, out bool value) + public static bool TryParseBooleanValue(string? str, out bool value) { // https://git-scm.com/docs/git-config#Documentation/git-config.txt-boolean @@ -75,9 +76,9 @@ public static bool TryParseBooleanValue(string str, out bool value) internal static long ParseInt64Value(string str, long defaultValue = 0) => TryParseInt64Value(str, out var value) ? value : defaultValue; - internal static bool TryParseInt64Value(string str, out long value) + internal static bool TryParseInt64Value(string? str, out long value) { - if (string.IsNullOrEmpty(str)) + if (NullableString.IsNullOrEmpty(str)) { value = 0; return false; diff --git a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitEnvironment.cs b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitEnvironment.cs index 75bc39a1..6d7be601 100644 --- a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitEnvironment.cs +++ b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitEnvironment.cs @@ -2,9 +2,9 @@ using System; using System.Diagnostics; +using System.Diagnostics.CodeAnalysis; using System.IO; using System.Linq; -using Microsoft.Build.Tasks.SourceControl; namespace Microsoft.Build.Tasks.Git { @@ -15,10 +15,10 @@ internal sealed class GitEnvironment public static readonly GitEnvironment Empty = new GitEnvironment(); - public string HomeDirectory { get; } - public string XdgConfigHomeDirectory { get; } - public string ProgramDataDirectory { get; } - public string SystemDirectory { get; } + public string? HomeDirectory { get; } + public string? XdgConfigHomeDirectory { get; } + public string? ProgramDataDirectory { get; } + public string? SystemDirectory { get; } // TODO: https://github.com/dotnet/sourcelink/issues/301 // consider adding environment variables: GIT_DIR, GIT_DISCOVERY_ACROSS_FILESYSTEM, GIT_CEILING_DIRECTORIES @@ -33,10 +33,10 @@ internal sealed class GitEnvironment // https://git-scm.com/docs/git#Documentation/git.txt-codeGITWORKTREEcode public GitEnvironment( - string homeDirectory = null, - string xdgConfigHomeDirectory = null, - string programDataDirectory = null, - string systemDirectory = null) + string? homeDirectory = null, + string? xdgConfigHomeDirectory = null, + string? programDataDirectory = null, + string? systemDirectory = null) { if (!string.IsNullOrWhiteSpace(homeDirectory)) { @@ -59,9 +59,9 @@ public GitEnvironment( } } - public static GitEnvironment Create(string configurationScope) + public static GitEnvironment Create(string? configurationScope) { - if (string.IsNullOrEmpty(configurationScope)) + if (NullableString.IsNullOrEmpty(configurationScope)) { return CreateFromProcessEnvironment(); } @@ -76,7 +76,7 @@ public static GitEnvironment Create(string configurationScope) public static GitEnvironment CreateFromProcessEnvironment() { - static string getVariable(string name) + static string? getVariable(string name) { try { @@ -88,7 +88,7 @@ static string getVariable(string name) } } - string homeDirectory; + string? homeDirectory; try { homeDirectory = Environment.GetFolderPath(Environment.SpecialFolder.UserProfile, Environment.SpecialFolderOption.DoNotVerify); @@ -106,7 +106,7 @@ static string getVariable(string name) } // internal for testing - internal static string FindSystemDirectory(string pathList, string unixEtcDir) + internal static string? FindSystemDirectory(string? pathList, string? unixEtcDir) { if (PathUtils.IsUnixLikePlatform) { @@ -122,11 +122,11 @@ internal static string FindSystemDirectory(string pathList, string unixEtcDir) return null; } - private static string FindWindowsGitInstallation(string pathList) + private static string? FindWindowsGitInstallation(string? pathList) { Debug.Assert(!PathUtils.IsUnixLikePlatform); - if (string.IsNullOrEmpty(pathList)) + if (NullableString.IsNullOrEmpty(pathList)) { return null; } diff --git a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitIgnore.Matcher.cs b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitIgnore.Matcher.cs index d36ce869..5196ac9b 100644 --- a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitIgnore.Matcher.cs +++ b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitIgnore.Matcher.cs @@ -16,7 +16,7 @@ internal sealed class Matcher ///

/// Maps full posix slash-terminated directory name to a pattern group. ///

- private readonly Dictionary _patternGroups; + private readonly Dictionary _patternGroups; ///

/// Normalized full path. OS specific directory separators. Optional. ///

- public string WorkingDirectory { get; } + public string? WorkingDirectory { get; } public GitEnvironment Environment { get; } private readonly Lazy<(ImmutableArray Submodules, ImmutableArray Diagnostics)> _lazySubmodules; private readonly Lazy _lazyIgnore; - private readonly Lazy _lazyHeadCommitSha; + private readonly Lazy _lazyHeadCommitSha; private readonly GitReferenceResolver _referenceResolver; - internal GitRepository(GitEnvironment environment, GitConfig config, string gitDirectory, string commonDirectory, string workingDirectory) + internal GitRepository(GitEnvironment environment, GitConfig config, string gitDirectory, string commonDirectory, string? workingDirectory) { - Debug.Assert(environment != null); - Debug.Assert(config != null); - Debug.Assert(PathUtils.IsNormalized(gitDirectory)); - Debug.Assert(PathUtils.IsNormalized(commonDirectory)); - Debug.Assert(workingDirectory == null || PathUtils.IsNormalized(workingDirectory)); + NullableDebug.Assert(environment != null); + NullableDebug.Assert(config != null); + NullableDebug.Assert(PathUtils.IsNormalized(gitDirectory)); + NullableDebug.Assert(PathUtils.IsNormalized(commonDirectory)); + NullableDebug.Assert(workingDirectory == null || PathUtils.IsNormalized(workingDirectory)); Config = config; GitDirectory = gitDirectory; @@ -66,7 +67,7 @@ internal GitRepository(GitEnvironment environment, GitConfig config, string gitD _referenceResolver = new GitReferenceResolver(gitDirectory, commonDirectory); _lazySubmodules = new Lazy<(ImmutableArray, ImmutableArray)>(ReadSubmodules); _lazyIgnore = new Lazy(LoadIgnore); - _lazyHeadCommitSha = new Lazy(ReadHeadCommitSha); + _lazyHeadCommitSha = new Lazy(ReadHeadCommitSha); } // test only @@ -75,16 +76,16 @@ internal GitRepository( GitConfig config, string gitDirectory, string commonDirectory, - string workingDirectory, + string? workingDirectory, ImmutableArray submodules, ImmutableArray submoduleDiagnostics, GitIgnore ignore, - string headCommitSha) + string? headCommitSha) : this(environment, config, gitDirectory, commonDirectory, workingDirectory) { _lazySubmodules = new Lazy<(ImmutableArray, ImmutableArray)>(() => (submodules, submoduleDiagnostics)); _lazyIgnore = new Lazy(() => ignore); - _lazyHeadCommitSha = new Lazy(() => headCommitSha); + _lazyHeadCommitSha = new Lazy(() => headCommitSha); } ///

@@ -94,7 +95,7 @@ internal GitRepository( /// /// The repository found requires higher version of git repository format that is currently supported. /// null if no git repository can be found that contains the specified path. - internal static GitRepository OpenRepository(string path, GitEnvironment environment) + internal static GitRepository? OpenRepository(string path, GitEnvironment environment) => TryFindRepository(path, out var location) ? OpenRepository(location, environment) : null; ///

@@ -105,19 +106,19 @@ internal static GitRepository OpenRepository(string path, GitEnvironment environ /// The repository found requires higher version of git repository format that is currently supported. public static GitRepository OpenRepository(GitRepositoryLocation location, GitEnvironment environment) { - Debug.Assert(environment != null); - Debug.Assert(location.GitDirectory != null); - Debug.Assert(location.CommonDirectory != null); + NullableDebug.Assert(environment != null); + NullableDebug.Assert(location.GitDirectory != null); + NullableDebug.Assert(location.CommonDirectory != null); // See https://git-scm.com/docs/gitrepository-layout var reader = new GitConfig.Reader(location.GitDirectory, location.CommonDirectory, environment); var config = reader.Load(); - var workingDirectory = GetWorkingDirectory(config, location.GitDirectory, location.CommonDirectory) ?? location.WorkingDirectory; + var workingDirectory = GetWorkingDirectory(config, location); // See https://github.com/git/git/blob/master/Documentation/technical/repository-version.txt - string versionStr = config.GetVariableValue("core", "repositoryformatversion"); + string? versionStr = config.GetVariableValue("core", "repositoryformatversion"); if (GitConfig.TryParseInt64Value(versionStr, out var version) && version > SupportedGitRepoFormatVersion) { throw new NotSupportedException(string.Format(Resources.UnsupportedRepositoryVersion, versionStr, SupportedGitRepoFormatVersion)); @@ -126,15 +127,14 @@ public static GitRepository OpenRepository(GitRepositoryLocation location, GitEn return new GitRepository(environment, config, location.GitDirectory, location.CommonDirectory, workingDirectory); } - // internal for testing - internal static string GetWorkingDirectory(GitConfig config, string gitDirectory, string commonDirectory) + private static string? GetWorkingDirectory(GitConfig config, GitRepositoryLocation location) { // Working trees cannot have the same common directory and git directory. // 'gitdir' file in a git directory indicates a working tree. - var gitdirFilePath = Path.Combine(gitDirectory, GitDirFileName); + var gitdirFilePath = Path.Combine(location.GitDirectory, GitDirFileName); - var isLinkedWorkingTree = PathUtils.ToPosixDirectoryPath(commonDirectory) != PathUtils.ToPosixDirectoryPath(gitDirectory) && + var isLinkedWorkingTree = PathUtils.ToPosixDirectoryPath(location.CommonDirectory) != PathUtils.ToPosixDirectoryPath(location.GitDirectory) && File.Exists(gitdirFilePath); if (isLinkedWorkingTree) @@ -170,13 +170,13 @@ internal static string GetWorkingDirectory(GitConfig config, string gitDirectory } // See https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreworktree - string value = config.GetVariableValue("core", "worktree"); + string? value = config.GetVariableValue("core", "worktree"); if (value != null) { // git does not expand home dir relative path ("~/") try { - return Path.GetFullPath(Path.Combine(gitDirectory, value)); + return Path.GetFullPath(Path.Combine(location.GitDirectory, value)); } catch { @@ -184,7 +184,7 @@ internal static string GetWorkingDirectory(GitConfig config, string gitDirectory } } - return null; + return location.WorkingDirectory; } ///

@@ -193,12 +193,12 @@ internal static string GetWorkingDirectory(GitConfig config, string gitDirectory /// /// /// Null if the HEAD tip reference can't be resolved. - public string GetHeadCommitSha() + public string? GetHeadCommitSha() => _lazyHeadCommitSha.Value; /// /// - private string ReadHeadCommitSha() + private string? ReadHeadCommitSha() => _referenceResolver.ResolveHeadReference(); ///

@@ -207,7 +207,7 @@ private string ReadHeadCommitSha() /// /// /// Null if the HEAD tip reference can't be resolved. - internal string ReadSubmoduleHeadCommitSha(string submoduleWorkingDirectoryFullPath) + internal string? ReadSubmoduleHeadCommitSha(string submoduleWorkingDirectoryFullPath) { var gitDirectory = ReadDotGitFile(Path.Combine(submoduleWorkingDirectoryFullPath, GitDirName)); if (!IsGitDirectory(gitDirectory, out var commonDirectory)) @@ -246,7 +246,7 @@ public ImmutableArray GetSubmoduleDiagnostics() return (ImmutableArray.Empty, ImmutableArray.Empty); } - ImmutableArray.Builder lazyDiagnostics = null; + ImmutableArray.Builder? lazyDiagnostics = null; void reportDiagnostic(string diagnostic) => (lazyDiagnostics ??= ImmutableArray.CreateBuilder()).Add(diagnostic); @@ -255,13 +255,13 @@ void reportDiagnostic(string diagnostic) foreach (var (name, path, url) in EnumerateSubmoduleConfig(submoduleConfig)) { - if (string.IsNullOrWhiteSpace(path)) + if (NullableString.IsNullOrWhiteSpace(path)) { reportDiagnostic(string.Format(Resources.InvalidSubmodulePath, name, path)); continue; } - if (string.IsNullOrWhiteSpace(url)) + if (NullableString.IsNullOrWhiteSpace(url)) { reportDiagnostic(string.Format(Resources.InvalidSubmoduleUrl, name, url)); continue; @@ -278,7 +278,7 @@ void reportDiagnostic(string diagnostic) continue; } - string headCommitSha; + string? headCommitSha; try { headCommitSha = ReadSubmoduleHeadCommitSha(fullPath); @@ -296,7 +296,7 @@ void reportDiagnostic(string diagnostic) } // internal for testing - internal GitConfig ReadSubmoduleConfig() + internal GitConfig? ReadSubmoduleConfig() { var workingDirectory = GetWorkingDirectory(); var submodulesConfigFile = Path.Combine(workingDirectory, GitModulesFileName); @@ -310,7 +310,7 @@ internal GitConfig ReadSubmoduleConfig() } // internal for testing - internal static IEnumerable<(string Name, string Path, string Url)> EnumerateSubmoduleConfig(GitConfig submoduleConfig) + internal static IEnumerable<(string Name, string? Path, string? Url)> EnumerateSubmoduleConfig(GitConfig submoduleConfig) { foreach (var group in submoduleConfig.Variables. Where(kvp => kvp.Key.SectionNameEquals("submodule")). @@ -318,8 +318,8 @@ internal GitConfig ReadSubmoduleConfig() OrderBy(group => group.Key)) { string name = group.Key; - string url = null; - string path = null; + string? url = null; + string? path = null; foreach (var variable in group) { @@ -408,7 +408,7 @@ public static bool TryFindRepository(string directory, out GitRepositoryLocation private static bool TryGetRepositoryLocationImpl(string directory, out GitRepositoryLocation location) { - string commonDirectory; + string? commonDirectory; var dotGitPath = Path.Combine(directory, GitDirName); if (Directory.Exists(dotGitPath)) @@ -475,7 +475,7 @@ private static string ReadDotGitFile(string path) } } - private static bool IsGitDirectory(string directory, out string commonDirectory) + private static bool IsGitDirectory(string directory, [NotNullWhen(true)]out string? commonDirectory) { // HEAD file is required if (!File.Exists(Path.Combine(directory, GitHeadFileName))) diff --git a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepositoryLocation.cs b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepositoryLocation.cs index 62d1eff3..6d1d96f3 100644 --- a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepositoryLocation.cs +++ b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepositoryLocation.cs @@ -1,6 +1,6 @@ // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. -using System.Diagnostics; +using System; namespace Microsoft.Build.Tasks.Git { @@ -19,13 +19,13 @@ internal readonly struct GitRepositoryLocation ///

/// Normalized full path. OS specific directory separators. Optional. ///

- public readonly string WorkingDirectory { get; } + public readonly string? WorkingDirectory { get; } - internal GitRepositoryLocation(string gitDirectory, string commonDirectory, string workingDirectory) + internal GitRepositoryLocation(string gitDirectory, string commonDirectory, string? workingDirectory) { - Debug.Assert(PathUtils.IsNormalized(gitDirectory)); - Debug.Assert(PathUtils.IsNormalized(commonDirectory)); - Debug.Assert(workingDirectory == null || PathUtils.IsNormalized(workingDirectory)); + NullableDebug.Assert(PathUtils.IsNormalized(gitDirectory)); + NullableDebug.Assert(PathUtils.IsNormalized(commonDirectory)); + NullableDebug.Assert(workingDirectory == null || PathUtils.IsNormalized(workingDirectory)); GitDirectory = gitDirectory; CommonDirectory = commonDirectory; diff --git a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitSubmodule.cs b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitSubmodule.cs index 4797564f..cba708d7 100644 --- a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitSubmodule.cs +++ b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitSubmodule.cs @@ -1,6 +1,7 @@ // Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. -using System.Diagnostics; +using System; +using System.Diagnostics.CodeAnalysis; namespace Microsoft.Build.Tasks.Git { @@ -27,14 +28,14 @@ internal readonly struct GitSubmodule ///

/// Head tip commit SHA. Null, if there is no commit. ///

/// Returns items describing repository source roots: @@ -32,19 +34,21 @@ public sealed class LocateRepository : RepositoryTask /// NestedRoot: For a submodule root, a path of the submodule root relative to the repository root. Ends with a slash. ///

[Output] - public ITaskItem[] Roots { get; private set; } + public ITaskItem[]? Roots { get; private set; } ///

/// Head tip commit SHA. ///

/// Creates a file in this directory that is a copy of the specified file. ///

+ /// The task calculates SourceLink URL for a given SourceRoot. If the SourceRoot is associated + /// with a git repository with a recognized domain the output + /// property is set to the content URL corresponding to the domain, otherwise it is set to + /// string "N/A". + ///

+ public sealed class GetSourceLinkUrl : GetSourceLinkUrlGitTask + { + protected override string HostsItemGroupName => "SourceLinkGitWebHost"; + protected override string ProviderDisplayName => "GitWeb"; + + protected override Uri GetDefaultContentUriFromHostUri(string authority, Uri gitUri) + => new Uri($"https://{authority}/gitweb", UriKind.Absolute); + + protected override string BuildSourceLinkUrl(Uri contentUri, Uri gitUri, string relativeUrl, string revisionId, ITaskItem? hostItem) + { + var trimLeadingSlash = relativeUrl.TrimStart('/'); + var trimmedContentUrl = contentUri.ToString().TrimEnd('/', '\\'); + + // p = project/path + // a = action + // hb = SHA/revision + // f = repo file path + var gitwebRawUrl = UriUtilities.Combine(trimmedContentUrl, $"?p={trimLeadingSlash}.git;a=blob_plain;hb={revisionId};f=*"); + return gitwebRawUrl; + } + } +} diff --git a/src/SourceLink.GitWeb/Microsoft.SourceLink.GitWeb.csproj b/src/SourceLink.GitWeb/Microsoft.SourceLink.GitWeb.csproj new file mode 100644 index 00000000..d9fb3080 --- /dev/null +++ b/src/SourceLink.GitWeb/Microsoft.SourceLink.GitWeb.csproj @@ -0,0 +1,35 @@ + + + net461;netcoreapp2.0 + true + + + true + $(MSBuildProjectName).nuspec + $(OutputPath) + + Generates source link for Git repositories using a GitWeb server. + MSBuild Tasks GitWeb source link + true + + + + + + + + + Microsoft.Build.Tasks.SourceControl + true + + + + + + + + + + + + diff --git a/src/SourceLink.GitWeb/Microsoft.SourceLink.GitWeb.nuspec b/src/SourceLink.GitWeb/Microsoft.SourceLink.GitWeb.nuspec new file mode 100644 index 00000000..5acaea90 --- /dev/null +++ b/src/SourceLink.GitWeb/Microsoft.SourceLink.GitWeb.nuspec @@ -0,0 +1,17 @@ + + + + $CommonMetadataElements$ + + + + + + + $CommonFileElements$ + + + + + + diff --git a/src/SourceLink.GitWeb/Resources.resx b/src/SourceLink.GitWeb/Resources.resx new file mode 100644 index 00000000..143a5dc8 --- /dev/null +++ b/src/SourceLink.GitWeb/Resources.resx @@ -0,0 +1,123 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + The Microsoft.SourceLink.GitWeb provider does not support translating the '{0}' protocol to content URLs. + + \ No newline at end of file diff --git a/src/SourceLink.GitWeb/TranslateRepositoryUrls.cs b/src/SourceLink.GitWeb/TranslateRepositoryUrls.cs new file mode 100644 index 00000000..591cd7d4 --- /dev/null +++ b/src/SourceLink.GitWeb/TranslateRepositoryUrls.cs @@ -0,0 +1,31 @@ +// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See +// License.txt in the project root for license information. + +using Microsoft.Build.Tasks.SourceControl; +using System; + +namespace Microsoft.SourceLink.GitWeb +{ + ///

+ /// This task normally translates all protocols to HTTPS git repo URLs for consistency. Not all + /// GitWebs support HTTPS URLs for clones. So instead we keep the SSH URL. The + /// Task converts the URLs to HTTP content URLs which GitWeb does + /// support. The output of this Task is independent of . + ///

+ public sealed class TranslateRepositoryUrls : TranslateRepositoryUrlsGitTask + { + ///

+ /// Keep the SSH URL. It is the only protocol currently known to work with GitWeb. + ///

- /// An absolute URL or a relative path (if it starts with `./` or `../`) to the default remote of the containing repository. + /// An absolute URL or a relative path (if it starts with `./` or `../`) to the origin remote of the containing repository. ///

- public string Url { get; } + public string? Url { get; } ///

/// Head tip commit SHA. Null, if there is no commit. ///

The value of environment variable {0} is not a well-formed list of URL pairs: '{1}'" diff --git a/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf b/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf index 177fe576..b5bb875c 100644 --- a/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

The value of environment variable {0} is not a well-formed list of URL pairs: '{1}'" diff --git a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf index bc963ae6..05d2ad3b 100644 --- a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf +++ b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf @@ -1,6 +1,6 @@ - +

The value of environment variable {0} is not a well-formed list of URL pairs: '{1}'" diff --git a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf index 177fe576..b5bb875c 100644 --- a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

Specifies that null is allowed as an input even if the corresponding type disallows it.

+ /// Source Link URL map. Maps file paths matching Source Link patterns to URLs. + ///

+ internal readonly struct SourceLinkMap + { + private readonly ReadOnlyCollection _entries; + + private SourceLinkMap(ReadOnlyCollection mappings) + { + _entries = mappings; + } + + public readonly struct Entry + { + public readonly FilePathPattern FilePath; + public readonly UriPattern Uri; + + public Entry(FilePathPattern filePath, UriPattern uri) + { + FilePath = filePath; + Uri = uri; + } + + public void Deconstruct(out FilePathPattern filePath, out UriPattern uri) + { + filePath = FilePath; + uri = Uri; + } + } + + public readonly struct FilePathPattern + { + public readonly string Path; + public readonly bool IsPrefix; + + public FilePathPattern(string path, bool isPrefix) + { + Path = path; + IsPrefix = isPrefix; + } + } + + public readonly struct UriPattern + { + public readonly string Prefix; + public readonly string Suffix; + + public UriPattern(string prefix, string suffix) + { + Prefix = prefix; + Suffix = suffix; + } + } + + public IReadOnlyList Entries => _entries; + + ///

+ /// Parses Source Link JSON string. + ///

+ /// is null. + /// The JSON does not follow Source Link specification. + /// is not valid JSON string. + public static SourceLinkMap Parse(string json) + { + if (json is null) + { + throw new ArgumentNullException(nameof(json)); + } + + var list = new List(); + + var root = JsonDocument.Parse(json, new JsonDocumentOptions() { AllowTrailingCommas = true }).RootElement; + if (root.ValueKind != JsonValueKind.Object) + { + throw new InvalidDataException(); + } + + foreach (var rootEntry in root.EnumerateObject()) + { + if (!rootEntry.NameEquals("documents")) + { + // potential future extensibility + continue; + } + + if (rootEntry.Value.ValueKind != JsonValueKind.Object) + { + throw new InvalidDataException(); + } + + foreach (var documentsEntry in rootEntry.Value.EnumerateObject()) + { + if (documentsEntry.Value.ValueKind != JsonValueKind.String || + !TryParseEntry(documentsEntry.Name, documentsEntry.Value.GetString(), out var entry)) + { + throw new InvalidDataException(); + } + + list.Add(entry); + } + } + + // Sort the map by decreasing file path length. This ensures that the most specific paths will checked before the least specific + // and that absolute paths will be checked before a wildcard path with a matching base + list.Sort((left, right) => -left.FilePath.Path.Length.CompareTo(right.FilePath.Path.Length)); + + return new SourceLinkMap(new ReadOnlyCollection(list)); + } + + private static bool TryParseEntry(string key, string value, out Entry entry) + { + entry = default; + + // VALIDATION RULES + // 1. The only acceptable wildcard is one and only one '*', which if present will be replaced by a relative path + // 2. If the filepath does not contain a *, the uri cannot contain a * and if the filepath contains a * the uri must contain a * + // 3. If the filepath contains a *, it must be the final character + // 4. If the uri contains a *, it may be anywhere in the uri + if (key.Length == 0) + { + return false; + } + + int filePathStar = key.IndexOf('*'); + if (filePathStar == key.Length - 1) + { + key = key.Substring(0, filePathStar); + } + else if (filePathStar >= 0) + { + return false; + } + + string uriPrefix, uriSuffix; + int uriStar = value.IndexOf('*'); + if (uriStar >= 0) + { + if (filePathStar < 0) + { + return false; + } + + uriPrefix = value.Substring(0, uriStar); + uriSuffix = value.Substring(uriStar + 1); + + if (uriSuffix.IndexOf('*') >= 0) + { + return false; + } + } + else + { + uriPrefix = value; + uriSuffix = ""; + } + + entry = new Entry( + new FilePathPattern(key, isPrefix: filePathStar >= 0), + new UriPattern(uriPrefix, uriSuffix)); + + return true; + } + + ///

+ /// Maps specified to the corresponding URL. + ///

/// Maps specified to the corresponding URL. ///

- /// is null. + /// is null. public bool TryGetUrl( string path, #if NETCOREAPP diff --git a/src/TestUtilities/ProcessUtilities.cs b/src/TestUtilities/ProcessUtilities.cs index 83406fb8..445b54cb 100644 --- a/src/TestUtilities/ProcessUtilities.cs +++ b/src/TestUtilities/ProcessUtilities.cs @@ -16,7 +16,7 @@ public static class ProcessUtilities public static ProcessResult Run( string fileName, string arguments, - string? workingDirectory = null, + string workingDirectory = "", IEnumerable>? additionalEnvironmentVars = null, string? stdInput = null) { @@ -88,7 +88,7 @@ public static ProcessResult Run( /// Launch a process, and return Process object. The process continues to run asynchronously. /// You cannot capture the output. ///

+ /// The task calculates SourceLink URL for a given SourceRoot. + /// If the SourceRoot is associated with a git repository with a recognized domain the + /// output property is set to the content URL corresponding to the domain, otherwise it is set to string "N/A". + ///

{0} item group is empty. At least one {1} repository host is required in order to generate SourceLink. diff --git a/src/Common/xlf/CommonResources.zh-Hant.xlf b/src/Common/xlf/CommonResources.zh-Hant.xlf index 623c7110..93892606 100644 --- a/src/Common/xlf/CommonResources.zh-Hant.xlf +++ b/src/Common/xlf/CommonResources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

{0} item group is empty. At least one {1} repository host is required in order to generate SourceLink. diff --git a/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hans.xlf b/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hans.xlf index 536f892f..e358863e 100644 --- a/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hans.xlf +++ b/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hans.xlf @@ -1,6 +1,6 @@ - +

Configuration file recursion exceeded maximum allowed depth of {0}. diff --git a/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hant.xlf b/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hant.xlf index 466629fe..30966089 100644 --- a/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hant.xlf +++ b/src/Microsoft.Build.Tasks.Git/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

Configuration file recursion exceeded maximum allowed depth of {0}. diff --git a/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hans.xlf b/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hans.xlf index 05d2ad3b..bc963ae6 100644 --- a/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hans.xlf +++ b/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hans.xlf @@ -1,6 +1,6 @@ - +

The value of environment variable {0} is not a well-formed list of URL pairs: '{1}'" diff --git a/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf b/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf index b5bb875c..177fe576 100644 --- a/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.AzureDevOpsServer.Git/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

The value of environment variable {0} is not a well-formed list of URL pairs: '{1}'" diff --git a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf index 05d2ad3b..bc963ae6 100644 --- a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf +++ b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hans.xlf @@ -1,6 +1,6 @@ - +

The value of environment variable {0} is not a well-formed list of URL pairs: '{1}'" diff --git a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf index b5bb875c..177fe576 100644 --- a/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.AzureRepos.Git/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

{0} must end with a directory separator: '{1}' diff --git a/src/SourceLink.Common/xlf/Resources.zh-Hant.xlf b/src/SourceLink.Common/xlf/Resources.zh-Hant.xlf index d2c13727..97978234 100644 --- a/src/SourceLink.Common/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.Common/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

{0} item group is empty. At least one {1} repository host is required in order to generate SourceLink. diff --git a/src/SourceLink.GitLab/xlf/Resources.zh-Hant.xlf b/src/SourceLink.GitLab/xlf/Resources.zh-Hant.xlf index ab6c29b8..b77078ea 100644 --- a/src/SourceLink.GitLab/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.GitLab/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

{0} item group is empty. At least one {1} repository host is required in order to generate SourceLink. diff --git a/src/SourceLink.GitWeb/xlf/Resources.zh-Hans.xlf b/src/SourceLink.GitWeb/xlf/Resources.zh-Hans.xlf index 2d6553a8..8472a671 100644 --- a/src/SourceLink.GitWeb/xlf/Resources.zh-Hans.xlf +++ b/src/SourceLink.GitWeb/xlf/Resources.zh-Hans.xlf @@ -1,6 +1,6 @@ - +

The Microsoft.SourceLink.GitWeb provider does not support translating the '{0}' protocol to content URLs. diff --git a/src/SourceLink.GitWeb/xlf/Resources.zh-Hant.xlf b/src/SourceLink.GitWeb/xlf/Resources.zh-Hant.xlf index efa8ded5..0ae63676 100644 --- a/src/SourceLink.GitWeb/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.GitWeb/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

The Microsoft.SourceLink.GitWeb provider does not support translating the '{0}' protocol to content URLs. diff --git a/src/SourceLink.Gitea/xlf/Resources.zh-Hans.xlf b/src/SourceLink.Gitea/xlf/Resources.zh-Hans.xlf index e4a4010d..da2cf8fc 100644 --- a/src/SourceLink.Gitea/xlf/Resources.zh-Hans.xlf +++ b/src/SourceLink.Gitea/xlf/Resources.zh-Hans.xlf @@ -1,6 +1,6 @@ - +

{0} item group is empty. At least one {1} repository host is required in order to generate SourceLink. diff --git a/src/SourceLink.Gitea/xlf/Resources.zh-Hant.xlf b/src/SourceLink.Gitea/xlf/Resources.zh-Hant.xlf index ab6c29b8..b77078ea 100644 --- a/src/SourceLink.Gitea/xlf/Resources.zh-Hant.xlf +++ b/src/SourceLink.Gitea/xlf/Resources.zh-Hant.xlf @@ -1,6 +1,6 @@ - +

{0} item group is empty. At least one {1} repository host is required in order to generate SourceLink. From 9006950900cd6a0783ae864c4ca27b8e6b753723 Mon Sep 17 00:00:00 2001 From: dotnet bot Date: Thu, 12 Aug 2021 09:44:14 -0700 Subject: [PATCH 140/161] Localized file check-in by OneLocBuild Task (#733) From 5e2c4f1d59413df38059baed8ddf73350fb5139a Mon Sep 17 00:00:00 2001 From: Chris Rummel Date: Thu, 12 Aug 2021 13:29:16 -0500 Subject: [PATCH 141/161] Allow using .git directory instead of gitdir redirect in submodules. (#653) * Allow using .git directory instead of gitdir redirect in submodules. * Address review comments and add test for old-style submodule behavior. * Use .git dir as the common directory as well. * Add more details to the comments about how this case can happen. * Address code review comments. * Allow empty dir Co-authored-by: tmat --- .../GitRepositoryTests.cs | 23 +++++++++++++++++-- .../GitDataReader/GitRepository.cs | 8 ++++++- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs b/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs index c0e502af..f1fe9428 100644 --- a/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs +++ b/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs @@ -297,6 +297,7 @@ public void Submodules_Errors() { "S10: 'sub10' 'http://github.com'", "S11: 'sub11' 'http://github.com'", + "S6: 'sub6' 'http://github.com'", "S9: 'sub9' 'http://github.com'" }, submodules.Select(s => $"{s.Name}: '{s.WorkingDirectoryRelativePath}' '{s.Url}'")); @@ -313,8 +314,6 @@ public void Submodules_Errors() TestUtilities.GetExceptionMessage(() => File.ReadAllText(Path.Combine(workingDir.Path, "sub4", ".git"))), // Could not find a part of the path 'sub5\.git'. TestUtilities.GetExceptionMessage(() => File.ReadAllText(Path.Combine(workingDir.Path, "sub5", ".git"))), - // Access to the path 'sub6\.git' is denied - TestUtilities.GetExceptionMessage(() => File.ReadAllText(Path.Combine(workingDir.Path, "sub6", ".git"))), // The format of the file 'sub7\.git' is invalid. string.Format(Resources.FormatOfFileIsInvalid, Path.Combine(workingDir.Path, "sub7", ".git")), // Path specified in file 'sub8\.git' is invalid. @@ -358,5 +357,25 @@ public void GetSubmoduleHeadCommitSha() var repository = new GitRepository(GitEnvironment.Empty, GitConfig.Empty, gitDir.Path, gitDir.Path, workingDir.Path); Assert.Equal("0000000000000000000000000000000000000000", repository.ReadSubmoduleHeadCommitSha(submoduleWorkingDir.Path)); } + + [Fact] + public void GetOldStyleSubmoduleHeadCommitSha() + { + using var temp = new TempRoot(); + + var gitDir = temp.CreateDirectory(); + var workingDir = temp.CreateDirectory(); + + // this is a unusual but legal case which can occur with older versions of Git or other tools. + // see https://git-scm.com/docs/gitsubmodules#_forms for more details. + var oldStyleSubmoduleWorkingDir = workingDir.CreateDirectory("old-style-submodule"); + var oldStyleSubmoduleGitDir = oldStyleSubmoduleWorkingDir.CreateDirectory(".git"); + var oldStyleSubmoduleRefsHeadDir = oldStyleSubmoduleGitDir.CreateDirectory("refs").CreateDirectory("heads"); + oldStyleSubmoduleRefsHeadDir.CreateFile("branch1").WriteAllText("1111111111111111111111111111111111111111"); + oldStyleSubmoduleGitDir.CreateFile("HEAD").WriteAllText("ref: refs/heads/branch1"); + + var repository = new GitRepository(GitEnvironment.Empty, GitConfig.Empty, gitDir.Path, gitDir.Path, workingDir.Path); + Assert.Equal("1111111111111111111111111111111111111111", repository.ReadSubmoduleHeadCommitSha(oldStyleSubmoduleWorkingDir.Path)); + } } } diff --git a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepository.cs b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepository.cs index 30ee72bc..7b77bbc7 100644 --- a/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepository.cs +++ b/src/Microsoft.Build.Tasks.Git/GitDataReader/GitRepository.cs @@ -211,7 +211,13 @@ public static GitRepository OpenRepository(GitRepositoryLocation location, GitEn /// Null if the HEAD tip reference can't be resolved. internal string? ReadSubmoduleHeadCommitSha(string submoduleWorkingDirectoryFullPath) { - var gitDirectory = ReadDotGitFile(Path.Combine(submoduleWorkingDirectoryFullPath, GitDirName)); + // Submodules don't usually have their own .git directories but this is still legal. + // This can occur with older versions of Git or other tools, or when a user clones one + // repo into another's source tree (but it was not yet registered as a submodule). + // See https://git-scm.com/docs/gitsubmodules#_forms for more details. + var dotGitPath = Path.Combine(submoduleWorkingDirectoryFullPath, GitDirName); + + var gitDirectory = Directory.Exists(dotGitPath) ? dotGitPath : ReadDotGitFile(dotGitPath); if (!IsGitDirectory(gitDirectory, out var commonDirectory)) { return null; From 48e002e14a97800c0d6acf24a55357699c9d72a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Matou=C5=A1ek?= Date: Thu, 12 Aug 2021 15:28:59 -0700 Subject: [PATCH 142/161] Fix discovery of working directory for worktrees (#734) SourceLink used gitdir to determine the directory (and incorrectly interpreting the content) but turns out git doesn't use it at all for this purpose. --- .../GitRepositoryTests.cs | 107 +++++++++++++++++- .../GitDataReader/GitRepository.cs | 44 +------ .../GitOperations.cs | 2 +- 3 files changed, 110 insertions(+), 43 deletions(-) diff --git a/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs b/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs index f1fe9428..b27949cf 100644 --- a/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs +++ b/src/Microsoft.Build.Tasks.Git.UnitTests/GitRepositoryTests.cs @@ -95,19 +95,33 @@ public void TryFindRepository_Worktree_Realistic() Assert.Equal(mainGitDir.Path, location.CommonDirectory); Assert.Null(location.WorkingDirectory); + var repository = GitRepository.OpenRepository(location, GitEnvironment.Empty); + Assert.Equal(location.GitDirectory, repository.GitDirectory); + Assert.Equal(location.CommonDirectory, repository.CommonDirectory); + Assert.Null(repository.WorkingDirectory); + // start under worktree directory: Assert.True(GitRepository.TryFindRepository(worktreeSubDir.Path, out location)); - Assert.Equal(worktreeGitDir.Path, location.GitDirectory); Assert.Equal(mainGitDir.Path, location.CommonDirectory); Assert.Equal(worktreeDir.Path, location.WorkingDirectory); + repository = GitRepository.OpenRepository(location, GitEnvironment.Empty); + Assert.Equal(location.GitDirectory, repository.GitDirectory); + Assert.Equal(location.WorkingDirectory, repository.WorkingDirectory); + Assert.Equal(location.CommonDirectory, repository.CommonDirectory); + // start under worktree git directory (git config works from this dir, but git status requires work dir): Assert.True(GitRepository.TryFindRepository(worktreeGitSubDir.Path, out location)); Assert.Equal(worktreeGitDir.Path, location.GitDirectory); Assert.Equal(mainGitDir.Path, location.CommonDirectory); Assert.Null(location.WorkingDirectory); + + repository = GitRepository.OpenRepository(location, GitEnvironment.Empty); + Assert.Equal(location.GitDirectory, repository.GitDirectory); + Assert.Equal(location.CommonDirectory, repository.CommonDirectory); + Assert.Null(repository.WorkingDirectory); } [Fact] @@ -170,6 +184,31 @@ public void OpenRepository() Assert.Equal("0000000000000000000000000000000000000000", repository.GetHeadCommitSha()); } + [Fact] + public void OpenRepository_WorkingDirectorySpecifiedInConfig() + { + using var temp = new TempRoot(); + + var homeDir = temp.CreateDirectory(); + + var workingDir = temp.CreateDirectory(); + var workingDir2 = temp.CreateDirectory(); + var gitDir = workingDir.CreateDirectory(".git"); + + gitDir.CreateFile("HEAD"); + gitDir.CreateFile("config").WriteAllText("[core]worktree = " + workingDir2.Path.Replace(@"\", @"\\")); + + Assert.True(GitRepository.TryFindRepository(gitDir.Path, out var location)); + Assert.Equal(gitDir.Path, location.CommonDirectory); + Assert.Equal(gitDir.Path, location.GitDirectory); + Assert.Null(location.WorkingDirectory); + + var repository = GitRepository.OpenRepository(location, GitEnvironment.Empty); + Assert.Equal(gitDir.Path, repository.CommonDirectory); + Assert.Equal(gitDir.Path, repository.GitDirectory); + Assert.Equal(workingDir2.Path, repository.WorkingDirectory); + } + [Fact] public void OpenRepository_VersionNotSupported() { @@ -191,6 +230,72 @@ public void OpenRepository_VersionNotSupported() Assert.Throws(() => GitRepository.OpenRepository(src.Path, new GitEnvironment(homeDir.Path))); } + [Fact] + public void OpenRepository_Worktree_GitdirFileMissing() + { + using var temp = new TempRoot(); + + var mainWorkingDir = temp.CreateDirectory(); + var mainGitDir = mainWorkingDir.CreateDirectory(".git"); + mainGitDir.CreateFile("HEAD"); + + var worktreesDir = mainGitDir.CreateDirectory("worktrees"); + var worktreeGitDir = worktreesDir.CreateDirectory("myworktree"); + var worktreeDir = temp.CreateDirectory(); + var worktreeGitFile = worktreeDir.CreateFile(".git").WriteAllText("gitdir: " + worktreeGitDir + " \r\n\t\v"); + + worktreeGitDir.CreateFile("HEAD"); + worktreeGitDir.CreateFile("commondir").WriteAllText("../..\n"); + // gitdir file that links back to the worktree working directory is missing from worktreeGitDir + + Assert.True(GitRepository.TryFindRepository(worktreeDir.Path, out var location)); + Assert.Equal(worktreeGitDir.Path, location.GitDirectory); + Assert.Equal(mainGitDir.Path, location.CommonDirectory); + Assert.Equal(worktreeDir.Path, location.WorkingDirectory); + + var repository = GitRepository.OpenRepository(location, GitEnvironment.Empty); + Assert.Equal(repository.GitDirectory, location.GitDirectory); + Assert.Equal(repository.CommonDirectory, location.CommonDirectory); + Assert.Equal(repository.WorkingDirectory, location.WorkingDirectory); + } + + ///

+ /// The directory in gitdir file is ignored for the purposes of determining repository working directory. + ///