eclipse-aascw / aas-core-codegen / 35609393177

90%

Build Type

push

github

Committed by web-flow

Commit Message

Support the JSON-able types (value-only) (#739)

The meta-models need a generic JSON-able value: value-only serialization
(AAS HTTP API Part 2, ``content=value``) has fields which the specification
itself leaves open and object-shaped, and no closed class can express them.

This introduces three type annotations, ``JSONValue``, ``JSONArray`` and
``JSONObject[K]``, through ``parse``, ``intermediate`` and the inference,
and implements them in the JSON Schema, the XSD and in all the six backends:
a JSON-able value is verified, de/serialized to and from JSON and over
an XML-RPC subset of XML, and every error names the way into the value with
a structured path.

The generated libraries keep the JSON-able support apart from the meta-model:

* ``jsonvalueverification`` verifies a JSON-able value and depends on no
  class of the meta-model,
* ``xmlrpc`` de/serializes it over the XML-RPC subset, and drives no document
  of its own -- the caller hands it the very reader or the very writer with
  which the enclosing document is being read or written,
* ``xmlcommon`` holds the XML primitives which both ``xmlization`` and
  ``xmlrpc`` need -- the namespace check, the framing of an element, the text
  of an element -- so that each is defined exactly once.

``xmlcommon`` is generated for every meta-model, while
``jsonvalueverification`` and ``xmlrpc`` only where a JSON-able type is
actually used. The modules which used to hold the moved code re-export it
under the old names, so nothing downstream has to be re-spelled.

The XML-RPC elements reside in no namespace at all, as the XML-RPC
specification prescribes, and not in the namespace of the enclosing document,
so that they are what real XML-RPC tooling expects. Only the outermost one
undeclares the default namespace, and the elements nested in it inherit that:

    <something xmlns="https://dummy.com">
      <value><boolean xmlns="">1</boolean></value>
      <values><data xmlns=""><value><double>1.5</double></value... (continued)

Coverage Stats

2094 of 2177 new or added lines in 98 files covered. (96.19%)

67 existing lines in 3 files now uncovered.

36834 of 42255 relevant lines covered (87.17%)

2.62 hits per line