net.openhft.chronicle.wire.utils

Interface YamlTester

All Known Implementing Classes:

TextMethodTester, YamlMethodTester

Deprecated.

@Deprecated
public interface YamlTester

The YamlTester interface provides utilities to perform testing on components using YAML configurations. It offers methods to run tests on given implementations using YAML files, compare them, and report any discrepancies. Two system properties can be set to influence the behavior of the tests:

• regress.tests: If set to true, it overwrites the output YAML file instead of checking it. Though the test will still fail on an exception. This is useful to verify the reasonableness of the output changes while committing.
• base.tests: If set to true, only the base tests are executed, skipping the generated tests.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	BASE_TESTS Deprecated. System property to determine whether to run only base tests.
static boolean	REGRESS_TESTS Deprecated. System property to determine whether to overwrite the output YAML file.

Method Summary

Modifier and Type	Method and Description
String	actual() Deprecated. Retrieves the actual result string obtained after test execution.
Map<String,String>	agitate(YamlAgitator agitator) Deprecated. Generates additional tests based on the current test configuration by using a specified YamlAgitator.
String	expected() Deprecated. Retrieves the expected result string after test execution.
static YamlTester	runTest(Class<?> implClass, String path) Deprecated. Executes tests for a given implementation class using the specified YAML files.
static <T> YamlTester	runTest(Function<T,Object> builder, Class<T> outClass, String path) Deprecated. Executes tests for a component built using the provided builder function.
static <T> YamlTester	runTest(Function<T,Object> builder, Function<WireOut,T> outFunction, String path) Deprecated. Executes tests on a component constructed by the given builder function and outputs the result using the provided outFunction.

Field Detail

REGRESS_TESTS

static final boolean REGRESS_TESTS

Deprecated.

System property to determine whether to overwrite the output YAML file.

BASE_TESTS

static final boolean BASE_TESTS

Deprecated.

System property to determine whether to run only base tests.

Method Detail

runTest

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

Deprecated.

Executes tests for a given implementation class using the specified YAML files. The method searches for a constructor in the implementation class that accepts a single interface argument and uses it to create an instance of the component.

Parameters:

implClass - Class of the implementation to be tested.

path - Directory path where the YAML files (in.yaml, out.yaml, and setup.yaml) are located.

Returns:

YamlTester instance containing the test results for comparison.

Throws:

AssertionError - If the test encounters issues or if the constructor doesn't match the expected format.

runTest

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

Deprecated.

Executes tests for a component built using the provided builder function. This method allows for more flexibility in constructing the component to be tested.

Type Parameters:

T - Type parameter representing the type of the input to the builder function.

Parameters:

builder - Function that builds the component to be tested.

outClass - Interface that represents the expected output type.

path - Directory path where the YAML files (in.yaml, out.yaml, and setup.yaml) are located.

Returns:

YamlTester instance containing the test results for comparison.

Throws:

AssertionError - If the test encounters issues.

runTest

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

Deprecated.

Executes tests on a component constructed by the given builder function and outputs the result using the provided outFunction. The input and expected results are sourced from `in.yaml` and `out.yaml` files, respectively. An optional `setup.yaml` file can also be provided to initialize the testing environment.

Type Parameters:

T - Type parameter indicating the type accepted by the builder function.

Parameters:

builder - Function to create the component under test.

outFunction - Interface function that represents the expected output type.

path - Directory path containing the YAML files (in.yaml, out.yaml, and optionally setup.yaml).

Returns:

YamlTester instance containing the test results for comparison.

Throws:

AssertionError - if any discrepancy is found or if an exception occurs during test execution.

agitate

Map<String,String> agitate(YamlAgitator agitator)

Deprecated.

Generates additional tests based on the current test configuration by using a specified YamlAgitator. These agitated tests can be used to validate component behavior under specific, possibly edge-case, scenarios.

Parameters:

agitator - YamlAgitator instance used to create additional test cases.

Returns:

A map where each key represents an agitated test input and the corresponding value is its test name.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if an I/O error occurs during test generation.

expected

String expected()

Deprecated.

Retrieves the expected result string after test execution.

Returns:

Expected result string.

actual

String actual()

Deprecated.

Retrieves the actual result string obtained after test execution.

Returns:

Actual result string.