Do not raise NUnit1032 if Fixture uses LifeCycle.InstancePerTestCase

nunit · Sep 24, 2023 · 2145034 · 2145034
1 parent c6175b3
commit 2145034
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 12 deletions.
diff --git a/...DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzerTests.cs b/...DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzerTests.cs
@@ -1,3 +1,4 @@
+using System.Threading.Tasks;
 using Gu.Roslyn.Asserts;
 using Microsoft.CodeAnalysis.Diagnostics;
 using NUnit.Analyzers.Constants;
@@ -742,5 +743,33 @@ private sealed class DummyAsyncWriter : IAsyncDisposable
             RoslynAssert.Valid(analyzer, testCode);
         }
 #endif
+
+        [Test]
+        public void ShouldNotAnalyzeWhenInstancePerTestCase()
+        {
+            var testCode = TestUtility.WrapClassInNamespaceAndAddUsing(@$"
+            [FixtureLifeCycle(LifeCycle.InstancePerTestCase)]
+            public class TestClass
+            {{
+                private readonly IDisposable? field;
+
+                public TestClass()
+                {{
+                    field = new DummyDisposable();
+                }}
+
+                [Test]
+                public void Test()
+                {{
+                    Assert.That(field, Is.Not.Null);
+                }}
+
+                {DummyDisposable}
+            }}
+            ");
+
+            // InstancePerTestCase mean test should use IDisposable
+            RoslynAssert.Valid(analyzer, testCode);
+        }
     }
 }
diff --git a/...alyzers/DiagnosticSuppressors/TypesThatOwnDisposableFieldsShouldBeDisposableSuppressor.cs b/...alyzers/DiagnosticSuppressors/TypesThatOwnDisposableFieldsShouldBeDisposableSuppressor.cs
@@ -45,18 +45,10 @@ public override void ReportSuppressions(SuppressionAnalysisContext context)
 
                 if (typeSymbol is not null)
                 {
-                    // Is the class set up for a InstancePerTestCase
-                    AttributeData? fixtureLifeCycleAttribute = typeSymbol.GetAllAttributes().FirstOrDefault(x => x.IsFixtureLifeCycleAttribute(context.Compilation));
-                    if (fixtureLifeCycleAttribute is not null &&
-                        fixtureLifeCycleAttribute.ConstructorArguments.Length == 1 &&
-                        fixtureLifeCycleAttribute.ConstructorArguments[0] is TypedConstant typeConstant &&
-                        typeConstant.Kind == TypedConstantKind.Enum &&
-                        typeConstant.Type.IsType(NUnitFrameworkConstants.FullNameOfLifeCycle, context.Compilation) &&
-                        typeConstant.Value is 1 /* LifeCycle.InstancePerTestCase */)
+                    if (typeSymbol.IsInstancePerTestCaseFixture(context.Compilation))
                     {
                         // If a TestFixture used InstancePerTestCase, it should be IDisposable
-                        if (diagnostic.Descriptor.Id == TypesThatOwnDisposableFieldsShouldHaveATearDown.SuppressedDiagnosticId)
-                            continue;
+                        continue;
                     }
 
                     if (typeSymbol.IsTestFixture(context.Compilation))

diff --git a/...zers/DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzer.cs b/...zers/DisposeFieldsAndPropertiesInTearDown/DisposeFieldsAndPropertiesInTearDownAnalyzer.cs
@@ -69,9 +69,10 @@ private static void AnalyzeDisposableFields(SyntaxNodeAnalysisContext context)
                 return;
             }
 
-            if (!typeSymbol.GetMembers().OfType<IMethodSymbol>().Any(m => m.IsTestRelatedMethod(context.Compilation)))
+            if (typeSymbol.IsInstancePerTestCaseFixture(context.Compilation) ||
+                !typeSymbol.IsTestFixture(context.Compilation))
             {
-                // Not a TestFixture, CA1812 should have picked this up.
+                // CA1001 should picked this up. Assuming it is enabled.
                 return;
             }
 

diff --git a/src/nunit.analyzers/Extensions/IMethodSymbolExtensions.cs b/src/nunit.analyzers/Extensions/IMethodSymbolExtensions.cs
@@ -1,5 +1,6 @@
 using System.Linq;
 using Microsoft.CodeAnalysis;
+using NUnit.Analyzers.Constants;
 
 namespace NUnit.Analyzers.Extensions
 {
@@ -72,5 +73,17 @@ internal static bool IsTestFixture(this ITypeSymbol typeSymbol, Compilation comp
         {
             return typeSymbol.GetMembers().OfType<IMethodSymbol>().Any(m => m.IsTestRelatedMethod(compilation));
         }
+
+        internal static bool IsInstancePerTestCaseFixture(this ITypeSymbol typeSymbol, Compilation compilation)
+        {
+            // Is there a FixtureLifeCycleAttribute?
+            AttributeData? fixtureLifeCycleAttribute = typeSymbol.GetAllAttributes().FirstOrDefault(x => x.IsFixtureLifeCycleAttribute(compilation));
+            return fixtureLifeCycleAttribute is not null &&
+                fixtureLifeCycleAttribute.ConstructorArguments.Length == 1 &&
+                fixtureLifeCycleAttribute.ConstructorArguments[0] is TypedConstant typeConstant &&
+                typeConstant.Kind == TypedConstantKind.Enum &&
+                typeConstant.Type.IsType(NUnitFrameworkConstants.FullNameOfLifeCycle, compilation) &&
+                typeConstant.Value is 1 /* LifeCycle.InstancePerTestCase */;
+        }
     }
 }