tests(mocha): fix snapshot expectations in retries - #15735
Merged
Conversation
adamraine
commented
Jan 8, 2024
| "largest-contentful-paint", | ||
| "largest-contentful-paint-element", | ||
| "layout-shift-elements", | ||
| "layout-shifts", |
Contributor
Author
There was a problem hiding this comment.
These snapshot updates should have been caught in #15703
Confirmed they are caught here now:
https://github.com/GoogleChrome/lighthouse/actions/runs/7451657749/job/20273235889?pr=15735
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
3 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.
Noticed that snapshot tests were passing where they should be failing in CI (#15730 (comment))
If a test is retried, the snapshot expectation indices will start where the previous attempt left off. This leads to
jest-snapshottreating the second attempt as a "new" snapshot which we automatically treat as passing because of theupdateSnapshot: 'new'setting.This PR uses
updateSnapshot: 'none'by default so that CI will never accidentally pass. This means we have to use-uto set an initial snapshot for new tests, but that seems like a small price to pay.However, mocha will only report the last failure attempt if a test is retried, which will now by a "snapshot does not exist" failure instead of a helpful snapshot diff. To fix this, this PR also resets the snapshot state between each test.