[release/10.0.4xx] Preserve .git suffix in repository names when generating SourceLink URLs (#1658)

* Preserve .git suffix in repository names when generating SourceLink URLs

Do not strip the `.git` suffix from repository names in GetSourceLinkUrlGitTask.
Some repositories legitimately include `.git` as part of their name, and removing
the suffix produces incorrect SourceLink URLs and 404 responses.

This change keeps `.git` when it is part of the repository name.

Additionally update the GitWeb provider to avoid appending `.git` when the
suffix is already present, preventing URLs like `repo.git.git`.

Add regression tests for repository names ending with `.git`.

* Update src/SourceLink.AzureRepos.Git.UnitTests/GetSourceLinkUrlTests.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update src/SourceLink.AzureRepos.Git.UnitTests/GetSourceLinkUrlTests.cs

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* SourceLinkUrl is nullable, but the test asserts it is not null or empty before returning it. The null-forgiving operator is used here to satisfy the nullable analysis.

* Revert change in GetSourceLinkUrlGitTask

The previous change modified the shared Git SourceLink task to preserve the
`.git` suffix in repository names. This introduced regressions in other
providers (e.g. Bitbucket and Common tests).

The fix will be moved to the Azure Repos provider where the exact repository
name is required by the Azure DevOps API, instead of changing the shared
behavior for all providers.

* Refactor Git URL handling in GetSourceLinkUrlGitTask

* Restore GetSourceLinkUrlTests and add tests for Azure Repos repositories ending with .git

Ensure that repository names ending with ".git" are not treated the same
as repositories without the suffix and that the suffix is preserved in
the generated SourceLink URL.

* Remove duplicated Azure Repos .git regression tests

Fix build failure caused by accidentally duplicated test methods
introduced while adding regression tests for repository names
ending with `.git`.

* Enhance GetSourceLinkUrlTests with error assertion

Restore error comment – removal was unintentional.

* Add comment explaining why gitUri.GetPath() is used instead of relativeUrl for AzDO

---------

Co-authored-by: Artur Zegarek <artureales@gmail.com>
Co-authored-by: Eales <46241595+Eales@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

src/Common/GitProvider/GetSourceLinkUrlGitTask.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the License.txt file in the project root for more information.
 
@@ -222,7 +222,7 @@ static bool IsValidContentUri(Uri uri)
             }
         }
 
