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

Consider whether ComparisonReports need to include a ComparisonResult for all differences, or just the first. #4

Open
tgregg opened this issue Nov 8, 2019 · 2 comments

Comments

@tgregg
Copy link
Contributor

tgregg commented Nov 8, 2019

The documentation implies that ComparisonResults should be generated for all differences. It's not clear that this provides much benefit, and risks adding complexity to the implementations and polluting the ComparisonReport.

Once a decision is made, the documentation should be updated to be explicit, and implementations updated as necessary.

ion-c's CLI, for example, only includes the first difference in its ComparisonReport, allowing it to short-circuit on the first difference.

@wesboyt
Copy link

wesboyt commented Nov 8, 2019

+1 for short circuiting.

@tgregg
Copy link
Contributor Author

tgregg commented Nov 8, 2019

Reporting on all differences would really just be for human consumption, because all comparison reports generated by the CLIs for use by ion-test-driver are expected to be empty.

The benefit would be that such a human could view and fix all of the comparison violations at once without having to re-run the driver. But I don't think this is a big enough benefit to justify complicating the implementation and potentially increasing the time the tests take to run.

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

No branches or pull requests

2 participants