Updated tooling and refactored SampleGen to remove special code path for when executing in tests

Author: Arlodotexe

CommunityToolkit.Tooling.SampleGen.Tests/Helpers/TestHelpers.Compilation.cs

@@ -33,14 +33,14 @@ internal static CSharpCompilation CreateCompilation(this IEnumerable<SyntaxTree>
         return CSharpCompilation.Create(assemblyName, syntaxTree, references ?? GetAllReferencedAssemblies(), new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary));
     }
 
-    internal static GeneratorDriver CreateSourceGeneratorDriver(this SyntaxTree syntaxTree, IIncrementalGenerator generator)
+    internal static GeneratorDriver CreateSourceGeneratorDriver(this SyntaxTree syntaxTree, params IIncrementalGenerator[] generators)
     {
-        return CSharpGeneratorDriver.Create(generator).WithUpdatedParseOptions((CSharpParseOptions)syntaxTree.Options);
+        return CSharpGeneratorDriver.Create(generators).WithUpdatedParseOptions((CSharpParseOptions)syntaxTree.Options);
     }
 
-    internal static GeneratorDriver CreateSourceGeneratorDriver(this SyntaxTree syntaxTree, params IIncrementalGenerator[] generators)
+    internal static GeneratorDriver CreateSourceGeneratorDriver(this Compilation compilation, params IIncrementalGenerator[] generators)
     {
-        return CSharpGeneratorDriver.Create(generators).WithUpdatedParseOptions((CSharpParseOptions)syntaxTree.Options);
+        return CSharpGeneratorDriver.Create(generators).WithUpdatedParseOptions((CSharpParseOptions)compilation.SyntaxTrees.First().Options);
     }
 
     internal static GeneratorDriver WithMarkdown(this GeneratorDriver driver, params string[] markdownFilesToCreate)

CommunityToolkit.Tooling.SampleGen.Tests/Helpers/TestHelpers.cs

