Revert "Update TestContext.Properties return type to IDictionary<string, object?> (#1481)"

engyebrahim · engyebrahim · commit 957a88e7aef7 · 2023-05-17T13:51:03.000+02:00
This reverts commit f277097.
diff --git a/src/Adapter/MSTestAdapter.PlatformServices/PublicAPI/PublicAPI.Shipped.txt b/src/Adapter/MSTestAdapter.PlatformServices/PublicAPI/PublicAPI.Shipped.txt
@@ -130,7 +130,7 @@ Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TraceListener
 Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TraceListenerWrapper.TraceListenerWrapper(System.IO.TextWriter! textWriter) -> void
 override Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TestContextImplementation.AddResultFile(string! fileName) -> void
 override Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TestContextImplementation.CurrentTestOutcome.get -> Microsoft.VisualStudio.TestTools.UnitTesting.UnitTestOutcome
-override Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TestContextImplementation.Properties.get -> System.Collections.Generic.IDictionary<string!, object?>!
+override Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TestContextImplementation.Properties.get -> System.Collections.IDictionary!
 override Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TestContextImplementation.Write(string! format, params object?[]! args) -> void
 override Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TestContextImplementation.Write(string? message) -> void
 override Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.TestContextImplementation.WriteLine(string! format, params object?[]! args) -> void
diff --git a/src/Adapter/MSTestAdapter.PlatformServices/Services/TestContextImplementation.cs b/src/Adapter/MSTestAdapter.PlatformServices/Services/TestContextImplementation.cs
@@ -45,6 +45,11 @@ public class TestContextImplementation : TestContext, ITestContext
     /// </summary>
     private bool _stringWriterDisposed = false;
 
+    /// <summary>
+    /// Properties.
+    /// </summary>
+    private IDictionary<string, object?> _properties;
+
     /// <summary>
     /// Unit test outcome.
     /// </summary>
@@ -83,7 +88,7 @@ public TestContextImplementation(ITestMethod testMethod, StringWriter stringWrit
 
         // Cannot get this type in constructor directly, because all signatures for all platforms need to be the same.
         _threadSafeStringWriter = (ThreadSafeStringWriter)stringWriter;
-        Properties = new Dictionary<string, object?>(properties)
+        _properties = new Dictionary<string, object?>(properties)
         {
             [FullyQualifiedTestClassNameLabel] = _testMethod.FullClassName,
             [ManagedTypeLabel] = _testMethod.ManagedTypeName,
@@ -110,7 +115,7 @@ public TestContextImplementation(ITestMethod testMethod, StringWriter stringWrit
 #endif
 
     /// <inheritdoc/>
-    public override IDictionary<string, object?> Properties { get; }
+    public override IDictionary Properties => (IDictionary)_properties;
 
 #if !WINDOWS_UWP && !WIN_UI
     /// <inheritdoc/>
@@ -291,13 +296,13 @@ public void SetDataConnection(object? dbConnection)
     /// <returns>True if found.</returns>
     public bool TryGetPropertyValue(string propertyName, out object? propertyValue)
     {
-        if (Properties == null)
+        if (_properties == null)
         {
             propertyValue = null;
             return false;
         }
 
-        return Properties.TryGetValue(propertyName, out propertyValue);
+        return _properties.TryGetValue(propertyName, out propertyValue);
     }
 
     /// <summary>
@@ -307,7 +312,7 @@ public bool TryGetPropertyValue(string propertyName, out object? propertyValue)
     /// <param name="propertyValue">The property value.</param>
     public void AddProperty(string propertyName, string propertyValue)
     {
-        Properties.Add(propertyName, propertyValue);
+        _properties.Add(propertyName, propertyValue);
     }
 
     /// <summary>
diff --git a/src/TestFramework/TestFramework.Extensions/PublicAPI/PublicAPI.Shipped.txt b/src/TestFramework/TestFramework.Extensions/PublicAPI/PublicAPI.Shipped.txt
@@ -1,6 +1,6 @@
 ﻿#nullable enable
 abstract Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.AddResultFile(string! fileName) -> void
-abstract Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.Properties.get -> System.Collections.Generic.IDictionary<string!, object?>!
+abstract Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.Properties.get -> System.Collections.IDictionary!
 abstract Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.Write(string! format, params object?[]! args) -> void
 abstract Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.Write(string? message) -> void
 abstract Microsoft.VisualStudio.TestTools.UnitTesting.TestContext.WriteLine(string! format, params object?[]! args) -> void
diff --git a/src/TestFramework/TestFramework.Extensions/TestContext.cs b/src/TestFramework/TestFramework.Extensions/TestContext.cs
@@ -48,7 +48,7 @@ public abstract class TestContext
     /// <summary>
     /// Gets test properties for a test.
     /// </summary>
-    public abstract IDictionary<string, object?> Properties { get; }
+    public abstract IDictionary Properties { get; }
 
     /// <summary>
     /// Gets or sets the cancellation token source. This token source is canceled when test times out. Also when explicitly canceled the test will be aborted.
@@ -195,10 +195,15 @@ public abstract class TestContext
         where T : class
     {
         DebugEx.Assert(Properties is not null, "Properties is null");
-        if (!Properties.TryGetValue(name, out object? propertyValue))
+#if WINDOWS_UWP || WIN_UI
+        if (!((IDictionary<string, object>)Properties).TryGetValue(name, out object? propertyValue))
         {
             return null;
         }
+#else
+        // This old API doesn't throw when key is not found, but returns null.
+        object? propertyValue = Properties[name];
+#endif
 
         // If propertyValue has a value, but it's not the right type
         if (propertyValue is not null and not T)
diff --git a/test/UnitTests/MSTestAdapter.UnitTests/PlatformServiceProviderTests.cs b/test/UnitTests/MSTestAdapter.UnitTests/PlatformServiceProviderTests.cs
@@ -83,7 +83,7 @@ public void GetTestContextShouldReturnAValidTestContext()
         // Assert.
         Verify(testContext.Context.FullyQualifiedTestClassName == "A.C.M");
         Verify(testContext.Context.TestName == "M");
-        Verify(testContext.Context.Properties.ContainsKey(properties.ToArray()[0].Key));
+        Verify(testContext.Context.Properties.Contains(properties.ToArray()[0].Key));
         Verify(((IDictionary<string, object>)testContext.Context.Properties).Contains(properties.ToArray()[0]));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public void GetTestContextShouldReturnAValidTestContext()`
`83`	`83`	`// Assert.`
`84`	`84`	`Verify(testContext.Context.FullyQualifiedTestClassName == "A.C.M");`
`85`	`85`	`Verify(testContext.Context.TestName == "M");`
`86`		`- Verify(testContext.Context.Properties.ContainsKey(properties.ToArray()[0].Key));`
	`86`	`+ Verify(testContext.Context.Properties.Contains(properties.ToArray()[0].Key));`
`87`	`87`	`Verify(((IDictionary<string, object>)testContext.Context.Properties).Contains(properties.ToArray()[0]));`
`88`	`88`	`}`
`89`	`89`	`}`