-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Update MSTest analyzers for 4.1 release #51464
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
14d4750
Update MSTest analyzers for 4.1 release
Evangelink 42b47d0
Update docs/core/testing/mstest-analyzers/mstest0063.md
Evangelink 778c4df
Fix MSTEST0062
Evangelink afbf874
Apply suggestion from @meaghanlewis
meaghanlewis 7b0fef3
Apply suggestion from @meaghanlewis
meaghanlewis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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
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
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
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,174 @@ | ||
| --- | ||
| title: "MSTEST0063: Test classes should have valid constructors" | ||
| description: "Learn about code analysis rule MSTEST0063: Test classes should have valid constructors" | ||
| ms.date: 02/04/2026 | ||
| f1_keywords: | ||
| - MSTEST0063 | ||
| - TestClassConstructorShouldBeValidAnalyzer | ||
| helpviewer_keywords: | ||
| - TestClassConstructorShouldBeValidAnalyzer | ||
| - MSTEST0063 | ||
| author: evangelink | ||
| ms.author: amauryleve | ||
| ai-usage: ai-assisted | ||
| dev_langs: | ||
| - CSharp | ||
| --- | ||
| # MSTEST0063: Test classes should have valid constructors | ||
|
|
||
| | Property | Value | | ||
| |-------------------------------------|----------------------------------------------------| | ||
| | **Rule ID** | MSTEST0063 | | ||
| | **Title** | Test classes should have valid constructors | | ||
| | **Category** | Usage | | ||
| | **Fix is breaking or non-breaking** | Non-breaking | | ||
| | **Enabled by default** | Yes | | ||
| | **Default severity** | Warning | | ||
| | **Introduced in version** | 4.1.0 | | ||
| | **Is there a code fix** | No | | ||
|
|
||
| ## Cause | ||
|
|
||
| A test class doesn't have a valid constructor. Valid constructors are `public` and either parameterless or have a single parameter of type <xref:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext>. | ||
|
|
||
| ## Rule description | ||
|
|
||
| Test classes must have a public constructor that is either parameterless or accepts a single <xref:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext> parameter. This allows the test framework to instantiate the test class properly. | ||
|
|
||
| Constructors that are non-public, have parameters of unsupported types, or have multiple parameters aren't valid and prevent the test framework from creating instances of the test class. | ||
|
|
||
| ```csharp | ||
| [TestClass] | ||
| public class MyTestClass | ||
| { | ||
| private MyTestClass() // Violation - constructor is not public | ||
| { | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```csharp | ||
| [TestClass] | ||
| public class MyTestClass | ||
| { | ||
| public MyTestClass(string value) // Violation - parameter type is not supported | ||
| { | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ```csharp | ||
| [TestClass] | ||
| public class MyTestClass | ||
| { | ||
| public MyTestClass(TestContext testContext, int value) // Violation - multiple parameters | ||
| { | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## How to fix violations | ||
|
|
||
| Ensure your test class has a valid constructor. A valid constructor must be: | ||
|
|
||
| 1. Declared as `public` | ||
meaghanlewis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Either parameterless or accept a single <xref:Microsoft.VisualStudio.TestTools.UnitTesting.TestContext> parameter | ||
Evangelink marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Parameterless constructor | ||
|
|
||
| ```csharp | ||
| [TestClass] | ||
| public class MyTestClass | ||
| { | ||
| public MyTestClass() | ||
| { | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void TestMethod() | ||
| { | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Constructor with TestContext | ||
|
|
||
| ```csharp | ||
| [TestClass] | ||
| public class MyTestClass | ||
| { | ||
| private readonly TestContext _testContext; | ||
|
|
||
| public MyTestClass(TestContext testContext) | ||
| { | ||
| _testContext = testContext; | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void TestMethod() | ||
| { | ||
| _testContext.WriteLine("Test is running..."); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Implicit parameterless constructor | ||
|
|
||
| If you don't define any constructor, the compiler generates a public parameterless constructor automatically: | ||
|
|
||
| ```csharp | ||
| [TestClass] | ||
| public class MyTestClass | ||
| { | ||
| [TestMethod] | ||
| public void TestMethod() | ||
| { | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Valid and invalid constructors together | ||
|
|
||
| If your test class has multiple constructors, at least one must be valid: | ||
|
|
||
| ```csharp | ||
| [TestClass] | ||
| public class MyTestClass | ||
| { | ||
| public MyTestClass() // Valid - this makes the class valid | ||
| { | ||
| } | ||
|
|
||
| private MyTestClass(int x) // Invalid, but ignored because a valid constructor exists | ||
| { | ||
| } | ||
|
|
||
| [TestMethod] | ||
| public void TestMethod() | ||
| { | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## When to suppress warnings | ||
|
|
||
| Don't suppress warnings from this rule. Test classes without valid constructors can't be instantiated by the test framework, and the tests won't run. | ||
|
|
||
| ## Suppress a warning | ||
|
|
||
| If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule. | ||
|
|
||
| ```csharp | ||
| #pragma warning disable MSTEST0063 | ||
| // The code that's violating the rule is on this line. | ||
| #pragma warning restore MSTEST0063 | ||
| ``` | ||
|
|
||
| To disable the rule for a file, folder, or project, set its severity to `none` in the [configuration file](../../../fundamentals/code-analysis/configuration-files.md). | ||
|
|
||
| ```ini | ||
| [*.{cs,vb}] | ||
| dotnet_diagnostic.MSTEST0063.severity = none | ||
| ``` | ||
|
|
||
| For more information, see [How to suppress code analysis warnings](../../../fundamentals/code-analysis/suppress-warnings.md). | ||
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
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
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.
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.
Uh oh!
There was an error while loading. Please reload this page.