Test: Add snapshot test for changelog formatting #34049
Merged
Conversation
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
gziolo
added
the
[Type] Automated Testing
7 tasks
|
Size Change: 0 B Total Size: 1.03 MB ℹ️ View Unchanged
|
getdave
approved these changes
Aug 13, 2021
Contributor
getdave
left a comment
getdave
left a comment
There was a problem hiding this comment.
This is looking good and a great example of when using snapshots is actually helpful.
My only concern was whether you'd modified any of the code that builds the changelog as we're making quite a few changes in various PRs that are about to be merged into trunk.
I wonder - by extracting the formatChangelog will you have lost some changes that have been merged into trunk since this PR was created? I noticed some inconsistencies so it makes me think that yes this will be the case.
I think (if you aren't already planning to do so) it would be good to copy/paste the changelog code from trunk into your formatChangelog once #34042 has been merged. That will ensure everything is up to date and we don't lose any changes.
Thanks again for adding tests 🥇
Member
Author
Contributor
Contributor
|
To be clear you should expect to see:
|
gziolo
force-pushed
the
update/test-changelog-format
branch
from
048810e to
7dc5d34
Compare
Member
Author
|
7dc5d34 - it looks like all the changes are applied correctly now. The diff in the snapshot is very simple to process and gives instant confirmation that the output looks as expected. |
Contributor
Looks good to go 🚢 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
A follow-up to my comment #34042 (comment):
The idea is very simple. I executed:
npm run changelog -- --milestone="Gutenberg 11.3"and saved the result from
fetchAllPullRequestscall as JSON.I extracted all processing logic to
formatChangelogfunction. The test uses the saved fixture (quite large) to verify the generated output string using the stored snapshot that should be good enough for visual verification.How has this been tested?
Screenshots
Despite the huge size of the fixture with the response from GitHub it seems to be pretty fast.
Types of changes
New test.
Checklist:
*.native.jsfiles for terms that need renaming or removal).