spring-boot-test/org.springframework.boot.test.json/GsonTester

GsonTester

open class GsonTester<T> : AbstractJsonMarshalTester<T>

AssertJ based JSON tester backed by Gson. Usually instantiated via initFields, for example: 

public class ExampleObjectJsonTests {

    private GsonTester<ExampleObject> json;

    @Before
    public void setup() {
        Gson gson = new GsonBuilder().create();
        GsonTester.initFields(this, gson);
    }

    @Test
    public void testWriteJson() throws IOException {
        ExampleObject object = //...
        assertThat(json.write(object)).isEqualToJson("expected.json");
    }

}
Content copied to clipboard
See AbstractJsonMarshalTester for more details.

Author

Phillip Webb

Since

1.4.0

Parameters

<T>

the type under test

Constructors

Link copied to clipboard
constructor(resourceLoadClass: Class<out Any>, type: ResolvableType, gson: Gson)
Create a new GsonTester instance.

Functions

Link copied to clipboard
open fun initFields(testInstance: Any, gson: Gson)
open fun initFields(testInstance: Any, gson: ObjectFactory<Gson>)
Utility method to initialize GsonTester fields.
Link copied to clipboard
open fun parse(jsonBytes: Array<Byte>): ObjectContent<T>
Return ObjectContent from parsing the specific JSON bytes.
open fun parse(jsonString: String): ObjectContent<T>
Return ObjectContent from parsing the specific JSON String.
Link copied to clipboard
open fun parseObject(jsonBytes: Array<Byte>): T
Return the object created from parsing the specific JSON bytes.
open fun parseObject(jsonString: String): T
Return the object created from parsing the specific JSON String.
Link copied to clipboard
open fun read(file: File): ObjectContent<T>
Return ObjectContent from reading from the specified file.
open fun read(inputStream: InputStream): ObjectContent<T>
Return ObjectContent from reading from the specified input stream.
open fun read(reader: Reader): ObjectContent<T>
Return ObjectContent from reading from the specified reader.
open fun read(resourcePath: String): ObjectContent<T>
Return ObjectContent from reading from the specified classpath resource.
open fun read(resource: Resource): ObjectContent<T>
Return ObjectContent from reading from the specified resource.
Link copied to clipboard
open fun readObject(file: File): T
Return the object created from reading from the specified file.
open fun readObject(inputStream: InputStream): T
Return the object created from reading from the specified input stream.
open fun readObject(reader: Reader): T
Return the object created from reading from the specified reader.
open fun readObject(resourcePath: String): T
Return the object created from reading from the specified classpath resource.
open fun readObject(resource: Resource): T
Return the object created from reading from the specified resource.
Link copied to clipboard
open fun write(value: T): JsonContent<T>
Return JsonContent from writing the specific value.