Skip to content
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 19 commits into from
Mar 18, 2024
Merged

Event fingerprints and comparison #3165

merged 19 commits into from
Mar 18, 2024

Conversation

rakow
Copy link
Contributor

@rakow rakow commented Mar 13, 2024

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 or EventsUtils.assertEqualEventsFingerprint

Also, many thanks to @zlukich for helping with the implementation.

@rakow rakow merged commit 95bdede into matsim-org:master Mar 18, 2024
46 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant