feat(map): Codegen for XMLSchema Target #64

jonathan-casey · 2023-10-13T14:28:37Z

Description

Add XMLSchema code generation for Map Type. Validated against xmlvalidation.com & w3schools.com.

Sample <String, String>

<xs:complexType name="Map1">
   <xs:sequence>
      <xs:complexType>
         <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="xs:string"/>
         </xs:sequence>
      </xs:complexType>
   </xs:sequence>
</xs:complexType>

Sample <String, DateTime>

<xs:complexType name="Map2">
   <xs:sequence>
      <xs:complexType>
         <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="xs:dateTime"/>
         </xs:sequence>
      </xs:complexType>
   </xs:sequence>
</xs:complexType>

Sample <String, SSN>

<xs:complexType name="Map3">
   <xs:sequence>
      <xs:complexType>
         <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="xs:string"/>
         </xs:sequence>
      </xs:complexType>
   </xs:sequence>
</xs:complexType>

Sample <String, Concept>

<xs:complexType name="Map4">
   <xs:sequence>
      <xs:complexType>
         <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="concerto:Concept"/>
         </xs:sequence>
      </xs:complexType>
   </xs:sequence>
</xs:complexType>

Sample <SSN, String>

<xs:complexType name="Map5">
   <xs:sequence>
      <xs:complexType>
         <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="xs:string"/>
         </xs:sequence>
      </xs:complexType>
   </xs:sequence>
</xs:complexType>

Sample <SSN, Employee>

<xs:complexType name="Map6">
   <xs:sequence>
      <xs:complexType>
         <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="org.acme.hr:Employee"/>
         </xs:sequence>
      </xs:complexType>
   </xs:sequence>
</xs:complexType>

Signed-off-by: Jonathan Casey <[email protected]>

lib/codegen/fromcto/xmlschema/xmlschemavisitor.js

mttrbrts

I had trouble validating the output schema. I'm also unsure about what the target XML document would look like for instances.

For example, the following fails to validate in VS Code.

<?xml version="1.0"?>
<xs:schema xmlns:org.acme.hr="org.acme.hr" targetNamespace="org.acme.hr" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" 
           xmlns:concerto="concerto"
  >
  <xs:element name="root">
    <xs:complexType name="Map1">
      <xs:sequence>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Problems:

s4s-att-not-allowed: Attribute 'name' cannot appear in element 'complexType'.
s4s-elt-must-match.1: The content of 'sequence' must match (annotation?, (element | group | choice | sequence | any)*). A problem was found starting at: complexType.

If I change the definition to the following, it does validate, but produces unexpected instances.

<?xml version="1.0"?>
<xs:schema xmlns:org.acme.hr="org.acme.hr" targetNamespace="org.acme.hr" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" 
           xmlns:concerto="concerto"
  >
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="key" type="xs:string"/>
        <xs:element name="value" type="xs:string"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

<?xml version="1.0" encoding="utf-8"?>
<!-- Created with Liquid Technologies Online Tools 1.0 (https://www.liquid-technologies.com) -->
<root xmlns="org.acme.hr" xmlns:concerto="concerto" xsi:schemaLocation="org.acme.hr schema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <key>string</key>
  <value>1981-11-16T18:39:36.34</value>
</root>

Is the design here better suited to our use case?

lib/codegen/fromcto/xmlschema/xmlschemavisitor.js

Signed-off-by: Jonathan Casey <[email protected]>

coveralls · 2023-11-09T15:26:54Z

coverage: 98.91% (-0.05%) from 98.955%
when pulling c78ccde on jonathan/codegen_map_xmlschema
into 79653dd on main.

Signed-off-by: Jonathan Casey <[email protected]>

jonathan-casey · 2023-11-10T14:43:32Z

I had trouble validating the output schema. I'm also unsure about what the target XML document would look like for instances.

For example, the following fails to validate in VS Code.

<?xml version="1.0"?>
<xs:schema xmlns:org.acme.hr="org.acme.hr" targetNamespace="org.acme.hr" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" 
           xmlns:concerto="concerto"
  >
  <xs:element name="root">
    <xs:complexType name="Map1">
      <xs:sequence>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="key" type="xs:string"/>
            <xs:element name="value" type="xs:string"/>
          </xs:sequence>
        </xs:complexType>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Problems:

s4s-att-not-allowed: Attribute 'name' cannot appear in element 'complexType'.
s4s-elt-must-match.1: The content of 'sequence' must match (annotation?, (element | group | choice | sequence | any)*). A problem was found starting at: complexType.

If I change the definition to the following, it does validate, but produces unexpected instances.

<?xml version="1.0"?>
<xs:schema xmlns:org.acme.hr="org.acme.hr" targetNamespace="org.acme.hr" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" 
           xmlns:concerto="concerto"
  >
  <xs:element name="root">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="key" type="xs:string"/>
        <xs:element name="value" type="xs:string"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

<?xml version="1.0" encoding="utf-8"?>
<!-- Created with Liquid Technologies Online Tools 1.0 (https://www.liquid-technologies.com) -->
<root xmlns="org.acme.hr" xmlns:concerto="concerto" xsi:schemaLocation="org.acme.hr schema.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <key>string</key>
  <value>1981-11-16T18:39:36.34</value>
</root>

Is the design here better suited to our use case?

@mttrbrts thanks for catching this. I've switched validators and was able to reproduce the same issues which are now patched.

RedHats VSCode plugin used for inline validation and liquid-technologies online instance validator both suggest the current generation of XSD is valid. Here is a sample:

XSD:

<?xml version="1.0"?>
<xs:schema xmlns:org.acme.hr="org.acme.hr" targetNamespace="org.acme.hr"
    elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns:concerto="concerto"
>
       <xs:complexType name="CompanyProperties">
        <xs:sequence>
           <xs:element name="key" type="xs:string"/>
           <xs:element name="value" type="xs:string"/>
        </xs:sequence>
     </xs:complexType>
     <xs:element name="CompanyProperties" type="org.acme.hr:CompanyProperties"/>
</xs:schema>

Instance:

<?xml version="1.0" encoding="UTF-8"?>
<org.acme.hr:CompanyProperties xmlns:org.acme.hr="org.acme.hr">
  <org.acme.hr:key>Some Thing</org.acme.hr:key>
  <org.acme.hr:value>Some Other Thing</org.acme.hr:value>
</org.acme.hr:CompanyProperties>

jonathan-casey · 2023-11-15T11:00:33Z

A sample XSD which supports multiple entries in a Map. Each Map will have its own 'entry' type defining the entries within the instance.

<xs:element name="diary">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="entry" type="diary_entryType" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>
</xs:element>

<xs:complexType name="diary_entryType">
  <xs:sequence>
    <xs:element name="key" type="xs:xs:dateTime"/>
    <xs:element name="value" type="xs:string"/>
  </xs:sequence>
</xs:complexType>

* feat(*): keys are variable typed Signed-off-by: Jonathan Casey <[email protected]> * test(*): update test Signed-off-by: Jonathan Casey <[email protected]> * test(*): update snapshot Signed-off-by: Jonathan Casey <[email protected]> * test(*): adds scalar test coverage Signed-off-by: Jonathan Casey <[email protected]> * feat(*): minor refactor, update tests Signed-off-by: Jonathan Casey <[email protected]> * test(*): update snapshot Signed-off-by: Jonathan Casey <[email protected]> --------- Signed-off-by: Jonathan Casey <[email protected]>

Signed-off-by: Jonathan Casey <[email protected]>

jonathan-casey added 3 commits October 13, 2023 15:24

feat(map): extend xmlschemavisitor

7cdcc56

Signed-off-by: Jonathan Casey <[email protected]>

test(map): adds test coverage

2c5e4a7

Signed-off-by: Jonathan Casey <[email protected]>

test(map): updates snapshots

98d5f33

Signed-off-by: Jonathan Casey <[email protected]>

jonathan-casey requested a review from a team October 13, 2023 14:28

feat(map): write scalars as primitives

cd7066c

Signed-off-by: Jonathan Casey <[email protected]>

jonathan-casey force-pushed the jonathan/codegen_map_xmlschema branch from f1a035d to cd7066c Compare October 16, 2023 12:48

jonathan-casey added 2 commits October 16, 2023 13:49

test(map): adds more test cases

fc880d0

Signed-off-by: Jonathan Casey <[email protected]>

test(map): update snapshot

41cfb77

Signed-off-by: Jonathan Casey <[email protected]>

ekarademir approved these changes Oct 16, 2023

View reviewed changes

lib/codegen/fromcto/xmlschema/xmlschemavisitor.js Show resolved Hide resolved

mttrbrts reviewed Oct 19, 2023

View reviewed changes

dselman requested changes Oct 19, 2023

View reviewed changes

lib/codegen/fromcto/xmlschema/xmlschemavisitor.js Outdated Show resolved Hide resolved

mttrbrts added this to the v3.x milestone Nov 8, 2023

mttrbrts assigned jonathan-casey Nov 8, 2023

jonathan-casey added 3 commits November 9, 2023 15:19

Merge branch 'main' into jonathan/codegen_map_xmlschema

0e45cfb

test(*): update snapshot

2cce59e

Signed-off-by: Jonathan Casey <[email protected]>

feat(*): add type def

5e2dcc5

Signed-off-by: Jonathan Casey <[email protected]>

jonathan-casey added 8 commits November 9, 2023 16:48

feat(*): removes superflous tags, declares element

3412f86

Signed-off-by: Jonathan Casey <[email protected]>

test(*): fix test regression

97f1b3f

Signed-off-by: Jonathan Casey <[email protected]>

test(*): update snapshot

63d37c7

Signed-off-by: Jonathan Casey <[email protected]>

feat(*): get type from model file

74ce780

Signed-off-by: Jonathan Casey <[email protected]>

test(*): fix test regression

7619ed6

Signed-off-by: Jonathan Casey <[email protected]>

test(*): update snapshot

ce647a1

Signed-off-by: Jonathan Casey <[email protected]>

Merge branch 'main' into jonathan/codegen_map_xmlschema

bc7653a

test(*): fix tests

7dd8d4f

Signed-off-by: Jonathan Casey <[email protected]>

jonathan-casey and others added 3 commits November 15, 2023 15:38

test(*): snapshot update

6b5eecb

Signed-off-by: Jonathan Casey <[email protected]>

feat(*): update xsd and test cov

025d948

Signed-off-by: Jonathan Casey <[email protected]>

dselman approved these changes Nov 15, 2023

View reviewed changes

jonathan-casey added 2 commits November 15, 2023 16:32

test(*): resets sandbox for test scenario

4239ab2

Signed-off-by: Jonathan Casey <[email protected]>

test(*): fix casing

c78ccde

Signed-off-by: Jonathan Casey <[email protected]>

mttrbrts approved these changes Nov 16, 2023

View reviewed changes

jonathan-casey merged commit e22a321 into main Nov 16, 2023
11 checks passed

jonathan-casey deleted the jonathan/codegen_map_xmlschema branch November 16, 2023 14:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(map): Codegen for XMLSchema Target #64

feat(map): Codegen for XMLSchema Target #64

jonathan-casey commented Oct 13, 2023 •

edited

Loading

mttrbrts left a comment

coveralls commented Nov 9, 2023 •

edited

Loading

jonathan-casey commented Nov 10, 2023

jonathan-casey commented Nov 15, 2023

feat(map): Codegen for XMLSchema Target #64

feat(map): Codegen for XMLSchema Target #64

Conversation

jonathan-casey commented Oct 13, 2023 • edited Loading

Description

Sample <String, String>

Sample <String, DateTime>

Sample <String, SSN>

Sample <String, Concept>

Sample <SSN, String>

Sample <SSN, Employee>

mttrbrts left a comment

Choose a reason for hiding this comment

coveralls commented Nov 9, 2023 • edited Loading

jonathan-casey commented Nov 10, 2023

jonathan-casey commented Nov 15, 2023

jonathan-casey commented Oct 13, 2023 •

edited

Loading

coveralls commented Nov 9, 2023 •

edited

Loading