Correct field and flag enumerations in JSON schemas.

Previously in usnistgov#360, @kylelaker reported a needed improvement to fix a regression for usnistgov/OSCAL#1773. While I had been completing testing in usnistgov#360 and properly expanding test coverage to address how we handle enumerations based on allow-other and target attributes for field and flag elements in Metaschema (both act similarly but subtly different with more scenarios for field), I observed my test data instances needed further correction in a way that cannot be address in the PR by Kyle. This merges the changes from the commit reffed by the URL below, adds my enhancement, tests, and all examples that helped me uncover missing code. usnistgov@6fb8a74 Co-authored-by: Kyle Laker <[email protected]>
aj-stein-nist · Jun 15, 2023 · a25c688 · a25c688
1 parent 62ad378
commit a25c688
Show file tree

Hide file tree

Showing 42 changed files with 717 additions and 368 deletions.
diff --git a/test-suite/metaschema-xspec/json-schema-gen/json-schema-gen.xspec b/test-suite/metaschema-xspec/json-schema-gen/json-schema-gen.xspec
@@ -3,36 +3,50 @@
    xmlns:m="http://csrc.nist.gov/ns/oscal/metaschema/1.0"
    xmlns:j="http://www.w3.org/2005/xpath-functions"
    stylesheet="../../../toolchains/xslt-M4/nist-metaschema-MAKE-JSON-SCHEMA.xsl" run-as="external">
-
    <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_unconstrained_metaschema.xml"/>
-         <x:expect label="the resulting JSON Schema should not have an enum to enforce it." 
-            test="$x:result => j:json-to-xml()" select="'../json-value_unconstrained.json' => j:unparsed-text() => j:json-to-xml()"/>
+      <x:scenario label="if it has a defined flag">
+         <x:scenario label="with no constraint and no allowed-values">
+            <x:context href="json-value_flag_unconstrained_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should not have an enum to enforce it." 
+               test="$x:result => j:json-to-xml()" select="'../json-value_flag_unconstrained.json' => j:unparsed-text() => j:json-to-xml()"/>
+         </x:scenario>
+         <x:scenario label="with a constraint, allowed-values, strict enforcement of allow-other='no' and explicit target of '.'">
+            <x:context href="json-value_flag_constrained-closed_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should have an enum to enforce it."
+               test="$x:result => j:json-to-xml()" select="'../json-value_flag_constrained-closed.json' => j:unparsed-text() => j:json-to-xml()"/> 
+         </x:scenario>
+         <x:scenario label="with a constraint, allowed-values, no explicit target, and permissive enforcement of allow-other='yes'">
+            <x:context href="json-value_flag_constrained-open_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should not have an enum to enforce it."
+               test="$x:result => j:json-to-xml()" select="'../json-value_flag_constrained-open.json' => j:unparsed-text() => j:json-to-xml()"/>
+         </x:scenario>
       </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_constrained-closed_metaschema.xml"/>
