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

test minor artifact changes for backward + forward compatability #10066

Merged
merged 5 commits into from
May 6, 2024

Conversation

MichelleArk
Copy link
Contributor

@MichelleArk MichelleArk commented Apr 30, 2024

resolves #9615

Problem

mashumaro (and so our BaseResource) class has support for forward and backward-compatible changes:

  1. adding a field with a default value
  2. removing a field with a default value

as in -- these changes are possible within a minor schema evolution, and would not break serialization / deserialization

However, if we are going to rely on these guaruntees we ought to test and document them!

Solution

Add unit tests for forward and backward compatability of minor schema evolutions, and update development docs to be more thorough.

Checklist

  • I have read the contributing guide and understand what's expected of me
  • I have run this code in development and it appears to resolve the stated issue
  • This PR includes tests, or tests are not required/relevant for this PR
  • This PR has no interface changes (e.g. macros, cli, logs, json artifacts, config files, adapter interface, etc) or this PR has already received feedback and approval from Product or DX
  • This PR includes type annotations for new and modified functions

@cla-bot cla-bot bot added the cla:yes label Apr 30, 2024
Copy link

codecov bot commented Apr 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.19%. Comparing base (35062ca) to head (3b0041f).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #10066      +/-   ##
==========================================
- Coverage   88.20%   88.19%   -0.01%     
==========================================
  Files         181      181              
  Lines       22665    22665              
==========================================
- Hits        19991    19989       -2     
- Misses       2674     2676       +2     
Flag Coverage Δ
integration 85.56% <ø> (ø)
unit 62.31% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MichelleArk MichelleArk added the Skip Changelog Skips GHA to check for changelog file label May 1, 2024
@MichelleArk MichelleArk marked this pull request as ready for review May 1, 2024 17:22
@MichelleArk MichelleArk requested a review from a team as a code owner May 1, 2024 17:22
@MichelleArk MichelleArk merged commit 3e8f2f1 into main May 6, 2024
64 checks passed
@MichelleArk MichelleArk deleted the unit-test-artifacts branch May 6, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes Skip Changelog Skips GHA to check for changelog file
Projects
None yet
2 participants