Add FrameworkConditionAttribute for conditional test execution based on .NET framework #6071
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,39 +1 @@ | ||
| {"sdk":{"version":"8.0.117","rollForward":"latestMinor"}} |
This file contains hidden or 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,110 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| using System.Runtime.InteropServices; | ||
|
|
||
| namespace Microsoft.VisualStudio.TestTools.UnitTesting; | ||
|
|
||
| /// <summary> | ||
| /// This attribute is used to conditionally control whether a test class or a test method will run or be ignored based on the .NET framework being used. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// This attribute isn't inherited. Applying it to a base class will not affect derived classes. | ||
| /// </remarks> | ||
| [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, Inherited = false, AllowMultiple = false)] | ||
| public sealed class FrameworkConditionAttribute : ConditionBaseAttribute | ||
| { | ||
| private readonly Frameworks _frameworks; | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FrameworkConditionAttribute"/> class. | ||
| /// </summary> | ||
| /// <param name="mode">Decides whether the frameworks will be included or excluded.</param> | ||
| /// <param name="frameworks">The .NET frameworks that this test includes/excludes.</param> | ||
| public FrameworkConditionAttribute(ConditionMode mode, Frameworks frameworks) | ||
| : base(mode) | ||
| { | ||
| _frameworks = frameworks; | ||
| IgnoreMessage = mode == ConditionMode.Include | ||
| ? $"Test is only supported on {frameworks}" | ||
| : $"Test is not supported on {frameworks}"; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="FrameworkConditionAttribute"/> class. | ||
| /// </summary> | ||
| /// <param name="frameworks">The .NET frameworks that this test supports.</param> | ||
| public FrameworkConditionAttribute(Frameworks frameworks) | ||
| : this(ConditionMode.Include, frameworks) | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Gets a value indicating whether the test method or test class should run. | ||
| /// </summary> | ||
| public override bool ShouldRun => IsCurrentFrameworkSupported(); | ||
|
|
||
| /// <summary> | ||
| /// Gets the ignore message (in case <see cref="ShouldRun"/> returns <see langword="false"/>). | ||
| /// </summary> | ||
| public override string? IgnoreMessage { get; } | ||
|
|
||
| /// <summary> | ||
| /// Gets the group name for this attribute. | ||
| /// </summary> | ||
| public override string GroupName => nameof(FrameworkConditionAttribute); | ||
|
|
||
| private bool IsCurrentFrameworkSupported() | ||
| { | ||
| Frameworks currentFramework = GetCurrentFramework(); | ||
| return (_frameworks & currentFramework) != 0; | ||
| } | ||
|
|
||
| private static Frameworks GetCurrentFramework() | ||
| { | ||
| string frameworkDescription = RuntimeInformation.FrameworkDescription; | ||
| Version version = Environment.Version; | ||
|
|
||
| // Check for .NET Framework | ||
| if (frameworkDescription.StartsWith(".NET Framework", StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| return Frameworks.NetFramework; | ||
| } | ||
|
|
||
| // Check for .NET Core | ||
| if (frameworkDescription.StartsWith(".NET Core", StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| return Frameworks.NetCore; | ||
| } | ||
|
|
||
| // Check for .NET 5+ | ||
| if (frameworkDescription.StartsWith(".NET ", StringComparison.OrdinalIgnoreCase) || | ||
| frameworkDescription.StartsWith(".NET Core", StringComparison.OrdinalIgnoreCase)) | ||
| { | ||
| Frameworks framework = Frameworks.Net; | ||
|
|
||
| // Add version-specific flags | ||
| if (version.Major >= 6) | ||
| { | ||
| framework |= Frameworks.Net6OrGreater; | ||
| } | ||
| if (version.Major >= 7) | ||
| { | ||
| framework |= Frameworks.Net7OrGreater; | ||
| } | ||
| if (version.Major >= 8) | ||
| { | ||
| framework |= Frameworks.Net8OrGreater; | ||
| } | ||
| if (version.Major >= 9) | ||
| { | ||
| framework |= Frameworks.Net9OrGreater; | ||
| } | ||
|
|
||
| return framework; | ||
| } | ||
|
|
||
| // Default to .NET for unknown cases | ||
| return Frameworks.Net; | ||
| } | ||
| } | ||
This file contains hidden or 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,46 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| namespace Microsoft.VisualStudio.TestTools.UnitTesting; | ||
|
|
||
| /// <summary> | ||
| /// An enum that is used with <see cref="FrameworkConditionAttribute"/> to control which .NET frameworks a test method or test class supports or doesn't support. | ||
| /// </summary> | ||
| [Flags] | ||
| public enum Frameworks | ||
| { | ||
| /// <summary> | ||
| /// Represents .NET Framework (the full framework on Windows). | ||
| /// </summary> | ||
| NetFramework = 1 << 0, | ||
|
|
||
| /// <summary> | ||
| /// Represents .NET Core 1.x, 2.x, and 3.x. | ||
| /// </summary> | ||
| NetCore = 1 << 1, | ||
|
|
||
| /// <summary> | ||
| /// Represents .NET 5 and later versions (unified platform). | ||
| /// </summary> | ||
| Net = 1 << 2, | ||
|
There was a problem hiding this comment. This is confusing. This one will be net5.0 only per the current implementation. I'm also not sure if it's good to add the versions to this enum:
There was a problem hiding this comment. You're absolutely right about both concerns. I've simplified the Frameworks enum to address these issues:
This design is much cleaner and follows the same pattern as Benefits:
Fixed in commit f3fa939. |
||
|
|
||
| /// <summary> | ||
| /// Represents .NET 6 and later versions. | ||
| /// </summary> | ||
| Net6OrGreater = 1 << 3, | ||
|
|
||
| /// <summary> | ||
| /// Represents .NET 7 and later versions. | ||
| /// </summary> | ||
| Net7OrGreater = 1 << 4, | ||
|
|
||
| /// <summary> | ||
| /// Represents .NET 8 and later versions. | ||
| /// </summary> | ||
| Net8OrGreater = 1 << 5, | ||
|
|
||
| /// <summary> | ||
| /// Represents .NET 9 and later versions. | ||
| /// </summary> | ||
| Net9OrGreater = 1 << 6, | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This check is redundant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're absolutely right. The check for ".NET Core" in line 82 was redundant since that case is already handled by the check on lines 75-78 which would return early. I've removed the redundant condition. Fixed in commit 4fe0d32.