@@ -6,20 +6,19 @@ namespace CommunityToolkit.Tooling.SampleGen.Tests.Helpers;
 public static partial class TestHelpers
 {
     internal static SourceGeneratorRunResult RunSourceGenerator<TGenerator>(this string source, string assemblyName, string markdown = "") where TGenerator : class, IIncrementalGenerator, new() => RunSourceGenerator<TGenerator>(source.ToSyntaxTree(), assemblyName, markdown);
-
+    
     internal static SourceGeneratorRunResult RunSourceGenerator<TGenerator>(this SyntaxTree syntaxTree, string assemblyName, string markdown = "")
         where TGenerator : class, IIncrementalGenerator, new()
     {
-        var references = GetAllReferencedAssemblies();
-        var compilation = syntaxTree.CreateCompilation(assemblyName, references); // assembly name should always be supplied in param
-        return RunSourceGenerator<TGenerator>(syntaxTree, compilation, markdown);
+        var compilation = syntaxTree.CreateCompilation(assemblyName); // assembly name should always be supplied in param
+        return RunSourceGenerator<TGenerator>(compilation, markdown);
     }
 
-    internal static SourceGeneratorRunResult RunSourceGenerator<TGenerator>(this SyntaxTree syntaxTree, Compilation compilation, string markdown = "")
+    internal static SourceGeneratorRunResult RunSourceGenerator<TGenerator>(this Compilation compilation, string markdown = "")
         where TGenerator : class, IIncrementalGenerator, new()
     {
         // Create a driver for the source generator
-        var driver = syntaxTree
+        var driver = compilation
             .CreateSourceGeneratorDriver(new TGenerator())
             .WithMarkdown(markdown);
 

CommunityToolkit.Tooling.SampleGen.Tests/ToolkitSampleGeneratedPaneTests.cs

@@ -4,7 +4,9 @@
 
 using CommunityToolkit.Tooling.SampleGen.Diagnostics;
 using CommunityToolkit.Tooling.SampleGen.Tests.Helpers;
+using Microsoft.CodeAnalysis;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System.Linq;
 
 namespace CommunityToolkit.Tooling.SampleGen.Tests;
 
@@ -51,7 +53,9 @@ public class UserControl {{ }}
     [TestMethod]
     public void PaneOption_GeneratesTitleProperty()
     {
-        var syntaxTree = """
+        // The sample registry is designed to be declared in the sample project, and generated in the project head where its displayed in the UI as data.
+        // To test the contents of the generated sample registry, we must replicate this setup.
+        var sampleProjectAssembly = """
             using System.ComponentModel;
             using CommunityToolkit.Tooling.SampleGen;
             using CommunityToolkit.Tooling.SampleGen.Attributes;
@@ -72,13 +76,16 @@ namespace Windows.UI.Xaml.Controls
             {
                 public class UserControl { }
             }
-        """.ToSyntaxTree();
+        """.ToSyntaxTree()
+            .CreateCompilation("MyApp.Samples")
+            .ToMetadataReference();
 
-        // Create compilation builder with custom assembly name
-        var compilation = syntaxTree.CreateCompilation("MyApp.Tests");
+        // Get all current referenced assemblies + our generated sample project.
+        var headReferences = TestHelpers.GetAllReferencedAssemblies().Concat(new[] { sampleProjectAssembly });
+        var headCompilation = string.Empty.ToSyntaxTree().CreateCompilation("MyApp.Head", headReferences);
 
         // Run source generator
-        var result = syntaxTree.RunSourceGenerator<ToolkitSampleMetadataGenerator>(compilation);
+        var result = headCompilation.RunSourceGenerator<ToolkitSampleMetadataGenerator>();
 
         result.AssertDiagnosticsAre();
         result.AssertNoCompilationErrors();
@@ -378,7 +385,7 @@ public class UserControl {{ }}
     [TestMethod]
     public void GeneratedPaneOption_ButtonAction()
     {
-        var source = $@"
+        var syntaxTree = $@"
             using System.ComponentModel;
             using CommunityToolkit.Tooling.SampleGen;
             using CommunityToolkit.Tooling.SampleGen.Attributes;
@@ -398,11 +405,29 @@ private void RaiseNotification()
             namespace Windows.UI.Xaml.Controls
             {{
                 public class UserControl {{ }}
-            }}";
+            }}".ToSyntaxTree();
 
 
-        var result = source.RunSourceGenerator<ToolkitSampleMetadataGenerator>(SAMPLE_ASM_NAME);
+        // Create compilation builder with custom assembly name
+        var compilation = syntaxTree.CreateCompilation("MyApp.Tests");
 
-        result.AssertDiagnosticsAre(DiagnosticDescriptors.SampleNotReferencedInMarkdown);
+        // Run source generator
+        var result = compilation.RunSourceGenerator<ToolkitSampleMetadataGenerator>();
+
+        result.AssertDiagnosticsAre();
+        result.AssertNoCompilationErrors();
+
+        result.AssertSourceGenerated(filename: "ToolkitSampleRegistry.g.cs", expectedContents: """
+        #nullable enable
+        namespace CommunityToolkit.Tooling.SampleGen;
+
+        public static class ToolkitSampleRegistry
+        {
+            public static System.Collections.Generic.Dictionary<string, CommunityToolkit.Tooling.SampleGen.Metadata.ToolkitSampleMetadata> Listing
+            { get; } = new() {
+                ["Sample"] = new CommunityToolkit.Tooling.SampleGen.Metadata.ToolkitSampleMetadata("Sample", "Test Sample", "", typeof(MyApp.Sample), () => new MyApp.Sample(), null, null, new CommunityToolkit.Tooling.SampleGen.Metadata.IGeneratedToolkitSampleOptionViewModel[] { new CommunityToolkit.Tooling.SampleGen.Metadata.ToolkitSampleNumericOptionMetadataViewModel(name: "TextSize", initial: 12, min: 8, max: 48, step: 2, showAsNumberBox: false, title: "FontSize") })
+            };
+        }
+        """);
     }
 }

CommunityToolkit.Tooling.SampleGen/ToolkitSampleMetadataGenerator.Sample.cs

@@ -125,7 +125,6 @@ void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = fa
                 var currentAssembly = data.Right;
 
                 var isExecutingInSampleProject = currentAssembly?.EndsWith(".Samples") ?? false;
-                var isExecutingInTestProject = currentAssembly?.EndsWith(".Tests") ?? false;
 
                 // Reconstruct sample metadata from attributes
                 var sampleMetadata = toolkitSampleAttributeData
@@ -151,9 +150,7 @@ void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = fa
                     ReportDocumentDiagnostics(ctx, sampleMetadata, markdownFileData, toolkitSampleAttributeData, docFrontMatter);
                 }
 
-                // For tests we need one pass to do diagnostics and registry as we're in a contrived environment that'll have both our scenarios. Though we check if we have anything to write, as we will hit both executes.
-                if ((!isExecutingInSampleProject && !skipRegistry) ||
-                    (isExecutingInTestProject && (docFrontMatter.Any() || sampleMetadata.Any())))
+                if (!isExecutingInSampleProject && !skipRegistry)
                 {
                     CreateDocumentRegistry(ctx, docFrontMatter);
                     CreateSampleRegistry(ctx, sampleMetadata);