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

Custom validation violation handling #19

Closed
3 tasks
Tracked by #1282
david-waltermire opened this issue May 10, 2022 · 2 comments
Closed
3 tasks
Tracked by #1282

Custom validation violation handling #19

david-waltermire opened this issue May 10, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@david-waltermire
Copy link
Collaborator

User Story:

As an OSCAL developer, I would like to be able to handle violations when using the DESERIALIZE_VALIDATE_CONSTRAINTS feature when deserializing a node item. For example when loading a profile to resolve (as per test), it currently will log an error if the source file has violations . But the returned OscalInstance does not contain any information regarding any violations.

Goals:

  • The information regarding existence of violations is returned as either an exception or included in the returned context.

Dependencies:

None

Acceptance Criteria

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@david-waltermire david-waltermire added the enhancement New feature or request label May 10, 2022
@david-waltermire david-waltermire self-assigned this May 10, 2022
@david-waltermire
Copy link
Collaborator Author

david-waltermire commented May 10, 2022

It would be useful to clarify what the DESERIALIZE_VALIDATE_CONSTRAINTS feature does in the Javadocs.

It would also be useful to force a failure if the file is found to be invalid. This could be handled by a new feature on the document loader/deserializer. Consider making this feature the default behavior.

@david-waltermire
Copy link
Collaborator Author

Resolved in usnistgov/metaschema-java#66.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant