diff --git a/MSTest.slnf b/MSTest.slnf index 3c3f4c624a..f8858c6031 100644 --- a/MSTest.slnf +++ b/MSTest.slnf @@ -11,6 +11,7 @@ "src\\Analyzers\\MSTest.Analyzers.CodeFixes\\MSTest.Analyzers.CodeFixes.csproj", "src\\Analyzers\\MSTest.Analyzers.Package\\MSTest.Analyzers.Package.csproj", "src\\Analyzers\\MSTest.Analyzers\\MSTest.Analyzers.csproj", + "src\\Analyzers\\MSTest.AotReflection.SourceGeneration\\MSTest.AotReflection.SourceGeneration.csproj", "src\\Analyzers\\MSTest.GlobalConfigsGenerator\\MSTest.GlobalConfigsGenerator.csproj", "src\\Analyzers\\MSTest.SourceGeneration\\MSTest.SourceGeneration.csproj", "src\\Package\\MSTest.Sdk\\MSTest.Sdk.csproj", diff --git a/TestFx.slnx b/TestFx.slnx index 991e9dc8db..4f9fc147da 100644 --- a/TestFx.slnx +++ b/TestFx.slnx @@ -69,6 +69,7 @@ + @@ -133,6 +134,7 @@ + diff --git a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MSTestReflectionMetadataGenerator.cs b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MSTestReflectionMetadataGenerator.cs index b94f9bc9ca..c0baa4025b 100644 --- a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MSTestReflectionMetadataGenerator.cs +++ b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MSTestReflectionMetadataGenerator.cs @@ -45,14 +45,27 @@ node is TypeDeclarationSyntax type .Where(static model => model is not null) .Select(static (model, _) => model!); - IncrementalValueProvider<(string? AssemblyName, ImmutableArray Classes)> combined = + // Pull assembly-level attributes from the compilation (one value per run) and + // wrap them in an equatable model so this branch of the pipeline can stay cached + // when only test-class code changes. + IncrementalValueProvider assemblyMetadata = + context.CompilationProvider.Select(static (c, ct) => + { + ct.ThrowIfCancellationRequested(); + return new AssemblyMetadataModel( + TestClassModelBuilder.BuildAttributes(c.Assembly.GetAttributes())); + }); + + IncrementalValueProvider<(string? AssemblyName, AssemblyMetadataModel Metadata, ImmutableArray Classes)> combined = context.CompilationProvider.Select(static (c, _) => c.AssemblyName) - .Combine(testClasses.Collect()); + .Combine(assemblyMetadata) + .Combine(testClasses.Collect()) + .Select(static (tuple, _) => (tuple.Left.Left, tuple.Left.Right, tuple.Right)); context.RegisterImplementationSourceOutput(combined, static (ctx, payload) => { string assemblyName = payload.AssemblyName ?? "Unknown"; - string source = MetadataRegistryEmitter.EmitRegistry(assemblyName, payload.Classes); + string source = MetadataRegistryEmitter.EmitRegistry(assemblyName, payload.Metadata, payload.Classes); ctx.AddSource("MSTestReflectionMetadata.Registry.g.cs", SourceText.From(source, Encoding.UTF8)); }); } diff --git a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MetadataRegistryEmitter.cs b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MetadataRegistryEmitter.cs index 7582344e7d..efead40f59 100644 --- a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MetadataRegistryEmitter.cs +++ b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/MetadataRegistryEmitter.cs @@ -32,6 +32,7 @@ public static string EmitSupportTypes() sb.AppendLine("using System;"); sb.AppendLine("using System.Collections.Generic;"); + sb.AppendLine("using System.Threading.Tasks;"); sb.AppendLine(); using (sb.Block($"namespace {GeneratedNamespace}")) @@ -57,8 +58,10 @@ public static string EmitSupportTypes() sb.AppendLine("public Type[] ParameterTypes { get; init; } = Array.Empty();"); sb.AppendLine("public string[] ParameterNames { get; init; } = Array.Empty();"); sb.AppendLine("public Attribute[] Attributes { get; init; } = Array.Empty();"); - sb.AppendLine("/// Direct invoker — replaces ."); - sb.AppendLine("public Func Invoke { get; init; } = static (_, _) => null;"); + sb.AppendLine("/// Materialized argument tuples from [DataRow] attributes (empty for non-data-driven tests). Each object?[] corresponds to one [DataRow] application."); + sb.AppendLine("public IReadOnlyList DataRows { get; init; } = Array.Empty();"); + sb.AppendLine("/// Direct invoker — replaces . Always returns a non-null so the caller can await regardless of whether the underlying test method is void, Task, Task<T>, ValueTask, or ValueTask<T>; the result value (if any) is discarded."); + sb.AppendLine("public Func Invoke { get; init; } = static (_, _) => Task.CompletedTask;"); } sb.AppendLine(); @@ -83,13 +86,14 @@ public static string EmitSupportTypes() return sb.ToString(); } - public static string EmitRegistry(string assemblyName, IReadOnlyList testClasses) + public static string EmitRegistry(string assemblyName, AssemblyMetadataModel assemblyMetadata, IReadOnlyList testClasses) { var sb = new IndentedStringBuilder(); AppendHeader(sb); sb.AppendLine("using System;"); sb.AppendLine("using System.Collections.Generic;"); + sb.AppendLine("using System.Threading.Tasks;"); sb.AppendLine(); using (sb.Block($"namespace {GeneratedNamespace}")) @@ -99,6 +103,12 @@ public static string EmitRegistry(string assemblyName, IReadOnlyList TestClasses { get; } = new TestClassReflectionInfo[]"); using (sb.Block(null)) { @@ -119,6 +129,35 @@ public static string EmitRegistry(string assemblyName, IReadOnlyList attributes) + { + if (attributes.Length == 0) + { + sb.AppendLine("public static IReadOnlyList AssemblyAttributes { get; } = Array.Empty();"); + return; + } + + sb.AppendLine("public static IReadOnlyList AssemblyAttributes { get; } = new Attribute[]"); + using (sb.Block(null)) + { + for (int i = 0; i < attributes.Length; i++) + { + AttributeApplicationModel attr = attributes[i]; + sb.Append(BuildAttributeExpression(attr)); + if (i < attributes.Length - 1) + { + sb.AppendLine(","); + } + else + { + sb.AppendLine(); + } + } + } + + sb.AppendLine(";"); + } + private static void EmitTestClass(IndentedStringBuilder sb, TestClassModel model) { string fqn = model.FullyQualifiedTypeName; @@ -190,6 +229,8 @@ private static void EmitMethods(IndentedStringBuilder sb, string fqn, TestClassM sb.AppendLine(","); EmitAttributesProperty(sb, "Attributes", method.Attributes); sb.AppendLine(","); + EmitDataRows(sb, method.DataRows); + sb.AppendLine(","); EmitMethodInvoker(sb, fqn, method); } @@ -238,13 +279,76 @@ private static void EmitMethodInvoker(IndentedStringBuilder sb, string classFqn, string args = BuildArgumentsFromObjectArray(method.Parameters); string call = $"{target}.{method.Name}({args})"; - string body = method.ReturnsVoid - ? $"{{ {call}; return null; }}" - : $"{{ return {call}; }}"; + // The contract is: return a non-null Task representing the (async or sync) completion of the + // test method, discarding any result value. This lets the caller use a single `await invoker(...)` + // path regardless of the underlying return shape. + // - void / non-Task sync: invoke, return Task.CompletedTask. + // - Task / Task: forward the returned Task (treat a `null` return as success). + // - ValueTask / ValueTask: avoid Task allocation for the synchronously-completed fast path + // via IsCompletedSuccessfully, otherwise call AsTask(). + string body; + if (method.ReturnsTask) + { + // Task derives from Task, so the same forwarding code handles both. A test method that + // *declares* a Task return type and then returns `null` is broken at runtime, but mirroring + // reflection-Invoke we tolerate it and treat it as already-completed. + body = $"{{ Task? __t = {call}; return __t ?? Task.CompletedTask; }}"; + } + else if (method.ReturnsValueTask) + { + body = $"{{ var __vt = {call}; return __vt.IsCompletedSuccessfully ? Task.CompletedTask : __vt.AsTask(); }}"; + } + else if (method.ReturnsVoid) + { + body = $"{{ {call}; return Task.CompletedTask; }}"; + } + else + { + // Non-void, non-Task return (e.g. `int Test()`). The test runner discards the value; we still + // execute the call for its side effects and report success. + body = $"{{ _ = {call}; return Task.CompletedTask; }}"; + } sb.AppendLine($"Invoke = static (instance, args) => {body},"); } + private static void EmitDataRows(IndentedStringBuilder sb, EquatableArray dataRows) + { + if (dataRows.Length == 0) + { + sb.Append("DataRows = Array.Empty()"); + sb.AppendLine(); + return; + } + + sb.AppendLine("DataRows = new object?[][]"); + using (sb.Block(null)) + { + for (int i = 0; i < dataRows.Length; i++) + { + EquatableArray args = dataRows[i].Arguments; + if (args.Length == 0) + { + sb.Append("Array.Empty()"); + } + else + { + string literals = string.Join(", ", args.AsImmutableArray().Select(BuildConstantExpression)); + sb.Append($"new object?[] {{ {literals} }}"); + } + + if (i < dataRows.Length - 1) + { + sb.AppendLine(","); + } + else + { + sb.AppendLine(); + } + } + } + } + private static void EmitParameterTypes(IndentedStringBuilder sb, EquatableArray parameters) { if (parameters.Length == 0) diff --git a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/TestClassModelBuilder.cs b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/TestClassModelBuilder.cs index 9188cf64c0..c5029b4100 100644 --- a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/TestClassModelBuilder.cs +++ b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Generators/TestClassModelBuilder.cs @@ -1,12 +1,15 @@ // Copyright (c) Microsoft Corporation. All rights reserved. // Licensed under the MIT license. See LICENSE file in the project root for full license information. +using System; using System.Collections.Generic; using System.Collections.Immutable; using System.Linq; +using System.Text; using Microsoft.CodeAnalysis; +using MSTest.AotReflection.SourceGeneration.Helpers; using MSTest.AotReflection.SourceGeneration.Model; namespace MSTest.AotReflection.SourceGeneration.Generators; @@ -19,31 +22,61 @@ internal static class TestClassModelBuilder { private static readonly SymbolDisplayFormat FullyQualifiedFormat = SymbolDisplayFormat.FullyQualifiedFormat.WithMiscellaneousOptions( - SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier - | SymbolDisplayMiscellaneousOptions.UseSpecialTypes); + SymbolDisplayMiscellaneousOptions.UseSpecialTypes); public static TestClassModel Build(INamedTypeSymbol typeSymbol) { + // Methods / properties are walked across the full inheritance chain (excluding + // System.Object) so that MSTest members declared on a base class — + // [ClassInitialize], [ClassCleanup], [TestInitialize], [TestCleanup], + // [TestMethod], the [TestContext] setter, … — are visible to the consumer + // without runtime reflection. + // + // Iteration order is derived-first so that an override or `new`-shadowed member + // on the derived type wins over the base declaration with the same signature. + // Constructors are NEVER inherited and are taken only from the leaf type. + var methodsByKey = new Dictionary(StringComparer.Ordinal); + var propertiesByName = new Dictionary(StringComparer.Ordinal); ImmutableArray.Builder methods = ImmutableArray.CreateBuilder(); ImmutableArray.Builder properties = ImmutableArray.CreateBuilder(); ImmutableArray.Builder ctors = ImmutableArray.CreateBuilder(); - foreach (ISymbol member in typeSymbol.GetMembers()) + for (INamedTypeSymbol? current = typeSymbol; + current is not null && current.SpecialType != SpecialType.System_Object; + current = current.BaseType) { - switch (member) + bool isLeaf = SymbolEqualityComparer.Default.Equals(current, typeSymbol); + + foreach (ISymbol member in current.GetMembers()) { - case IMethodSymbol { MethodKind: MethodKind.Ordinary } method - when method.DeclaredAccessibility is Accessibility.Public or Accessibility.Internal: - methods.Add(BuildMethod(method)); - break; - case IPropertySymbol property - when property.DeclaredAccessibility is Accessibility.Public or Accessibility.Internal: - properties.Add(BuildProperty(property)); - break; - case IMethodSymbol { MethodKind: MethodKind.Constructor, IsStatic: false } ctor - when ctor.DeclaredAccessibility is Accessibility.Public or Accessibility.Internal: - ctors.Add(new TestConstructorModel(BuildParameters(ctor))); - break; + switch (member) + { + case IMethodSymbol { MethodKind: MethodKind.Ordinary } method + when IsAccessibleFromConsumer(method): + string key = BuildMethodSignatureKey(method); + if (!methodsByKey.ContainsKey(key)) + { + TestMethodModel model = BuildMethod(method); + methodsByKey[key] = model; + methods.Add(model); + } + + break; + case IPropertySymbol property + when IsAccessibleFromConsumer(property): + if (!propertiesByName.ContainsKey(property.Name)) + { + TestPropertyModel model = BuildProperty(property); + propertiesByName[property.Name] = model; + properties.Add(model); + } + + break; + case IMethodSymbol { MethodKind: MethodKind.Constructor, IsStatic: false } ctor + when isLeaf && ctor.DeclaredAccessibility is Accessibility.Public or Accessibility.Internal: + ctors.Add(new TestConstructorModel(BuildParameters(ctor))); + break; + } } } @@ -61,6 +94,49 @@ public static TestClassModel Build(INamedTypeSymbol typeSymbol) Attributes: BuildAttributes(typeSymbol.GetAttributes())); } + private static bool IsAccessibleFromConsumer(ISymbol symbol) + => symbol.DeclaredAccessibility is + Accessibility.Public + or Accessibility.Internal + or Accessibility.Protected + or Accessibility.ProtectedOrInternal + or Accessibility.ProtectedAndInternal; + + private static string BuildMethodSignatureKey(IMethodSymbol method) + { + var sb = new StringBuilder(); + sb.Append(method.IsStatic ? "S:" : "I:"); + sb.Append(method.Name); + sb.Append('('); + bool first = true; + foreach (IParameterSymbol p in method.Parameters) + { + if (!first) + { + sb.Append(','); + } + + first = false; + switch (p.RefKind) + { + case RefKind.Ref: + sb.Append("ref "); + break; + case RefKind.Out: + sb.Append("out "); + break; + case RefKind.In: + sb.Append("in "); + break; + } + + sb.Append(p.Type.ToDisplayString(FullyQualifiedFormat)); + } + + sb.Append(')'); + return sb.ToString(); + } + private static TestMethodModel BuildMethod(IMethodSymbol method) { ITypeSymbol returnType = method.ReturnType; @@ -74,6 +150,8 @@ private static TestMethodModel BuildMethod(IMethodSymbol method) || returnTypeFqn.StartsWith("global::System.Threading.Tasks.ValueTask<", System.StringComparison.Ordinal); bool returnsVoid = returnType.SpecialType == SpecialType.System_Void; + ImmutableArray inheritedAttributes = CollectInheritedAttributes(method); + return new TestMethodModel( Name: method.Name, IsStatic: method.IsStatic, @@ -82,7 +160,63 @@ private static TestMethodModel BuildMethod(IMethodSymbol method) ReturnsValueTask: returnsValueTask, ReturnsVoid: returnsVoid, Parameters: BuildParameters(method), - Attributes: BuildAttributes(method.GetAttributes())); + Attributes: BuildAttributes(inheritedAttributes), + DataRows: BuildDataRows(inheritedAttributes)); + } + + // Walks the attribute list and reifies each [DataRow(...)] application into a flat + // object?[] row. Mirrors DataRowAttribute's runtime behavior: when the constructor uses + // the variadic overload (object? data1, params object?[] moreData), Roslyn surfaces the + // tail as a single Array TypedConstant, which we flatten back so the consumer sees the + // same shape as DataRowAttribute.Data. + private static EquatableArray BuildDataRows(ImmutableArray attributes) + { + if (attributes.IsDefaultOrEmpty) + { + return EquatableArray.Empty; + } + + ImmutableArray.Builder builder = ImmutableArray.CreateBuilder(); + foreach (AttributeData attribute in attributes) + { + if (attribute.AttributeClass is not { } attributeClass) + { + continue; + } + + if (attributeClass.ToDisplayString(FullyQualifiedFormat) != "global::" + MSTestAttributeNames.DataRow) + { + continue; + } + + ImmutableArray ctorArgs = attribute.ConstructorArguments; + ImmutableArray.Builder rowBuilder = ImmutableArray.CreateBuilder(); + + bool lastIsParamsArray = + attribute.AttributeConstructor is { Parameters: { IsDefaultOrEmpty: false } parameters } + && parameters[parameters.Length - 1].IsParams + && !ctorArgs.IsDefaultOrEmpty + && ctorArgs[ctorArgs.Length - 1].Kind == TypedConstantKind.Array; + + for (int i = 0; i < ctorArgs.Length; i++) + { + if (i == ctorArgs.Length - 1 && lastIsParamsArray) + { + foreach (TypedConstant element in ctorArgs[i].Values) + { + rowBuilder.Add(ToModel(element)); + } + } + else + { + rowBuilder.Add(ToModel(ctorArgs[i])); + } + } + + builder.Add(new DataRowModel(new EquatableArray(rowBuilder.ToImmutable()))); + } + + return new EquatableArray(builder.ToImmutable()); } private static TestPropertyModel BuildProperty(IPropertySymbol property) @@ -90,7 +224,68 @@ private static TestPropertyModel BuildProperty(IPropertySymbol property) Name: property.Name, FullyQualifiedType: property.Type.ToDisplayString(FullyQualifiedFormat), HasPublicSetter: property.SetMethod is { DeclaredAccessibility: Accessibility.Public }, - Attributes: BuildAttributes(property.GetAttributes())); + Attributes: BuildAttributes(CollectInheritedAttributes(property))); + + // Mirror the runtime behavior of MemberInfo.GetCustomAttributes(inherit: true): walk the + // overridden-method chain and union attributes, keeping the most-derived application when + // the same attribute type appears on multiple levels. + private static ImmutableArray CollectInheritedAttributes(IMethodSymbol method) + { + ImmutableArray own = method.GetAttributes(); + if (method.OverriddenMethod is null) + { + return own; + } + + var seen = new HashSet(StringComparer.Ordinal); + ImmutableArray.Builder builder = ImmutableArray.CreateBuilder(); + AppendUnique(builder, seen, own); + for (IMethodSymbol? baseMethod = method.OverriddenMethod; baseMethod is not null; baseMethod = baseMethod.OverriddenMethod) + { + AppendUnique(builder, seen, baseMethod.GetAttributes()); + } + + return builder.ToImmutable(); + } + + private static ImmutableArray CollectInheritedAttributes(IPropertySymbol property) + { + ImmutableArray own = property.GetAttributes(); + if (property.OverriddenProperty is null) + { + return own; + } + + var seen = new HashSet(StringComparer.Ordinal); + ImmutableArray.Builder builder = ImmutableArray.CreateBuilder(); + AppendUnique(builder, seen, own); + for (IPropertySymbol? baseProperty = property.OverriddenProperty; baseProperty is not null; baseProperty = baseProperty.OverriddenProperty) + { + AppendUnique(builder, seen, baseProperty.GetAttributes()); + } + + return builder.ToImmutable(); + } + + private static void AppendUnique( + ImmutableArray.Builder builder, + HashSet seen, + ImmutableArray attributes) + { + foreach (AttributeData attribute in attributes) + { + if (attribute.AttributeClass is not { } attributeClass) + { + continue; + } + + string key = attributeClass.ToDisplayString(FullyQualifiedFormat); + if (seen.Add(key)) + { + builder.Add(attribute); + } + } + } private static EquatableArray BuildParameters(IMethodSymbol method) { diff --git a/src/Analyzers/MSTest.AotReflection.SourceGeneration/MSTest.AotReflection.SourceGeneration.csproj b/src/Analyzers/MSTest.AotReflection.SourceGeneration/MSTest.AotReflection.SourceGeneration.csproj index 1369428997..dc9bbade05 100644 --- a/src/Analyzers/MSTest.AotReflection.SourceGeneration/MSTest.AotReflection.SourceGeneration.csproj +++ b/src/Analyzers/MSTest.AotReflection.SourceGeneration/MSTest.AotReflection.SourceGeneration.csproj @@ -29,4 +29,8 @@ + + + + diff --git a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Model/TestClassModel.cs b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Model/TestClassModel.cs index cc7586fdef..0be713a783 100644 --- a/src/Analyzers/MSTest.AotReflection.SourceGeneration/Model/TestClassModel.cs +++ b/src/Analyzers/MSTest.AotReflection.SourceGeneration/Model/TestClassModel.cs @@ -41,6 +41,12 @@ internal enum ConstantValueKind internal sealed record TestParameterModel(string FullyQualifiedType, string Name); +/// +/// One row of arguments from a [DataRow] attribute, materialized at compile time so +/// the consumer can iterate without re-reading DataRowAttribute.Data via reflection. +/// +internal sealed record DataRowModel(EquatableArray Arguments); + internal sealed record TestMethodModel( string Name, bool IsStatic, @@ -49,7 +55,8 @@ internal sealed record TestMethodModel( bool ReturnsValueTask, bool ReturnsVoid, EquatableArray Parameters, - EquatableArray Attributes); + EquatableArray Attributes, + EquatableArray DataRows); internal sealed record TestPropertyModel( string Name, @@ -60,6 +67,14 @@ internal sealed record TestPropertyModel( internal sealed record TestConstructorModel( EquatableArray Parameters); +/// +/// Assembly-scoped metadata captured at compile time so the consumer never has to call +/// for +/// attributes declared with [assembly: ...] in the same compilation. +/// +internal sealed record AssemblyMetadataModel( + EquatableArray Attributes); + internal sealed record TestClassModel( string FullyQualifiedTypeName, string ContainingNamespace, diff --git a/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests.csproj b/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests.csproj new file mode 100644 index 0000000000..b91def2e3a --- /dev/null +++ b/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests.csproj @@ -0,0 +1,24 @@ + + + + net8.0 + MSTest.AotReflection.SourceGeneration.UnitTests + true + true + Exe + + + + + + + + + + + + + + + diff --git a/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/MSTestReflectionMetadataGeneratorTests.cs b/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/MSTestReflectionMetadataGeneratorTests.cs new file mode 100644 index 0000000000..ff8fe422c1 --- /dev/null +++ b/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/MSTestReflectionMetadataGeneratorTests.cs @@ -0,0 +1,1262 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using AwesomeAssertions; + +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; + +using MSTest.AotReflection.SourceGeneration.Generators; + +namespace MSTest.AotReflection.SourceGeneration.UnitTests; + +/// +/// Behavior tests for . +/// These pin the current PoC output so the upcoming follow-up PRs (#1837) can extend it safely. +/// +[TestClass] +public sealed class MSTestReflectionMetadataGeneratorTests +{ + /// + /// Minimal MSTest attribute stubs so the generator can locate [TestClass] / + /// [TestMethod] in test fixtures without dragging the real TestFramework + /// assemblies into the Roslyn compilation. + /// + private const string MinimalMSTestStub = """ + namespace Microsoft.VisualStudio.TestTools.UnitTesting + { + [System.AttributeUsage(System.AttributeTargets.Class)] + public class TestClassAttribute : System.Attribute { } + + [System.AttributeUsage(System.AttributeTargets.Method)] + public class TestMethodAttribute : System.Attribute + { + public TestMethodAttribute() { } + public TestMethodAttribute(string displayName) { DisplayName = displayName; } + public string? DisplayName { get; set; } + } + + [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple = true)] + public class TestCategoryAttribute : System.Attribute + { + public TestCategoryAttribute(string category) { Category = category; } + public string Category { get; } + } + + [System.AttributeUsage(System.AttributeTargets.Property)] + public class TestContextAttribute : System.Attribute { } + + [System.AttributeUsage(System.AttributeTargets.Method)] + public class TestInitializeAttribute : System.Attribute { } + + [System.AttributeUsage(System.AttributeTargets.Method)] + public class TestCleanupAttribute : System.Attribute { } + + [System.AttributeUsage(System.AttributeTargets.Assembly, AllowMultiple = true)] + public class ParallelizeAttribute : System.Attribute + { + public int Workers { get; set; } + public string? Scope { get; set; } + } + + [System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple = true)] + public class DataRowAttribute : System.Attribute + { + public DataRowAttribute(object? data1) { } + public DataRowAttribute(object? data1, params object?[] moreData) { } + } + } + """; + + [TestMethod] + public void Generator_EmitsSupportTypes_OnAnyCompilation() + { + const string userCode = """ + // Intentionally empty — no [TestClass] in the consumer. + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + // Support types are emitted via RegisterPostInitializationOutput → always present. + string support = result.GeneratedSources + .Single(s => s.HintName == "MSTestReflectionMetadata.SupportTypes.g.cs") + .SourceText.ToString(); + + support.Should().Contain("namespace MSTest.SourceGenerated"); + support.Should().Contain("internal sealed class TestClassReflectionInfo"); + support.Should().Contain("internal sealed class TestMethodReflectionInfo"); + support.Should().Contain("internal sealed class TestPropertyReflectionInfo"); + support.Should().Contain("internal sealed class TestConstructorReflectionInfo"); + } + + [TestMethod] + public void Generator_EmitsRegistry_WithDiscoveredTestClass() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class MyTests + { + [TestMethod] + public void Test1() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + + registry.Should().Contain("internal static class MSTestReflectionMetadata"); + registry.Should().Contain("public const string AssemblyName = \"TestSample\";"); + registry.Should().Contain("Type = typeof(global::Sample.MyTests)"); + registry.Should().Contain("Name = \"Test1\""); + registry.Should().Contain("Invoke = static (instance, args) => { ((global::Sample.MyTests)instance!).Test1(); return Task.CompletedTask; },"); + } + + [TestMethod] + public void Generator_EmitsEmptyRegistry_WhenNoTestClasses() + { + const string userCode = """ + namespace Sample + { + // No [TestClass] anywhere. + public class NotATest { public void Foo() { } } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("public static IReadOnlyList TestClasses { get; } = new TestClassReflectionInfo[]"); + // No concrete TestClassReflectionInfo instance is emitted (note the open paren). + registry.Should().NotContain("new TestClassReflectionInfo("); + } + + [TestMethod] + public void Generator_SkipsStaticTestClass() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public static class StaticTests + { + [TestMethod] + public static void Test1() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + // Static classes are excluded by the predicate in the generator (cannot be instantiated). + registry.Should().NotContain("StaticTests"); + } + + [TestMethod] + public void Generator_SkipsAbstractTestClass() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public abstract class AbstractTests + { + [TestMethod] + public void Test1() { } + } + + [TestClass] + public class ConcreteTests + { + [TestMethod] + public void Test2() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + // Abstract classes are filtered in BuildModel — they cannot be instantiated. + registry.Should().NotContain("AbstractTests"); + registry.Should().Contain("typeof(global::Sample.ConcreteTests)"); + } + + [TestMethod] + public void Generator_SkipsGenericTestClass() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class GenericTests + { + [TestMethod] + public void Test1() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + // Open-generic test classes are out of scope for this PoC. + registry.Should().NotContain("GenericTests"); + } + + [TestMethod] + public void Generator_EmitsConstructorInvoker() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class CtorTests + { + public CtorTests() { } + + [TestMethod] + public void Test1() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("Constructors = new TestConstructorReflectionInfo[]"); + registry.Should().Contain("Invoke = static args => new global::Sample.CtorTests(),"); + } + + [TestMethod] + public void Generator_EmitsParameterTypes_ForMethodWithParameters() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class ParamTests + { + [TestMethod] + public void Test1(int x, string y) { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("ParameterTypes = new Type[] { typeof(int), typeof(string) }"); + registry.Should().Contain("ParameterNames = new string[] { \"x\", \"y\" }"); + } + + [TestMethod] + public void Generator_FlagsAsyncReturnTypes() + { + const string userCode = """ + using System.Threading.Tasks; + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class AsyncTests + { + [TestMethod] + public Task Test1() => Task.CompletedTask; + + [TestMethod] + public ValueTask Test2() => default; + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("Name = \"Test1\""); + registry.Should().Contain("ReturnsTask = true"); + registry.Should().Contain("Name = \"Test2\""); + registry.Should().Contain("ReturnsValueTask = true"); + } + + [TestMethod] + public void Generator_CapturesClassLevelAttributes() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + [TestCategory("Smoke")] + public class TaggedTests + { + [TestMethod] + public void Test1() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("global::Microsoft.VisualStudio.TestTools.UnitTesting.TestClassAttribute"); + registry.Should().Contain("global::Microsoft.VisualStudio.TestTools.UnitTesting.TestCategoryAttribute"); + registry.Should().Contain("\"Smoke\""); + } + + [TestMethod] + public void Generator_EmitsPropertyGetterAndSetter() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class TestContext { } + + [TestClass] + public class PropTests + { + [TestContext] + public TestContext? Context { get; set; } + + [TestMethod] + public void Test1() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("Name = \"Context\""); + registry.Should().Contain("HasPublicSetter = true"); + registry.Should().Contain("Get = static instance => instance is null ? null : (object?)((global::Sample.PropTests)instance).Context,"); + registry.Should().Contain("Set = static (instance, value) => ((global::Sample.PropTests)instance!).Context = (global::Sample.TestContext)value!,"); + } + + [TestMethod] + public void Generator_EmittedSource_CompilesCleanly() + { + const string userCode = """ + using System.Threading.Tasks; + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class TestContext { } + + [TestClass] + [TestCategory("Smoke")] + public class FullShape + { + [TestContext] + public TestContext? Context { get; set; } + + public FullShape() { } + + [TestMethod("alias")] + public void Sync(int x) { } + + [TestMethod] + public Task Asynchronous() => Task.CompletedTask; + } + } + """; + + Compilation outputCompilation = RunGeneratorAndGetCompilation(MinimalMSTestStub, userCode); + + IEnumerable diagnostics = outputCompilation + .GetDiagnostics() + .Where(d => d.Severity == DiagnosticSeverity.Error); + + diagnostics.Should().BeEmpty( + "the generated source MUST compile cleanly when consumed in the same compilation as the user code"); + } + + [TestMethod] + public void Generator_StripsNullableAnnotation_FromTypeofExpressions() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class TestContext { } + + [TestClass] + public class NullableShapes + { + [TestContext] + public TestContext? Context { get; set; } + + [TestMethod] + public void TakesNullableRef(string? value) { } + + [TestMethod] + public void TakesNullableValueType(int? n) { } + } + } + """; + + Compilation outputCompilation = RunGeneratorAndGetCompilation(MinimalMSTestStub, userCode); + string registry = outputCompilation + .SyntaxTrees + .Single(t => t.FilePath.EndsWith("MSTestReflectionMetadata.Registry.g.cs", System.StringComparison.Ordinal)) + .ToString(); + + // typeof(...) MUST NOT carry nullable reference type annotation (CS8639). + registry.Should().NotContain("typeof(global::Sample.TestContext?)"); + registry.Should().NotContain("typeof(string?)"); + // Reference types in typeof drop the annotation entirely. + registry.Should().Contain("typeof(global::Sample.TestContext)"); + registry.Should().Contain("typeof(string)"); + // Nullable value types are still distinct from their underlying type and must be preserved as Nullable. + registry.Should().Contain("typeof(int?)"); + + // The whole compilation must be free of CS errors. + IEnumerable errors = outputCompilation + .GetDiagnostics() + .Where(d => d.Severity == DiagnosticSeverity.Error); + errors.Should().BeEmpty("typeof(T?) on a reference type is invalid C# (CS8639)"); + } + + [TestMethod] + public void Generator_IsIncremental_SupportTypesAreCached_WhenInputUnchanged() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class IncTests + { + [TestMethod] + public void Test1() { } + } + } + """; + + CSharpCompilation compilation = CreateCompilation(MinimalMSTestStub, userCode); + GeneratorDriver driver = CSharpGeneratorDriver + .Create(new MSTestReflectionMetadataGenerator()) + .WithUpdatedParseOptions((CSharpParseOptions)compilation.SyntaxTrees.First().Options); + + // Track step output cache reasons. + driver = driver.RunGenerators(compilation); + driver = driver.RunGenerators(compilation); + + GeneratorDriverRunResult result = driver.GetRunResult(); + result.Diagnostics.Should().BeEmpty(); + result.Results.Should().ContainSingle(); + // Two passes against the same compilation must produce identical sources. + result.Results[0].GeneratedSources.Should().HaveCount(2); + } + + [TestMethod] + public void Generator_IncludesMethodsFromBaseType() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class BaseTests + { + [TestInitialize] + public void Setup() { } + + [TestMethod] + public void InheritedTest() { } + } + + [TestClass] + public class DerivedTests : BaseTests + { + [TestMethod] + public void DerivedTest() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + registry.Should().Contain("Name = \"InheritedTest\""); + registry.Should().Contain("Name = \"Setup\""); + registry.Should().Contain("Name = \"DerivedTest\""); + // The TestInitialize attribute applied on the base method must propagate too. + registry.Should().Contain("global::Microsoft.VisualStudio.TestTools.UnitTesting.TestInitializeAttribute"); + } + + [TestMethod] + public void Generator_IncludesMethodsFromMultiLevelInheritance() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class GrandparentTests + { + [TestMethod] + public void GrandparentTest() { } + } + + public class ParentTests : GrandparentTests + { + [TestMethod] + public void ParentTest() { } + } + + [TestClass] + public class LeafTests : ParentTests + { + [TestMethod] + public void LeafTest() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + registry.Should().Contain("Name = \"GrandparentTest\""); + registry.Should().Contain("Name = \"ParentTest\""); + registry.Should().Contain("Name = \"LeafTest\""); + } + + [TestMethod] + public void Generator_OverriddenVirtualMethod_KeepsOnlyDerivedImplementation() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class BaseTests + { + [TestMethod] + public virtual void Run() { } + } + + [TestClass] + public class DerivedTests : BaseTests + { + public override void Run() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // Only one entry for Run should be emitted, and the invoker must dispatch on the derived type. + int runEntries = registry.Split(["Name = \"Run\""], System.StringSplitOptions.None).Length - 1; + runEntries.Should().Be(1, "the derived override must replace the base entry (not duplicate it)"); + registry.Should().Contain("((global::Sample.DerivedTests)instance!).Run();"); + registry.Should().NotContain("((global::Sample.BaseTests)instance!).Run();"); + + // The override does NOT re-apply [TestMethod] but the attribute must still be visible + // via the override chain — matching the runtime semantics of GetCustomAttributes(inherit: true). + registry.Should().Contain("global::Microsoft.VisualStudio.TestTools.UnitTesting.TestMethodAttribute"); + } + + [TestMethod] + public void Generator_NewKeywordHiddenMethod_DedupsBySignature() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class BaseTests + { + [TestMethod] + public void Hidden() { } + } + + [TestClass] + public class DerivedTests : BaseTests + { + [TestMethod] + public new void Hidden() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + int hiddenEntries = registry.Split(["Name = \"Hidden\""], System.StringSplitOptions.None).Length - 1; + hiddenEntries.Should().Be(1, "members with the same name and signature must be de-duplicated; derived wins"); + registry.Should().Contain("((global::Sample.DerivedTests)instance!).Hidden();"); + } + + [TestMethod] + public void Generator_OverloadsWithDifferentSignatures_AreAllPreserved() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class BaseTests + { + [TestMethod] + public void Op(int x) { } + } + + [TestClass] + public class DerivedTests : BaseTests + { + [TestMethod] + public void Op(string x) { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // Both overloads survive — they have different signatures. + int opEntries = registry.Split(["Name = \"Op\""], System.StringSplitOptions.None).Length - 1; + opEntries.Should().Be(2); + registry.Should().Contain("typeof(int)"); + registry.Should().Contain("typeof(string)"); + } + + [TestMethod] + public void Generator_IncludesPropertiesFromBaseType() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class TestContext { } + + public class BaseTests + { + [TestContext] + public virtual TestContext Context { get; set; } = new(); + } + + [TestClass] + public class DerivedTests : BaseTests + { + [TestMethod] + public void Test() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + registry.Should().Contain("Name = \"Context\""); + registry.Should().Contain("global::Microsoft.VisualStudio.TestTools.UnitTesting.TestContextAttribute"); + } + + [TestMethod] + public void Generator_DoesNotInheritConstructors() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class BaseTests + { + public BaseTests(int x) { } + } + + [TestClass] + public class DerivedTests : BaseTests + { + public DerivedTests() : base(1) { } + + [TestMethod] + public void Test() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // Only the derived ctor (parameterless) should be emitted — base ctor is never inherited. + registry.Should().Contain("Invoke = static args => new global::Sample.DerivedTests(),"); + registry.Should().NotContain("Invoke = static args => new global::Sample.BaseTests("); + // No int parameter from the base constructor leaks into the constructor list. + registry.Should().NotContain("ParameterTypes = new Type[] { typeof(int) },"); + } + + [TestMethod] + public void Generator_AbstractBaseWithConcreteDerived_FoldsBaseMembers() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + public class TestContext { } + + public abstract class AbstractBase + { + [TestInitialize] + public void Setup() { } + + [TestContext] + public TestContext Ctx { get; set; } = new(); + } + + [TestClass] + public class Concrete : AbstractBase + { + [TestMethod] + public void Test() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + registry.Should().Contain("Name = \"Setup\""); + registry.Should().Contain("Name = \"Ctx\""); + registry.Should().Contain("Name = \"Test\""); + // The base class was abstract but the concrete derived type is the one emitted. + registry.Should().Contain("Type = typeof(global::Sample.Concrete)"); + } + + [TestMethod] + public void Generator_DoesNotWalkPastSystemObject() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class SimpleTests + { + [TestMethod] + public void Test() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // Members of System.Object (ToString, Equals, GetHashCode, GetType) must NOT be emitted. + registry.Should().NotContain("Name = \"ToString\""); + registry.Should().NotContain("Name = \"Equals\""); + registry.Should().NotContain("Name = \"GetHashCode\""); + registry.Should().NotContain("Name = \"GetType\""); + } + + [TestMethod] + public void Generator_CapturesAssemblyLevelAttribute() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + [assembly: Parallelize(Workers = 4, Scope = "Method")] + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public void Test() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("public static IReadOnlyList AssemblyAttributes { get; } = new Attribute[]"); + registry.Should().Contain("new global::Microsoft.VisualStudio.TestTools.UnitTesting.ParallelizeAttribute()"); + registry.Should().Contain("Workers = 4"); + registry.Should().Contain("Scope = \"Method\""); + } + + [TestMethod] + public void Generator_AssemblyAttributes_IsEmptyArray_WhenNoneApplied() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public void Test() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("public static IReadOnlyList AssemblyAttributes { get; } = Array.Empty();"); + registry.Should().NotContain("public static IReadOnlyList AssemblyAttributes { get; } = new Attribute[]"); + } + + [TestMethod] + public void Generator_CapturesMultipleAssemblyAttributes_InDeclarationOrder() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + [assembly: Parallelize(Workers = 1)] + [assembly: Parallelize(Workers = 2)] + [assembly: Parallelize(Workers = 3)] + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public void Test() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + + int idx1 = registry.IndexOf("Workers = 1", StringComparison.Ordinal); + int idx2 = registry.IndexOf("Workers = 2", StringComparison.Ordinal); + int idx3 = registry.IndexOf("Workers = 3", StringComparison.Ordinal); + + idx1.Should().BeGreaterThan(-1); + idx2.Should().BeGreaterThan(idx1); + idx3.Should().BeGreaterThan(idx2); + } + + [TestMethod] + public void Generator_AssemblyAttributes_AreEmittedEvenWithNoTestClasses() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + [assembly: Parallelize(Workers = 8)] + + namespace Sample + { + public class NotATest { } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("new global::Microsoft.VisualStudio.TestTools.UnitTesting.ParallelizeAttribute()"); + registry.Should().Contain("Workers = 8"); + registry.Should().NotContain("new TestClassReflectionInfo("); + } + + [TestMethod] + public void Generator_EmitsEmptyDataRows_WhenMethodHasNoDataRow() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public void NoData() { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("DataRows = Array.Empty()"); + registry.Should().NotContain("DataRows = new object?[][]"); + } + + [TestMethod] + public void Generator_CapturesSingleDataRow_WithScalarArgs() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + [DataRow(1, "x")] + public void Test(int a, string b) { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("DataRows = new object?[][]"); + registry.Should().Contain("new object?[] { 1, \"x\" }"); + } + + [TestMethod] + public void Generator_CapturesMultipleDataRows_InDeclarationOrder() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + [DataRow(1, "a")] + [DataRow(2, "b")] + [DataRow(3, "c")] + public void Test(int a, string b) { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("DataRows = new object?[][]"); + + int idx1 = registry.IndexOf("new object?[] { 1, \"a\" }", StringComparison.Ordinal); + int idx2 = registry.IndexOf("new object?[] { 2, \"b\" }", StringComparison.Ordinal); + int idx3 = registry.IndexOf("new object?[] { 3, \"c\" }", StringComparison.Ordinal); + + idx1.Should().BeGreaterThan(-1); + idx2.Should().BeGreaterThan(idx1); + idx3.Should().BeGreaterThan(idx2); + } + + [TestMethod] + public void Generator_FlattensParamsArrayInDataRow() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + [DataRow(1, 2, 3, 4)] + public void Test(int a, int b, int c, int d) { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + // The variadic `params object?[] moreData` tail must be flattened into a single flat row + // within the DataRows block — the row contains all four values inline, not nested. + registry.Should().Contain("new object?[] { 1, 2, 3, 4 }"); + } + + [TestMethod] + public void Generator_HandlesNullValueInDataRow() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + [DataRow(null)] + public void Test(string? value) { } + } + } + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string registry = GetRegistry(result); + registry.Should().Contain("DataRows = new object?[][]"); + // The single-arg DataRowAttribute(object? data1) overload binds null to object, + // which surfaces as `(object)null!` from BuildConstantExpression (C# keyword form + // produced by FullyQualifiedFormat for System.Object). + registry.Should().Contain("new object?[] { (object)null! }"); + } + + [TestMethod] + public void Generator_SupportType_DeclaresInvokeAsTaskReturning() + { + const string userCode = """ + // Empty consumer — we only care about the post-init support types. + """; + + GeneratorRunResult result = RunGenerator(MinimalMSTestStub, userCode); + + result.Diagnostics.Should().BeEmpty(); + string support = result.GeneratedSources + .Single(s => s.HintName == "MSTestReflectionMetadata.SupportTypes.g.cs") + .SourceText.ToString(); + + support.Should().Contain("using System.Threading.Tasks;"); + // Invoke must be Task-returning so consumers can await without type-testing the result. + support.Should().Contain("public Func Invoke { get; init; } = static (_, _) => Task.CompletedTask;"); + } + + [TestMethod] + public void Generator_InvokerForVoidMethod_ReturnsCompletedTask() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public void SyncVoid() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + registry.Should().Contain("Invoke = static (instance, args) => { ((global::Sample.Tests)instance!).SyncVoid(); return Task.CompletedTask; },"); + } + + [TestMethod] + public void Generator_InvokerForTaskMethod_ForwardsTask() + { + const string userCode = """ + using System.Threading.Tasks; + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public Task AsyncTask() => Task.CompletedTask; + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // Task and Task both forward via the same `Task? __t = …` path; null is tolerated so + // the invoker contract (non-null Task) holds even for a misbehaving test method. + registry.Should().Contain("Invoke = static (instance, args) => { Task? __t = ((global::Sample.Tests)instance!).AsyncTask(); return __t ?? Task.CompletedTask; },"); + } + + [TestMethod] + public void Generator_InvokerForTaskOfTMethod_ForwardsTask() + { + const string userCode = """ + using System.Threading.Tasks; + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public Task AsyncTaskOfInt() => Task.FromResult(42); + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + registry.Should().Contain("Invoke = static (instance, args) => { Task? __t = ((global::Sample.Tests)instance!).AsyncTaskOfInt(); return __t ?? Task.CompletedTask; },"); + } + + [TestMethod] + public void Generator_InvokerForValueTaskMethod_UnwrapsViaAsTask() + { + const string userCode = """ + using System.Threading.Tasks; + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public ValueTask AsyncValueTask() => default; + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // ValueTask unwrap uses IsCompletedSuccessfully so the synchronous-completion fast path + // skips the Task allocation; only when the operation actually went async do we pay AsTask(). + registry.Should().Contain("Invoke = static (instance, args) => { var __vt = ((global::Sample.Tests)instance!).AsyncValueTask(); return __vt.IsCompletedSuccessfully ? Task.CompletedTask : __vt.AsTask(); },"); + } + + [TestMethod] + public void Generator_InvokerForValueTaskOfTMethod_UnwrapsViaAsTask() + { + const string userCode = """ + using System.Threading.Tasks; + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public ValueTask AsyncValueTaskOfString() => new ValueTask("ok"); + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + registry.Should().Contain("Invoke = static (instance, args) => { var __vt = ((global::Sample.Tests)instance!).AsyncValueTaskOfString(); return __vt.IsCompletedSuccessfully ? Task.CompletedTask : __vt.AsTask(); },"); + } + + [TestMethod] + public void Generator_InvokerForNonVoidSyncMethod_DiscardsResultAndReturnsCompletedTask() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public int SyncInt() => 42; + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // For a sync non-void test the returned value is discarded but the call must still execute + // (its side-effects ARE the test). We surface that with a `_ = call;` pattern. + registry.Should().Contain("Invoke = static (instance, args) => { _ = ((global::Sample.Tests)instance!).SyncInt(); return Task.CompletedTask; },"); + } + + [TestMethod] + public void Generator_EmittedRegistry_ImportsSystemThreadingTasks() + { + const string userCode = """ + using Microsoft.VisualStudio.TestTools.UnitTesting; + + namespace Sample + { + [TestClass] + public class Tests + { + [TestMethod] + public void Test() { } + } + } + """; + + string registry = GetRegistry(RunGenerator(MinimalMSTestStub, userCode)); + + // The registry file references Task.CompletedTask directly in every invoker, so it must + // bring System.Threading.Tasks into scope. + registry.Should().Contain("using System.Threading.Tasks;"); + } + + private static string GetRegistry(GeneratorRunResult result) + => result.GeneratedSources + .Single(s => s.HintName == "MSTestReflectionMetadata.Registry.g.cs") + .SourceText.ToString() + .Replace("\r\n", "\n"); + + private static GeneratorRunResult RunGenerator(params string[] sources) + { + CSharpCompilation compilation = CreateCompilation(sources); + GeneratorDriver driver = CSharpGeneratorDriver.Create(new MSTestReflectionMetadataGenerator()); + driver = driver.RunGeneratorsAndUpdateCompilation(compilation, out _, out _); + return driver.GetRunResult().Results[0]; + } + + private static Compilation RunGeneratorAndGetCompilation(params string[] sources) + { + CSharpCompilation compilation = CreateCompilation(sources); + GeneratorDriver driver = CSharpGeneratorDriver.Create(new MSTestReflectionMetadataGenerator()); + driver.RunGeneratorsAndUpdateCompilation(compilation, out Compilation outputCompilation, out _); + return outputCompilation; + } + + private static CSharpCompilation CreateCompilation(params string[] sources) + { + IEnumerable trees = sources.Select(s => CSharpSyntaxTree.ParseText(s)); + MetadataReference[] references = new[] + { + MetadataReference.CreateFromFile(typeof(object).Assembly.Location), + MetadataReference.CreateFromFile(typeof(System.Runtime.CompilerServices.ModuleInitializerAttribute).Assembly.Location), + MetadataReference.CreateFromFile(typeof(System.Reflection.Assembly).Assembly.Location), + MetadataReference.CreateFromFile(typeof(System.Collections.Generic.Dictionary<,>).Assembly.Location), + MetadataReference.CreateFromFile(typeof(System.Reflection.MethodInfo).Assembly.Location), + MetadataReference.CreateFromFile(typeof(System.Linq.Enumerable).Assembly.Location), + MetadataReference.CreateFromFile(typeof(System.Threading.Tasks.Task).Assembly.Location), + }; + + return CSharpCompilation.Create( + "TestSample", + trees, + references, + new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)); + } +} diff --git a/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/Program.cs b/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/Program.cs new file mode 100644 index 0000000000..9fbdc73473 --- /dev/null +++ b/test/UnitTests/MSTest.AotReflection.SourceGeneration.UnitTests/Program.cs @@ -0,0 +1,19 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT license. See LICENSE file in the project root for full license information. + +using Microsoft.Testing.Extensions; + +ITestApplicationBuilder builder = await TestApplication.CreateBuilderAsync(args); +builder.AddMSTest(() => [Assembly.GetEntryAssembly()!]); + +#if ENABLE_CODECOVERAGE +builder.AddCodeCoverageProvider(); +#endif +builder.AddHangDumpProvider(); +builder.AddCrashDumpProvider(ignoreIfNotSupported: true); +builder.AddTrxReportProvider(); +builder.AddAppInsightsTelemetryProvider(); +builder.AddAzureDevOpsProvider(); + +using ITestApplication app = await builder.BuildAsync(); +return await app.RunAsync();