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

Fix issues with archive_catalog marked keywords not being required #505

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

WilliamJamieson
Copy link
Collaborator

@WilliamJamieson WilliamJamieson commented Nov 11, 2024

Closes #502
Closes #503

In order to walk the schemas to find archive_catalog information, a valid AsdfFile object must exist satisfying those schemas. Thus in order to discover this metadata, all those properties must be present meaning that they must be required by the schemas.

This PR adds a test to check that archive_catalog (and sdf) force the keyword to be required. Moreover, this PR fixes all the failures detected by this process.

Tasks

  • Update or add relevant rad tests.
  • Update relevant docstrings and / or docs/ page.
  • Does this PR change any schema files?
    • Schema changes were discussed at RAD Review Board meeting.
  • Does this PR change any API used downstream? (If not, label with no-changelog-entry-needed.)
News fragment change types:
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: fixes an issue
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.misc.rst: infrastructure or miscellaneous change

Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.05%. Comparing base (af9de57) to head (1bebd16).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #505      +/-   ##
==========================================
+ Coverage   95.81%   96.05%   +0.23%     
==========================================
  Files           4        4              
  Lines         215      228      +13     
==========================================
+ Hits          206      219      +13     
  Misses          9        9              

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

Copy link
Collaborator

@schlafly schlafly left a comment

Choose a reason for hiding this comment

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

Thanks. It's good to see that sw_version and context_used were the most important problems here.

I don't think we want to touch the FPS & TVAC schemas. I don't actually know if those are affected by the "required" changes but if one of those fields were left out, we don't want to invalidate those files now; those schemas are fixed.

For the changes to the non-frozen schemas, that looks possibly right to me, except that inverse_linearity will never be set in practice and probably should not have been assigned an archive_catalog. I don't know well enough if we always set all of those keywords. Let's not merge this for the upcoming release this week.

But it's great to see that the two sw_version and context_used are the only things that got missed in the intermediate release, thanks!

@WilliamJamieson WilliamJamieson force-pushed the bugfix/schema_info_required branch from 1bebd16 to 5dac4b3 Compare November 25, 2024 19:44
Copy link
Collaborator

@PaulHuwe PaulHuwe left a comment

Choose a reason for hiding this comment

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

LGTM - I will approve once the FPS & TVAC changes are removed.

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

Successfully merging this pull request may close these issues.

Require Keywords With archive_catalog Check CRDS Keywords Not Required
3 participants