Flow execution context across fixture methods when using timeout

[Evangelink]

Problem

Before the timeout PR, or when no timeout is being set (runsettings or on fixture/test methods), then all methods are being called synchronously and so the state is "shared" and can be mutated by all steps. For example, when changing the culture in AssemblyInitialize this culture will be set for the ClassInitialize, all the way down to the test method then back to the AssemblyCleanup.

When setting up timeouts, we are starting new thread so we can stop observing the execution when the timeout expires (to overcome non-cooperative cancellation). Because of this thread creation, each thread works in isolation and its state is not preserved and flown to the other methods which is unexpected by users.

Solution

To overcome this issue, we need to manually capture and restore the right ExecutionContext at the right time. The logic I decided to go with is to flow top-to-bottom meaning that the AssemblyInitialize context is flown down to the ClassInitialize... This is allowing to have a behavior similar to the one when no timeout is set.

Design decision

But there is a question happening for ClassCleanup and AssemblyCleanup methods where the state when there is no timeout is undeterministic as it depends on the last executed test (for ClassCleanup) and last executed ClassCleanup for AssemblyCleanup. Although, technically, we could mimic this behavior, I think it's better to have the ClassCleanup reusing the state of left by the corresponding ClassInitialize and have the AssemblyCleanup reusing the state left the by corresponding AssemblyInitialize as it fixes the undeterminism and it is also closer to what happens for awaited async methods.

Examples

When timeout is set:

flowchart TD

A[AssemblyInitialize\nCulture is English\nSet culture to Japanese] --> B(ClassInitialize\nCulture is Japanese\nSet culture to Italian)
B --> C(TestInitialize\nCulture is Italian\nSet culture to French)
C --> D(TestMethod\nCulture is French\nSet culture to Czech)
D --> E(TestCleanup\nCulture is Czech\nSet culture to Spanish)
E --> F(ClassCleanup\nCulture is Italian - result of ClassInitialize state and not Spanish result of TestCleanup\nSet culture to Hungarian)
F --> G(AssemblyCleanup\nCulture is Japanese - result of AssemblyInitialize state and not Hungarian of ClassCleanup)

Loading

When timeout is not set:

flowchart TD

A[AssemblyInitialize\nCulture is English\nSet culture to Japanese] --> B(ClassInitialize\nCulture is Japanese\nSet culture to Italian)
B --> C(TestInitialize\nCulture is Italian\nSet culture to French)
C --> D(TestMethod\nCulture is French\nSet culture to Czech)
D --> E(TestCleanup\nCulture is Czech\nSet culture to Spanish)
E --> F(ClassCleanup\nCulture is Spanish result of TestCleanup\nSet culture to Hungarian)
F --> G(AssemblyCleanup\nCulture is Hungarian result of ClassCleanup)

Loading

Fixes AB#2051896

[testplatform-bot]

✅ Successfully linked to Azure Boards work item(s):

• Bug 2051896

[testplatform-bot]

✅ Successfully linked to Azure Boards work item(s):

• Bug 2051896

[testplatform-bot]

✅ Successfully linked to Azure Boards work item(s):

• Bug 2051896