net.openhft.chronicle.wire

Class TextMethodTester<T>

java.lang.Object

net.openhft.chronicle.wire.TextMethodTester<T>

Type Parameters:

T - The type of the output class.

All Implemented Interfaces:

YamlTester

Direct Known Subclasses:

YamlMethodTester

public class TextMethodTester<T>
extends Object
implements YamlTester

Provides a tester for methods with text input, primarily focused on YAML testing. This tester is configurable and can simulate various situations, using specified exception handlers, update interceptors, and other components.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextMethodTester.PostSetup Represents an action that should be performed after a setup procedure.

Field Summary

Fields

Modifier and Type	Field and Description
static Consumer<net.openhft.chronicle.core.util.InvocationTargetRuntimeException>	DEFAULT_INVOCATION_TARGET_RUNTIME_EXCEPTION_CONSUMER
static boolean	SINGLE_THREADED_CHECK_DISABLED

Fields inherited from interface net.openhft.chronicle.wire.utils.YamlTester

BASE_TESTS, REGRESS_TESTS

Constructor Summary

Constructors

Constructor and Description
TextMethodTester(String input, BiFunction<T,net.openhft.chronicle.bytes.UpdateInterceptor,Object> componentFunction, Class<T> outputClass, String output) Constructs a TextMethodTester with specified input, component function, output class, and output.
TextMethodTester(String input, Function<T,Object> componentFunction, Class<T> outputClass, String output) Constructs a TextMethodTester with specified input, component function, output class, and output.
TextMethodTester(String input, Function<T,Object> componentFunction, Function<WireOut,T> outputFunction, String output) Constructs a TextMethodTester with specified input, component function, output function, and output.

Method Summary

Modifier and Type	Method and Description
String	actual() Retrieves the actual test output.
TextMethodTester<T>	addOutputClass(Class<?> outputClass) Adds an output class to the tester.
Function<String,String>	afterRun() Retrieves the after-run function.
@NotNull TextMethodTester<T>	afterRun(Function<String,String> afterRun) Specifies the function to execute after a run.
Map<String,String>	agitate(YamlAgitator agitator) Generates additional tests based on the current test configuration by using a specified YamlAgitator.
protected Wire	createWire(byte[] byteArray) Creates a Wire object from a given byte array.
protected Wire	createWire(net.openhft.chronicle.bytes.Bytes<?> bytes) Creates a Wire instance based on the provided bytes.
TextMethodTester<T>	exceptionHandlerFunction(Function<T,net.openhft.chronicle.core.onoes.ExceptionHandler> exceptionHandlerFunction) Sets the exception handling function for the tester.
TextMethodTester<T>	exceptionHandlerFunctionAndLog(boolean exceptionHandlerFunctionAndLog) Configures whether the tester should log the exception handling function.
BiConsumer<net.openhft.chronicle.bytes.MethodReader,T>	exceptionHandlerSetup() Retrieves the exception handler setup.
TextMethodTester<T>	exceptionHandlerSetup(BiConsumer<net.openhft.chronicle.bytes.MethodReader,T> exceptionHandlerSetup) Specifies the BiConsumer for handling the exception setup.
String	expected() Retrieves the expected output result.
String	genericEvent() Retrieves the generic event string.
TextMethodTester<T>	genericEvent(String genericEvent) Specifies the generic event string.
TextMethodTester<T>	inputFunction(Function<String,String> inputFunction) Configures the input transformation function for the tester.
protected @NotNull StringBuilder	loadLastValues() Loads the last values from the output wire file.
TextMethodTester<T>	methodReaderInterceptorReturns(net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns) Sets the MethodReaderInterceptorReturns for the tester.
Consumer<net.openhft.chronicle.core.util.InvocationTargetRuntimeException>	onInvocationException() Retrieves the exception consumer for InvocationTargetRuntimeException.
TextMethodTester<T>	onInvocationException(Consumer<net.openhft.chronicle.core.util.InvocationTargetRuntimeException> onInvocationException) Specifies the consumer for InvocationTargetRuntimeException.
boolean	readOne(net.openhft.chronicle.bytes.MethodReader reader0, net.openhft.chronicle.core.onoes.ExceptionHandler exceptionHandler) Attempts to read a single message or event from the provided MethodReader.
static boolean	resourceExists(String resourceName) Checks if a given resource exists.
String[]	retainLast() Gets the strings to be retained from the last run.
@NotNull TextMethodTester<T>	retainLast(String... retainLast) Specifies strings that should be retained from the last run.
@NotNull TextMethodTester<T>	run() Executes the test based on the specified setup.
String	setup() Retrieves the single setup value.
@NotNull TextMethodTester<T>	setup(@Nullable String setup) Specifies a single setup string for the method tester.
@NotNull TextMethodTester<T>	setups(@NotNull List<String> setups) Specifies a list of setup strings for the method tester.
TextMethodTester<T>	testFilter(Predicate<String> testFilter) Sets a filter for the tester to determine which tests should be executed.
TextMethodTester<T>	timeoutMS(long timeoutMS) Sets the timeout (in milliseconds) for the tester.
TextMethodTester<T>	updateInterceptor(net.openhft.chronicle.bytes.UpdateInterceptor updateInterceptor) Sets the UpdateInterceptor for the tester.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.wire.utils.YamlTester

