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

Removed collapsible tests #53

Conversation

david-waltermire
Copy link
Contributor

@david-waltermire david-waltermire commented Dec 6, 2024

Committer Notes

This feature is no longer supported in Metaschema 1.0.0+. It was removed intentionally in usnistgov/metaschema#405 based on community feedback.

This PR resolves usnistgov/metaschema#774 and #36.

It also obviates the need for usnistgov/metaschema#775 and #37, which should be closed.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you squashed any non-relevant commits and commit messages? [instructions]
  • Do all automated CI/CD checks pass?

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all website](https://pages.nist.gov/metaschema) and readme documentation affected by the changes you made? Changes to the website can be made in the website/content directory of your branch.

Summary by CodeRabbit

  • Chores
    • Deleted several obsolete metaschema files related to collapsible components, including XML and JSON Schema definitions, to streamline the testing framework.

Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request involves the deletion of several files related to the collapsible metaschema used in unit testing. These files include XML and JSON representations of the metaschema and associated test cases. The changes do not alter any declarations of exported or public entities, but they remove definitions and test cases that were previously utilized for validating the collapsible components within the schema generation context.

Changes

File Change Summary
test-suite/schema-generation/collapsible/collapsible-no-op_metaschema.xml Deleted file containing XML representation of a collapsible metaschema for unit testing.
test-suite/schema-generation/collapsible/collapsible_metaschema.xml Deleted file defining a collapsible metaschema in XML format for unit testing.
test-suite/schema-generation/collapsible/collapsible_test_multiple_PASS.json Deleted file containing JSON structure for a test case with multiple values for a collapsible component.
test-suite/schema-generation/collapsible/collapsible_test_singleton_PASS.json Deleted file containing JSON structure for a test case with a single value for a collapsible component.
test-suite/schema-generation/collapsible/target/collapsible-no-op_metaschema-jsonschema.json Deleted file with JSON Schema definition for a collapsible no-op metaschema unit test.
test-suite/schema-generation/collapsible/target/collapsible-no-op_metaschema-xmlschema.xsd Deleted XML Schema Definition (XSD) file for a collapsible no-op metaschema.
test-suite/schema-generation/collapsible/target/collapsible_metaschema-jsonschema.json Deleted file with JSON Schema definition for a collapsible metaschema used in unit testing.
test-suite/schema-generation/collapsible/target/collapsible_metaschema-xmlschema.xsd Deleted XML Schema Definition (XSD) file for a collapsible metaschema.

Assessment against linked issues

Objective Addressed Explanation
Update GlobalFieldDefinitionType to support collapsible (Issue #774) The changes do not address the missing definition for collapsible.

🐰 In the meadow, where changes bloom,
Old files vanish, making room.
Collapsible dreams, now set aside,
A new path awaits, with hope as our guide.
With every hop, we’ll find our way,
To brighter schemas, come what may! 🌼


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@david-waltermire
Copy link
Contributor Author

@ronaldtse FYI

@aj-stein-gsa aj-stein-gsa force-pushed the feature/remove-collapsible-tests branch from b9cee5f to e13698c Compare December 11, 2024 14:28
@aj-stein-gsa aj-stein-gsa merged commit 2ba1fad into metaschema-framework:develop Dec 11, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
2 participants