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.

Sign up for GitHub

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

Jump to bottom

Improve backward-compatibility testing #546

Merged
merged 25 commits into from
Jul 25, 2023
Merged

Improve backward-compatibility testing #546

merged 25 commits into from
Jul 25, 2023

Conversation

westse
Copy link
Contributor

@westse westse commented Jul 18, 2023 •
edited by joschi
Loading

  • 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

westse added 23 commits July 10, 2023 10:49
@westse
Test utility assertions
f848a0a
@westse
Compatibility test Header
268a391
@westse
Compatibility test Headers
de09f5b
@westse
Compatibility test MaxLength
91aa0eb
@westse
Compatibility test NumericRange
50be2cd
@westse
Compatibility test OneOf
d08dc29
@westse
Compatibility test OpenApi Endpoints
7f6e632
@westse
Compatibility test Operation
1252204
@westse
Compatibility test Parameters
47c7e74
@westse
Compatibility test Path
6c3c528
@westse
Compatibility test Paths
19750fc
@westse
Compatibility test ReadOnly
c1f676b
@westse
Compatibility test RequestBody
33c37ab
@westse
Compatibility test SecurityRequirements
07ec48f
@westse
Compatibility test SecurityScheme
30dff2a
@westse
Compatibility test WriteOnly
bbc392a
@westse
Compatibility test ApiResponse
068283d 
- Remove redundant ApiResponseDiffTest. Comment regarding original issue retained.
@westse
Compatibility test Content
ae29b0d
@westse
Compatibility test Enum
cc99ba2
@westse
Compatibility test OauthFlow
fc0ab48
@westse
Compatibility test Required
5a8456c
@westse
Compatibility test Schema
4bdcece
@westse
Remove redundant backward compatibility tests
2f8bdc6 
- testApiAdded() superseded by PathsBCTest.changedButCompatible().
- testApiMissing() superseded by PathsBCTest.decreased().
- testApiChangedOperationAdded() superseded by PathBCTest.changedButCompatible().
- testApiChangedOperationMissing() superseded by PathBCTest.opsDecreased().
- testApiOperationChanged() superseded by EnumBCTest and MaxLengthBCTest.
- testApiReadWriteOnlyPropertiesChanged() superseded by WriteOnlyBCTest.
@westse westse force-pushed the backcompat-tests branch from 6b9c32c to 2f8bdc6 Compare July 19, 2023 20:25
This was referenced Jul 21, 2023
Closed
Merged
@joschi joschi self-assigned this Jul 25, 2023
@joschi joschi added this to the 2.1.0 milestone Jul 25, 2023
joschi
joschi approved these changes Jul 25, 2023
View reviewed changes
Copy link
Contributor

@joschi joschi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@westse Wow, awesome! Thank you very much for this extensive contribution! ❤️

@joschi joschi changed the title Fix #545 Improve backward-compatibility testing Improve backward-compatibility testing Jul 25, 2023
@joschi joschi merged commit 5a54a6a into OpenAPITools:master Jul 25, 2023
@westse westse deleted the backcompat-tests branch July 26, 2023 22:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joschi joschi joschi approved these changes

Assignees

@joschi joschi

Labels
enhancement
Projects
None yet
Milestone
2.1.0
Development

Successfully merging this pull request may close these issues.

Backward-compatibility test coverage
2 participants
@westse @joschi