Skip to content
This repository was archived by the owner on Nov 8, 2018. It is now read-only.

Commit 72a0fe8

Browse files
sharwellsharwell
committed
Add 'UseConfigureAwait' analyzer
Fixes #14
1 parent 9f35281 commit 72a0fe8

File tree

8 files changed

+421
-97
lines changed

8 files changed

+421
-97
lines changed

‎AsyncUsageAnalyzers/AsyncUsageAnalyzers.Test/AsyncUsageAnalyzers.Test.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,7 @@
125125
<Compile Include="Naming\AvoidAsyncSuffixUnitTests.cs" />
126126
<Compile Include="Naming\UseAsyncSuffixUnitTests.cs" />
127127
<Compile Include="Reliability\AvoidAsyncVoidUnitTests.cs" />
128+
<Compile Include="Usage\UseConfigureAwaitUnitTests.cs" />
128129
<Compile Include="Verifiers\CodeFixVerifier.cs" />
129130
<Compile Include="Verifiers\DiagnosticVerifier.cs" />
130131
<Compile Include="Helpers\CodeFixVerifier.Helper.cs" />

‎AsyncUsageAnalyzers/AsyncUsageAnalyzers.Test/Usage/UseConfigureAwaitUnitTests.cs

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
namespace AsyncUsageAnalyzers.Test.Usage
2+
{
3+
using System.Threading;
4+
using System.Threading.Tasks;
5+
using AsyncUsageAnalyzers.Usage;
6+
using Microsoft.CodeAnalysis.CodeFixes;
7+
using Microsoft.CodeAnalysis.Diagnostics;
8+
using TestHelper;
9+
using Xunit;
10+
11+
public class UseConfigureAwaitUnitTests : CodeFixVerifier
12+
{
13+
[Fact]
14+
public async Task TestSimpleExpression()
15+
{
16+
string testCode = @"
17+
using System.Threading.Tasks;
18+
class ClassName
19+
{
20+
async Task MethodNameAsync()
21+
{
22+
await Task.Delay(1000);
23+
}
24+
}
25+
";
26+
string fixedCode = @"
27+
using System.Threading.Tasks;
28+
class ClassName
29+
{
30+
async Task MethodNameAsync()
31+
{
32+
await Task.Delay(1000).ConfigureAwait(false);
33+
}
34+
}
35+
";
36+
37+
DiagnosticResult expected = CSharpDiagnostic().WithLocation(7, 15);
38+
await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
39+
await VerifyCSharpDiagnosticAsync(fixedCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
40+
await VerifyCSharpFixAsync(testCode, fixedCode, cancellationToken: CancellationToken.None).ConfigureAwait(false);
41+
}
42+
43+
[Fact]
44+
public async Task TestNestedExpressions()
45+
{
46+
string testCode = @"
47+
using System.Threading.Tasks;
48+
class ClassName
49+
{
50+
async Task<Task> FirstMethodAsync()
51+
{
52+
return Task.FromResult(true);
53+
}
54+
55+
async Task MethodNameAsync()
56+
{
57+
await (await FirstMethodAsync());
58+
}
59+
}
60+
";
61+
string fixedCode = @"
62+
using System.Threading.Tasks;
63+
class ClassName
64+
{
65+
async Task<Task> FirstMethodAsync()
66+
{
67+
return Task.FromResult(true);
68+
}
69+
70+
async Task MethodNameAsync()
71+
{
72+
await (await FirstMethodAsync().ConfigureAwait(false)).ConfigureAwait(false);
73+
}
74+
}
75+
";
76+
77+
DiagnosticResult[] expected =
78+
{
79+
CSharpDiagnostic().WithLocation(12, 15),
80+
CSharpDiagnostic().WithLocation(12, 22)
81+
};
82+
await VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
83+
await VerifyCSharpDiagnosticAsync(fixedCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
84+
await VerifyCSharpFixAsync(testCode, fixedCode, cancellationToken: CancellationToken.None).ConfigureAwait(false);
85+
}
86+
87+
protected override DiagnosticAnalyzer GetCSharpDiagnosticAnalyzer()
88+
{
89+
return new UseConfigureAwaitAnalyzer();
90+
}
91+
92+
protected override CodeFixProvider GetCSharpCodeFixProvider()
93+
{
94+
return new UseConfigureAwaitCodeFixProvider();
95+
}
96+
}
97+
}

‎AsyncUsageAnalyzers/AsyncUsageAnalyzers/AsyncUsageAnalyzers.csproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@
7373
<DesignTime>True</DesignTime>
7474
<DependentUpon>UsageResources.resx</DependentUpon>
7575
</Compile>
76+
<Compile Include="Usage\UseConfigureAwaitAnalyzer.cs" />
77+
<Compile Include="Usage\UseConfigureAwaitCodeFixProvider.cs" />
7678
</ItemGroup>
7779
<ItemGroup>
7880
<EmbeddedResource Include="Naming\NamingResources.resx">

‎AsyncUsageAnalyzers/AsyncUsageAnalyzers/Usage/UsageResources.Designer.cs

Lines changed: 27 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎AsyncUsageAnalyzers/AsyncUsageAnalyzers/Usage/UsageResources.resx

Lines changed: 125 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,101 +1,129 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<root>
3-
<!--
4-
Microsoft ResX Schema
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
556
6-
Version 1.3
7-
8-
The primary goals of this format is to allow a simple XML format
9-
that is mostly human readable. The generation and parsing of the
10-
various data types are done through the TypeConverter classes
11-
associated with the data types.
12-
13-
Example:
14-
15-
... ado.net/XML headers & schema ...
16-
<resheader name="resmimetype">text/microsoft-resx</resheader>
17-
<resheader name="version">1.3</resheader>
18-
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19-
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20-
<data name="Name1">this is my long string</data>
21-
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22-
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23-
[base64 mime encoded serialized .NET Framework object]
24-
</data>
25-
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26-
[base64 mime encoded string representing a byte array form of the .NET Framework object]
27-
</data>
28-
29-
There are any number of "resheader" rows that contain simple
30-
name/value pairs.
31-
32-
Each data row contains a name, and value. The row also contains a
33-
type or mimetype. Type corresponds to a .NET class that support
34-
text/value conversion through the TypeConverter architecture.
35-
Classes that don't support this are serialized and stored with the
36-
mimetype set.
37-
38-
The mimetype is used for serialized objects, and tells the
39-
ResXResourceReader how to depersist the object. This is currently not
40-
extensible. For a given mimetype the value must be set accordingly:
41-
42-
Note - application/x-microsoft.net.object.binary.base64 is the format
43-
that the ResXResourceWriter will generate, however the reader can
44-
read any of the formats listed below.
45-
46-
mimetype: application/x-microsoft.net.object.binary.base64
47-
value : The object must be serialized with
48-
: System.Serialization.Formatters.Binary.BinaryFormatter
49-
: and then encoded with base64 encoding.
50-
51-
mimetype: application/x-microsoft.net.object.soap.base64
52-
value : The object must be serialized with
53-
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
54-
: and then encoded with base64 encoding.
55-
56-
mimetype: application/x-microsoft.net.object.bytearray.base64
57-
value : The object must be serialized into a byte array
58-
: using a System.ComponentModel.TypeConverter
59-
: and then encoded with base64 encoding.
60-
-->
61-
62-
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63-
<xsd:element name="root" msdata:IsDataSet="true">
64-
<xsd:complexType>
65-
<xsd:choice maxOccurs="unbounded">
66-
<xsd:element name="data">
67-
<xsd:complexType>
68-
<xsd:sequence>
69-
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
70-
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
71-
</xsd:sequence>
72-
<xsd:attribute name="name" type="xsd:string" msdata:Ordinal="1" />
73-
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
74-
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
75-
</xsd:complexType>
76-
</xsd:element>
77-
<xsd:element name="resheader">
78-
<xsd:complexType>
79-
<xsd:sequence>
80-
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
81-
</xsd:sequence>
82-
<xsd:attribute name="name" type="xsd:string" use="required" />
83-
</xsd:complexType>
84-
</xsd:element>
85-
</xsd:choice>
86-
</xsd:complexType>
87-
</xsd:element>
88-
</xsd:schema>
89-
<resheader name="resmimetype">
90-
<value>text/microsoft-resx</value>
91-
</resheader>
92-
<resheader name="version">
93-
<value>1.3</value>
94-
</resheader>
95-
<resheader name="reader">
96-
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.3500.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
97-
</resheader>
98-
<resheader name="writer">
99-
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.3500.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
100-
</resheader>
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="UseConfigureAwaitDescription" xml:space="preserve">
121+
<value>The continuation behavior for a Task should be configured by calling ConfigureAwait prior to awaiting the task.</value>
122+
</data>
123+
<data name="UseConfigureAwaitMessageFormat" xml:space="preserve">
124+
<value>Call ConfigureAwait before awaiting a Task</value>
125+
</data>
126+
<data name="UseConfigureAwaitTitle" xml:space="preserve">
127+
<value>Use ConfigureAwait</value>
128+
</data>
101129
</root>

0 commit comments

Comments
 (0)