Skip to content

Commit

Permalink
Fix JSON Schema generation for #240 and add tests.
Browse files Browse the repository at this point in the history
  • Loading branch information
@aj-stein-nist
aj-stein-nist committed Dec 28, 2022
1 parent a7873c7 commit 71233f4
Show file tree
Hide file tree
Showing 5 changed files with 733 additions and 16 deletions.
157 changes: 157 additions & 0 deletions test-suite/metaschema-xspec/json-schema-gen/json-schema-gen.xspec
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- autogenerated 2021-12-14T16:02:57.305-05:00 following model in example-set.xspec-->
<x:description xmlns:x="http://www.jenitennison.com/xslt/xspec"
xmlns:m="http://csrc.nist.gov/ns/oscal/metaschema/1.0"
xmlns:j="http://www.w3.org/2005/xpath-functions"
stylesheet="../../../toolchains/xslt-M4/schema-gen/make-json-schema-metamap.xsl"
run-as="external" xmlns:ov="http://csrc.nist.gov/ns/oscal/test/variable">

<x:scenario label="When generating a JSON schema from composed Metaschema definitions">
<x:scenario label="if it has a defined field with no constraint and no allowed-values">
<x:context href="json-value-testing-mini-metaschema-COMPOSED.xml"
select="/*/m:define-field[@name='unconstrained']"/>
<x:expect label="the resulting JSON Schema should not have an enum to enforce it." xmlns="http://www.w3.org/2005/xpath-functions">
<map key="oscal-value-testing-mini-oscal-value-testing-mini:unconstrained">
<string key="title">Unconstrained</string>
<string key="description">A field whose value is constrained only by its nominal datatype, 'token'.</string>
<string key="$id">#field_oscal-value-testing-mini_unconstrained</string>
<string key="type">object</string>
<map key="properties">
<map key="some">
<string key="title">Some Flag</string>
<string key="description">Some flag some flag some flag.</string>
<string key="$ref">#/definitions/StringDatatype</string>
</map>
<map key="token-value">
<string key="$ref">#/definitions/TokenDatatype</string>
</map>
</map>
<array key="required">
<string>token-value</string>
</array>
<boolean key="additionalProperties">false</boolean>
</map>
</x:expect>
</x:scenario>

<x:scenario label="if it has a defined field with a constraint, allowed-values, strict enforcement of allow-other='no' and explicit target of '.'">
<x:context href="json-value-testing-mini-metaschema-COMPOSED.xml"
select="/*/m:define-field[@name='constrained-closed']"/>
<x:expect label="the resulting JSON Schema should have an enum to enforce it." xmlns="http://www.w3.org/2005/xpath-functions">
<map key="oscal-value-testing-mini-oscal-value-testing-mini:constrained-closed">
<string key="title">Constrained closed</string>
<string key="description">Because allow-other is 'no' an enumeration can be given in the JSON Schema.</string>
<string key="$id">#field_oscal-value-testing-mini_constrained-closed</string>
<string key="type">object</string>
<map key="properties">
<map key="some">
<string key="title">Some Flag</string>
<string key="description">Some flag some flag some flag.</string>
<string key="$ref">#/definitions/StringDatatype</string>
</map>
<map key="token-value">
<array key="allOf">
<map>
<string key="$ref">#/definitions/TokenDatatype</string>
</map>
<map>
<array key="enum">
<string>one</string>
<string>two</string>
<string>three</string>
<string>four</string>
</array>
</map>
</array>
</map>
</map>
<array key="required">
<string>token-value</string>
</array>
<boolean key="additionalProperties">false</boolean>
</map>
</x:expect>
</x:scenario>

<x:scenario label="if it has a defined field with a constraint, allowed-values, no explicit target, and permissive enforcement of allow-other='yes'">
<x:context href="json-value-testing-mini-metaschema-COMPOSED.xml"
select="/*/m:define-field[@name='constrained-open']"/>
<x:expect label="the resulting JSON Schema should not have an enum to enforce it." xmlns="http://www.w3.org/2005/xpath-functions">
<map key="oscal-value-testing-mini-oscal-value-testing-mini:constrained-open">
<string key="title">Constrained open</string>
<string key="description">Because allow-other is 'yes' no enumeration can be given in the JSON Schema.</string>
<string key="$id">#field_oscal-value-testing-mini_constrained-open</string>
<string key="type">object</string>
<map key="properties">
<map key="some">
<string key="title">Some Flag</string>
<string key="description">Some flag some flag some flag.</string>
<string key="$ref">#/definitions/StringDatatype</string>
</map>
<map key="token-value">
<string key="$ref">#/definitions/TokenDatatype</string>
</map>
</map>
<array key="required">
<string>token-value</string>
</array>
<boolean key="additionalProperties">false</boolean>
</map>
</x:expect>
</x:scenario>

<x:scenario label="if it has a defined field with a constraint, allowed-values, strict enforcement of allow-other='no' and explicit target other than '.'">
<x:context href="json-value-testing-mini-metaschema-COMPOSED.xml"
select="/*/m:define-field[@name='constrained-narrow']"/>
<x:expect label="the resulting JSON Schema should not have an enum to enforce it." xmlns="http://www.w3.org/2005/xpath-functions">
<map key="oscal-value-testing-mini-oscal-value-testing-mini:constrained-narrow">
<string key="title">Constrained narrow</string>
<string key="description">Although allow-other is 'no' an enumeration can't be given in the JSON Schema since it targets a qualified set (only a subset) of the elements in scope.</string>
<string key="$id">#field_oscal-value-testing-mini_constrained-narrow</string>
<string key="type">object</string>
<map key="properties">
<map key="some">
<string key="title">Some Flag</string>
<string key="description">Some flag some flag some flag.</string>
<string key="$ref">#/definitions/StringDatatype</string>
</map>
<map key="token-value">
<string key="$ref">#/definitions/TokenDatatype</string>
</map>
</map>
<array key="required">
<string>token-value</string>
</array>
<boolean key="additionalProperties">false</boolean>
</map>
</x:expect>
</x:scenario>

<x:scenario label="if it has a defined field with a constraint, allowed-values, permissive enforcement of allow-other='yes' and explicit target other than '.'">
<x:context href="json-value-testing-mini-metaschema-COMPOSED.xml"
select="/*/m:define-field[@name='constrained-sortof']"/>
<x:expect label="the resulting JSON Schema should not have an enum to enforce it." xmlns="http://www.w3.org/2005/xpath-functions">
<map key="oscal-value-testing-mini-oscal-value-testing-mini:constrained-sortof">
<string key="title">Constrained, sort of</string>
<string key="description">Although allow-other is 'no' an enumeration can't be given in the JSON Schema since it targets a qualified set (only a subset) of the elements in scope.</string>
<string key="$id">#field_oscal-value-testing-mini_constrained-sortof</string>
<string key="type">object</string>
<map key="properties">
<map key="some">
<string key="title">Some Flag</string>
<string key="description">Some flag some flag some flag.</string>
<string key="$ref">#/definitions/StringDatatype</string>
</map>
<map key="token-value">
<string key="$ref">#/definitions/TokenDatatype</string>
</map>
</map>
<array key="required">
<string>token-value</string>
</array>
<boolean key="additionalProperties">false</boolean>
</map>
</x:expect>
</x:scenario>
</x:scenario>
</x:description>
121 changes: 121 additions & 0 deletions test-suite/metaschema-xspec/json-schema-gen/json-value-testing-mini-jsonschema.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@

{ "$schema" : "http://json-schema.org/draft-07/schema#",
"$id" : "http://csrc.nist.gov/ns/oscal/0.1/oscal-value-testing-mini-schema.json",
"$comment" : "JSON value testing mini metaschema: JSON Schema",
"type" : "object",
"definitions" :
{ "oscal-value-testing-mini-oscal-value-testing-mini:root" :
{ "title" : "Root",
"description" : "Root root root.",
"$id" : "#assembly_oscal-value-testing-mini_root",
"type" : "object",
"properties" :
{ "unconstrained" :
{ "$ref" : "#field_oscal-value-testing-mini_unconstrained" },
"constrained-open" :
{ "$ref" : "#field_oscal-value-testing-mini_constrained-open" },
"constrained-closed" :
{ "$ref" : "#field_oscal-value-testing-mini_constrained-closed" },
"constrained-narrow" :
{ "$ref" : "#field_oscal-value-testing-mini_constrained-narrow" },
"constrained-sortof" :
{ "$ref" : "#field_oscal-value-testing-mini_constrained-sortof" } },
"additionalProperties" : false },
"oscal-value-testing-mini-oscal-value-testing-mini:unconstrained" :
{ "title" : "Unconstrained",
"description" : "A field whose value is constrained only by its nominal datatype, 'token'.",
"$id" : "#field_oscal-value-testing-mini_unconstrained",
"type" : "object",
"properties" :
{ "some" :
{ "title" : "Some Flag",
"description" : "Some flag some flag some flag.",
"$ref" : "#/definitions/StringDatatype" },
"token-value" :
{ "type" : "string" } },
"required" :
[ "token-value" ],
"additionalProperties" : false },
"oscal-value-testing-mini-oscal-value-testing-mini:constrained-open" :
{ "title" : "Constrained open",
"description" : "Because allow-other is 'yes' no enumeration can be given in the JSON Schema.",
"$id" : "#field_oscal-value-testing-mini_constrained-open",
"type" : "object",
"properties" :
{ "some" :
{ "title" : "Some Flag",
"description" : "Some flag some flag some flag.",
"$ref" : "#/definitions/StringDatatype" },
"token-value" :
{ "type" : "string" } },
"required" :
[ "token-value" ],
"additionalProperties" : false },
"oscal-value-testing-mini-oscal-value-testing-mini:constrained-closed" :
{ "title" : "Constrained closed",
"description" : "Because allow-other is 'no' an enumeration can be given in the JSON Schema.",
"$id" : "#field_oscal-value-testing-mini_constrained-closed",
"type" : "object",
"properties" :
{ "some" :
{ "title" : "Some Flag",
"description" : "Some flag some flag some flag.",
"$ref" : "#/definitions/StringDatatype" },
"token-value" :
{ "type" : "string" } },
"required" :
[ "token-value" ],
"additionalProperties" : false,
"enum" :
[ "one",
"two",
"three",
"four" ] },
"oscal-value-testing-mini-oscal-value-testing-mini:constrained-narrow" :
{ "title" : "Constrained narrow",
"description" : "Although allow-other is 'no' an enumeration can't be given in the JSON Schema since it targets a qualified set (only a subset) of the elements in scope.",
"$id" : "#field_oscal-value-testing-mini_constrained-narrow",
"type" : "object",
"properties" :
{ "some" :
{ "title" : "Some Flag",
"description" : "Some flag some flag some flag.",
"$ref" : "#/definitions/StringDatatype" },
"token-value" :
{ "type" : "string" } },
"required" :
[ "token-value" ],
"additionalProperties" : false,
"enum" :
[ "one",
"two",
"three",
"four" ] },
"oscal-value-testing-mini-oscal-value-testing-mini:constrained-sortof" :
{ "title" : "Constrained, sort of",
"description" : "Although allow-other is 'no' an enumeration can't be given in the JSON Schema since it targets a qualified set (only a subset) of the elements in scope.",
"$id" : "#field_oscal-value-testing-mini_constrained-sortof",
"type" : "object",
"properties" :
{ "some" :
{ "title" : "Some Flag",
"description" : "Some flag some flag some flag.",
"$ref" : "#/definitions/StringDatatype" },
"token-value" :
{ "type" : "string" } },
"required" :
[ "token-value" ],
"additionalProperties" : false },
"StringDatatype" :
{ "type" : "string",
"pattern" : "^\\S(.*\\S)?$" },
"TokenDatatype" :
{ "type" : "string",
"pattern" : "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$" } },
"properties" :
{ "root" :
{ "$ref" : "#assembly_oscal-value-testing-mini_root" } },
"required" :
[ "root" ],
"additionalProperties" : false,
"maxProperties" : 1 }
Loading

0 comments on commit 71233f4

Please sign in to comment.