-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathanalyzers-testing.md
93 lines (76 loc) · 1.74 KB
/
analyzers-testing.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
sidebar_label: Analyzers Testing
---
# Unit Testing of Analyzers
## NuGet Package
```
dotnet add package roslynator.testing.csharp.xunit
```
or
```
dotnet add package roslynator.testing.csharp.mstest
```
## Example: Test Analyzer With Code Fix
```cs
using Roslynator.Testing.CSharp.Xunit;
using Xunit;
public class AccessibilityModifiersTests
: XunitDiagnosticVerifier<AccessibilityModifiersAnalyzer, AccessibilityModifiersCodeFixProvider>
{
public override DiagnosticDescriptor Descriptor { get; } = DiagnosticDescriptors.AddOrRemoveAccessibilityModifiers;
[Fact]
public async Task Test()
{
await VerifyDiagnosticAndFixAsync(
source: @"
namespace N
{
class [|C|]
{
}
}
",
expectedSource: @"
namespace N
{
internal class C
{
}
}
",
options: Options.AddConfigOption("roslynator_accessibility_modifiers", "explicit"));
}
}
```
## Example: Test Analyzer Without Code Fix
Use `EmptyCodeFixProvider` in tests of analyzers without a code fix.
```cs
using Roslynator.Testing.CSharp.Xunit;
using Xunit;
public class UnusedParameterTests
: XunitDiagnosticVerifier<UnusedParameterAnalyzer, EmptyCodeFixProvider>
{
public override DiagnosticDescriptor Descriptor { get; } = DiagnosticDescriptors.UnusedParameter;
[Fact]
public async Task Test()
{
await VerifyDiagnosticAsync(
source: @"
class C
{
void M([|object p|])
{
}
}
"
);
}
}
```
## How to Mark Diagnostic's Location
Diagnostic's location is marked directly in a test code using `[|` and `|]` tokens.
## How to Add Config Options
Each test method has parameter `options` of type `TestOptions`:
```cs
options: Options.AddConfigOption("option_key", "option_value")
```