feat(assertions): support custom expect message#3309
Merged
Conversation
Adds an optional `message` argument to `Expect(...)` overloads (locator, page, API response). When the assertion fails, the message is prepended to the thrown PlaywrightException, providing extra context in test reports — the same pattern as the JS/Python `expect(thing, "msg")` form. Wired through Assertions.Expect, the four PlaywrightTest harnesses (NUnit, MSTest, Xunit, Xunit.v3; MSTest.v4 reuses MSTest sources), AssertionsBase / LocatorAssertions / PageAssertions / APIResponseAssertions, and propagated through `.Not`. Fixes microsoft#2161
yury-s
approved these changes
May 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
string messageargument toExpect(locator)/Expect(page)/Expect(response)(bothMicrosoft.Playwright.Assertionsand the fourPlaywrightTestharnesses — NUnit / MSTest / Xunit / Xunit.v3; MSTest.v4 inherits via shared sources).PlaywrightException, mirroring the JS/Pythonexpect(thing, "msg")behavior..Not.Fixes #2161