Skip to content

Commit ddc2396

Browse files
mikkelbuMikkel Bundgaard
mikkelbu
and
Mikkel Bundgaard
authored
chore: Bump NUnit.Analyzers documentation to version 4.4.0 (#989)
Co-authored-by: Mikkel Bundgaard <[email protected]>
1 parent 26fd020 commit ddc2396

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+662
-96
lines changed

‎docs/articles/nunit-analyzers/NUnit-Analyzers.md

+13
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Rules which enforce structural requirements on the test code.
5555
| [NUnit1030](NUnit1030.md) | The type of parameter provided by the TestCaseSource does not match the type of the parameter in the Test method | :white_check_mark: | :exclamation: | :x: |
5656
| [NUnit1031](NUnit1031.md) | The individual arguments provided by a ValuesAttribute must match the type of the corresponding parameter of the method | :white_check_mark: | :exclamation: | :x: |
5757
| [NUnit1032](NUnit1032.md) | An IDisposable field/property should be Disposed in a TearDown method | :white_check_mark: | :exclamation: | :x: |
58+
| [NUnit1033](NUnit1033.md) | The Write methods on TestContext will be marked as Obsolete and eventually removed | :white_check_mark: | :warning: | :white_check_mark: |
5859

5960
## Assertion Rules (NUnit2001 - )
6061

@@ -112,6 +113,10 @@ Rules which improve assertions in the test code.
112113
| [NUnit2048](NUnit2048.md) | Consider using Assert.That(...) instead of StringAssert(...) | :white_check_mark: | :warning: | :white_check_mark: |
113114
| [NUnit2049](NUnit2049.md) | Consider using Assert.That(...) instead of CollectionAssert(...) | :white_check_mark: | :warning: | :white_check_mark: |
114115
| [NUnit2050](NUnit2050.md) | NUnit 4 no longer supports string.Format specification | :white_check_mark: | :exclamation: | :white_check_mark: |
116+
| [NUnit2051](NUnit2051.md) | Consider using Assert.That(expr, Is.Positive) instead of ClassicAssert.Positive(expr) | :white_check_mark: | :information_source: | :white_check_mark: |
117+
| [NUnit2052](NUnit2052.md) | Consider using Assert.That(expr, Is.Negative) instead of ClassicAssert.Negative(expr) | :white_check_mark: | :information_source: | :white_check_mark: |
118+
| [NUnit2053](NUnit2053.md) | Consider using Assert.That(actual, Is.AssignableFrom(expected)) instead of ClassicAssert.IsAssignableFrom(expected, actual) | :white_check_mark: | :information_source: | :white_check_mark: |
119+
| [NUnit2054](NUnit2054.md) | Consider using Assert.That(actual, Is.Not.AssignableFrom(expected)) instead of ClassicAssert.IsNotAssignableFrom(expected, actual) | :white_check_mark: | :information_source: | :white_check_mark: |
115120

116121
## Suppressor Rules (NUnit3001 - )
117122

@@ -124,3 +129,11 @@ builds (version 3.0.0 and above) which require Visual Studio 2019 (version 16.3)
124129
| [NUnit3002](NUnit3002.md) | Field/Property is initialized in SetUp or OneTimeSetUp method | :white_check_mark: | :information_source: | :x: |
125130
| [NUnit3003](NUnit3003.md) | Class is an NUnit TestFixture and is instantiated using reflection | :white_check_mark: | :information_source: | :x: |
126131
| [NUnit3004](NUnit3004.md) | Field should be Disposed in TearDown or OneTimeTearDown method | :white_check_mark: | :information_source: | :x: |
132+
133+
## Style Rules (NUnit4001 - )
134+
135+
Rules which help you write concise and readable NUnit test code.
136+
137+
| Id | Title | :mag: | :memo: | :bulb: |
138+
| :-- | :-- | :--: | :--: | :--: |
139+
| [NUnit4001](NUnit4001.md) | Simplify the Values attribute | :white_check_mark: | :information_source: | :x: |

‎docs/articles/nunit-analyzers/NUnit1001.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseUsage/TestCaseUsageAnalyzer.cs)
11+
| Code | [TestCaseUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseUsage/TestCaseUsageAnalyzer.cs)
1212

1313
## Description
1414

@@ -29,6 +29,12 @@ public void SampleTest(int numberValue)
2929
{
3030
Assert.That(numberValue, Is.EqualTo(1));
3131
}
32+
33+
[TestCase<double>(42)]
34+
public void SampleTest(int numberValue)
35+
{
36+
Assert.That(numberValue, Is.EqualTo(1));
37+
}
3238
```
3339

3440
### Problem

‎docs/articles/nunit-analyzers/NUnit1002.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Warning
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1003.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseUsage/TestCaseUsageAnalyzer.cs)
11+
| Code | [TestCaseUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseUsage/TestCaseUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1004.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseUsage/TestCaseUsageAnalyzer.cs)
11+
| Code | [TestCaseUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseUsage/TestCaseUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1005.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
11+
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1006.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
11+
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1007.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
11+
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1008.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Warning
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ParallelizableUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ParallelizableUsage/ParallelizableUsageAnalyzer.cs)
11+
| Code | [ParallelizableUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ParallelizableUsage/ParallelizableUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1009.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ParallelizableUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ParallelizableUsage/ParallelizableUsageAnalyzer.cs)
11+
| Code | [ParallelizableUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ParallelizableUsage/ParallelizableUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1010.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ParallelizableUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ParallelizableUsage/ParallelizableUsageAnalyzer.cs)
11+
| Code | [ParallelizableUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ParallelizableUsage/ParallelizableUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1011.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1012.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
11+
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1013.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
11+
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1014.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
11+
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1015.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1016.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1017.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1018.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1019.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1020.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1021.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Warning
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
11+
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1022.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
11+
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1023.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
11+
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1024.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
11+
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1025.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
11+
| Code | [ValueSourceUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ValueSourceUsage/ValueSourceUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1026.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodAccessibilityLevelAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodAccessibilityLevel/TestMethodAccessibilityLevelAnalyzer.cs)
11+
| Code | [TestMethodAccessibilityLevelAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodAccessibilityLevel/TestMethodAccessibilityLevelAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1027.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
11+
| Code | [TestMethodUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestMethodUsage/TestMethodUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1028.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Info
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [NonTestMethodAccessibilityLevelAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/NonTestMethodAccessibilityLevel/NonTestMethodAccessibilityLevelAnalyzer.cs)
11+
| Code | [NonTestMethodAccessibilityLevelAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/NonTestMethodAccessibilityLevel/NonTestMethodAccessibilityLevelAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1029.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1030.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
11+
| Code | [TestCaseSourceUsesStringAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/TestCaseSourceUsage/TestCaseSourceUsesStringAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1031.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [ValuesUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/ValuesUsage/ValuesUsageAnalyzer.cs)
11+
| Code | [ValuesUsageAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/ValuesUsage/ValuesUsageAnalyzer.cs)
1212

1313
## Description
1414

‎docs/articles/nunit-analyzers/NUnit1032.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,58 @@
88
| Severity | Error
99
| Enabled | True
1010
| Category | Structure
11-
| Code | [DisposeFieldsAndPropertiesInTearDownAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.1.0/src/nunit.analyzers/DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzer.cs)
11+
| Code | [DisposeFieldsAndPropertiesInTearDownAnalyzer](https://github.com/nunit/nunit.analyzers/blob/4.4.0/src/nunit.analyzers/DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzer.cs)
1212

1313
## Description
1414

1515
An IDisposable field/property should be Disposed in a TearDown method.
1616

17+
This analyzer rule only applies to a `TestFixture` which is using the default
18+
NUnit `SingleInstance` life cycle where the class is instantiated once for all tests.
19+
20+
If you are using `LifeCycle.InstancePerTestCase` you should dispose the fields/properties
21+
in the `Dispose` method of the test class.
22+
1723
## Motivation
1824

1925
Not Disposing fields/properties can cause memory leaks or failing tests.
2026

2127
## How to fix violations
2228

29+
### LifeCycle.SingleInstance
30+
2331
Dispose any fields/properties that are initialized in `SetUp` or `Test` methods in a `TearDown` method.
2432
Fields/Properties that are initialized in `OneTimeSetUp`, or with initializers or in constructors
2533
must be disposed in `OneTimeTearDown`.
2634

35+
### LifeCycle.InstancePerTestCase
36+
37+
If you have `IDisposable` fields or properties, your class must implement the
38+
[`IDisposable`](https://learn.microsoft.com/en-us/dotnet/api/system.idisposable?view=net-8.0) interface.
39+
40+
Dispose any fields/properties that are initialized at declaration or in the constructor in the
41+
[`Dispose`](https://learn.microsoft.com/en-us/dotnet/api/system.idisposable.dispose?view=net-8.0) method.
42+
43+
The NUnit.Analyzer will not help you here as the functionality is available in
44+
[Microsoft .NET Analyzers](https://www.nuget.org/packages/Microsoft.CodeAnalysis.NetAnalyzers).
45+
These are the rules that will help you with this:
46+
47+
* [CA1001](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1001)
48+
Types that own disposable fields should be disposable
49+
* [CA2213](https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca2213)
50+
Disposable fields should be disposed
51+
52+
Unfortunately, those rules are not enabled by default, you can enable them in your project in a
53+
[`.editorconfig`](https://learn.microsoft.com/en-us/visualstudio/code-quality/use-roslyn-analyzers?view=vs-2022#manually-configure-rule-severity-in-an-editorconfig-file)
54+
file using the following content:
55+
56+
```xml
57+
# CA1001: Types that own disposable fields should be disposable
58+
dotnet_diagnostic.CA1001.severity = warning
59+
# CA2213: Disposable fields should be disposed
60+
dotnet_diagnostic.CA2213.severity = warning
61+
```
62+
2763
<!-- start generated config severity -->
2864
## Configure severity
2965

0 commit comments

Comments
 (0)