org.evomaster.client.java.instrumentation.object

Class ClassToSchema

java.lang.Object

org.evomaster.client.java.instrumentation.object.ClassToSchema

public class ClassToSchema
extends Object

The SUT when getting data, it might unmarshal/deserialize it into a specif class. Typical case is when a HTTP body payload is a JSON object, which should match a DTO in the SUT. So, we need a way to represent the schema of an object, independently from Java. So, for simplicity, we use OpenAPI.
Note: the marshalling can depend on the actual used libraries, eg Jackson and GSON, as they might use special annotations on the DTOs.

Constructor Summary

Constructors

Constructor and Description
ClassToSchema()

Method Summary

Modifier and Type	Method and Description
static String	getOrDeriveNonNestedSchema(Class<?> klass)
static String	getOrDeriveNonNestedSchema(Class<?> klass, boolean objectFieldsRequired, List<CustomTypeToOasConverter> converters)
static String	getOrDeriveSchema(Class<?> klass, List<Class<?>> nested)
static String	getOrDeriveSchema(Class<?> klass, List<Class<?>> nested, boolean objectFieldsRequired, List<CustomTypeToOasConverter> converters)
static Map<String,String>	getOrDeriveSchemaAndNestedClasses(Class<?> klass, boolean objectFieldsRequired, List<CustomTypeToOasConverter> converters)
static String	getOrDeriveSchemaWithItsRef(Class<?> klass)
static String	getOrDeriveSchemaWithItsRef(Class<?> klass, boolean objectFieldsRequired, List<CustomTypeToOasConverter> converters)
static void	registerSchemaIfNeeded(Class<?> valueType)
static void	registerSchemaIfNeeded(Class<?> valueType, boolean objectFieldsRequired, List<CustomTypeToOasConverter> converters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClassToSchema

public ClassToSchema()

Method Detail

registerSchemaIfNeeded

public static void registerSchemaIfNeeded(Class<?> valueType)

registerSchemaIfNeeded

public static void registerSchemaIfNeeded(Class<?> valueType,
                                          boolean objectFieldsRequired,
                                          List<CustomTypeToOasConverter> converters)

getOrDeriveSchemaWithItsRef

public static String getOrDeriveSchemaWithItsRef(Class<?> klass)

Returns:

a schema representation of the class along with schemas of its ref classes in the form "kclass name: { "kclass name": "schema", "ref class name": "schema", .... }" it is mainly used by [JsonTaint.handlePossibleJsonTaint] For example (see more details with ClassToSchemaTest.testCycleDto), public class CycleDtoA { private String cycleAId; private CycleDtoB cycleDtoB; } public class CycleDtoB { private String cycleBId; private CycleDtoA cycleDtoA; } for CycleDtoA, it will return "org.evomaster.client.java.instrumentation.object.dtos.CycleDtoA":{ "org.evomaster.client.java.instrumentation.object.dtos.CycleDtoA":{"type":"object", "properties": {"cycleAId":{"type":"string"},"cycleDtoB":{"$ref":"#/components/schemas/org.evomaster.client.java.instrumentation.object.dtos.CycleDtoB"}}}, "org.evomaster.client.java.instrumentation.object.dtos.CycleDtoB":{"type":"object", "properties": {"cycleBId":{"type":"string"},"cycleDtoA":{"$ref":"#/components/schemas/org.evomaster.client.java.instrumentation.object.dtos.CycleDtoA"}}}}

getOrDeriveSchemaWithItsRef

public static String getOrDeriveSchemaWithItsRef(Class<?> klass,
                                                 boolean objectFieldsRequired,
                                                 List<CustomTypeToOasConverter> converters)

getOrDeriveNonNestedSchema

public static String getOrDeriveNonNestedSchema(Class<?> klass,
                                                boolean objectFieldsRequired,
                                                List<CustomTypeToOasConverter> converters)

getOrDeriveNonNestedSchema

public static String getOrDeriveNonNestedSchema(Class<?> klass)

Returns:

a schema representation of the class in the form "name: {...}"

getOrDeriveSchema

public static String getOrDeriveSchema(Class<?> klass,
                                       List<Class<?>> nested)

Parameters:

nested - is a list of nested classes

Returns:

a schema representation of the class in the form "name: {...}", ie like a field entry in an OpenAPI object definition

getOrDeriveSchema

public static String getOrDeriveSchema(Class<?> klass,
                                       List<Class<?>> nested,
                                       boolean objectFieldsRequired,
                                       List<CustomTypeToOasConverter> converters)

getOrDeriveSchemaAndNestedClasses

public static Map<String,String> getOrDeriveSchemaAndNestedClasses(Class<?> klass,
                                                                   boolean objectFieldsRequired,
                                                                   List<CustomTypeToOasConverter> converters)