Skip to content

fix(test): Make serialization tests robust against key reordering #4990

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+53 −32
Open

fix(test): Make serialization tests robust against key reordering #4990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48c699b
feat(test): Introduce JsonAssert for robust JSON comparison
Fr4nk03 Oct 9, 2025
ec5edf5
fix(test): Refactor property serialization tests to use JsonAssert
Fr4nk03 Oct 9, 2025
8f7f4db
Merge branch 'master' into bug/fix-json-equal-assertions
daniel-kmiecik Oct 10, 2025
57f7a9c
Merge branch 'master' into bug/fix-json-equal-assertions
daniel-kmiecik Oct 13, 2025
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
65 changes: 33 additions & 32 deletions .../src/test/java/io/swagger/v3/core/serialization/properties/PropertySerializationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import com.fasterxml.jackson.databind.ObjectMapper;
import io.swagger.v3.core.util.Json;
import io.swagger.v3.core.util.JsonAssert;
import io.swagger.v3.oas.models.media.ArraySchema;
import io.swagger.v3.oas.models.media.BooleanSchema;
import io.swagger.v3.oas.models.media.DateSchema;
Expand Down Expand Up @@ -32,7 +33,7 @@ public void serializeBooleanSchema() throws IOException {
final BooleanSchema p = new BooleanSchema()
._default(true);
final String json = "{\"type\":\"boolean\",\"default\":true}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a BooleanSchema")
Expand All @@ -43,14 +44,14 @@ public void deserializeBooleanSchema() throws IOException {
assertNull(p.getFormat());
assertEquals(p.getClass(), BooleanSchema.class);
assertEquals(((BooleanSchema) p).getDefault(), Boolean.FALSE);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a DateProperty")
public void serializeDateProperty() throws IOException {
final DateSchema p = new DateSchema();
final String json = "{\"type\":\"string\",\"format\":\"date\"}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a DateProperty")
Expand All @@ -60,14 +61,14 @@ public void deserializeDateProperty() throws IOException {
assertEquals(p.getType(), "string");
assertEquals(p.getFormat(), "date");
assertEquals(p.getClass(), DateSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a DateTimeProperty")
public void serializeDateTimeProperty() throws IOException {
final DateTimeSchema p = new DateTimeSchema();
final String json = "{\"type\":\"string\",\"format\":\"date-time\"}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a DateTimeProperty")
Expand All @@ -77,7 +78,7 @@ public void deserializeDateTimeProperty() throws IOException {
assertEquals(p.getType(), "string");
assertEquals(p.getFormat(), "date-time");
assertEquals(p.getClass(), DateTimeSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a DoubleProperty")
Expand All @@ -86,7 +87,7 @@ public void serializeDoubleProperty() throws IOException {
._default(new BigDecimal("3.14159"));
p.format("double");
final String json = "{\"type\":\"number\",\"format\":\"double\",\"default\":3.14159}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a DoubleProperty")
Expand All @@ -96,7 +97,7 @@ public void deserializeDoubleProperty() throws IOException {
assertEquals(p.getType(), "number");
assertEquals(p.getFormat(), "double");
assertEquals(p.getClass(), NumberSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a FloatProperty")
Expand All @@ -105,7 +106,7 @@ public void serializeFloatProperty() throws IOException {
._default(new BigDecimal("1.2"));
p.format("float");
final String json = "{\"type\":\"number\",\"format\":\"float\",\"default\":1.2}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a FloatProperty")
Expand All @@ -115,15 +116,15 @@ public void deserializeFloatProperty() throws IOException {
assertEquals(p.getType(), "number");
assertEquals(p.getFormat(), "float");
assertEquals(p.getClass(), NumberSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize an IntegerProperty")
public void serializeIntegerProperty() throws IOException {
final IntegerSchema p = new IntegerSchema()
._default(32);
final String json = "{\"type\":\"integer\",\"format\":\"int32\",\"default\":32}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a IntegerProperty")
Expand All @@ -133,7 +134,7 @@ public void deserializeIntegerProperty() throws IOException {
assertEquals(p.getType(), "integer");
assertEquals(p.getFormat(), "int32");
assertEquals(p.getClass(), IntegerSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a LongProperty")
Expand All @@ -142,7 +143,7 @@ public void serializeLongProperty() throws IOException {
.format("int64")
._default(8675309);
final String json = "{\"type\":\"integer\",\"format\":\"int64\",\"default\":8675309}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a LongProperty")
Expand All @@ -152,14 +153,14 @@ public void deserializeLongProperty() throws IOException {
assertEquals(p.getType(), "integer");
assertEquals(p.getFormat(), "int64");
assertEquals(p.getClass(), IntegerSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a string MapProperty")
public void serializeStringMapProperty() throws IOException {
final Schema p = new MapSchema().additionalProperties(new StringSchema());
final String json = "{\"type\":\"object\",\"additionalProperties\":{\"type\":\"string\"}}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a string MapProperty")
Expand All @@ -168,14 +169,14 @@ public void deserializeStringMapProperty() throws IOException {
final Schema p = m.readValue(json, Schema.class);
assertEquals(p.getType(), "object");
assertEquals(p.getClass(), MapSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a integer MapProperty")
public void serializeIntegerMapProperty() throws IOException {
final Schema p = new MapSchema().additionalProperties(new IntegerSchema());
final String json = "{\"type\":\"object\",\"additionalProperties\":{\"type\":\"integer\",\"format\":\"int32\"}}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a integer MapProperty")
Expand All @@ -184,14 +185,14 @@ public void deserializeIntegerMapProperty() throws IOException {
final Schema p = m.readValue(json, Schema.class);
assertEquals(p.getType(), "object");
assertEquals(p.getClass(), MapSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a long MapProperty")
public void serializeLongMapProperty() throws IOException {
final Schema p = new MapSchema().additionalProperties(new IntegerSchema().format("int64"));
final String json = "{\"type\":\"object\",\"additionalProperties\":{\"type\":\"integer\",\"format\":\"int64\"}}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a long MapProperty")
Expand All @@ -200,30 +201,30 @@ public void deserializeLongMapProperty() throws IOException {
final Schema p = m.readValue(json, Schema.class);
assertEquals(p.getType(), "object");
assertEquals(p.getClass(), MapSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a RefProperty")
public void serializeRefProperty() throws IOException {
final Schema p = new Schema().$ref("#/definitions/Dog");
final String json = "{\"$ref\":\"#/definitions/Dog\"}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a RefProperty")
public void deserializeRefProperty() throws IOException {
final String json = "{\"$ref\":\"#/definitions/Dog\"}";
final Schema p = m.readValue(json, Schema.class);
assertEquals(p.getClass(), Schema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a StringProperty")
public void serializeStringProperty() throws IOException {
final StringSchema p = new StringSchema()
._default("Bob");
final String json = "{\"type\":\"string\",\"default\":\"Bob\"}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a StringProperty")
Expand All @@ -232,7 +233,7 @@ public void deserializeStringProperty() throws IOException {
final Schema p = m.readValue(json, Schema.class);
assertEquals(p.getType(), "string");
assertEquals(p.getClass(), StringSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a StringProperty with enums")
Expand All @@ -243,7 +244,7 @@ public void serializeEnumStringProperty() throws IOException {
this.add("b");
}});
final String json = "{\"type\":\"string\",\"enum\":[\"a\",\"b\"]}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a StringProperty with enums")
Expand All @@ -255,7 +256,7 @@ public void deserializeEnumStringProperty() throws IOException {
assertNotNull(_enum);
assertEquals(_enum, Arrays.asList("a", "b"));
assertEquals(p.getClass(), StringSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize an IntegerProperty with enums")
Expand All @@ -267,14 +268,14 @@ public void deserializeEnumIntegerProperty() throws IOException {
assertNotNull(_enum);
assertEquals(_enum, Arrays.asList(1, 2));
assertEquals(p.getClass(), IntegerSchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a string array property")
public void serializeArrayStringProperty() throws IOException {
final Schema p = new ArraySchema().items(new StringSchema());
final String json = "{\"type\":\"array\",\"items\":{\"type\":\"string\"}}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize a string array property")
Expand All @@ -283,22 +284,22 @@ public void deserializeArrayStringProperty() throws IOException {
final Schema p = m.readValue(json, Schema.class);
assertEquals(p.getType(), "array");
assertEquals(p.getClass(), ArraySchema.class);
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a string property with readOnly set")
public void serializeReadOnlyStringProperty() throws IOException {
final Schema p = new StringSchema().readOnly(true);
final String json = "{\"type\":\"string\",\"readOnly\":true}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize a string property with readOnly unset")
public void deserializeNotReadOnlyStringProperty() throws IOException {
final StringSchema p = new StringSchema();
p.setReadOnly(false);
final String json = "{\"type\":\"string\",\"readOnly\":false}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should serialize an object property with required set")
Expand All @@ -307,7 +308,7 @@ public void serializeObjectPropertyWithRequiredProperties() throws IOException {
.addProperties("stringProperty", new StringSchema());
p.required(Arrays.asList("stringProperty"));
final String json = "{\"required\":[\"stringProperty\"],\"type\":\"object\",\"properties\":{\"stringProperty\":{\"type\":\"string\"}}}";
assertEquals(m.writeValueAsString(p), json);
JsonAssert.assertJsonEquals(m, m.writeValueAsString(p), json);
}

@Test(description = "it should deserialize an object property with required set")
Expand Down
20 changes: 20 additions & 0 deletions modules/swagger-core/src/test/java/io/swagger/v3/core/util/JsonAssert.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package io.swagger.v3.core.util;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import static org.testng.Assert.assertTrue;

public final class JsonAssert {
private JsonAssert() {
}

public static void assertJsonEquals(ObjectMapper mapper, String expectedJson, String actualJson) {
try {
JsonNode expectedNode = mapper.readTree(expectedJson);
JsonNode actualNode = mapper.readTree(actualJson);
assertTrue(expectedNode.equals(actualNode));
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}
Loading