Feat: Ability to easily test for Diagnostic Analyzers

Author: AnnaSasDev

src/CodeOfChaos.Testing.TUnit/Conditions/CompilationContainsDiagnosticAssertCondition.cs

@@ -10,10 +10,7 @@ namespace CodeOfChaos.Testing.TUnit.Conditions.Library;
 // ---------------------------------------------------------------------------------------------------------------------
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
-public abstract class ContainsDiagnosticAssertCondition<T>(string expectedId): ExpectedValueAssertCondition<T, string>(expectedId) {
-    
-    protected abstract ImmutableArray<Diagnostic> GetDiagnostics(T value);
-
+public class ContainsDiagnosticAssertCondition<T>(Func<T, ImmutableArray<Diagnostic>> getDiagnosticsAction, string expectedId): ExpectedValueAssertCondition<T, string>(expectedId) {
     // -----------------------------------------------------------------------------------------------------------------
     // Methods
     // -----------------------------------------------------------------------------------------------------------------
@@ -22,9 +19,9 @@ protected override Task<AssertionResult> GetResult(T? actualValue, string? expec
         if (actualValue is null) return AssertionResult.Fail($"{nameof(T)} is null");
         if (expectedValue is null) return AssertionResult.Fail("Expected value is null");
 
-        ImmutableArray<Diagnostic> diagnostics = GetDiagnostics(actualValue);
+        ImmutableArray<Diagnostic> diagnostics = getDiagnosticsAction(actualValue);
         if (!diagnostics.Any()) return FailWithMessage("No diagnostics");
         if (diagnostics.Any(d => d.Id == expectedValue)) return AssertionResult.Passed;
         return FailWithMessage("No diagnostic with Id");
     }
-}
+}

src/CodeOfChaos.Testing.TUnit/Conditions/CompilationContainsDiagnosticsExclusivelyAssertCondition.cs

@@ -10,10 +10,8 @@ namespace CodeOfChaos.Testing.TUnit.Conditions.Library;
 // ---------------------------------------------------------------------------------------------------------------------
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
-public abstract class ContainsDiagnosticsExclusivelyAssertCondition<T>(string[] expectedIds)
+public class ContainsDiagnosticsExclusivelyAssertCondition<T>(Func<T, ImmutableArray<Diagnostic>> getDiagnosticsAction, string[] expectedIds)
     : ExpectedValueAssertCondition<T, string[]>(expectedIds) {
-    
-    protected abstract ImmutableArray<Diagnostic> GetDiagnostics(T value);
 
     // -----------------------------------------------------------------------------------------------------------------
     // Methods
@@ -23,7 +21,7 @@ protected override Task<AssertionResult> GetResult(T? actualValue, string[]? exp
         if (actualValue is null) return AssertionResult.Fail($"{nameof(T)} is null");
         if (expectedValues is null) return AssertionResult.Fail("Expected value is null");
 
-        ImmutableArray<Diagnostic> diagnostics = GetDiagnostics(actualValue);
+        ImmutableArray<Diagnostic> diagnostics = getDiagnosticsAction(actualValue);
         if (!diagnostics.Any() && expectedValues.Length == 0) return AssertionResult.Passed;
         if (!diagnostics.Any()) return FailWithMessage("No diagnostics");
         if (expectedValues.Length != diagnostics.Length) return FailWithMessage("Wrong number of diagnostics");

src/CodeOfChaos.Testing.TUnit/Conditions/CompilationDoesNotContainDiagnosticAssertCondition.cs

@@ -10,10 +10,8 @@ namespace CodeOfChaos.Testing.TUnit.Conditions.Library;
 // ---------------------------------------------------------------------------------------------------------------------
 // Code
 // ---------------------------------------------------------------------------------------------------------------------
-public abstract class DoesNotContainDiagnosticAssertCondition<T>(string expectedId)
+public class DoesNotContainDiagnosticAssertCondition<T>(Func<T, ImmutableArray<Diagnostic>> getDiagnosticsAction, string expectedId)
     : ExpectedValueAssertCondition<T, string>(expectedId) {
-    
-    protected abstract ImmutableArray<Diagnostic> GetDiagnostics(T value);
 
     // -----------------------------------------------------------------------------------------------------------------
     // Methods
@@ -24,7 +22,7 @@ protected override Task<AssertionResult> GetResult(T? actualValue, string? expec
         if (actualValue is null) return AssertionResult.Fail($"{nameof(T)} is null");
         if (expectedValue is null) return AssertionResult.Fail("Expected value is null");
 
-        ImmutableArray<Diagnostic> diagnostics = GetDiagnostics(actualValue);
+        ImmutableArray<Diagnostic> diagnostics = getDiagnosticsAction(actualValue);
 
         if (diagnostics.Any(d => d.Id == expectedValue)) return FailWithMessage("Diagnostic with Id");
 

src/CodeOfChaos.Testing.TUnit/Conditions/GeneratorDriverRunResultContainsDiagnosticAssertCondition.cs

@@ -2,6 +2,7 @@
 // Imports
 // ---------------------------------------------------------------------------------------------------------------------
 using CodeOfChaos.Testing.TUnit.Conditions;
+using CodeOfChaos.Testing.TUnit.Conditions.Library;
 using Microsoft.CodeAnalysis;
 using System.Runtime.CompilerServices;
 using TUnit.Assertions.AssertConditions;
@@ -17,21 +18,30 @@ namespace CodeOfChaos.Testing.TUnit;
 public static class TUnitExtensionsCompilation {
     public static InvokableValueAssertionBuilder<Compilation> ContainsDiagnostic(this IValueSource<Compilation> valueSource, string expectedId, [CallerArgumentExpression(nameof(expectedId))] string doNotPopulateThisValue1 = "") {
         return valueSource.RegisterAssertion(
-            assertCondition: new CompilationContainsDiagnosticAssertCondition(expectedId),
+            assertCondition: new ContainsDiagnosticAssertCondition<Compilation>(
+                static compilation => compilation.GetDiagnostics(), 
+                expectedId
+            ),
             argumentExpressions: [doNotPopulateThisValue1]
         );
     }
 
     public static InvokableValueAssertionBuilder<Compilation> DoesNotContainDiagnostic(this IValueSource<Compilation> valueSource, string expectedId, [CallerArgumentExpression(nameof(expectedId))] string doNotPopulateThisValue1 = "") {
         return valueSource.RegisterAssertion(
-            assertCondition: new CompilationDoesNotContainDiagnosticAssertCondition(expectedId),
+            assertCondition: new DoesNotContainDiagnosticAssertCondition<Compilation>(
+                static compilation => compilation.GetDiagnostics(), 
+                expectedId
+            ),
             argumentExpressions: [doNotPopulateThisValue1]
         );
     }
 
     public static InvokableValueAssertionBuilder<Compilation> ContainsDiagnosticsExclusively(this IValueSource<Compilation> valueSource, string[] expectedIds, [CallerArgumentExpression(nameof(expectedIds))] string doNotPopulateThisValue1 = "") {
         return valueSource.RegisterAssertion(
-            assertCondition: new CompilationContainsDiagnosticsExclusivelyAssertCondition(expectedIds),
+            assertCondition: new ContainsDiagnosticsExclusivelyAssertCondition<Compilation>(
+                static compilation => compilation.GetDiagnostics(), 
+                expectedIds
+            ),
             argumentExpressions: [doNotPopulateThisValue1]
         );
     }