Merge pull request #589 from manfred-brands/issue585_asyncInit

Descend into local asynchronous methods.
nunit · Sep 12, 2023 · c652c64 · c652c64
2 parents 761ff86 + cfe5e9d
commit c652c64
Show file tree

Hide file tree

Showing 4 changed files with 103 additions and 0 deletions.
diff --git a/...s.tests/DiagnosticSuppressors/NonNullableFieldOrPropertyIsUninitializedSuppressorTests.cs b/...s.tests/DiagnosticSuppressors/NonNullableFieldOrPropertyIsUninitializedSuppressorTests.cs
@@ -246,6 +246,39 @@ private void SetFields()
  RoslynAssert.Suppressed(suppressor, testCode);
  }
 
+ [TestCase("async Task", "await ", "", "")]
+ [TestCase("async Task", "await ", "this.", "")]
+ [TestCase("async Task", "await ", "", ".ConfigureAwait(false)")]
+ [TestCase("async Task", "await ", "this.", ".ConfigureAwait(false)")]
+ [TestCase("void", "", "", ".Wait()")]
+ [TestCase("void", "", "this.", ".Wait()")]
+ public void FieldAssignedInAsyncCalledMethod(string returnType, string awaitKeyWord, string accessor, string suffix)
+ {
+ var testCode = TestUtility.WrapMethodInClassNamespaceAndAddUsings(@$"
+ private string ↓field;
+
+ [SetUp]
+ public {returnType} Initialize()
+ {{
+ {awaitKeyWord}{accessor}SetFields(){suffix};
+ }}
+
+ [Test]
+ public void Test()
+ {{
+ Assert.That({accessor}field, Is.Not.Null);
+ }}
+
+ private Task SetFields()
+ {{
+ {accessor}field = string.Empty;
+ return Task.CompletedTask;
+ }}
+ ");
+
+ RoslynAssert.Suppressed(suppressor, testCode);
+ }
+
  [TestCase("SetUp", "")]
  [TestCase("OneTimeSetUp", "this.")]
  public void FieldAssignedInCalledMethods(string attribute, string prefix)

diff --git a/...DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzerTests.cs b/...DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzerTests.cs
@@ -225,6 +225,40 @@ public void TearDownMethod()
  RoslynAssert.Diagnostics(analyzer, expectedDiagnostic, testCode);
  }
 
+ [Test]
+ public void FieldConditionallyAssignedInCalledLocalMethod()
+ {
+ var testCode = TestUtility.WrapMethodInClassNamespaceAndAddUsings($@"
+ private object? ↓field;
+ private bool initializeField;
+
+ public TestClass(bool initializeField) => this.initializeField = initializeField;
+
+ [SetUp]
+ public async Task SetUp()
+ {{
+ if (initializeField)
+ await InitializeField().ConfigureAwait(false);
+ }}
+
+ [TearDown]
+ public void TearDownMethod()
+ {{
+ field = null;
+ }}
+
+ private Task InitializeField()
+ {{
+ field = new DummyDisposable();
+ return Task.CompletedTask;
+ }}
+
+ {DummyDisposable}
+ ");
+
+ RoslynAssert.Diagnostics(analyzer, expectedDiagnostic, testCode);
+ }
+
  [Test]
  public void AnalyzeWhenPropertyBackingFieldIsDisposed(
  [Values("field", "Property")] string fieldOrProperty)

diff --git a/...it.analyzers/DiagnosticSuppressors/NonNullableFieldOrPropertyIsUninitializedSuppressor.cs b/...it.analyzers/DiagnosticSuppressors/NonNullableFieldOrPropertyIsUninitializedSuppressor.cs
@@ -202,6 +202,17 @@ private static bool IsAssignedIn(
  ExpressionSyntax? expressionStatement,
  string fieldOrPropertyName)
  {
+ if (expressionStatement is AwaitExpressionSyntax awaitExpression)
+ {
+ expressionStatement = awaitExpression.Expression;
+ if (expressionStatement is InvocationExpressionSyntax awaitInvocationExpression &&
+ awaitInvocationExpression.Expression is MemberAccessExpressionSyntax awaitMemberAccessExpression &&
+ awaitMemberAccessExpression.Name.Identifier.Text == "ConfigureAwait")
+ {
+ expressionStatement = awaitMemberAccessExpression.Expression;
+ }
+ }
+
  if (expressionStatement is AssignmentExpressionSyntax assignmentExpression)
  {
  if (assignmentExpression.Left is TupleExpressionSyntax tupleExpression)
@@ -224,6 +235,13 @@ private static bool IsAssignedIn(
  }
  else if (expressionStatement is InvocationExpressionSyntax invocationExpression)
  {
+ if (invocationExpression.Expression is MemberAccessExpressionSyntax memberAccessExpression &&
+ memberAccessExpression.Expression is InvocationExpressionSyntax awaitedInvocationExpression &&
+ memberAccessExpression.Name.Identifier.Text == "Wait")
+ {
+ invocationExpression = awaitedInvocationExpression;
+ }
+
  string? identifier = GetIdentifier(invocationExpression.Expression);
 
  if (!string.IsNullOrEmpty(identifier) &&

diff --git a/...zers/DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzer.cs b/...zers/DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzer.cs
@@ -227,6 +227,17 @@ private static void AssignedIn(Parameters parameters, HashSet<string> assignment
 
  private static void AssignedIn(Parameters parameters, HashSet<string> assignments, ExpressionSyntax expression)
  {
+ if (expression is AwaitExpressionSyntax awaitExpression)
+ {
+ expression = awaitExpression.Expression;
+ if (expression is InvocationExpressionSyntax awaitInvocationExpression &&
+ awaitInvocationExpression.Expression is MemberAccessExpressionSyntax awaitMemberAccessExpression &&
+ awaitMemberAccessExpression.Name.Identifier.Text == "ConfigureAwait")
+ {
+ expression = awaitMemberAccessExpression.Expression;
+ }
+ }
+
  if (expression is AssignmentExpressionSyntax assignmentExpression)
  {
  // We only deal with simple assignments, not tuple or deconstruct
@@ -241,6 +252,13 @@ private static void AssignedIn(Parameters parameters, HashSet<string> assignment
  }
  else if (expression is InvocationExpressionSyntax invocationExpression)
  {
+ if (invocationExpression.Expression is MemberAccessExpressionSyntax memberAccessExpression &&
+ memberAccessExpression.Expression is InvocationExpressionSyntax awaitedInvocationExpression &&
+ memberAccessExpression.Name.Identifier.Text == "Wait")
+ {
+ invocationExpression = awaitedInvocationExpression;
+ }
+
  string? method = GetIdentifier(invocationExpression.Expression);
  if (method is not null)
  {