Skip to content

[rel/3.8] Improve ExecutionContext propagation #5246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
youssef-backport-bot wants to merge 14 commits into from
Closed

[rel/3.8] Improve ExecutionContext propagation #5246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
7acc89f
Improve ExecutionContext propagation
Youssef1313 Feb 28, 2025
0850334
Fix tests
Youssef1313 Mar 2, 2025
59bf164
Fix for class cleanups
Youssef1313 Mar 2, 2025
5ccab9b
Adjust
Youssef1313 Mar 3, 2025
324007d
Adjust for netfx
Youssef1313 Mar 3, 2025
c6ceb4c
Adjust
Youssef1313 Mar 3, 2025
24adbf5
Delete wrong comment
Youssef1313 Mar 3, 2025
69a7d6e
Remove misleading comment
Youssef1313 Mar 3, 2025
c21a3a9
Enhance tests
Youssef1313 Mar 3, 2025
4bb0059
Fix test
Youssef1313 Mar 3, 2025
5e5c304
More test fixes
Youssef1313 Mar 3, 2025
8156e21
Fix tests
Youssef1313 Mar 3, 2025
cf626d9
Delete unintentionally committed code
Youssef1313 Mar 4, 2025
8f3511a
[create-pull-request] automated change
Youssef1313 Mar 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2,688 changes: 2,688 additions & 0 deletions changes.patch
View file
Open in desktop

Large diffs are not rendered by default.

25 changes: 19 additions & 6 deletions src/Adapter/MSTest.TestAdapter/Execution/TestAssemblyInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
using Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.Extensions;
using Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.Helpers;
using Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.ObjectModel;
using Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices;
using Microsoft.VisualStudio.TestTools.UnitTesting;

using UnitTestOutcome = Microsoft.VisualStudio.TestTools.UnitTesting.UnitTestOutcome;
Expand Down Expand Up @@ -107,6 +106,8 @@ internal set
/// </summary>
internal Assembly Assembly { get; }

internal ExecutionContext? ExecutionContext { get; set; }

/// <summary>
/// Runs assembly initialize method.
/// </summary>
Expand Down Expand Up @@ -143,11 +144,17 @@ public void RunAssemblyInitialize(TestContext testContext)
try
{
AssemblyInitializationException = FixtureMethodRunner.RunWithTimeoutAndCancellation(
() => AssemblyInitializeMethod.InvokeAsSynchronousTask(null, testContext),
() =>
{
AssemblyInitializeMethod.InvokeAsSynchronousTask(null, testContext);
// **After** we have executed the assembly initialize, we save the current context.
// This context will contain async locals set by the assembly initialize method.
ExecutionContext = ExecutionContext.Capture();
},
testContext.CancellationTokenSource,
AssemblyInitializeMethodTimeoutMilliseconds,
AssemblyInitializeMethod,
new AssemblyExecutionContextScope(isCleanup: false),
executionContext: ExecutionContext,
Resource.AssemblyInitializeWasCancelled,
Resource.AssemblyInitializeTimedOut);
}
Expand Down Expand Up @@ -216,11 +223,15 @@ public void RunAssemblyInitialize(TestContext testContext)
try
{
AssemblyCleanupException = FixtureMethodRunner.RunWithTimeoutAndCancellation(
() => AssemblyCleanupMethod.InvokeAsSynchronousTask(null),
() =>
{
AssemblyCleanupMethod.InvokeAsSynchronousTask(null);
ExecutionContext = ExecutionContext.Capture();
},
new CancellationTokenSource(),
AssemblyCleanupMethodTimeoutMilliseconds,
AssemblyCleanupMethod,
new AssemblyExecutionContextScope(isCleanup: true),
ExecutionContext,
Resource.AssemblyCleanupWasCancelled,
Resource.AssemblyCleanupTimedOut);
}
Expand Down Expand Up @@ -282,11 +293,13 @@ public void RunAssemblyInitialize(TestContext testContext)
{
AssemblyCleanupMethod.InvokeAsSynchronousTask(null, testContext);
}

ExecutionContext = ExecutionContext.Capture();
},
testContext.CancellationTokenSource,
AssemblyCleanupMethodTimeoutMilliseconds,
AssemblyCleanupMethod,
new AssemblyExecutionContextScope(isCleanup: true),
ExecutionContext,
Resource.AssemblyCleanupWasCancelled,
Resource.AssemblyCleanupTimedOut);
}
Expand Down
30 changes: 21 additions & 9 deletions src/Adapter/MSTest.TestAdapter/Execution/TestClassInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
using Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.Extensions;
using Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.Helpers;
using Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.ObjectModel;
using Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices;
using Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.Interface;
using Microsoft.VisualStudio.TestTools.UnitTesting;

Expand Down Expand Up @@ -234,6 +233,8 @@ internal set
}
}

internal ExecutionContext? ExecutionContext { get; set; }

/// <summary>
/// Gets a queue of test initialize methods to call for this type.
/// </summary>
Expand Down Expand Up @@ -507,11 +508,17 @@ TestResult DoRun()
}

return FixtureMethodRunner.RunWithTimeoutAndCancellation(
() => methodInfo.InvokeAsSynchronousTask(null, testContext),
() =>
{
methodInfo.InvokeAsSynchronousTask(null, testContext);
// **After** we have executed the class initialize, we save the current context.
// This context will contain async locals set by the class initialize method.
ExecutionContext = ExecutionContext.Capture();
},
testContext.CancellationTokenSource,
timeout,
methodInfo,
new ClassExecutionContextScope(ClassType),
ExecutionContext ?? Parent?.ExecutionContext,
Resource.ClassInitializeWasCancelled,
Resource.ClassInitializeTimedOut);
}
Expand Down Expand Up @@ -549,12 +556,12 @@ TestResult DoRun()
try
{
classCleanupMethod = ClassCleanupMethod;
ClassCleanupException = classCleanupMethod is not null ? InvokeCleanupMethod(classCleanupMethod, BaseClassCleanupMethods.Count, null!) : null;
ClassCleanupException = classCleanupMethod is not null ? InvokeCleanupMethod(classCleanupMethod, null!) : null;
var baseClassCleanupQueue = new Queue<MethodInfo>(BaseClassCleanupMethods);
while (baseClassCleanupQueue.Count > 0 && ClassCleanupException is null)
{
classCleanupMethod = baseClassCleanupQueue.Dequeue();
ClassCleanupException = InvokeCleanupMethod(classCleanupMethod, baseClassCleanupQueue.Count, null!);
ClassCleanupException = InvokeCleanupMethod(classCleanupMethod, null!);
}

IsClassCleanupExecuted = ClassCleanupException is null;
Expand Down Expand Up @@ -634,7 +641,7 @@ TestResult DoRun()
{
if (!classCleanupMethod.DeclaringType!.IsIgnored(out _))
{
ClassCleanupException = InvokeCleanupMethod(classCleanupMethod, remainingCleanupCount: BaseClassCleanupMethods.Count, testContext);
ClassCleanupException = InvokeCleanupMethod(classCleanupMethod, testContext);
}
}

Expand All @@ -645,7 +652,7 @@ TestResult DoRun()
classCleanupMethod = BaseClassCleanupMethods[i];
if (!classCleanupMethod.DeclaringType!.IsIgnored(out _))
{
ClassCleanupException = InvokeCleanupMethod(classCleanupMethod, remainingCleanupCount: BaseClassCleanupMethods.Count - 1 - i, testContext);
ClassCleanupException = InvokeCleanupMethod(classCleanupMethod, testContext);
if (ClassCleanupException is not null)
{
break;
Expand Down Expand Up @@ -798,7 +805,7 @@ void DoRun()
}
}

private TestFailedException? InvokeCleanupMethod(MethodInfo methodInfo, int remainingCleanupCount, TestContext testContext)
private TestFailedException? InvokeCleanupMethod(MethodInfo methodInfo, TestContext testContext)
{
TimeoutInfo? timeout = null;
if (ClassCleanupMethodTimeoutMilliseconds.TryGetValue(methodInfo, out TimeoutInfo localTimeout))
Expand All @@ -817,11 +824,16 @@ void DoRun()
{
methodInfo.InvokeAsSynchronousTask(null, testContext);
}

// **After** we have executed the class cleanup, we save the current context.
// This context will contain async locals set by the current class cleanup method.
// This is essential to propagate async locals between multiple class cleanup methods.
ExecutionContext = ExecutionContext.Capture();
},
testContext.CancellationTokenSource,
timeout,
methodInfo,
new ClassExecutionContextScope(ClassType, remainingCleanupCount),
ExecutionContext ?? Parent.ExecutionContext,
Resource.ClassCleanupWasCancelled,
Resource.ClassCleanupTimedOut);
}
Expand Down
Loading