-        private static bool TryGetMatchingContentUri(UrlMapping[] mappings, Uri repoUri, [NotNullWhen(true)]out Uri? contentUri, out ITaskItem? hostItem)
+        private static bool TryGetMatchingContentUri(UrlMapping[] mappings, Uri repoUri, [NotNullWhen(true)] out Uri? contentUri, out ITaskItem? hostItem)
         {
             UrlMapping? FindMatch(bool exactHost)
             {

src/SourceLink.AzureRepos.Git.UnitTests/AzureDevOpsUrlParserHostedTests.cs

@@ -55,6 +55,10 @@ public void TryParseHostedHttp_Error(string host, string relativeUrl)
         [InlineData("contoso.com", "/account/project/_git/repo", "account/project", "repo")]
         [InlineData("contoso.com", "/account/project/_git/_full/repo", "account/project", "repo")]
         [InlineData("contoso.com", "/account/project/_git/_optimized/repo", "account/project", "repo")]
+        [InlineData("dev.azure.com", "/org/project/_git/repo.git", "org/project", "repo.git")]
+        [InlineData("dev.azure.com", "/org/project/_git/repo.git/", "org/project", "repo.git")]
+        [InlineData("account.visualstudio.com", "/DefaultCollection/project/_git/repo.git", "project", "repo.git")]
+
         public void TryParseHostedHttp_Success(string host, string relativeUrl, string repositoryPath, string repositoryName)
         {
             Assert.True(AzureDevOpsUrlParser.TryParseHostedHttp(host, relativeUrl, out var actualRepositoryPath, out var actualRepositoryName));

src/SourceLink.AzureRepos.Git.UnitTests/GetSourceLinkUrlTests.cs

@@ -71,7 +71,7 @@ public void BadUrl(string domainAndAccount, string host)
             };
 
             var result = task.Execute();
-
+            
             // ERROR : The value of SourceRoot.RepositoryUrl with identity '/src/' is invalid: 'http://account.visualstudio.com/_git'""
             AssertEx.AssertEqualToleratingWhitespaceDifferences(
                 "ERROR : " + string.Format(CommonResources.ValueOfWithIdentityIsInvalid, "SourceRoot.RepositoryUrl", "/src/", $"http://{domainAndAccount}/_git"), engine.Log);
@@ -155,7 +155,6 @@ public void Project_Team_NonVisualStudioHost()
 
             var result = task.Execute();
 
-            // ERROR : The value of SourceRoot.RepositoryUrl with identity '/src/' is invalid: 'http://contoso.com/account/project/team/_git/repo'""
             AssertEx.AssertEqualToleratingWhitespaceDifferences(
                 "ERROR : " + string.Format(CommonResources.ValueOfWithIdentityIsInvalid, "SourceRoot.RepositoryUrl", "/src/", "http://contoso.com/account/project/team/_git/repo"), engine.Log);
 
@@ -285,5 +284,56 @@ public void VisualStudioHost_ImplicitHost_DeafultCollection_Project_Team(string
             AssertEx.AreEqual($"https://{domain}/project/_apis/git/repositories/repo/items?api-version=1.0&versionType=commit&version=0123456789abcdefABCDEF000000000000000000&path=/*", task.SourceLinkUrl);
             Assert.True(result);
         }
+
+        [Fact]
+        public void DevAzureCom_RepositoryName_WithDotGit_IsNotIgnored()
+        {
+            var urlWithoutDotGit = ExecuteDevAzureCom("https://dev.azure.com/org/project/_git/repo");
+            var urlWithDotGit = ExecuteDevAzureCom("https://dev.azure.com/org/project/_git/repo.git");
+
+            Assert.True(
+                !string.Equals(urlWithoutDotGit, urlWithDotGit, StringComparison.Ordinal),
+                $"Repository name is ignored: URLs are identical.\n" +
+                $"Input without .git: https://dev.azure.com/org/project/_git/repo\n" +
+                $"Input with .git:    https://dev.azure.com/org/project/_git/repo.git\n" +
+                $"Output:             {urlWithoutDotGit}");
+        }
+
+        [Fact]
+        public void DevAzureCom_RepositoryName_WithDotGit_IsPreservedInOutput()
+        {
+            var url = ExecuteDevAzureCom("https://dev.azure.com/org/project/_git/repo.git");
+
+            // Ensure the '.git' suffix is preserved in the repository segment of the URL, not just anywhere.
+            Assert.Contains(
+                "project/_apis/git/repositories/repo.git/items",
+                url);
+        }
+
+        private static string ExecuteDevAzureCom(string repositoryUrl)
+        {
+            var engine = new MockEngine();
+
+            var task = new GetSourceLinkUrl()
+            {
+                BuildEngine = engine,
+                SourceRoot = new MockItem("/src/",
+                    KVP("RepositoryUrl", repositoryUrl),
+                    KVP("SourceControl", "git"),
+                    KVP("RevisionId", "0123456789abcdefABCDEF000000000000000000")),
+                Hosts = new[]
+                {
+                    new MockItem("dev.azure.com")
+                }
+            };
+
+            var result = task.Execute();
+
+            AssertEx.AssertEqualToleratingWhitespaceDifferences("", engine.Log);
+            Assert.True(result);
+            Assert.False(string.IsNullOrEmpty(task.SourceLinkUrl));
+
+            return task.SourceLinkUrl!;
+        }
     }
 }

src/SourceLink.AzureRepos.Git/GetSourceLinkUrl.cs

@@ -32,7 +32,10 @@ protected override Uri GetDefaultContentUriFromRepositoryUri(Uri repositoryUri)
 
         protected override string? BuildSourceLinkUrl(Uri contentUri, Uri gitUri, string relativeUrl, string revisionId, ITaskItem? hostItem)
         {
-            if (!AzureDevOpsUrlParser.TryParseHostedHttp(gitUri.GetHost(), relativeUrl, out var projectPath, out var repositoryName))
+            // Azure DevOps does not support optional ".git" suffix in repository URLs and adding it may result in 404.
+            // Unlike other providers (GitHub, GitLab, etc.), relativeUrl may include the ".git" suffix,
+            // so use gitUri.GetPath() here instead.
+            if (!AzureDevOpsUrlParser.TryParseHostedHttp(gitUri.GetHost(), gitUri.GetPath(), out var projectPath, out var repositoryName))
             {
                 Log.LogError(CommonResources.ValueOfWithIdentityIsInvalid, Names.SourceRoot.RepositoryUrlFullName, SourceRoot!.ItemSpec, gitUri);
                 return null;