refactor(formatting): escape dots in strings to prevent namespace interpretation in VS Test Explorer

Author: thomhurst

TUnit.Core.Tests/Helpers/ArgumentFormatterTests.cs

@@ -58,9 +58,39 @@ public void FormatDefault_LargeTuple_FormatsAllElements()
     public void FormatDefault_TupleWithNull_HandlesNullCorrectly()
     {
         var tuple = (1, null, "test");
-        
+
         var result = ArgumentFormatter.Format(tuple, []);
-        
+
         Assert.That(result, Is.EqualTo("(1, null, test)"));
     }
+
+    [Test]
+    public void FormatDefault_StringWithDots_EscapesDotsWithMiddleDot()
+    {
+        var stringWithDots = "1.2.3";
+
+        var result = ArgumentFormatter.Format(stringWithDots, []);
+
+        Assert.That(result, Is.EqualTo("1·2·3"));
+    }
+
+    [Test]
+    public void FormatDefault_StringWithoutDots_ReturnsUnchanged()
+    {
+        var stringWithoutDots = "hello world";
+
+        var result = ArgumentFormatter.Format(stringWithoutDots, []);
+
+        Assert.That(result, Is.EqualTo("hello world"));
+    }
+
+    [Test]
+    public void FormatArguments_WithStringsContainingDots_EscapesDots()
+    {
+        var args = new object?[] { "hello", "with.dot", "1.2.3" };
+
+        var result = ArgumentFormatter.FormatArguments(args);
+
+        Assert.That(result, Is.EqualTo("hello, with·dot, 1·2·3"));
+    }
 }

TUnit.Core/Attributes/TestData/ClassDataSources.cs

@@ -73,9 +73,24 @@ private string GetKey(int index, SharedType[] sharedTypes, string[] keys)
 
     private static object Create([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.NonPublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.NonPublicProperties | DynamicallyAccessedMemberTypes.PublicMethods | DynamicallyAccessedMemberTypes.NonPublicMethods)] Type type, DataGeneratorMetadata dataGeneratorMetadata)
     {
+        return CreateWithNestedDependencies(type, dataGeneratorMetadata, recursionDepth: 0);
+    }
+
+    private const int MaxRecursionDepth = 10;
+
+    [UnconditionalSuppressMessage("Trimming", "IL2072:Target parameter argument does not satisfy 'DynamicallyAccessedMembersAttribute' requirements",
+        Justification = "PropertyType from PropertyInjectionMetadata has the required DynamicallyAccessedMembers annotations")]
+    private static object CreateWithNestedDependencies([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors | DynamicallyAccessedMemberTypes.NonPublicConstructors | DynamicallyAccessedMemberTypes.PublicProperties | DynamicallyAccessedMemberTypes.NonPublicProperties | DynamicallyAccessedMemberTypes.PublicMethods | DynamicallyAccessedMemberTypes.NonPublicMethods)] Type type, DataGeneratorMetadata dataGeneratorMetadata, int recursionDepth)
+    {
+        if (recursionDepth >= MaxRecursionDepth)
+        {
+            throw new InvalidOperationException($"Maximum recursion depth ({MaxRecursionDepth}) exceeded when creating nested ClassDataSource dependencies. This may indicate a circular dependency.");
+        }
+
+        object instance;
         try
         {
-            return Activator.CreateInstance(type)!;
+            instance = Activator.CreateInstance(type)!;
         }
         catch (TargetInvocationException targetInvocationException)
         {
@@ -86,5 +101,21 @@ private static object Create([DynamicallyAccessedMembers(DynamicallyAccessedMemb
 
             throw;
         }
+
+        // Populate nested ClassDataSource properties recursively
+        var propertySource = PropertySourceRegistry.GetSource(type);
+        if (propertySource?.ShouldInitialize == true)
+        {
+            var propertyMetadata = propertySource.GetPropertyMetadata();
+            foreach (var metadata in propertyMetadata)
+            {
+                // Recursively create the property value using CreateWithNestedDependencies
+                // This will handle nested ClassDataSource properties
+                var propertyValue = CreateWithNestedDependencies(metadata.PropertyType, dataGeneratorMetadata, recursionDepth + 1);
+                metadata.SetProperty(instance, propertyValue);
+            }
+        }
+
+        return instance;
     }
 }

TUnit.Core/Attributes/TestData/MatrixDataSourceAttribute.cs

@@ -175,8 +175,10 @@ private bool IsExcluded(object?[] exclusion, IEnumerable<object?> row)
         var enumValues = Enum.GetValuesAsUnderlyingType(resolvedType)
                              .Cast<object?>();
 #else
+#pragma warning disable IL3050 // Enum.GetValues is used for test data generation at discovery time, not in AOT scenarios
             var enumValues = Enum.GetValues(resolvedType)
                 .Cast<object?>();
+#pragma warning restore IL3050
 #endif
             if (isNullable)
             {

TUnit.Core/Helpers/ArgumentFormatter.cs

@@ -63,11 +63,18 @@ private static string FormatDefault(object? o)
             return toString;
         }
 
-        if (type.IsPrimitive || o is string)
+        if (type.IsPrimitive)
         {
             return toString;
         }
 
+        if (o is string str)
+        {
+            // Replace dots with middle dot (·) to prevent VS Test Explorer from interpreting them as namespace separators
+            // Only do this if the string contains dots, to avoid unnecessary allocations
+            return str.Contains('.') ? str.Replace(".", "·") : str;
+        }
+
         if (toString == type.FullName || toString == type.AssemblyQualifiedName)
         {
             return type.Name;

TUnit.Core/Helpers/CastHelper.cs

@@ -11,6 +11,8 @@ namespace TUnit.Core.Helpers;
 public static class CastHelper
 {
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    [UnconditionalSuppressMessage("AOT", "IL3050:Calling members annotated with 'RequiresDynamicCodeAttribute' may break functionality when AOT compiling.",
+        Justification = "Array.CreateInstance is used for test data generation at discovery time, not in AOT-compiled test execution.")]
     public static T? Cast<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods | DynamicallyAccessedMemberTypes.NonPublicMethods)] T>(object? value)
     {
         if (value is null)
@@ -180,6 +182,8 @@ public static class CastHelper
     }
 
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
+    [UnconditionalSuppressMessage("AOT", "IL3050:Calling members annotated with 'RequiresDynamicCodeAttribute' may break functionality when AOT compiling.",
+        Justification = "Array.CreateInstance is used for test data generation at discovery time, not in AOT-compiled test execution.")]
     public static object? Cast([DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods | DynamicallyAccessedMemberTypes.NonPublicMethods)] Type type, object? value)
     {
         if (value is null)

TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet10_0.verified.txt

@@ -1943,7 +1943,13 @@ namespace .Helpers
         "have matching annotations.")]
     public static class CastHelper
     {
+        [.("AOT", "IL3050:Calling members annotated with \'RequiresDynamicCodeAttribute\' may break fu" +
+            "nctionality when AOT compiling.", Justification=" is used for test data generation at discovery time, not in A" +
+            "OT-compiled test execution.")]
         public static object? Cast([.(..None | ..PublicMethods | ..NonPublicMethods)]  type, object? value) { }
+        [.("AOT", "IL3050:Calling members annotated with \'RequiresDynamicCodeAttribute\' may break fu" +
+            "nctionality when AOT compiling.", Justification=" is used for test data generation at discovery time, not in A" +
+            "OT-compiled test execution.")]
         public static T? Cast<[.(..None | ..PublicMethods | ..NonPublicMethods)]  T>(object? value) { }
         public static .MethodInfo? GetConversionMethod([.(..None | ..PublicMethods | ..NonPublicMethods)]  baseType, [.(..None | ..PublicMethods | ..NonPublicMethods)]  targetType) { }
     }

TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet8_0.verified.txt

@@ -1943,7 +1943,13 @@ namespace .Helpers
         "have matching annotations.")]
     public static class CastHelper
     {
+        [.("AOT", "IL3050:Calling members annotated with \'RequiresDynamicCodeAttribute\' may break fu" +
+            "nctionality when AOT compiling.", Justification=" is used for test data generation at discovery time, not in A" +
+            "OT-compiled test execution.")]
         public static object? Cast([.(..None | ..PublicMethods | ..NonPublicMethods)]  type, object? value) { }
+        [.("AOT", "IL3050:Calling members annotated with \'RequiresDynamicCodeAttribute\' may break fu" +
+            "nctionality when AOT compiling.", Justification=" is used for test data generation at discovery time, not in A" +
+            "OT-compiled test execution.")]
         public static T? Cast<[.(..None | ..PublicMethods | ..NonPublicMethods)]  T>(object? value) { }
         public static .MethodInfo? GetConversionMethod([.(..None | ..PublicMethods | ..NonPublicMethods)]  baseType, [.(..None | ..PublicMethods | ..NonPublicMethods)]  targetType) { }
     }

TUnit.PublicAPI/Tests.Core_Library_Has_No_API_Changes.DotNet9_0.verified.txt

@@ -1943,7 +1943,13 @@ namespace .Helpers
         "have matching annotations.")]
     public static class CastHelper
     {
+        [.("AOT", "IL3050:Calling members annotated with \'RequiresDynamicCodeAttribute\' may break fu" +
+            "nctionality when AOT compiling.", Justification=" is used for test data generation at discovery time, not in A" +
+            "OT-compiled test execution.")]
         public static object? Cast([.(..None | ..PublicMethods | ..NonPublicMethods)]  type, object? value) { }
+        [.("AOT", "IL3050:Calling members annotated with \'RequiresDynamicCodeAttribute\' may break fu" +
+            "nctionality when AOT compiling.", Justification=" is used for test data generation at discovery time, not in A" +
+            "OT-compiled test execution.")]
         public static T? Cast<[.(..None | ..PublicMethods | ..NonPublicMethods)]  T>(object? value) { }
         public static .MethodInfo? GetConversionMethod([.(..None | ..PublicMethods | ..NonPublicMethods)]  baseType, [.(..None | ..PublicMethods | ..NonPublicMethods)]  targetType) { }
     }