runTest, runTest, runTest

Field Detail

SINGLE_THREADED_CHECK_DISABLED

public static final boolean SINGLE_THREADED_CHECK_DISABLED

DEFAULT_INVOCATION_TARGET_RUNTIME_EXCEPTION_CONSUMER

public static final Consumer<net.openhft.chronicle.core.util.InvocationTargetRuntimeException> DEFAULT_INVOCATION_TARGET_RUNTIME_EXCEPTION_CONSUMER

Constructor Detail

TextMethodTester

public TextMethodTester(String input,
                        Function<T,Object> componentFunction,
                        Class<T> outputClass,
                        String output)

Constructs a TextMethodTester with specified input, component function, output class, and output.

Parameters:

input - The text input for the method.

componentFunction - Function to handle components within the tester.

outputClass - The class representing the type of output.

output - The text representation of the output.

TextMethodTester

public TextMethodTester(String input,
                        BiFunction<T,net.openhft.chronicle.bytes.UpdateInterceptor,Object> componentFunction,
                        Class<T> outputClass,
                        String output)

Constructs a TextMethodTester with specified input, component function, output class, and output.

Parameters:

input - The text input for the method.

componentFunction - BiFunction to handle components with an update interceptor.

outputClass - The class representing the type of output.

output - The text representation of the output.

TextMethodTester

public TextMethodTester(String input,
                        Function<T,Object> componentFunction,
                        Function<WireOut,T> outputFunction,
                        String output)

Constructs a TextMethodTester with specified input, component function, output function, and output.

Parameters:

input - The text input for the method.

componentFunction - Function to handle components within the tester.

outputFunction - Function to generate the output based on wire data.

output - The text representation of the output.

Method Detail

addOutputClass

public TextMethodTester<T> addOutputClass(Class<?> outputClass)

Adds an output class to the tester.

Parameters:

outputClass - The additional output class to be added.

Returns:

The current TextMethodTester instance.

resourceExists

public static boolean resourceExists(String resourceName)

Checks if a given resource exists.

Parameters:

resourceName - The name of the resource.

Returns:

true if the resource exists, otherwise false.

retainLast

public String[] retainLast()

Gets the strings to be retained from the last run.

Returns:

An array of strings to be retained.

retainLast

@NotNull
public @NotNull TextMethodTester<T> retainLast(String... retainLast)

Specifies strings that should be retained from the last run.

Parameters:

retainLast - Strings to retain.

Returns:

The current TextMethodTester instance.

setup

