fix(core): generate correct xml examples for array schemas GH-642 (#643)

Co-authored-by: Timon Back <[email protected]>
springwolf · Mar 8, 2024 · 19ad4aa · 19ad4aa
1 parent a8f18eb
commit 19ad4aa
Show file tree

Hide file tree

Showing 11 changed files with 19 additions and 17 deletions.
diff --git a/...a/io/github/springwolf/core/asyncapi/components/examples/walkers/DefaultSchemaWalker.java b/...a/io/github/springwolf/core/asyncapi/components/examples/walkers/DefaultSchemaWalker.java
@@ -118,10 +118,13 @@ private T getExampleValueFromSchemaAnnotation(Schema schema) {
     }
 
     private T buildArrayExample(Schema schema, Map<String, Schema> definitions, Set<Schema> visited) {
-        String name = exampleValueGenerator.lookupSchemaName(schema);
-        T arrayItem = buildExample(name, schema.getItems(), definitions, visited);
+        Schema arrayItemSchema =
+                resolveSchemaFromRef(schema.getItems(), definitions).orElse(schema.getItems());
+        String arrayItemName = exampleValueGenerator.lookupSchemaName(arrayItemSchema);
+        T arrayItem = buildExample(arrayItemName, arrayItemSchema, definitions, visited);
 
-        return exampleValueGenerator.createArrayExample(arrayItem);
+        String arrayName = exampleValueGenerator.lookupSchemaName(schema);
+        return exampleValueGenerator.createArrayExample(arrayName, arrayItem);
     }
 
     private T buildFromStringSchema(Schema schema) {

diff --git a/...io/github/springwolf/core/asyncapi/components/examples/walkers/ExampleValueGenerator.java b/...io/github/springwolf/core/asyncapi/components/examples/walkers/ExampleValueGenerator.java
@@ -83,7 +83,7 @@ public interface ExampleValueGenerator<T, R> {
 
     T createUnknownSchemaStringFormatExample(String schemaFormat);
 
-    T createArrayExample(T arrayItem);
+    T createArrayExample(String name, T arrayItem);
 
     T createRaw(Object exampleValueString);
 

diff --git a/.../springwolf/core/asyncapi/components/examples/walkers/json/ExampleJsonValueGenerator.java b/.../springwolf/core/asyncapi/components/examples/walkers/json/ExampleJsonValueGenerator.java
@@ -136,7 +136,7 @@ public JsonNode createUnknownSchemaStringFormatExample(String schemaFormat) {
     }
 
     @Override
-    public JsonNode createArrayExample(JsonNode arrayItem) {
+    public JsonNode createArrayExample(String name, JsonNode arrayItem) {
         ArrayNode array = objectMapper.createArrayNode();
         array.add(arrayItem);
         return array;

diff --git a/...ub/springwolf/core/asyncapi/components/examples/walkers/xml/ExampleXmlValueGenerator.java b/...ub/springwolf/core/asyncapi/components/examples/walkers/xml/ExampleXmlValueGenerator.java
@@ -190,8 +190,8 @@ public Node createUnknownSchemaStringFormatExample(String schemaFormat) {
     }
 
     @Override
-    public Node createArrayExample(Node arrayItem) {
-        return arrayItem;
+    public Node createArrayExample(String name, Node arrayItem) {
+        return wrapNode(name, arrayItem);
     }
 
     @Override

diff --git a/.../springwolf/core/asyncapi/components/examples/walkers/yaml/ExampleYamlValueGenerator.java b/.../springwolf/core/asyncapi/components/examples/walkers/yaml/ExampleYamlValueGenerator.java
@@ -153,8 +153,8 @@ public JsonNode createUnknownSchemaStringFormatExample(String schemaFormat) {
     }
 
     @Override
-    public JsonNode createArrayExample(JsonNode arrayItem) {
-        return this.exampleJsonValueGenerator.createArrayExample(arrayItem);
+    public JsonNode createArrayExample(String name, JsonNode arrayItem) {
+        return this.exampleJsonValueGenerator.createArrayExample(name, arrayItem);
     }
 
     @Override

diff --git a/...faultSchemaWalkerJsonIntegrationTest.java → ...faultSchemaWalkerJsonIntegrationTest.java b/...faultSchemaWalkerJsonIntegrationTest.java → ...faultSchemaWalkerJsonIntegrationTest.java
diff --git a/...efaultSchemaWalkerXmlIntegrationTest.java → ...efaultSchemaWalkerXmlIntegrationTest.java b/...efaultSchemaWalkerXmlIntegrationTest.java → ...efaultSchemaWalkerXmlIntegrationTest.java
@@ -346,9 +346,9 @@ void type_object_array() {
 
             String actual = xmlSchemaWalker.fromSchema(schema, emptyMap()).trim();
 
-            // TODO FixeMe Expected
-            // :"<type_object_array><array_element><b>true</b><s>string</s></array_element></type_object_array>"
-            assertThat(actual).isEqualTo("<type_object_array><b>true</b><s>string</s></type_object_array>");
+            assertThat(actual)
+                    .isEqualTo(
+                            "<type_object_array><array_element><b>true</b><s>string</s></array_element></type_object_array>");
         }
 
         @Test

diff --git a/...faultSchemaWalkerYamlIntegrationTest.java → ...faultSchemaWalkerYamlIntegrationTest.java b/...faultSchemaWalkerYamlIntegrationTest.java → ...faultSchemaWalkerYamlIntegrationTest.java
diff --git a/...aultOperationsServiceIntegrationTest.java → ...aultOperationsServiceIntegrationTest.java b/...aultOperationsServiceIntegrationTest.java → ...aultOperationsServiceIntegrationTest.java
@@ -1,10 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
-package io.github.springwolf.core.asyncapi.oprtations;
+package io.github.springwolf.core.asyncapi.operations;
 
 import io.github.springwolf.asyncapi.v3.model.channel.ChannelReference;
 import io.github.springwolf.asyncapi.v3.model.operation.Operation;
 import io.github.springwolf.asyncapi.v3.model.operation.OperationAction;
-import io.github.springwolf.core.asyncapi.operations.DefaultOperationsService;
 import io.github.springwolf.core.asyncapi.scanners.OperationsScanner;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;

diff --git a/springwolf-core/src/test/resources/schemas/xml/array-definitions-xml.json b/springwolf-core/src/test/resources/schemas/xml/array-definitions-xml.json
@@ -9,7 +9,7 @@
         }
       }
     },
-    "examples" : [ "<ArrayFoo><flist><b>true</b><s>string</s></flist></ArrayFoo>" ]
+    "examples" : [ "<ArrayFoo><flist><SimpleFoo><b>true</b><s>string</s></SimpleFoo></flist></ArrayFoo>" ]
   },
   "io.github.springwolf.core.asyncapi.components.DefaultXmlComponentsServiceTest$SimpleFoo" : {
     "type" : "string",

diff --git a/springwolf-core/src/test/resources/schemas/xml/complex-definitions-xml.json b/springwolf-core/src/test/resources/schemas/xml/complex-definitions-xml.json
@@ -28,7 +28,7 @@
         "type" : "string"
       }
     },
-    "examples" : [ "<ComplexFoo><b>true</b><d>1.1</d><dt>2015-07-20T15:49:04-07:00</dt><f>1.1</f><i>0</i><n><nba>YmFzZTY0LWV4YW1wbGU=</nba><nc><cyclic/></nc><nli>0</nli><nmfm/><ns>string</ns><nsm><s>string</s></nsm><nu>3fa85f64-5717-4562-b3fc-2c963f66afa6</nu></n><s>string</s></ComplexFoo>" ]
+    "examples" : [ "<ComplexFoo><b>true</b><d>1.1</d><dt>2015-07-20T15:49:04-07:00</dt><f>1.1</f><i>0</i><n><nba>YmFzZTY0LWV4YW1wbGU=</nba><nc><cyclic/></nc><nli>0</nli><nmfm/><ns>string</ns><nsm><MyClass><s>string</s></MyClass></nsm><nu>3fa85f64-5717-4562-b3fc-2c963f66afa6</nu></n><s>string</s></ComplexFoo>" ]
   },
   "io.github.springwolf.core.asyncapi.components.DefaultXmlComponentsServiceTest$ComplexFoo$Nested" : {
     "type" : "string",
@@ -71,7 +71,7 @@
         "format" : "uuid"
       }
     },
-    "examples" : [ "<Nested><nba>YmFzZTY0LWV4YW1wbGU=</nba><nc><cyclic/></nc><nli>0</nli><nmfm/><ns>string</ns><nsm><s>string</s></nsm><nu>3fa85f64-5717-4562-b3fc-2c963f66afa6</nu></Nested>" ]
+    "examples" : [ "<Nested><nba>YmFzZTY0LWV4YW1wbGU=</nba><nc><cyclic/></nc><nli>0</nli><nmfm/><ns>string</ns><nsm><MyClass><s>string</s></MyClass></nsm><nu>3fa85f64-5717-4562-b3fc-2c963f66afa6</nu></Nested>" ]
   },
   "io.github.springwolf.core.asyncapi.components.DefaultXmlComponentsServiceTest$ComplexFoo$Nested$Cyclic" : {
     "type" : "string",