Add model version testing section to documentation #168453
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
pgayvallet
added
Team:Core
|
Pinging @elastic/kibana-core (Team:Core) |
afharo
approved these changes
Oct 10, 2023
Comment on lines
914
to
938
| describe('Model version 2', () => { | ||
| it('properly backfill the expected fields when converting from v1 to v2', () => { | ||
| const obj = createSomeSavedObject(); | ||
|
|
||
| const migrated = migrator.migrate({ | ||
| document: obj, | ||
| fromVersion: 1, | ||
| toVersion: 2, | ||
| }); | ||
|
|
||
| expect(migrated.properties).toEqual(myExpectedProperties); | ||
| }); | ||
|
|
||
| it('properly removes the expected fields when converting from v2 to v1', () => { | ||
| const obj = createSomeSavedObject(); | ||
|
|
||
| const migrated = migrator.migrate({ | ||
| document: obj, | ||
| fromVersion: 2, | ||
| toVersion: 1, | ||
| }); | ||
|
|
||
| expect(migrated.properties).toEqual(myExpectedProperties); | ||
| }); | ||
| }); |
There was a problem hiding this comment.
For best practices, should we recommend having a global myExpectedProperties for each version so that we can test symmetric migrations (when possible)
There was a problem hiding this comment.
I'd say it's probably a developer's preference? e.g I usually use different documents / attributes between different tests (just to increase the potential branch coverage), so I think I would be using different attributes when testing the up and down parts of the migration 😄
dej611
pushed a commit
to dej611/kibana
that referenced
this pull request
Oct 17, 2023
## Summary Follow-up of elastic#167501 and elastic#167861 Add section in the model version documentation about testing plan
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.
Summary
Follow-up of #167501 and #167861
Add section in the model version documentation about testing plan