feat: Refactor JSON report comparison for better diffing in unit-tests. #1352
Conversation
This file contains 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
|
✅ Rule acceptance tests passed. |
davidgamez
approved these changes
Mar 13, 2023
...t-comparator/src/test/java/org/mobilitydata/gtfsvalidator/outputcomparator/cli/MainTest.java
Show resolved
Hide resolved
ryon
pushed a commit
to JarvusInnovations/gtfs-validator
that referenced
this pull request
Apr 1, 2023
…s. (MobilityData#1352) * Refactor JSON report comparison for better diffing in unit-tests. * Rename test resources for clarity.
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.
Refactor JSON test artifact checks in the acceptance test
output-comparisontool to make it easier to understand diffs when tests fail or or a test is updated. Currently, the JSON output report is tested in the unit-test as a single-line, non-pretty-printed string, which makes it really hard to tell what changed when the test fails or is updated. This PR refactors the test to check a pretty-printed version of the JSON output for better diffing. The expected content of the report is stored as a resource in the test/resources directory, since inlining a multi-line string is still pretty ugly in Java.This refactor is in support of issue #1349 where some changes to the output comparator are coming in a follow-up PR.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle testto make sure you didn't break anything