Skip to content

Backward-compatibility test coverage #545

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

Closed
westse opened this issue Jul 18, 2023 · 0 comments · Fixed by #546
Closed

Backward-compatibility test coverage #545

westse opened this issue Jul 18, 2023 · 0 comments · Fixed by #546
Assignees
Milestone

Comments

@westse
Copy link
Contributor

westse commented Jul 18, 2023

Coverage is currently very light. Improvement here will enable future refactors to be made with confidence that no unintended regressions are being introduced. Additionally the improved testing will act as executable documentation, which in turn will improve adoption, contribution, etc

@joschi joschi added this to the 2.1.0 milestone Jul 25, 2023
joschi pushed a commit that referenced this issue Jul 25, 2023
- Attempts to be exhaustive on backward-compatibility coverage to raise confidence that future refactors will not introduce unintended regressions.
- Each incompatible condition is tested separately by comparing two spec files where the only difference is that fine-grained incompatible condition.
- In some cases the current behavior appears incorrect. Tests are still added for these to avoid unintended regression, but are given TODO comments for later follow-up.
- Pre-existing tests have been removed if they are redundant to avoid confusion and to follow the convention.

Closes #545
joschi pushed a commit that referenced this issue Dec 16, 2023
config-file and config-prop CLI options

- Gives user fine-grained control of what constitutes an incompatibile change.

Maven plugin config parameters

- configFiles param for a separate yaml config file Corresponds to CLI --config-file option.
- configProps param for specifying config props in pom.xml. Corresponds to CLI --config-prop option.
- OpenApiDiffMojoTest updated to verify parameters work.

Relies on recent exhaustive testing of incompatible checks to ensure no regressions (see #545).

Fix #551
Fix #550
Fix #303
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants