Skip to content

[ResourceLock] Replace [DoNotParallelize] with [ResourceLock] in MSBuildCompatibilityHelperTests - #11808

Merged
Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
nohwnd-bot:resource-lock/msbuild-compat-helper-tests-f79d9d38591de884
Oct 8, 2026
Merged

Amaury Levé (Evangelink) merged 1 commit into
microsoft:mainfrom
nohwnd-bot:resource-lock/msbuild-compat-helper-tests-f79d9d38591de884

Conversation

@nohwnd-bot

Copy link
Copy Markdown
Contributor

Replaces the class-level [DoNotParallelize] on MSBuildCompatibilityHelperTests (in test/UnitTests/Microsoft.Testing.Platform.MSBuild.UnitTests, which already runs with [assembly: Parallelize(Scope = ExecutionScope.MethodLevel, Workers = 0)]) with a class-level [ResourceLock] on a dedicated custom key.

Current parallelization scope. Microsoft.Testing.Platform.MSBuild.UnitTests is already opted into MethodLevel parallelism via Program.cs. The [DoNotParallelize] on MSBuildCompatibilityHelperTests previously pulled every test in the class out of the parallel set into the sequential tail.

Shared resource. MSBuildCompatibilityHelper's three process-wide static caches: s_msBuildVersion, s_supportsMultiline, s_supportsTerminalLoggerWithExtendedMessages (src/Platform/Microsoft.Testing.Platform.MSBuild/Tasks/MSBuildCompatibilityHelper.cs).

Resource coverage matrix:

Resource Direct test writers Production readers/writers Tests invoking those production paths Declaration
MSBuildCompatibilityHelper static caches All 6 tests in MSBuildCompatibilityHelperTests: 2 call SupportsMultiLine()/SupportsTerminalLoggerWithExtendedMessages() directly (lazily populating the caches), 2 use the WithMSBuildVersion helper which replaces the backing fields via reflection, 2 call TryWriteExtendedMessage() (one via WithMSBuildVersion) InvokeTestingPlatformTask.HandleRequestAsync (src/Platform/Microsoft.Testing.Platform.MSBuild/Tasks/InvokeTestingPlatformTask.Execution.cs) calls SupportsMultiLine(), SupportsTerminalLoggerWithExtendedMessages(), and TryWriteExtendedMessage() None — confirmed by grepping the whole repo for MSBuildCompatibilityHelper call sites: the only references outside the production file are the 6 tests inside MSBuildCompatibilityHelperTests.cs itself. InvokeTestingPlatformTaskTests.cs and MSBuildTests.cs in the same assembly instantiate other MSBuild tasks (InvokeTestingPlatformTask is only ever constructed, never driving HandleRequestAsync's named-pipe request handling; TestingPlatformEntryPointTask/ConfigurationFileTask are unrelated types) and never reach MSBuildCompatibilityHelper Class-level [ResourceLock(MSBuildCompatibilityHelperCacheResource)], where MSBuildCompatibilityHelperCacheResource is a new private const string on the test class, per the repo convention of never using a bare string literal key

Because no other concurrently-runnable test in the assembly reaches MSBuildCompatibilityHelper, the class-level lock is both necessary (the 6 tests mutate/read a shared static cache and must not interleave with each other) and sufficient (nothing else in the assembly can observe or race on that cache) — while being strictly narrower than the previous assembly-tail [DoNotParallelize] deferral, since the class can now run concurrently with the rest of the assembly instead of being pulled into the sequential phase.

Why not eliminate the shared state instead? The caches are internal implementation details of MSBuildCompatibilityHelper (a production internal static class); rewriting it to avoid static caching is out of scope for this bounded refactoring, and [ResourceLock] is the documented fix for exactly this "process-global state that must be coordinated" category per the shared parallel-safety-audit guidance (category A).

Validation:

  • bash ./build.sh -projects $(pwd)/test/UnitTests/Microsoft.Testing.Platform.MSBuild.UnitTests/Microsoft.Testing.Platform.MSBuild.UnitTests.csproj — build succeeded (0 errors).
  • PATH="$PWD/.dotnet:$PATH" dotnet exec artifacts/bin/Microsoft.Testing.Platform.MSBuild.UnitTests/Debug/net9.0/Microsoft.Testing.Platform.MSBuild.UnitTests.dll --filter "FullyQualifiedName~MSBuildCompatibilityHelperTests" — 10/10 passed, run 3 times in a row to check for new flakiness from the removed [DoNotParallelize], no failures.
  • PATH="$PWD/.dotnet:$PATH" dotnet exec artifacts/bin/Microsoft.Testing.Platform.MSBuild.UnitTests/Debug/net9.0/Microsoft.Testing.Platform.MSBuild.UnitTests.dll (full assembly, MethodLevel/4 workers) — 229 passed, 1 skipped (pre-existing, OS-specific, unrelated to this change), 0 failed.
  • Workflow run: https://github.com/microsoft/testfx/actions/runs/37732212973

Declaration-reconciliation self-review (category C): the lock's key is private to this test class (not reused elsewhere), so no key-mismatch/near-miss risk; the lock covers every production reader/writer of the resource (not just the one API the changed test calls); the sole observers in the assembly are the 6 tests on this class, all now under the same lock, so there is no concurrent interleaving that can race on the caches with the replacement declaration in place.

No assembly-level [Parallelize]/[DoNotParallelize], MSTestParallelizeScope/MSTestParallelizeWorkers, .runsettings, or testconfig.json parallelization settings were added or changed — only the class-level attribute on MSBuildCompatibilityHelperTests.

gh-aw-workflow-id: resource-lock-refactoring

Warning

Firewall blocked 74 domains

The following domains were blocked by the firewall during workflow execution:

  • 0t3vsblobprodcus362.vsblob.vsassets.io
  • 11vvsblobprodcus336.vsblob.vsassets.io
  • 1k9vsblobprodcus379.vsblob.vsassets.io
  • 1s1vsblobprodcus386.vsblob.vsassets.io
  • 37bvsblobprodcus311.vsblob.vsassets.io
  • 37cvsblobprodcus359.vsblob.vsassets.io
  • 4m6vsblobprodcus384.vsblob.vsassets.io
  • 4vyvsblobprodcus361.vsblob.vsassets.io
  • 4zjvsblobprodcus390.vsblob.vsassets.io
  • 51yvsblobprodcus36.vsblob.vsassets.io
  • 5dkvsblobprodcus355.vsblob.vsassets.io
  • 5rqvsblobprodcus385.vsblob.vsassets.io
  • 7k6vsblobprodcus337.vsblob.vsassets.io
  • 7tjvsblobprodcus341.vsblob.vsassets.io
  • 80zvsblobprodcus35.vsblob.vsassets.io
  • 8xbvsblobprodcus382.vsblob.vsassets.io
  • 96bvsblobprodcus338.vsblob.vsassets.io
  • ajhvsblobprodcus363.vsblob.vsassets.io
  • bcnvsblobprodcus378.vsblob.vsassets.io
  • builds.dotnet.microsoft.com
  • c78vsblobprodcus322.vsblob.vsassets.io
  • cflvsblobprodcus383.vsblob.vsassets.io
  • ci.dot.net
  • ckzvsblobprodcus347.vsblob.vsassets.io
  • d0svsblobprodcus381.vsblob.vsassets.io
  • data.nuget.org
  • dlbvsblobprodcus316.vsblob.vsassets.io
  • e7bvsblobprodcus348.vsblob.vsassets.io
  • fdpvsblobprodcus345.vsblob.vsassets.io
  • frdvsblobprodcus327.vsblob.vsassets.io
  • gbsvsblobprodcus365.vsblob.vsassets.io
  • h6tvsblobprodcus346.vsblob.vsassets.io
  • i1qvsblobprodcus353.vsblob.vsassets.io
  • imzvsblobprodcus368.vsblob.vsassets.io
  • jd4vsblobprodcus366.vsblob.vsassets.io
  • josvsblobprodcus372.vsblob.vsassets.io
  • jrqvsblobprodcus343.vsblob.vsassets.io
  • k0ivsblobprodcus356.vsblob.vsassets.io
  • k4kvsblobprodcus344.vsblob.vsassets.io
  • kgfvsblobprodcus314.vsblob.vsassets.io
  • kijvsblobprodcus387.vsblob.vsassets.io
  • kxqvsblobprodcus376.vsblob.vsassets.io
  • l49vsblobprodcus358.vsblob.vsassets.io
  • l7avsblobprodcus319.vsblob.vsassets.io
  • ljcvsblobprodcus317.vsblob.vsassets.io
  • lylvsblobprodcus31.vsblob.vsassets.io
  • m16vsblobprodcus374.vsblob.vsassets.io
  • m6xvsblobprodcus342.vsblob.vsassets.io
  • mfjvsblobprodcus373.vsblob.vsassets.io
  • n3kvsblobprodcus335.vsblob.vsassets.io
  • o3svsblobprodcus318.vsblob.vsassets.io
  • ofvvsblobprodcus315.vsblob.vsassets.io
  • pc2vsblobprodcus360.vsblob.vsassets.io
  • pdfvsblobprodcus380.vsblob.vsassets.io
  • pe3vsblobprodcus354.vsblob.vsassets.io
  • pkgs.dev.azure.com
  • rcxvsblobprodcus328.vsblob.vsassets.io
  • s8mvsblobprodcus38.vsblob.vsassets.io
  • se1vsblobprodcus349.vsblob.vsassets.io
  • southcentralus0.in.applicationinsights.azure.com
  • sqdvsblobprodcus333.vsblob.vsassets.io
  • st8vsblobprodcus339.vsblob.vsassets.io
  • tphvsblobprodcus375.vsblob.vsassets.io
  • u3hvsblobprodcus371.vsblob.vsassets.io
  • u6ovsblobprodcus377.vsblob.vsassets.io
  • ukkvsblobprodcus352.vsblob.vsassets.io
  • uy6vsblobprodcus34.vsblob.vsassets.io
  • v53vsblobprodcus320.vsblob.vsassets.io
  • vb4vsblobprodcus33.vsblob.vsassets.io
  • vwvvsblobprodcus334.vsblob.vsassets.io
  • x3yvsblobprodcus370.vsblob.vsassets.io
  • xupvsblobprodcus332.vsblob.vsassets.io
  • yluvsblobprodcus367.vsblob.vsassets.io
  • yttvsblobprodcus357.vsblob.vsassets.io

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "0t3vsblobprodcus362.vsblob.vsassets.io"
    - "11vvsblobprodcus336.vsblob.vsassets.io"
    - "1k9vsblobprodcus379.vsblob.vsassets.io"
    - "1s1vsblobprodcus386.vsblob.vsassets.io"
    - "37bvsblobprodcus311.vsblob.vsassets.io"
    - "37cvsblobprodcus359.vsblob.vsassets.io"
    - "4m6vsblobprodcus384.vsblob.vsassets.io"
    - "4vyvsblobprodcus361.vsblob.vsassets.io"
    - "4zjvsblobprodcus390.vsblob.vsassets.io"
    - "51yvsblobprodcus36.vsblob.vsassets.io"
    - "5dkvsblobprodcus355.vsblob.vsassets.io"
    - "5rqvsblobprodcus385.vsblob.vsassets.io"
    - "7k6vsblobprodcus337.vsblob.vsassets.io"
    - "7tjvsblobprodcus341.vsblob.vsassets.io"
    - "80zvsblobprodcus35.vsblob.vsassets.io"
    - "8xbvsblobprodcus382.vsblob.vsassets.io"
    - "96bvsblobprodcus338.vsblob.vsassets.io"
    - "ajhvsblobprodcus363.vsblob.vsassets.io"
    - "bcnvsblobprodcus378.vsblob.vsassets.io"
    - "builds.dotnet.microsoft.com"
    - "c78vsblobprodcus322.vsblob.vsassets.io"
    - "cflvsblobprodcus383.vsblob.vsassets.io"
    - "ci.dot.net"
    - "ckzvsblobprodcus347.vsblob.vsassets.io"
    - "d0svsblobprodcus381.vsblob.vsassets.io"
    - "data.nuget.org"
    - "dlbvsblobprodcus316.vsblob.vsassets.io"
    - "e7bvsblobprodcus348.vsblob.vsassets.io"
    - "fdpvsblobprodcus345.vsblob.vsassets.io"
    - "frdvsblobprodcus327.vsblob.vsassets.io"
    - "gbsvsblobprodcus365.vsblob.vsassets.io"
    - "h6tvsblobprodcus346.vsblob.vsassets.io"
    - "i1qvsblobprodcus353.vsblob.vsassets.io"
    - "imzvsblobprodcus368.vsblob.vsassets.io"
    - "jd4vsblobprodcus366.vsblob.vsassets.io"
    - "josvsblobprodcus372.vsblob.vsassets.io"
    - "jrqvsblobprodcus343.vsblob.vsassets.io"
    - "k0ivsblobprodcus356.vsblob.vsassets.io"
    - "k4kvsblobprodcus344.vsblob.vsassets.io"
    - "kgfvsblobprodcus314.vsblob.vsassets.io"
    - "kijvsblobprodcus387.vsblob.vsassets.io"
    - "kxqvsblobprodcus376.vsblob.vsassets.io"
    - "l49vsblobprodcus358.vsblob.vsassets.io"
    - "l7avsblobprodcus319.vsblob.vsassets.io"
    - "ljcvsblobprodcus317.vsblob.vsassets.io"
    - "lylvsblobprodcus31.vsblob.vsassets.io"
    - "m16vsblobprodcus374.vsblob.vsassets.io"
    - "m6xvsblobprodcus342.vsblob.vsassets.io"
    - "mfjvsblobprodcus373.vsblob.vsassets.io"
    - "n3kvsblobprodcus335.vsblob.vsassets.io"
    - "o3svsblobprodcus318.vsblob.vsassets.io"
    - "ofvvsblobprodcus315.vsblob.vsassets.io"
    - "pc2vsblobprodcus360.vsblob.vsassets.io"
    - "pdfvsblobprodcus380.vsblob.vsassets.io"
    - "pe3vsblobprodcus354.vsblob.vsassets.io"
    - "pkgs.dev.azure.com"
    - "rcxvsblobprodcus328.vsblob.vsassets.io"
    - "s8mvsblobprodcus38.vsblob.vsassets.io"
    - "se1vsblobprodcus349.vsblob.vsassets.io"
    - "southcentralus0.in.applicationinsights.azure.com"
    - "sqdvsblobprodcus333.vsblob.vsassets.io"
    - "st8vsblobprodcus339.vsblob.vsassets.io"
    - "tphvsblobprodcus375.vsblob.vsassets.io"
    - "u3hvsblobprodcus371.vsblob.vsassets.io"
    - "u6ovsblobprodcus377.vsblob.vsassets.io"
    - "ukkvsblobprodcus352.vsblob.vsassets.io"
    - "uy6vsblobprodcus34.vsblob.vsassets.io"
    - "v53vsblobprodcus320.vsblob.vsassets.io"
    - "vb4vsblobprodcus33.vsblob.vsassets.io"
    - "vwvvsblobprodcus334.vsblob.vsassets.io"
    - "x3yvsblobprodcus370.vsblob.vsassets.io"
    - "xupvsblobprodcus332.vsblob.vsassets.io"
    - "yluvsblobprodcus367.vsblob.vsassets.io"
    - "yttvsblobprodcus357.vsblob.vsassets.io"

See Network Configuration for more information.

Automated by the ResourceLock refactoring workflow. · copilot · auto · 386.8 AIC · ⌖ 17 AIC · ⊞ 12.1K | [History]( · ◷)

…yHelperTests

MSBuildCompatibilityHelperTests mutates MSBuildCompatibilityHelper's
process-wide static caches (s_msBuildVersion, s_supportsMultiline,
s_supportsTerminalLoggerWithExtendedMessages) via reflection and through
its public API. No other test class in the assembly calls
MSBuildCompatibilityHelper, so a class-level [ResourceLock] on a
dedicated const key fully covers the resource while letting this class
run concurrently with the rest of the assembly instead of being
deferred to the sequential tail by the previous [DoNotParallelize].

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings October 8, 2026 05:44

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The lock covers the shared-cache tests while preserving concurrency with unrelated tests.

0 open findings

What changed in this PR

Narrows synchronization in the MSBuild unit tests so unrelated tests can run concurrently while shared caches remain protected.

Changes:

  • Replaces class-level [DoNotParallelize] with [ResourceLock].
  • Adds a named lock key and documents its coverage.
File Description
test/​UnitTests/​Microsoft.Testing.Platform.MSBuild.UnitTests/​MSBuildCompatibilityHelperTests.cs Uses a dedicated resource lock to serialize cache-accessing tests.

🧠 Review effort: Balanced


Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

@Evangelink
Amaury Levé (Evangelink) marked this pull request as ready for review October 8, 2026 07:18
@microsoft-github-policy-service microsoft-github-policy-service Bot added the state/needs-review Awaiting review from the team. label Oct 8, 2026
@github-actions github-actions Bot added state/approved Proposal approved; ready for implementation. and removed state/needs-review Awaiting review from the team. labels Oct 8, 2026
@Evangelink
Amaury Levé (Evangelink) merged commit 3c59d77 into microsoft:main Oct 8, 2026
11 of 12 checks passed
@microsoft-github-policy-service microsoft-github-policy-service Bot removed the state/approved Proposal approved; ready for implementation. label Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants