Obsolete CancelledTestNodeStateProperty (#6828)

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: Youssef1313 <[email protected]>

Author: Copilot

src/Adapter/MSTest.Engine/Engine/TestExecutionContext.cs

@@ -55,7 +55,9 @@ public void ReportException(Exception exception, CancellationToken? timeoutCance
             // We want to consider user timeouts as failures if they didn't use our cancellation token
             OperationCanceledException canceledException
                 when canceledException.CancellationToken == _originalCancellationToken || canceledException.CancellationToken == CancellationToken
+#pragma warning disable CS0618 // Type or member is obsolete
                 => new CancelledTestNodeStateProperty(ExceptionFlattener.FlattenOrUnwrap(exception)),
+#pragma warning restore CS0618 // Type or member is obsolete
             OperationCanceledException canceledException when canceledException.CancellationToken == timeoutCancellationToken
                 => new TimeoutTestNodeStateProperty(ExceptionFlattener.FlattenOrUnwrap(exception)),
             AssertFailedException => new FailedTestNodeStateProperty(ExceptionFlattener.FlattenOrUnwrap(exception), exception.Message),

src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/AzureDevOpsReporter.cs

@@ -130,7 +130,9 @@ public async Task ConsumeAsync(IDataProducer dataProducer, IData value, Cancella
             case ErrorTestNodeStateProperty error:
                 await WriteExceptionAsync(error.Explanation, error.Exception, cancellationToken).ConfigureAwait(false);
                 break;
+#pragma warning disable CS0618 // Type or member is obsolete
             case CancelledTestNodeStateProperty cancelled:
+#pragma warning restore CS0618 // Type or member is obsolete
                 await WriteExceptionAsync(cancelled.Explanation, cancelled.Exception, cancellationToken).ConfigureAwait(false);
                 break;
             case TimeoutTestNodeStateProperty timeout:

src/Platform/Microsoft.Testing.Extensions.HangDump/HangDumpActivityIndicator.cs

@@ -172,7 +172,9 @@ public async Task ConsumeAsync(IDataProducer dataProducer, IData value, Cancella
 
             _testsCurrentExecutionState.TryAdd(nodeChangedMessage.TestNode.Uid, (nodeChangedMessage.TestNode.DisplayName, typeof(InProgressTestNodeStateProperty), _clock.UtcNow));
         }
+#pragma warning disable CS0618 // Type or member is obsolete
         else if (state is PassedTestNodeStateProperty or ErrorTestNodeStateProperty or CancelledTestNodeStateProperty
+#pragma warning restore CS0618 // Type or member is obsolete
             or FailedTestNodeStateProperty or TimeoutTestNodeStateProperty or SkippedTestNodeStateProperty
             && _testsCurrentExecutionState.TryRemove(nodeChangedMessage.TestNode.Uid, out (string Name, Type Type, DateTimeOffset StartTime) record)
             && _traceLevelEnabled)

src/Platform/Microsoft.Testing.Extensions.MSBuild/MSBuildConsumer.cs

@@ -125,7 +125,9 @@ await HandleFailuresAsync(
                             cancellationToken).ConfigureAwait(false);
                         break;
 
+#pragma warning disable CS0618 // Type or member is obsolete
                     case CancelledTestNodeStateProperty canceledState:
+#pragma warning restore CS0618 // Type or member is obsolete
                         await HandleFailuresAsync(
                             testNodeStateChanged.TestNode.DisplayName,
                             isCanceled: true,

src/Platform/Microsoft.Testing.Platform/Messages/TestNodeProperties.Categories.cs

@@ -19,14 +19,18 @@ internal static class TestNodePropertiesCategories
             typeof(FailedTestNodeStateProperty),
             typeof(ErrorTestNodeStateProperty),
             typeof(TimeoutTestNodeStateProperty),
+#pragma warning disable CS0618 // Type or member is obsolete
             typeof(CancelledTestNodeStateProperty),
+#pragma warning restore CS0618 // Type or member is obsolete
         ];
 
     public static Type[] WellKnownTestNodeTestRunOutcomeFailedProperties { get; } =
         [
             typeof(FailedTestNodeStateProperty),
             typeof(ErrorTestNodeStateProperty),
             typeof(TimeoutTestNodeStateProperty),
+#pragma warning disable CS0618 // Type or member is obsolete
             typeof(CancelledTestNodeStateProperty),
+#pragma warning restore CS0618 // Type or member is obsolete
         ];
 }

src/Platform/Microsoft.Testing.Platform/Messages/TestNodeProperties.cs

@@ -437,6 +437,7 @@ public override int GetHashCode()
 /// <summary>
 /// Property that represents an eventual cancellation of a test node.
 /// </summary>
+[Obsolete("CancelledTestNodeStateProperty is obsolete. Test frameworks should throw OperationCanceledException using the cancellation token passed by Microsoft.Testing.Platform instead of using this state.")]
 public sealed class CancelledTestNodeStateProperty : TestNodeStateProperty, IEquatable<CancelledTestNodeStateProperty>
 {
     /// <summary>

src/Platform/Microsoft.Testing.Platform/OutputDevice/BrowserOutputDevice.cs

@@ -356,7 +356,9 @@ public Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationTo
                         OnFailedTest(testNodeStateChanged, timeoutState, timeoutState.Exception, duration);
                         break;
 
+#pragma warning disable CS0618 // Type or member is obsolete
                     case CancelledTestNodeStateProperty cancelledState:
+#pragma warning restore CS0618 // Type or member is obsolete
                         OnFailedTest(testNodeStateChanged, cancelledState, cancelledState.Exception, duration);
                         break;
 

src/Platform/Microsoft.Testing.Platform/OutputDevice/TerminalOutputDevice.cs

@@ -460,7 +460,9 @@ public Task ConsumeAsync(IDataProducer dataProducer, IData value, CancellationTo
                              standardError);
                         break;
 
+#pragma warning disable CS0618 // Type or member is obsolete
                     case CancelledTestNodeStateProperty cancelledState:
+#pragma warning restore CS0618 // Type or member is obsolete
                         _terminalTestReporter.TestCompleted(
                              testNodeStateChanged.TestNode.Uid.Value,
                              testNodeStateChanged.TestNode.DisplayName,

src/Platform/Microsoft.Testing.Platform/ServerMode/DotnetTest/IPC/DotnetTestDataConsumer.cs

@@ -241,7 +241,9 @@ public async Task ConsumeAsync(IDataProducer dataProducer, IData value, Cancella
                 exceptions = FlattenToExceptionMessages(reason, timeoutTestNodeStateProperty.Exception);
                 break;
 
+#pragma warning disable CS0618 // Type or member is obsolete
             case CancelledTestNodeStateProperty cancelledTestNodeStateProperty:
+#pragma warning restore CS0618 // Type or member is obsolete
                 state = TestStates.Cancelled;
                 duration = testNodeUpdateMessage.TestNode.Properties.SingleOrDefault<TimingProperty>()?.GlobalTiming.Duration.Ticks;
                 reason = nodeState.Explanation;

src/Platform/Microsoft.Testing.Platform/ServerMode/JsonRpc/Json/Json.cs

@@ -248,7 +248,9 @@ public Json(Dictionary<Type, JsonSerializer>? serializers = null, Dictionary<Typ
                                 break;
                             }
 
+#pragma warning disable CS0618 // Type or member is obsolete
                         case CancelledTestNodeStateProperty canceledTestNodeStateProperty:
+#pragma warning restore CS0618 // Type or member is obsolete
                             {
                                 properties.Add(("execution-state", "canceled"));
                                 Exception? exception = canceledTestNodeStateProperty.Exception;