Fix missing skip reason (microsoft#3754)

Co-authored-by: Marco Rossignoli <mrossignol@microsoft.com>
MarcoRossignoli · Sep 3, 2024 · 400bc96 · 400bc96
1 parent ccf7de7
commit 400bc96
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 5 deletions.
diff --git a/...ngplatform/Source/TestingPlatformExplorer/TestingFramework/TestingFramework.Attributes.cs b/...ngplatform/Source/TestingPlatformExplorer/TestingFramework/TestingFramework.Attributes.cs
@@ -6,6 +6,12 @@ namespace TestingPlatformExplorer.TestingFramework;
 [AttributeUsage(AttributeTargets.Method)]
 public class SkipAttribute : Attribute
 {
+    public string Reason { get; private set; }
+
+    public SkipAttribute(string reason)
+    {
+        Reason = reason;
+    }
 }
 
 [AttributeUsage(AttributeTargets.Method)]

diff --git a/docs/testingplatform/Source/TestingPlatformExplorer/TestingFramework/TestingFramework.cs b/docs/testingplatform/Source/TestingPlatformExplorer/TestingFramework/TestingFramework.cs
@@ -152,13 +152,14 @@ public async Task ExecuteRequestAsync(ExecuteRequestContext context)
                                 }
                             }
 
-                            if (test.GetCustomAttribute<SkipAttribute>() != null)
+                            SkipAttribute? skipAttribute = test.GetCustomAttribute<SkipAttribute>();
+                            if (skipAttribute != null)
                             {
                                 var skippedTestNode = new TestNode()
                                 {
                                     Uid = $"{test.DeclaringType!.FullName}.{test.Name}",
                                     DisplayName = test.Name,
-                                    Properties = new PropertyBag(SkippedTestNodeStateProperty.CachedInstance),
+                                    Properties = new PropertyBag(new SkippedTestNodeStateProperty(skipAttribute.Reason)),
                                 };
 
                                 if (_capabilities.TrxCapability.IsTrxEnabled)

diff --git a/docs/testingplatform/Source/TestingPlatformExplorer/UnitTests.cs b/docs/testingplatform/Source/TestingPlatformExplorer/UnitTests.cs
@@ -33,7 +33,7 @@ public static void TestMethod3(ITestOutputHelper testOutputHelper)
         }
     }
 
-    [Skip]
+    [Skip("Temporary disabled")]
     [TestMethod]
     public static void TestMethod4() => Assert.AreEqual(1, 1);
 }
diff --git a/src/Platform/Microsoft.Testing.Platform/ServerMode/JsonRpc/Json/Json.cs b/src/Platform/Microsoft.Testing.Platform/ServerMode/JsonRpc/Json/Json.cs
@@ -210,9 +210,14 @@ public Json(Dictionary<Type, JsonSerializer>? serializers = null, Dictionary<Typ
                                 break;
                             }
 
-                        case SkippedTestNodeStateProperty:
+                        case SkippedTestNodeStateProperty skippedTestNodeStateProperty:
                             {
                                 properties.Add(("execution-state", "skipped"));
+                                if (!RoslynString.IsNullOrEmpty(skippedTestNodeStateProperty.Explanation))
+                                {
+                                    properties.Add(("error.message", skippedTestNodeStateProperty.Explanation));
+                                }
+
                                 break;
                             }
 

diff --git a/src/Platform/Microsoft.Testing.Platform/ServerMode/JsonRpc/SerializerUtilities.cs b/src/Platform/Microsoft.Testing.Platform/ServerMode/JsonRpc/SerializerUtilities.cs
@@ -284,9 +284,15 @@ static SerializerUtilities()
                                     break;
                                 }
 
-                            case SkippedTestNodeStateProperty:
+                            case SkippedTestNodeStateProperty skippedTestNodeStateProperty:
                                 {
                                     properties["execution-state"] = "skipped";
+
+                                    if (!RoslynString.IsNullOrEmpty(skippedTestNodeStateProperty.Explanation))
+                                    {
+                                        properties["error.message"] = skippedTestNodeStateProperty.Explanation;
+                                    }
+
                                     break;
                                 }