Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature: GitWeb Source Link provider
GitWeb only currently supports SSH repository URLs. #505
- Loading branch information
1 parent
39c946a
commit 1b424fc
Showing
28 changed files
with
844 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| // 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; | ||
| using System.IO; | ||
| using TestUtilities; | ||
|
|
||
| namespace Microsoft.SourceLink.IntegrationTests | ||
| { | ||
| public class GitWebTests : DotNetSdkTestBase | ||
| { | ||
| public GitWebTests() | ||
| : base("Microsoft.SourceLink.GitWeb") | ||
| { | ||
| } | ||
|
|
||
| [ConditionalFact(typeof(DotNetSdkAvailable))] | ||
| public void FullValidation_Ssh() | ||
| { | ||
| // Test non-ascii characters and escapes in the URL. Escaped URI reserved characters | ||
| // should remain escaped, non-reserved characters unescaped in the results. | ||
| var repoUrl = $"ssh://git@噸.com/test-%72epo\u1234%24%2572%2F.git"; | ||
| var repoName = "test-repo\u1234%24%2572%2F.git"; | ||
|
|
||
| var repo = GitUtilities.CreateGitRepositoryWithSingleCommit(ProjectDir.Path, new[] { ProjectFileName }, repoUrl); | ||
| var commitSha = repo.Head.Tip.Sha; | ||
|
|
||
| VerifyValues( | ||
| customProps: @" | ||
| <PropertyGroup> | ||
| <PublishRepositoryUrl>true</PublishRepositoryUrl> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <SourceLinkGitWebHost Include='噸.com' ContentUrl='https://噸.com/gitweb'/> | ||
| </ItemGroup> | ||
| ", | ||
| customTargets: "", | ||
| targets: new[] | ||
| { | ||
| "Build", "Pack" | ||
| }, | ||
| expressions: new[] | ||
| { | ||
| "@(SourceRoot)", | ||
| "@(SourceRoot->'%(SourceLinkUrl)')", | ||
| "$(SourceLink)", | ||
| "$(PrivateRepositoryUrl)", | ||
| "$(RepositoryUrl)" | ||
| }, | ||
| expectedResults: new[] | ||
| { | ||
| ProjectSourceRoot, | ||
| $"https://噸.com/gitweb/?p={repoName};a=blob_plain;hb={commitSha};f=*", | ||
| s_relativeSourceLinkJsonPath, | ||
| $"ssh://git@噸.com/{repoName}", | ||
| $"ssh://git@噸.com/{repoName}" | ||
| }); | ||
|
|
||
| AssertEx.AreEqual( | ||
| $@"{{""documents"":{{""{ProjectSourceRoot.Replace(@"\", @"\\")}*"":""https://噸.com/gitweb/?p={repoName};a=blob_plain;hb={commitSha};f=*""}}}}", | ||
| File.ReadAllText(Path.Combine(ProjectDir.Path, s_relativeSourceLinkJsonPath))); | ||
|
|
||
| TestUtilities.ValidateAssemblyInformationalVersion( | ||
| Path.Combine(ProjectDir.Path, s_relativeOutputFilePath), | ||
| "1.0.0+" + commitSha); | ||
|
|
||
| TestUtilities.ValidateNuSpecRepository( | ||
| Path.Combine(ProjectDir.Path, s_relativePackagePath), | ||
| type: "git", | ||
| commit: commitSha, | ||
| url: $"ssh://git@噸.com/{repoName}"); | ||
| } | ||
|
|
||
| [ConditionalFact(typeof(DotNetSdkAvailable))] | ||
| public void Issues_error_on_git_url() | ||
| { | ||
| var repoUrl = "git://噸.com/invalid_url_protocol.git"; | ||
| var repo = GitUtilities.CreateGitRepositoryWithSingleCommit(ProjectDir.Path, new[] { ProjectFileName }, repoUrl); | ||
| var commitSha = repo.Head.Tip.Sha; | ||
|
|
||
| VerifyValues( | ||
| customProps: @" | ||
| <PropertyGroup> | ||
| <PublishRepositoryUrl>true</PublishRepositoryUrl> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <SourceLinkGitWebHost Include='噸.com' ContentUrl='https://噸.com/gitweb'/> | ||
| </ItemGroup> | ||
| ", | ||
| customTargets: "", | ||
| targets: new[] | ||
| { | ||
| "Build", "Pack" | ||
| }, | ||
| expressions: Array.Empty<string>(), | ||
| expectedErrors: new[]{ | ||
| string.Format(GitWeb.Resources.RepositoryUrlIsNotSupportedByProvider, "GIT") | ||
| }); | ||
| } | ||
|
|
||
| [ConditionalFact(typeof(DotNetSdkAvailable))] | ||
| public void Issues_error_on_https_url() | ||
| { | ||
| var repoUrl = "https://噸.com/invalid_url_protocol.git"; | ||
| var repo = GitUtilities.CreateGitRepositoryWithSingleCommit(ProjectDir.Path, new[] { ProjectFileName }, repoUrl); | ||
| var commitSha = repo.Head.Tip.Sha; | ||
|
|
||
| VerifyValues( | ||
| customProps: @" | ||
| <PropertyGroup> | ||
| <PublishRepositoryUrl>true</PublishRepositoryUrl> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <SourceLinkGitWebHost Include='噸.com' ContentUrl='https://噸.com/gitweb'/> | ||
| </ItemGroup> | ||
| ", | ||
| customTargets: "", | ||
| targets: new[] | ||
| { | ||
| "Build", "Pack" | ||
| }, | ||
| expressions: Array.Empty<string>(), | ||
| expectedErrors: new[] | ||
| { | ||
| string.Format(GitWeb.Resources.RepositoryUrlIsNotSupportedByProvider, "HTTP") | ||
| }); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // 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 TestUtilities; | ||
| using Xunit; | ||
| using static TestUtilities.KeyValuePairUtils; | ||
|
|
||
| namespace Microsoft.SourceLink.GitWeb.UnitTests | ||
| { | ||
| public class GetSourceLinkUrlTests | ||
| { | ||
| [Fact] | ||
| public void EmptyHosts() | ||
| { | ||
| var engine = new MockEngine(); | ||
|
|
||
| var task = new GetSourceLinkUrl() | ||
| { | ||
| BuildEngine = engine, | ||
| SourceRoot = new MockItem("x", KVP("RepositoryUrl", "http://abc.com"), KVP("SourceControl", "git")), | ||
| }; | ||
|
|
||
| bool result = task.Execute(); | ||
|
|
||
| AssertEx.AssertEqualToleratingWhitespaceDifferences( | ||
| "ERROR : " + string.Format(CommonResources.AtLeastOneRepositoryHostIsRequired, "SourceLinkGitWebHost", "GitWeb"), engine.Log); | ||
|
|
||
| Assert.False(result); | ||
| } | ||
|
|
||
| [Theory] | ||
| [InlineData("", "")] | ||
| [InlineData("", "/")] | ||
| [InlineData("/", "")] | ||
| [InlineData("/", "/")] | ||
| public void BuildSourceLinkUrl(string s1, string s2) | ||
| { | ||
| var engine = new MockEngine(); | ||
|
|
||
| var task = new GetSourceLinkUrl() | ||
| { | ||
| BuildEngine = engine, | ||
| SourceRoot = new MockItem("/src/", KVP("RepositoryUrl", "ssh://git@src.intranet.company.com/root_dir_name/sub_dirs/reponame.git" + s1), KVP("SourceControl", "git"), KVP("RevisionId", "0123456789abcdefABCDEF000000000000000000")), | ||
| Hosts = new[] | ||
| { | ||
| // NOTE: i don't know what the spec parameter is for. but for all the other | ||
| // tests like this for various providers it is the domain of the Repo URL. | ||
| new MockItem("src.intranet.company.com", KVP("ContentUrl", "https://src.intranet.company.com/gitweb" + s2)), | ||
| } | ||
| }; | ||
|
|
||
| bool result = task.Execute(); | ||
| AssertEx.AssertEqualToleratingWhitespaceDifferences("", engine.Log); | ||
| AssertEx.AreEqual("https://src.intranet.company.com/gitweb/?p=root_dir_name/sub_dirs/reponame.git;a=blob_plain;hb=0123456789abcdefABCDEF000000000000000000;f=*", task.SourceLinkUrl); | ||
| Assert.True(result); | ||
| } | ||
| } | ||
| } |
9 changes: 9 additions & 0 deletions
9
src/SourceLink.GitWeb.UnitTests/Microsoft.SourceLink.GitWeb.UnitTests.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>net461;netcoreapp2.0</TargetFrameworks> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\SourceLink.GitWeb\Microsoft.SourceLink.GitWeb.csproj" /> | ||
| <ProjectReference Include="..\TestUtilities\TestUtilities.csproj" /> | ||
| </ItemGroup> | ||
| </Project> |
51 changes: 51 additions & 0 deletions
51
src/SourceLink.GitWeb.UnitTests/TranslateRepositoryUrlsTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| // 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.Linq; | ||
| using TestUtilities; | ||
| using Xunit; | ||
| using static TestUtilities.KeyValuePairUtils; | ||
|
|
||
| namespace Microsoft.SourceLink.GitWeb.UnitTests | ||
| { | ||
| public class TranslateRepositoryUrlsTests | ||
| { | ||
| [Fact] | ||
| public void Translate() | ||
| { | ||
| var engine = new MockEngine(); | ||
|
|
||
| var task = new TranslateRepositoryUrls() | ||
| { | ||
| BuildEngine = engine, | ||
| RepositoryUrl = "ssh://git@src.intranet.company.com/root_dir_name/sub_dirs/reponame.git", | ||
| IsSingleProvider = true, | ||
| SourceRoots = new[] | ||
| { | ||
| new MockItem("/1/", KVP("SourceControl", "git"), KVP("ScmRepositoryUrl", "ssh://git@src.intranet.company.com/root_dir_name/sub_dirs/reponame.git")), | ||
| new MockItem("/2/", KVP("SourceControl", "tfvc"), KVP("ScmRepositoryUrl", "ssh://git@src.intranet.company1.com/root_dir_name/sub_dirs/reponame.git")), | ||
| new MockItem("/2/", KVP("SourceControl", "git"), KVP("ScmRepositoryUrl", "ssh://git@src.intranet.company1.com/root_dir_name/sub_dirs/reponame.git")), | ||
| new MockItem("/2/", KVP("SourceControl", "tfvc"), KVP("ScmRepositoryUrl", "ssh://git@src.intranet.company2.com/root_dir_name/sub_dirs/reponame.git")), | ||
| }, | ||
| Hosts = new[] | ||
| { | ||
| new MockItem("src.intranet.company1.com") | ||
| } | ||
| }; | ||
|
|
||
| bool result = task.Execute(); | ||
| AssertEx.AssertEqualToleratingWhitespaceDifferences("", engine.Log); | ||
|
|
||
| AssertEx.AreEqual("ssh://git@src.intranet.company.com/root_dir_name/sub_dirs/reponame.git", task.TranslatedRepositoryUrl); | ||
|
|
||
| AssertEx.Equal(new[] | ||
| { | ||
| "ssh://git@src.intranet.company.com/root_dir_name/sub_dirs/reponame.git", | ||
| "ssh://git@src.intranet.company1.com/root_dir_name/sub_dirs/reponame.git", | ||
| "ssh://git@src.intranet.company1.com/root_dir_name/sub_dirs/reponame.git", | ||
| "ssh://git@src.intranet.company2.com/root_dir_name/sub_dirs/reponame.git", | ||
| }, task.TranslatedSourceRoots.Select(r => r.GetMetadata("ScmRepositoryUrl"))); | ||
|
|
||
| Assert.True(result); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // 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 Microsoft.Build.Framework; | ||
| using Microsoft.Build.Tasks.SourceControl; | ||
|
|
||
| namespace Microsoft.SourceLink.GitWeb | ||
| { | ||
| /// <summary> | ||
| /// The task calculates SourceLink URL for a given SourceRoot. If the SourceRoot is associated | ||
| /// with a git repository with a recognized domain the <see cref="SourceLinkUrl"/> output | ||
| /// property is set to the content URL corresponding to the domain, otherwise it is set to | ||
| /// string "N/A". | ||
| /// </summary> | ||
| 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; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.