Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for the new GitLab raw url #713

Merged
merged 1 commit into from
Aug 16, 2021
Merged

Add support for the new GitLab raw url #713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 36 additions & 6 deletions src/SourceLink.GitLab.UnitTests/GetSourceLinkUrlTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,15 @@ public void EmptyHosts()
}

[Theory]
[InlineData("", "")]
[InlineData("", "/")]
[InlineData("/", "")]
[InlineData("/", "/")]
public void BuildSourceLinkUrl(string s1, string s2)
[InlineData("", "", null)]
[InlineData("", "/", null)]
[InlineData("/", "", null)]
[InlineData("/", "/", null)]
[InlineData("", "", "12.0")]
[InlineData("", "/", "12.0")]
[InlineData("/", "", "12.0")]
[InlineData("/", "/", "12.0")]
public void BuildSourceLinkUrl(string s1, string s2, string version)
{
var engine = new MockEngine();

Expand All @@ -44,7 +48,33 @@ public void BuildSourceLinkUrl(string s1, string s2)
SourceRoot = new MockItem("/src/", KVP("RepositoryUrl", "http://subdomain.mygitlab.com:100/a/b" + s1), KVP("SourceControl", "git"), KVP("RevisionId", "0123456789abcdefABCDEF000000000000000000")),
Hosts = new[]
{
new MockItem("mygitlab.com", KVP("ContentUrl", "https://domain.com/x/y" + s2)),
version == null
? new MockItem("mygitlab.com", KVP("ContentUrl", "https://domain.com/x/y" + s2))
: new MockItem("mygitlab.com", KVP("ContentUrl", "https://domain.com/x/y" + s2), KVP("Version", version)),
}
};

bool result = task.Execute();
AssertEx.AssertEqualToleratingWhitespaceDifferences("", engine.Log);
AssertEx.AreEqual("https://domain.com/x/y/a/b/-/raw/0123456789abcdefABCDEF000000000000000000/*", task.SourceLinkUrl);
Assert.True(result);
}

[Theory]
[InlineData("", "/", "11.0")]
[InlineData("/", "", "11.0")]
[InlineData("/", "/", "11.0")]
public void BuildSourceLinkUrl_DeprecatedVersion(string s1, string s2, string version)
{
var engine = new MockEngine();

var task = new GetSourceLinkUrl()
{
BuildEngine = engine,
SourceRoot = new MockItem("/src/", KVP("RepositoryUrl", "http://subdomain.mygitlab.com:100/a/b" + s1), KVP("SourceControl", "git"), KVP("RevisionId", "0123456789abcdefABCDEF000000000000000000")),
Hosts = new[]
{
new MockItem("mygitlab.com", KVP("ContentUrl", "https://domain.com/x/y" + s2), KVP("Version", version)),
}
};

Expand Down
28 changes: 27 additions & 1 deletion src/SourceLink.GitLab/GetSourceLinkUrl.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,33 @@ public sealed class GetSourceLinkUrl : GetSourceLinkUrlGitTask
protected override string HostsItemGroupName => "SourceLinkGitLabHost";
protected override string ProviderDisplayName => "GitLab";

private const string VersionMetadataName = "Version";

// see https://gitlab.com/gitlab-org/gitlab/-/issues/28848
private static readonly Version s_versionWithNewUrlFormat = new Version(12, 0);

protected override string? BuildSourceLinkUrl(Uri contentUri, Uri gitUri, string relativeUrl, string revisionId, ITaskItem? hostItem)
=> UriUtilities.Combine(UriUtilities.Combine(contentUri.ToString(), relativeUrl), "raw/" + revisionId + "/*");
{
var path = GetVersion(hostItem) >= s_versionWithNewUrlFormat
? "-/raw/" + revisionId + "/*"
: "raw/" + revisionId + "/*";
return UriUtilities.Combine(UriUtilities.Combine(contentUri.ToString(), relativeUrl), path);
}

private Version GetVersion(ITaskItem? hostItem)
{
var versionAsString = hostItem?.GetMetadata(VersionMetadataName);
if (!NullableString.IsNullOrEmpty(versionAsString))
{
if (Version.TryParse(versionAsString, out var version))
{
return version;
}

Log.LogError(CommonResources.ItemOfItemGroupMustSpecifyMetadata, hostItem!.ItemSpec, HostsItemGroupName, VersionMetadataName);
}

return s_versionWithNewUrlFormat;
}
}
}