Skip to content

Commit

Permalink
Create seperate module for swagger-java17 tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@micryc
micryc committed Oct 3, 2024
1 parent 7977064 commit 4a4cea2
Show file tree
Hide file tree
Showing 11 changed files with 369 additions and 108 deletions.
66 changes: 0 additions & 66 deletions ...s/swagger-core/src/test/java/io/swagger/v3/core/resolving/v31/ModelResolverOAS31Test.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -348,70 +348,4 @@ public void setMyField(Number myField) {
this.myField = myField;
}
}

@Test
public void testOAS31JavaRecord() {
String expectedYaml = "JavaRecordWithOAS31Fields:\n" +
" type: object\n" +
" $comment: Random comment at schema level\n" +
" $id: http://yourdomain.com/schemas/myschema.json\n" +
" description: this is model for testing OAS 3.1 Java Record resolving\n" +
" properties:\n" +
" test:\n" +
" type: string\n" +
" isLatest:\n" +
" type: boolean\n" +
" randomList:\n" +
" type: array\n" +
" contains:\n" +
" type: string\n" +
" items:\n" +
" type: string\n" +
" maxContains: 10\n" +
" minContains: 1\n" +
" prefixItems:\n" +
" - type: string\n" +
" unevaluatedItems:\n" +
" type: number\n" +
" Status:\n" +
" type:\n" +
" - string\n" +
" - number\n";

Map<String, Schema> stringSchemaMap = ModelConverters.getInstance(true).readAll(JavaRecordWithOAS31Fields.class);
SerializationMatchers.assertEqualsToYaml31(stringSchemaMap, expectedYaml);
}

@io.swagger.v3.oas.annotations.media.Schema(
$id = "http://yourdomain.com/schemas/myschema.json",
description = "this is model for testing OAS 3.1 Java Record resolving",
$comment = "Random comment at schema level",
types = "object"
)
private record JavaRecordWithOAS31Fields(
String test,
boolean isLatest,
@ArraySchema(
maxContains = 10,
minContains = 1,
contains = @io.swagger.v3.oas.annotations.media.Schema(
types = "string"
),
unevaluatedItems = @io.swagger.v3.oas.annotations.media.Schema(
types = "number"
),
prefixItems = {
@io.swagger.v3.oas.annotations.media.Schema(
types = "string"
)
}
)
List<String> randomList,
@io.swagger.v3.oas.annotations.media.Schema(types = {
"string",
"number"
})
Object Status
){
}
}
96 changes: 96 additions & 0 deletions modules/swagger-java17-support/pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-project</artifactId>
<version>2.2.25-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<artifactId>swagger-java17-support</artifactId>
<packaging>jar</packaging>
<name>swagger-java17-support</name>
<description>Module for Java 17 specific tests</description>
<dependencies>
<!-- Add dependencies required for your tests -->
<dependency>
<groupId>org.testng</groupId>
<artifactId>testng</artifactId>
<scope>test</scope>
</dependency>
<!-- Dependency on swagger-jaxrs2 module -->
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2</artifactId>
<version>${project.version}</version>
</dependency>
<!-- Dependency on swagger-core module -->
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-core</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-jaxrs2</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-models</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-multipart</artifactId>
<version>${jersey2-version}</version>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
</exclusion>
<exclusion>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.inject</groupId>
<artifactId>jersey-hk2</artifactId>
<version>${jersey2-version}</version>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>javax.annotation</groupId>
<artifactId>javax.annotation-api</artifactId>
</exclusion>
<exclusion>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
</plugin>
</plugins>
</build>
<properties>
<maven.compiler.release>17</maven.compiler.release>
</properties>

</project>
47 changes: 47 additions & 0 deletions modules/swagger-java17-support/src/test/java/io/swagger/v3/java17/Reader/ReaderTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package io.swagger.v3.java17.Reader;

import io.swagger.v3.java17.matchers.SerializationMatchers;
import io.swagger.v3.java17.resources.TestControllerWithRecordResource;
import io.swagger.v3.jaxrs2.Reader;
import io.swagger.v3.oas.integration.SwaggerConfiguration;
import io.swagger.v3.oas.models.OpenAPI;
import org.testng.annotations.Test;

public class ReaderTest {

@Test
public void TestJavaRecordRef(){
Reader reader = new Reader(new SwaggerConfiguration().openAPI(new OpenAPI()).openAPI31(true));

OpenAPI openAPI = reader.read(TestControllerWithRecordResource.class);
String yaml = "openapi: 3.1.0\n" +
"paths:\n" +
" /v17:\n" +
" post:\n" +
" operationId: opsRecordID\n" +
" responses:\n" +
" default:\n" +
" description: Successful operation\n" +
" content:\n" +
" application/json:\n" +
" schema:\n" +
" $ref: '#/components/schemas/JavaRecordResource'\n" +
"components:\n" +
" schemas:\n" +
" JavaRecordResource:\n" +
" type: object\n" +
" properties:\n" +
" test:\n" +
" type: string\n" +
" description: Testing of Java Record Processing\n" +
" isLatest:\n" +
" type: boolean\n" +
" id:\n" +
" type: string\n" +
" age:\n" +
" type: integer\n" +
" format: int32";
SerializationMatchers.assertEqualsToYaml31(openAPI, yaml);

}
}
88 changes: 88 additions & 0 deletions ...ger-java17-support/src/test/java/io/swagger/v3/java17/matchers/SerializationMatchers.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
package io.swagger.v3.java17.matchers;

import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.NumericNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import io.swagger.v3.core.util.Json;
import io.swagger.v3.core.util.Json31;
import io.swagger.v3.core.util.Yaml;
import io.swagger.v3.core.util.Yaml31;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.util.Comparator;

import static org.testng.Assert.assertEquals;

public class SerializationMatchers {
private static final Logger LOGGER = LoggerFactory.getLogger(SerializationMatchers.class);

public static void assertEqualsToYaml(Object objectToSerialize, String yamlStr) {
apply(objectToSerialize, yamlStr, Yaml.mapper(), false);
}

public static void assertEqualsToYamlExact(Object objectToSerialize, String yamlStr) {
apply(objectToSerialize, yamlStr, Yaml.mapper(), true);
}

public static void assertEqualsToJson(Object objectToSerialize, String jsonStr) {
apply(objectToSerialize, jsonStr, Json.mapper(), false);
}

public static void assertEqualsToYaml31(Object objectToSerialize, String yamlStr) {
apply31(objectToSerialize, yamlStr, Yaml31.mapper());
}

public static void assertEqualsToJson31(Object objectToSerialize, String jsonStr) {
apply31(objectToSerialize, jsonStr, Json31.mapper());
}

private static void apply(Object objectToSerialize, String str, ObjectMapper mapper, boolean exactMatch) {
final ObjectNode lhs = mapper.convertValue(objectToSerialize, ObjectNode.class);
ObjectNode rhs = null;
try {
rhs = mapper.readValue(str, ObjectNode.class);
} catch (IOException e) {
LOGGER.error("Failed to read value", e);
}
if (exactMatch || !lhs.equals(new ObjectNodeComparator(), rhs)) {
assertEquals(Yaml.pretty(lhs), Yaml.pretty(rhs));
//fail(String.format("Serialized object:\n%s\ndoes not equal to expected serialized string:\n%s", lhs, rhs));
}
}

private static void apply31(Object objectToSerialize, String str, ObjectMapper mapper) {
final ObjectNode lhs = mapper.convertValue(objectToSerialize, ObjectNode.class);
ObjectNode rhs = null;
try {
rhs = mapper.readValue(str, ObjectNode.class);
} catch (IOException e) {
LOGGER.error("Failed to read value", e);
}
if (!lhs.equals(new ObjectNodeComparator(), rhs)) {
assertEquals(Yaml31.pretty(lhs), Yaml31.pretty(rhs));
}
}

static final class ObjectNodeComparator implements Comparator<JsonNode> {
@Override
public int compare(JsonNode o1, JsonNode o2) {
if (o1.equals(o2)) {
return 0;
}
if ((o1 instanceof NumericNode) && (o2 instanceof NumericNode)) {
double d1 = ((NumericNode) o1).asDouble();
double d2 = ((NumericNode) o2).asDouble();
return Double.compare(d1, d2);
}
int comp = o1.asText().compareTo(o2.asText());
if (comp == 0) {
return Integer.compare(o1.hashCode(), o2.hashCode());
}
return comp;
}
}

}
4 changes: 2 additions & 2 deletions ...ger/v3/core/resolving/JavaRecordTest.java → ...r/v3/java17/resolving/JavaRecordTest.java
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package io.swagger.v3.core.resolving;
package io.swagger.v3.java17.resolving;

import io.swagger.v3.core.converter.ModelConverters;
import io.swagger.v3.core.matchers.SerializationMatchers;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.java17.matchers.SerializationMatchers;
import org.testng.annotations.Test;

import javax.validation.constraints.*;
Expand Down
34 changes: 34 additions & 0 deletions .../swagger-java17-support/src/test/java/io/swagger/v3/java17/resolving/SwaggerTestBase.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package io.swagger.v3.java17.resolving;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.util.DefaultPrettyPrinter;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import io.swagger.v3.core.jackson.ModelResolver;

public abstract class SwaggerTestBase {
static ObjectMapper mapper;

public static ObjectMapper mapper() {
if (mapper == null) {
mapper = new ObjectMapper();
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
}
return mapper;
}

protected ModelResolver modelResolver() {
return new ModelResolver(new ObjectMapper());
}

protected void prettyPrint(Object o) {
try {
System.out.println(mapper().writer(new DefaultPrettyPrinter()).writeValueAsString(o));
} catch (Exception e) {
e.printStackTrace();
}
}
}
Loading

0 comments on commit 4a4cea2

Please sign in to comment.