-
Notifications
You must be signed in to change notification settings - Fork 16
Refactor archiver tests #1542
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
Refactor archiver tests #1542
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
* collect information about each file together * only compute expected data once * name files with the corner case they test
dshemetov
approved these changes
Mar 4, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this, definitely overdue! Few minor suggestions, but overall looks great 🚀
krivard
commented
Mar 4, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this was excellent, thank you
Co-authored-by: Dmitry Shemetov <[email protected]>
dshemetov
reviewed
Mar 5, 2022
dshemetov
reviewed
Mar 5, 2022
dshemetov
reviewed
Mar 5, 2022
dshemetov
reviewed
Mar 5, 2022
Co-authored-by: Dmitry Shemetov <[email protected]>
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.
Based on #1522
Description
Type of change (bug fix, new feature, etc), brief description, and motivation for these changes.
Archiver tests are a twisty maze of numbered csv files, each file testing a different corner case. The before, after, and expected .diff content is defined in different places in the code, sometimes multiple times. This approach is difficult to interpret without spending extensive time with the code, making it (1) difficult to update, (2) difficult to review, and (3) easy for errors or inconsistencies to creep in.
This PR refactors the archiver tests to:
Changelog
Itemize code/test/documentation changes and files added/removed.
CSV_BEFORE
,CSV_AFTER
, variousexpected_csv[0-9]_diff
definitions merged into a singleCSVS
dictEXPECTEDS
storing the filenames expected in various locations at different stages of archivediffingCSVS
dict, with an assert check wherever changes to the test cases must be manually propagated toEXPECTEDS
CSV_BEFORE
etc toCSVS
andEXPECTEDS
Fixes