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

Update OSCAL schemas to latest (M4) Metaschema models #724

Closed
3 tasks
wendellpiez opened this issue Aug 4, 2020 · 6 comments · Fixed by #758
Closed
3 tasks

Update OSCAL schemas to latest (M4) Metaschema models #724

wendellpiez opened this issue Aug 4, 2020 · 6 comments · Fixed by #758
Assignees
Labels
closable enhancement Scope: Modeling Issues targeted at development of OSCAL formats User Story

Comments

@wendellpiez
Copy link
Contributor

User Story:

The new Metaschema implementation (XSLT-M4) brings new features and capabilities, but current OSCAL schemas in the OSCAL repo are not valid to its models in several respects (for example, syntax of local definitions).

Updated versions of all the OSCAL schemas have been produced in the Metaschema repo, here:

https://github.com/wendellpiez/metaschema/tree/issue39-pipeline-refactor/test-suite/oscal

These can serve as a basis for further editing.

Goals:

The main OSCAL metaschemas in the OSCAL repo should be updated. While reflecting new syntax and working with new tools, the new metaschemas should be functionally equivalent (describe the same models) as the schemas they replace, and any data valid to the Milestone 3 model should still be valid.

The refreshed metaschemas must run successfully through the (new) XSLT-M4 infrastructure, validating to its copies of Metaschema XSD and Schematron, and producing useful outputs when run through production pipelines.

All current OSCAL schemas and schema modules must be accounted for.

Dependencies:

Stable scripting from CL and under CI/CD, to run all necessary integrations and validation checks against XSLT-M4.

Also, the Metaschema branch to be targeted as a submodule of an OSCAL branch must be identified so correct (XSLT-M4) resources are available, if not as usnistgov/metaschema/master then something else.

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.
@brian-ruf
Copy link
Contributor

Status 3-Sept-2020

This is dependent on the work in issue #721, which is just starting.

@wendellpiez
Copy link
Contributor Author

Update Sep 24

@david-waltermire-nist has been making progress on this Issue, not only confirming M4 syntax but enhancing and improving the metaschemas, starting with the metadata metaschema module.

@brian-ruf
Copy link
Contributor

brian-ruf commented Oct 8, 2020

Status 8-Oct-2020

Significant progress has been made.
@david-waltermire-nist is focused on catalog, profile, an implementation layers including common models (metadata and back-matter).
@brianrufgsa is focused on assessment and assessment results layers. (80% transitioned; however, a second pass is needed to focus on constraints)

@brian-ruf
Copy link
Contributor

Status 15-Oct-2020

Completed initial pass on assessment and assessment results layers.
Compiled schemas and using them to test/adjust sample files.

Working out some issues, especially where inheriting from other metaschemas. Working toward fully valid files by making only intended file changes and ensuring the schemas still validate the files.

@brian-ruf
Copy link
Contributor

Status 22-Oct-2020

Made some progress validating existing sample files against sample files. Need to make another pass now that other aspects of the metaschema are updated, plus evaluate additional opportunities to add constraints.

@david-waltermire david-waltermire added this to the OSCAL 1.0.0 RC 1 milestone Oct 30, 2020
@david-waltermire david-waltermire linked a pull request Oct 30, 2020 that will close this issue
30 tasks
@david-waltermire
Copy link
Contributor

This work is complete in PR #758. This issue will be closed when the PR is processed.

@david-waltermire david-waltermire added closable Scope: Modeling Issues targeted at development of OSCAL formats labels Nov 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
closable enhancement Scope: Modeling Issues targeted at development of OSCAL formats User Story
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants