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 possible Schematron documentation checks #1501

Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/workflow-generate-metaschema-resources.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,24 @@ jobs:
run: |
zip ${{ runner.temp }}/metaschema-artifacts.zip -r xml/schema/*.xsd json/schema/*.json xml/convert/*.xsl json/convert/*.xsl
working-directory: ${{ env.CHECKOUT_PATH }}
- name: Zip Schematron Validation Results for Debugging
if: always()
run: |
zip ${{ runner.temp }}/schematron-validations.zip -r ${{ runner.temp }} build/metaschema/toolchains/xslt-M4/validate/metaschema-composition-check-compiled.xsl
working-directory: ${{ env.CHECKOUT_PATH }}
- uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8
with:
name: schemas-and-converters
path: |
${{ runner.temp }}/metaschema-artifacts.zip
retention-days: 5
- uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8
if: always()
with:
name: schematron-validation-reports
path: |
${{ runner.temp }}/schematron-validations.zip
retention-days: 5
# Store Built Artifacts
# ---------------
- name: Publish Schemas and Converters
Expand Down
2 changes: 1 addition & 1 deletion build/metaschema
Submodule metaschema updated 42 files
+4 −3 schema/xml/metaschema-markup-line.xsd
+10 −17 schema/xml/metaschema-markup-multiline.xsd
+15 −21 schema/xml/metaschema-prose-base.xsd
+25 −28 schema/xml/metaschema.xsd
+3 −1 test-suite/schema-generation/datatypes/readme.md
+0 −49 test-suite/schema-generation/datatypes/target/charstrings_metaschema-jsonschema.json
+0 −49 test-suite/schema-generation/datatypes/target/charstrings_metaschema-xmlschema.xsd
+0 −62 test-suite/schema-generation/datatypes/target/datatypes-date_metaschema-jsonschema.json
+0 −228 test-suite/schema-generation/datatypes/target/datatypes-date_metaschema-xmlschema.xsd
+0 −60 test-suite/schema-generation/datatypes/target/datatypes-datetime-no-tz_metaschema-jsonschema.json
+0 −236 test-suite/schema-generation/datatypes/target/datatypes-datetime-no-tz_metaschema-xmlschema.xsd
+0 −60 test-suite/schema-generation/datatypes/target/datatypes-datetime_metaschema-jsonschema.json
+0 −230 test-suite/schema-generation/datatypes/target/datatypes-datetime_metaschema-xmlschema.xsd
+0 −45 test-suite/schema-generation/datatypes/target/datatypes-numeric_metaschema-jsonschema.json
+0 −235 test-suite/schema-generation/datatypes/target/datatypes-numeric_metaschema-xmlschema.xsd
+0 −101 test-suite/schema-generation/datatypes/target/datatypes-prose_metaschema-jsonschema.json
+0 −101 test-suite/schema-generation/datatypes/target/datatypes-prose_metaschema-xmlschema.xsd
+0 −30 test-suite/schema-generation/datatypes/target/datatypes-token_metaschema-jsonschema.json
+0 −203 test-suite/schema-generation/datatypes/target/datatypes-token_metaschema-xmlschema.xsd
+0 −65 test-suite/schema-generation/datatypes/target/datatypes-uri_metaschema-jsonschema.json
+0 −247 test-suite/schema-generation/datatypes/target/datatypes-uri_metaschema-xmlschema.xsd
+0 −42 test-suite/schema-generation/datatypes/target/datatypes-uuid_metaschema-jsonschema.json
+0 −216 test-suite/schema-generation/datatypes/target/datatypes-uuid_metaschema-xmlschema.xsd
+0 −0 test-suite/schema-generation/dates-times/datatypes-date_metaschema.xml
+0 −0 test-suite/schema-generation/dates-times/datatypes-date_test_fancy_FAIL.xml
+0 −0 test-suite/schema-generation/dates-times/datatypes-date_test_tricky_FAIL.json
+0 −0 test-suite/schema-generation/dates-times/datatypes-date_test_valid_PASS.json
+0 −0 test-suite/schema-generation/dates-times/datatypes-date_test_valid_PASS.xml
+0 −0 test-suite/schema-generation/dates-times/datatypes-datetime-no-tz_json-schema.json
+0 −0 test-suite/schema-generation/dates-times/datatypes-datetime-no-tz_metaschema.xml
+0 −0 test-suite/schema-generation/dates-times/datatypes-datetime-no-tz_test_valid_PASS.json
+13 −0 test-suite/schema-generation/dates-times/datatypes-datetime-notz_test_valid_PASS.xml
+10 −0 test-suite/schema-generation/dates-times/datatypes-datetime-notz_test_various_FAIL.xml
+0 −0 test-suite/schema-generation/dates-times/datatypes-datetime_metaschema.xml
+0 −0 test-suite/schema-generation/dates-times/datatypes-datetime_test_valid_PASS.json
+10 −0 test-suite/schema-generation/dates-times/datatypes-datetime_test_valid_PASS.xml
+10 −0 test-suite/schema-generation/dates-times/datatypes-datetime_test_various_FAIL.xml
+12 −0 test-suite/schema-generation/dates-times/datatypes-datetime_test_working_FAIL.xml
+21 −0 test-suite/schema-generation/dates-times/datatypes-datetime_test_working_PASS.xml
+29 −21 test-suite/schema-generation/unit-tests.xml
+19 −0 test-suite/worked-examples/readme.md
+5 −0 toolchains/xslt-M4/validate/metaschema-composition-check.sch
2 changes: 1 addition & 1 deletion src/metaschema/oscal_control-common_metaschema.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<!ENTITY allowed-values-control-group-property-name SYSTEM "./shared-constraints/allowed-values-control-group-property-name.ent">
]>
<?xml-stylesheet type="text/css" href="metaschema-author.css"?>
<METASCHEMA xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<METASCHEMA
xmlns="http://csrc.nist.gov/ns/oscal/metaschema/1.0" abstract="yes">
<schema-name>OSCAL Control Catalog Format -- Common Models</schema-name>
<schema-version>1.0.4</schema-version>
Expand Down
14 changes: 5 additions & 9 deletions src/metaschema/oscal_ssp_metaschema.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<!-- ############################################## -->
<define-assembly name="system-security-plan">
<formal-name>System Security Plan (SSP)</formal-name>
<description>A system security plan, such as those described in NIST SP 800-18</description>
<description>A system security plan, such as those described in NIST SP 800-18.</description>
<root-name>system-security-plan</root-name>
<define-flag name="uuid" as-type="uuid" required="yes">
<formal-name>System Security Plan Universally Unique Identifier</formal-name>
Expand Down Expand Up @@ -106,8 +106,7 @@
<field ref="date-authorized"/>
<define-field name="security-sensitivity-level" min-occurs="1">
<formal-name>Security Sensitivity Level</formal-name>
<description>The overall information system sensitivity categorization, such as defined by <a href="https://doi.org/10.6028/NIST.FIPS.199">FIPS-199</a>.
</description>
<description>The overall information system sensitivity categorization, such as defined by <a href="https://doi.org/10.6028/NIST.FIPS.199">FIPS-199</a>.</description>
<remarks>
<p>Often, organizations require the security sensitivity level to correspond with the highest confidentiality, integrity, or availability level identified by <code>security-impact-level</code>.
</p>
Expand Down Expand Up @@ -181,8 +180,7 @@
</define-assembly>
<define-assembly name="system-information">
<formal-name>System Information</formal-name>
<description>Contains details about all information types that are stored, processed, or transmitted by the system, such as privacy information, and those defined in <a href="https://doi.org/10.6028/NIST.SP.800-60v2r1">NIST SP 800-60</a>.
</description>
<description>Contains details about all information types that are stored, processed, or transmitted by the system, such as privacy information, and those defined in <a href="https://doi.org/10.6028/NIST.SP.800-60v2r1">NIST SP 800-60</a>.</description>
<model>
<assembly ref="property" max-occurs="unbounded">
<group-as name="props" in-json="ARRAY"/>
Expand All @@ -192,8 +190,7 @@
</assembly>
<define-assembly name="information-type" min-occurs="1" max-occurs="unbounded">
<formal-name>Information Type</formal-name>
<description>Contains details about one information type that is stored, processed, or transmitted by the system, such as privacy information, and those defined in <a href="https://doi.org/10.6028/NIST.SP.800-60v2r1">NIST SP 800-60</a>.
</description>
<description>Contains details about one information type that is stored, processed, or transmitted by the system, such as privacy information, and those defined in <a href="https://doi.org/10.6028/NIST.SP.800-60v2r1">NIST SP 800-60</a>.</description>
<group-as name="information-types" in-json="ARRAY"/>
<define-flag name="uuid" as-type="uuid">
<formal-name>Information Type Universally Unique Identifier</formal-name>
Expand Down Expand Up @@ -535,8 +532,7 @@
</assembly>
<define-assembly name="leveraged-authorization" max-occurs="unbounded">
<formal-name>Leveraged Authorization</formal-name>
<description>A description of another authorized system from which this system inherits capabilities that satisfy security requirements. Another term for this concept is a <em>common control provider</em>.
</description>
<description>A description of another authorized system from which this system inherits capabilities that satisfy security requirements. Another term for this concept is a <em>common control provider</em>.</description>
<group-as name="leveraged-authorizations" in-json="ARRAY"/>
<define-flag name="uuid" as-type="uuid" required="yes">
<formal-name>Leveraged Authorization Universally Unique Identifier</formal-name>
Expand Down