-         <x:expect label="the resulting JSON Schema should have an enum to enforce it."
-            test="$x:result => j:json-to-xml()" select="'../json-value_constrained-closed.json' => j:unparsed-text() => j:json-to-xml()"/> 
-      </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_constrained-open_metaschema.xml"/>
-         <x:expect label="the resulting JSON Schema should not have an enum to enforce it."
-            test="$x:result => j:json-to-xml()" select="'../json-value_constrained-open.json' => j:unparsed-text() => j:json-to-xml()"/>
-      </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_constrained-narrow_metaschema.xml"/>
-         <x:expect label="the resulting JSON Schema should not have an enum to enforce it."
-            test="$x:result => j:json-to-xml()" select="'../json-value_constrained-narrow.json' => j:unparsed-text() => j:json-to-xml()"/>
-      </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_constrained-sortof_metaschema.xml"/>
-         <x:expect label="the resulting JSON Schema should not have an enum to enforce it."
-            test="$x:result => j:json-to-xml()" select="'../json-value_constrained-sortof.json' => j:unparsed-text() => j:json-to-xml()"/>
+      <x:scenario label="if it has a defined field">
+         <x:scenario label="with no constraint and no allowed-values">
+            <x:context href="json-value_field_unconstrained_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should not have an enum to enforce it." 
+               test="$x:result => j:json-to-xml()" select="'../json-value_field_unconstrained.json' => j:unparsed-text() => j:json-to-xml()"/>
+         </x:scenario>
+         <x:scenario label="with a constraint, allowed-values, strict enforcement of allow-other='no' and explicit target of '.'">
+            <x:context href="json-value_field_constrained-closed_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should have an enum to enforce it."
+               test="$x:result => j:json-to-xml()" select="'../json-value_field_constrained-closed.json' => j:unparsed-text() => j:json-to-xml()"/> 
+         </x:scenario>
+         <x:scenario label="with a constraint, allowed-values, no explicit target, and permissive enforcement of allow-other='yes'">
+            <x:context href="json-value_field_constrained-open_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should not have an enum to enforce it."
+               test="$x:result => j:json-to-xml()" select="'../json-value_field_constrained-open.json' => j:unparsed-text() => j:json-to-xml()"/>
+         </x:scenario>
+         <x:scenario label="with a constraint, allowed-values, strict enforcement of allow-other='no' and explicit target other than '.'">
+            <x:context href="json-value_field_constrained-narrow_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should not have an enum to enforce it."
+               test="$x:result => j:json-to-xml()" select="'../json-value_field_constrained-narrow.json' => j:unparsed-text() => j:json-to-xml()"/>
+         </x:scenario>
+         <x:scenario label="with a constraint, allowed-values, permissive enforcement of allow-other='yes' and explicit target other than '.'">
+            <x:context href="json-value_field_constrained-sortof_metaschema.xml"/>
+            <x:expect label="the resulting JSON Schema should not have an enum to enforce it."
+               test="$x:result => j:json-to-xml()" select="'../json-value_field_constrained-sortof.json' => j:unparsed-text() => j:json-to-xml()"/>
+         </x:scenario>
       </x:scenario>
    </x:scenario>
 </x:description>
diff --git a/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-closed.json b/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-closed.json
diff --git a/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-narrow.json b/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-narrow.json
diff --git a/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-open.json b/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-open.json
diff --git a/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-sortof.json b/test-suite/metaschema-xspec/json-schema-gen/json-value_constrained-sortof.json
diff --git a/test-suite/metaschema-xspec/json-schema-gen/json-value_field_constrained-closed.json b/test-suite/metaschema-xspec/json-schema-gen/json-value_field_constrained-closed.json
@@ -0,0 +1,53 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "http://csrc.nist.gov/ns/metaschema-tests/0.1/json-value_field_constrained-closed-schema.json",
+  "$comment": "JSON value testing mini metaschema: JSON Schema",
+  "type": "object",
+  "definitions": {
+    "json-value_field_constrained-closed-json-value_field_constrained-closed:test-root": {
+      "title": "Root",
+      "description": "The root assembly of this example module.",
+      "$id": "#assembly_json-value_field_constrained-closed_test-root",
+      "type": "object",
+      "properties": {
+        "test-field": {
+          "$ref": "#field_json-value_field_constrained-closed_test-field"
+        }
+      },
+      "additionalProperties": false
+    },
+    "json-value_field_constrained-closed-json-value_field_constrained-closed:test-field": {
+      "title": "Test Field",
+      "description": "A test field.",
+      "$id": "#field_json-value_field_constrained-closed_test-field",
+      "allOf": [
+        {
+          "$ref": "#/definitions/TokenDatatype"
+        },
+        {
+          "enum": [
+            "one",
+            "two",
+            "three",
+            "four"
+          ]
+        }
+      ]
+    },
+    "TokenDatatype": {
+      "description": "A non-colonized name as defined by XML Schema Part 2: Datatypes Second Edition. https://www.w3.org/TR/xmlschema11-2/#NCName.",
+      "type": "string",
+      "pattern": "^(\\p{L}|_)(\\p{L}|\\p{N}|[.\\-_])*$"
+    }
+  },
+  "properties": {
+    "test-root": {
+      "$ref": "#assembly_json-value_field_constrained-closed_test-root"
+    }
+  },
+  "required": [
+    "test-root"
+  ],
+  "additionalProperties": false,
+  "maxProperties": 1
+}