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.

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

Add GitHubWorkItem #4813

Merged
merged 4 commits into from
Jan 29, 2025
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Address review comments
Evangelink committed Jan 28, 2025
commit 74e5e45ec50bb072127d76c2357f5a81489f451d
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ namespace Microsoft.VisualStudio.TestTools.UnitTesting;
/// GitHubWorkItem attribute; used to specify a GitHub issue associated with this test.
/// </summary>
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public sealed class GitHubWorkItemAttribute : WorkItemAttribute
public sealed partial class GitHubWorkItemAttribute : WorkItemAttribute
{
/// <summary>
/// Initializes a new instance of the <see cref="GitHubWorkItemAttribute"/> class for the GitHub WorkItem Attribute.
@@ -28,7 +28,19 @@ public GitHubWorkItemAttribute(string url)
/// <param name="url">The URL to a GitHub ticket.</param>
/// <returns>The ticket ID.</returns>
private static int ExtractId(string url)
=> int.TryParse(url.Substring(url.LastIndexOf('/') + 1), out int id)
? id
: throw new ArgumentException("The URL provided is not a valid GitHub ticket URL.", nameof(url));
{
#if NET7_0_OR_GREATER
Match match = GitHubTicketRegex().Match(url);
#else
Match match = Regex.Match(url, @"https:\/\/github\.com\/.+\/.+\/(issues|pull|discussions)\/(\d+)(#.+)?");
#endif
return match.Success && int.TryParse(match.Groups[2].Value, out int issueId)
? issueId
: throw new ArgumentException(FrameworkMessages.InvalidGitHubUrl, nameof(url));
}

#if NET7_0_OR_GREATER
[GeneratedRegex("https:\\/\\/github\\.com\\/.+\\/.+\\/(issues|pull|discussions)\\/(\\d+)(#.+)?")]
private static partial Regex GitHubTicketRegex();
#endif
}
Original file line number Diff line number Diff line change
@@ -244,6 +244,9 @@ Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataAttribute.IgnoreMessage.
Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataSourceType.AutoDetect = 2 -> Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataSourceType
*REMOVED*Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataAttribute.DynamicDataAttribute(string! dynamicDataSourceName, Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataSourceType dynamicDataSourceType = Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataSourceType.Property) -> void
*REMOVED*Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataAttribute.DynamicDataAttribute(string! dynamicDataSourceName, System.Type! dynamicDataDeclaringType, Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataSourceType dynamicDataSourceType = Microsoft.VisualStudio.TestTools.UnitTesting.DynamicDataSourceType.Property) -> void
Microsoft.VisualStudio.TestTools.UnitTesting.GitHubWorkItemAttribute
Microsoft.VisualStudio.TestTools.UnitTesting.GitHubWorkItemAttribute.GitHubWorkItemAttribute(string! url) -> void
Microsoft.VisualStudio.TestTools.UnitTesting.GitHubWorkItemAttribute.Url.get -> string!
Microsoft.VisualStudio.TestTools.UnitTesting.ITestDataSourceIgnoreCapability
Microsoft.VisualStudio.TestTools.UnitTesting.ITestDataSourceIgnoreCapability.IgnoreMessage.get -> string?
Microsoft.VisualStudio.TestTools.UnitTesting.ITestDataSourceIgnoreCapability.IgnoreMessage.set -> void

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -296,4 +296,7 @@ Actual: {2}</value>
<data name="IsNotEmptyFailMsg" xml:space="preserve">
<value>Expected collection to contain any item but it is empty. {0}</value>
</data>
<data name="InvalidGitHubUrl" xml:space="preserve">
<value>Invalid GitHub ticket URL</value>
</data>
</root>
83 changes: 83 additions & 0 deletions test/UnitTests/TestFramework.UnitTests/GitHubWorkItemTests.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using Microsoft.VisualStudio.TestTools.UnitTesting;

using TestFramework.ForTestingMSTest;

namespace Microsoft.VisualStudio.TestPlatform.TestFramework.UnitTests;

public class GitHubWorkItemTests : TestContainer
{
public void GitHubWorkItemAttributeShouldExtractIdFromUrl_IssueUrl()
{
string url = "https://github.com/microsoft/testfx/issues/1234";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_IssueUrlWithEndingSlash()
{
string url = "https://github.com/microsoft/testfx/issues/1234/";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_IssueUrlWithComment()
{
string url = "https://github.com/microsoft/testfx/issues/1234#issuecomment-2581012838";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_PRUrl()
{
string url = "https://github.com/microsoft/testfx/pull/1234";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_PRUrlWithEndingSlash()
{
string url = "https://github.com/microsoft/testfx/pull/1234/";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_PRUrlWithComment()
{
string url = "https://github.com/microsoft/testfx/pull/1234#discussion_r1932733213";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_DiscussionUrl()
{
string url = "https://github.com/microsoft/testfx/discussions/1234";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_DiscussionUrlWithEndingSlash()
{
string url = "https://github.com/microsoft/testfx/discussions/1234/";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}

public void GitHubWorkItemAttributeShouldExtractIdFromUrl_DiscussionUrlWithComment()
{
string url = "https://github.com/microsoft/testfx/discussions/1234#discussioncomment-11865020";
GitHubWorkItemAttribute attribute = new(url);
Verify(attribute.Url == url);
Verify(attribute.Id == 1234);
}
}