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

Add support for yaml OSCAL files validation #1091

Merged

Conversation

guyzyl
Copy link
Contributor

@guyzyl guyzyl commented Jan 18, 2022

Add support for yaml OSCAL files validation

Committer Notes

Added support for yaml OSCAL files validation to oscal-content-validatory.py.

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?

Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

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

Thanks for a short and sweet contribution! I think it will depend on the view of @david-waltermire-nist and team, but thus far we had limited expectations of YAML support in our tooling, so I defer to him on whether we want/need it for now.

I also have one question about the library choice from previous experience.

src/utils/util/requirements.txt Outdated Show resolved Hide resolved
guyzyl added a commit to guyzyl/OSCAL that referenced this pull request Jan 19, 2022
This was done to address the concern raised in the PR - usnistgov#1091 (comment)
Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

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

Ok, I finally tested it out. This looks good to merge, @david-waltermire-nist. I am going to probably follow up in Gitter because the code is functional and works, but does indicate some errors in the JSON and Schema validation of official catalogs in usnistgov/oscal-content@a31b484. Will look into that and why it is different from our pipeline tooling with AJV. 🤷

@guyzyl
Copy link
Contributor Author

guyzyl commented Jan 24, 2022

@aj-stein-nist if any more work is needed on this script I'd be more than happy to work on it 🙂

@aj-stein-nist
Copy link
Contributor

@aj-stein-nist if any more work is needed on this script I'd be more than happy to work on it 🙂

Of course, the pinning requirement was simple and I updated in the branch and tested, it all worked. Just wanted to make sure we easily get tracking on specific deps and make sure we get automatic updates, I did similarly for our requirements.txt manifest elsewhere. I hope to get Dave to merge it later today with our upcoming release!

@aj-stein-nist
Copy link
Contributor

@david-waltermire-nist I think we can discuss later but you had asked yesterday afternoon if there were others ready for merge and ready for 1.0.1 release. This was small and points to the relevant branch, so this can probably go in too.

@aj-stein-nist
Copy link
Contributor

Need to rebase this one too.

@aj-stein-nist
Copy link
Contributor

And ... rebased! We're good to go.

@david-waltermire david-waltermire merged commit c2848eb into usnistgov:release-1.0 Jan 26, 2022
@guyzyl guyzyl deleted the add-yaml-support-to-validator branch January 26, 2022 21:28
iMichaela pushed a commit to iMichaela/OSCAL that referenced this pull request Apr 7, 2022
* Add support for yaml OSCAL files validation
* Replace pyyaml library with ruamel.yaml This was done to address the concern raised in the PR - usnistgov#1091 (comment)
* Pin specific versions of PyPI packages.

Co-authored-by: Alexander Stein <[email protected]>
Rene2mt pushed a commit to Rene2mt/OSCAL that referenced this pull request May 17, 2022
* Add support for yaml OSCAL files validation
* Replace pyyaml library with ruamel.yaml This was done to address the concern raised in the PR - usnistgov#1091 (comment)
* Pin specific versions of PyPI packages.

Co-authored-by: Alexander Stein <[email protected]>
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.

3 participants