-
Notifications
You must be signed in to change notification settings - Fork 453
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
Event fingerprints and comparison #3165
Merged
Merged
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
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.
The
EventsUtils.compareEventsFiles
method is often used within tests to check if a simulation result is still as expected or if there is a potential regression.However, when testing a full scenario, the generated event files can already so big that they should not be checked into git.
Simply storing and comparing the hash of an event file will often times not be sufficient, because event files could be semantically the same, but produce slightly different event files. For example, events at the same time step can occur in any order, as well as attributes within an event.
For this reason, this PR introduces an event fingerprint file format, which contains very reduced information of an event file, but still allows for checking the same type of differences that the full event comparison will return. I.e. different timestamps, different number of events, etc.
In our test scenario, a ~16MB compressed event files results in a ~120kb compressed fingerprint file.
The new functionality should be used via
EventsUtils.createAndCompareEventsFingerprint
orEventsUtils.assertEqualEventsFingerprint
Also, many thanks to @zlukich for helping with the implementation.