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

Validate before conversion #217

Open
5 tasks
aj-stein-nist opened this issue Oct 27, 2023 · 1 comment
Open
5 tasks

Validate before conversion #217

aj-stein-nist opened this issue Oct 27, 2023 · 1 comment
Labels
enhancement New feature or request
Milestone

Comments

@aj-stein-nist
Copy link
Collaborator

User Story:

As a developer or engineer using oscal-cli, in order to ensure that invalid (but well-formed) OSCAL content is not converted between raw data formats, I would like to be able to optionally validate before conversion, and warn if converting invalid content even if well-formed.

Background: While completing integration tests to smoke test all subcommands for #178, I determined that in some cases the CLI will convert between XML and JSON and YAML when data is well-formed (valid JSON or XML or YAML), even if it does not conform with the schema and Metaschema-constraint requirements for an instance of a given model.

Goals:

  • Make validation before conversion the default processing approach (I am open to warning or halting conversion)
  • Implement a command-line flag to enforce validation before conversion (I would like to be able to disable this for performance reasons for very large OSCAL document instances)

Dependencies:

N/A

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated.
  • 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.
@aj-stein-nist aj-stein-nist added the enhancement New feature or request label Oct 27, 2023
@aj-stein-nist aj-stein-nist moved this from Needs Triage to Todo in NIST OSCAL Work Board Jan 31, 2024
@aj-stein-nist
Copy link
Collaborator Author

I will be able to handle this after an upcoming minor release, moved status from Needs Triage to To Do.

@aj-stein-nist aj-stein-nist modified the milestones: Future, Next Feb 1, 2024
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
Status: Todo
Development

No branches or pull requests

1 participant