Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Mar 8, 2024
+19 −17
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions ...a/io/github/springwolf/core/asyncapi/components/examples/walkers/DefaultSchemaWalker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down
2 changes: 1 addition & 1 deletion ...io/github/springwolf/core/asyncapi/components/examples/walkers/ExampleValueGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down
2 changes: 1 addition & 1 deletion .../springwolf/core/asyncapi/components/examples/walkers/json/ExampleJsonValueGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions ...ub/springwolf/core/asyncapi/components/examples/walkers/xml/ExampleXmlValueGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .../springwolf/core/asyncapi/components/examples/walkers/yaml/ExampleYamlValueGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
0 ...faultSchemaWalkerJsonIntegrationTest.java → ...faultSchemaWalkerJsonIntegrationTest.java
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions ...efaultSchemaWalkerXmlIntegrationTest.java → ...efaultSchemaWalkerXmlIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
0 ...faultSchemaWalkerYamlIntegrationTest.java → ...faultSchemaWalkerYamlIntegrationTest.java
View file
Open in desktop
File renamed without changes.
3 changes: 1 addition & 2 deletions ...aultOperationsServiceIntegrationTest.java → ...aultOperationsServiceIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 1 addition & 1 deletion springwolf-core/src/test/resources/schemas/xml/array-definitions-xml.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions springwolf-core/src/test/resources/schemas/xml/complex-definitions-xml.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down