net.openhft.chronicle.wire.utils

Interface YamlTester

All Known Implementing Classes:

TextMethodTester, YamlMethodTester

public interface YamlTester

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	BASE_TESTS When enabled only the base tests are run.
static boolean	REGRESS_TESTS Enabling this will overwrite the output yaml file instead of checking it.

Method Summary

Modifier and Type	Method and Description
String	actual()
default Map<String,String>	agitate(YamlAgitator agitator) Using this test as a template, generate more tests using this YamlAgitator
String	expected()
static YamlTester	runTest(Class<?> implClass, String path) Test a component implemented in a class using in.yaml comparing with out.yaml, with optionally setup.yaml to initialise it.
static <T> YamlTester	runTest(Function<T,Object> builder, Class<T> outClass, String path) Test a component implemented in a class using in.yaml comparing with out.yaml, with optionally setup.yaml to initialise it.
static <T> YamlTester	runTest(Function<T,Object> builder, Function<WireOut,T> outFunction, String path) Test a component implemented in a class using in.yaml comparing with out.yaml, with optionally setup.yaml to initialise it.

Field Detail

REGRESS_TESTS

static final boolean REGRESS_TESTS

Enabling this will overwrite the output yaml file instead of checking it. The test will still fail on an exception. You can check the output has changing in a reasonable way when committing the changes.

BASE_TESTS

static final boolean BASE_TESTS

When enabled only the base tests are run. i.e. generated tests are skipped.

Method Detail

runTest

static YamlTester runTest(Class<?> implClass,
                          String path)
                   throws AssertionError

Test a component implemented in a class using in.yaml comparing with out.yaml, with optionally setup.yaml to initialise it.

Parameters:

implClass - of the implementation

path - where the yaml files can be found

Returns:

the results for comparison

Throws:

AssertionError - if anything went wrong

runTest

static <T> YamlTester runTest(Function<T,Object> builder,
                              Class<T> outClass,
                              String path)
                       throws AssertionError

Test a component implemented in a class using in.yaml comparing with out.yaml, with optionally setup.yaml to initialise it.

Parameters:

builder - to construct a component to be tested

outClass - the interface of output

path - where the yaml files can be found

Returns:

the results for comparison

Throws:

AssertionError - if anything went wrong

runTest

static <T> YamlTester runTest(Function<T,Object> builder,
                              Function<WireOut,T> outFunction,
                              String path)
                       throws AssertionError

Test a component implemented in a class using in.yaml comparing with out.yaml, with optionally setup.yaml to initialise it.

Parameters:

builder - to construct a component to be tested

outFunction - the interface of output

path - where the yaml files can be found

Returns:

the results for comparison

Throws:

AssertionError - if anything went wrong

agitate

default Map<String,String> agitate(YamlAgitator agitator)
                            throws net.openhft.chronicle.core.io.IORuntimeException

Using this test as a template, generate more tests using this YamlAgitator

Parameters:

agitator - to use

Returns:

a map of gerenated inputs to test names

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an IO error occurs

expected

String expected()

Returns:

the expected String

actual

String actual()

Returns:

the actual String