public String setup()

Retrieves the single setup value. Throws an exception if there are none or multiple setups.

Returns:

The single setup string.

Throws:

IllegalStateException - if there are no setups or more than one setup.

setup

@NotNull
public @NotNull TextMethodTester<T> setup(@Nullable
                                                   @Nullable String setup)

Specifies a single setup string for the method tester.

Parameters:

setup - The setup string to set.

Returns:

The current TextMethodTester instance.

setups

@NotNull
public @NotNull TextMethodTester<T> setups(@NotNull
                                                    @NotNull List<String> setups)

Specifies a list of setup strings for the method tester.

Parameters:

setups - The list of setup strings.

Returns:

The current TextMethodTester instance.

afterRun

public Function<String,String> afterRun()

Retrieves the after-run function.

Returns:

The function to execute after the run.

afterRun

@NotNull
public @NotNull TextMethodTester<T> afterRun(Function<String,String> afterRun)

Specifies the function to execute after a run.

Parameters:

afterRun - The after-run function.

Returns:

The current TextMethodTester instance.

exceptionHandlerSetup

public BiConsumer<net.openhft.chronicle.bytes.MethodReader,T> exceptionHandlerSetup()

Retrieves the exception handler setup.

Returns:

The BiConsumer handling exception setup.

exceptionHandlerSetup

public TextMethodTester<T> exceptionHandlerSetup(BiConsumer<net.openhft.chronicle.bytes.MethodReader,T> exceptionHandlerSetup)

Specifies the BiConsumer for handling the exception setup.

Parameters:

exceptionHandlerSetup - The exception handler setup BiConsumer.

Returns:

The current TextMethodTester instance.

genericEvent

public String genericEvent()

Retrieves the generic event string.

Returns:

The generic event string.

genericEvent

public TextMethodTester<T> genericEvent(String genericEvent)

Specifies the generic event string.

Parameters:

genericEvent - The generic event string.

Returns:

The current TextMethodTester instance.

onInvocationException

public Consumer<net.openhft.chronicle.core.util.InvocationTargetRuntimeException> onInvocationException()

Retrieves the exception consumer for InvocationTargetRuntimeException.

Returns:

The exception consumer.

onInvocationException

public TextMethodTester<T> onInvocationException(Consumer<net.openhft.chronicle.core.util.InvocationTargetRuntimeException> onInvocationException)

Specifies the consumer for InvocationTargetRuntimeException.

Parameters:

onInvocationException - The consumer for InvocationTargetRuntimeException.

Returns:

The current TextMethodTester instance.

run

@NotNull
public @NotNull TextMethodTester<T> run()
                                          throws IOException

Executes the test based on the specified setup.

Returns:

The current TextMethodTester instance.

Throws:

IOException - if there is an error in IO operations.

agitate

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

Description copied from interface: YamlTester

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.

Specified by:

agitate in interface YamlTester

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.

readOne

public boolean readOne(net.openhft.chronicle.bytes.MethodReader reader0,
                       net.openhft.chronicle.core.onoes.ExceptionHandler exceptionHandler)

Attempts to read a single message or event from the provided MethodReader. Handles any exceptions thrown during the reading process by using the provided ExceptionHandler or the default onInvocationException.

Parameters:

reader0 - The MethodReader used to read the message or event.

exceptionHandler - The handler to manage any exceptions thrown during the reading process.

Returns:

true if the reading is successful or if an exception was caught and handled. Returns false if no messages were read and no exception occurred.

createWire

protected Wire createWire(byte[] byteArray)

Creates a Wire object from a given byte array. This method provides flexibility by allowing input to be processed using the inputFunction if it's set, or using the byte array directly if it's not.

Parameters:

byteArray - The byte array from which the Wire object will be created.

Returns:

A new Wire object constructed using the provided byte array or its processed content.

createWire

protected Wire createWire(net.openhft.chronicle.bytes.Bytes<?> bytes)

Creates a Wire instance based on the provided bytes. The choice between creating a YamlWire or a TextWire is determined by the value of the TEXT_AS_YAML flag. In both cases, text documents and timestamps are enabled.

Parameters:

bytes - The bytes from which the Wire instance will be created.

Returns:

A new Wire instance, either YamlWire or TextWire based on the TEXT_AS_YAML flag.

loadLastValues

@NotNull
protected @NotNull StringBuilder loadLastValues()
                                                  throws IOException,
                                                         net.openhft.chronicle.core.io.InvalidMarshallableException

Loads the last values from the output wire file. Reads events from the wire and stores them in a map. The events are stored in sorted order.

Returns:

A StringBuilder containing the extracted events from the wire.

Throws:

IOException - If there's a problem reading the wire file.

net.openhft.chronicle.core.io.InvalidMarshallableException - If the wire file contains invalid or unmarshallable data.

expected

public String expected()

Retrieves the expected output result. If the expected result is not yet available, it will attempt to run the test to compute it.

Specified by:

expected in interface YamlTester

Returns:

The expected output string.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If there's an IO issue while running the test.

actual

public String actual()

Retrieves the actual test output. If the actual result is not yet available, it will attempt to run the test to compute it.

Specified by:

actual in interface YamlTester

Returns:

The actual test output string.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If there's an IO issue while running the test.

updateInterceptor

public TextMethodTester<T> updateInterceptor(net.openhft.chronicle.bytes.UpdateInterceptor updateInterceptor)

Sets the UpdateInterceptor for the tester. This allows for custom logic to be executed when updates are detected.

Parameters:

updateInterceptor - The update interceptor to set.

Returns:

The current instance of TextMethodTester, allowing for method chaining.

methodReaderInterceptorReturns

public TextMethodTester<T> methodReaderInterceptorReturns(net.openhft.chronicle.bytes.MethodReaderInterceptorReturns methodReaderInterceptorReturns)

Sets the MethodReaderInterceptorReturns for the tester. This allows for custom interception of method reader return values.

Parameters:

methodReaderInterceptorReturns - The method reader interceptor to set.

Returns:

The current instance of TextMethodTester, allowing for method chaining.

timeoutMS

public TextMethodTester<T> timeoutMS(long timeoutMS)

Sets the timeout (in milliseconds) for the tester.

Parameters:

timeoutMS - The timeout in milliseconds to set.

Returns:

The current instance of TextMethodTester, allowing for method chaining.

exceptionHandlerFunction

public TextMethodTester<T> exceptionHandlerFunction(Function<T,net.openhft.chronicle.core.onoes.ExceptionHandler> exceptionHandlerFunction)

Sets the exception handling function for the tester. This function determines how exceptions are handled during test execution.

Parameters:

exceptionHandlerFunction - The exception handling function to set.

Returns:

The current instance of TextMethodTester, allowing for method chaining.

exceptionHandlerFunctionAndLog

public TextMethodTester<T> exceptionHandlerFunctionAndLog(boolean exceptionHandlerFunctionAndLog)

Configures whether the tester should log the exception handling function. This determines how exceptions are logged during test execution.

Parameters:

exceptionHandlerFunctionAndLog - Flag to determine if the exception handling function should be logged.

Returns:

The current instance of TextMethodTester, allowing for method chaining.

testFilter

public TextMethodTester<T> testFilter(Predicate<String> testFilter)

Sets a filter for the tester to determine which tests should be executed.

Parameters:

testFilter - The filter predicate that accepts a test's name as a parameter.

Returns:

The current instance of TextMethodTester, allowing for method chaining.

inputFunction

public TextMethodTester<T> inputFunction(Function<String,String> inputFunction)

Configures the input transformation function for the tester. This function allows for modification of input values before they're processed.

Parameters:

inputFunction - The function that transforms input values.

Returns:

The current instance of TextMethodTester, allowing for method chaining.