Skip to content

Quarantine OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant #63074

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.

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

Merged
merged 3 commits into from
Aug 3, 2025

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 3, 2025

The test OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant has been failing due to a mismatch between the received and verified OpenAPI document JSON output. This test uses the Verify framework to ensure the localized OpenAPI document output remains consistent, but recent changes have caused the output to differ from the expected snapshot.

To prevent this failing test from blocking builds while a proper fix is being developed, this PR quarantines the test by adding the [QuarantinedTest] attribute with a reference to the tracking issue.

The quarantined test will:

  • Continue to run and report its status
  • Be marked with the Quarantined=true trait for filtering
  • Not cause build failures when it fails
  • Remain visible to developers for monitoring

This approach follows the established pattern in the repository for handling flaky or temporarily failing tests while preserving test visibility and allowing proper investigation and resolution.

Fixes #63073.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@Copilot Copilot AI changed the title [WIP] Quarantine OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant Quarantine OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant Aug 3, 2025
@Copilot Copilot AI requested a review from captainsafia August 3, 2025 01:18
Copilot finished work on behalf of captainsafia August 3, 2025 01:18
@captainsafia captainsafia marked this pull request as ready for review August 3, 2025 04:45
@Copilot Copilot AI review requested due to automatic review settings August 3, 2025 04:45
@captainsafia captainsafia requested a review from a team as a code owner August 3, 2025 04:45
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR quarantines a failing test VerifyOpenApiDocumentIsInvariant to prevent it from blocking builds while a proper fix is being developed. The test has been experiencing failures due to mismatched OpenAPI document JSON output compared to expected snapshots.

  • Adds [QuarantinedTest] attribute to the failing test with a reference to tracking issue #63073
  • Maintains test visibility and execution while preventing build failures
  • Follows established repository patterns for handling temporarily failing tests

@martincostello
Copy link
Member

#63077 should fix this without the need to quarantine.

@JamesNK JamesNK merged commit 4069504 into main Aug 3, 2025
30 checks passed
@JamesNK JamesNK deleted the copilot/fix-63073 branch August 3, 2025 10:35
@dotnet-policy-service dotnet-policy-service bot added this to the 10.0-rc1 milestone Aug 3, 2025
@JamesNK
Copy link
Member

JamesNK commented Aug 3, 2025

#63077 should fix this without the need to quarantine.

Policy is we quarantine then check to ensure the test is reliably fixed 30 days later.

@martincostello
Copy link
Member

martincostello commented Aug 3, 2025

It was just an issue caused by a PR changing the same file not being up to the subsequently merged PR, it was broken not flakey. The referenced PR fixes the test.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Quarantine OpenApiDocumentLocalizationTests.VerifyOpenApiDocumentIsInvariant
4 participants