net.openhft.chronicle.bytes

Class BytesTextMethodTester<T>

java.lang.Object

net.openhft.chronicle.bytes.BytesTextMethodTester<T>

Type Parameters:

T - interface type whose methods are recorded and verified

public class BytesTextMethodTester<T>
extends Object

Utility for exercising an interface backed by Bytes using a textual description of the method calls. The input file typically contains a hex dump with optional comments describing the invocations. These calls are dispatched to a component supplied by componentFunction and the resulting output is serialised to text and compared with the expected output file. It is a convenient way to perform data driven tests of writer/reader style APIs.

Constructor Summary

Constructors

Constructor and Description
BytesTextMethodTester(String input, Function<T,Object> componentFunction, Class<T> outputClass, String output) Creates a tester configured with the given files and component builder.

Method Summary

Modifier and Type	Method and Description
String	actual() Returns the text generated from running the component under test.
Function<String,String>	afterRun() Returns the post-processing function applied to actual and expected output.
@NotNull BytesTextMethodTester	afterRun(UnaryOperator<String> afterRun) Sets a post-processing function applied to both expected and actual output before comparison.
String	expected() Returns the contents of the expected output file after optional post-processing.
@NotNull BytesTextMethodTester	run() Executes the test.
String	setup() Returns the path to the optional setup file.
@NotNull BytesTextMethodTester	setup(String setup) Sets a setup file to be processed before the main input.

Methods inherited from class java.lang.Object

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

Constructor Detail

BytesTextMethodTester

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

Creates a tester configured with the given files and component builder.

Parameters:

input - path to the text (usually hex) file describing the method invocations

componentFunction - function producing the component(s) that will process the invocations

outputClass - interface class defining the methods encoded in the files

output - path to the expected output file

Method Detail

setup

public String setup()

Returns the path to the optional setup file.

setup

@NotNull
public @NotNull BytesTextMethodTester setup(String setup)

Sets a setup file to be processed before the main input.

Parameters:

setup - path to the setup file

Returns:

this tester for chaining

afterRun

public Function<String,String> afterRun()

Returns the post-processing function applied to actual and expected output.

afterRun

@NotNull
public @NotNull BytesTextMethodTester afterRun(UnaryOperator<String> afterRun)

Sets a post-processing function applied to both expected and actual output before comparison.

Parameters:

afterRun - normalising function

Returns:

this tester for chaining

run

@NotNull
public @NotNull BytesTextMethodTester run()
                                            throws IOException

Executes the test. The input (and optional setup) files are parsed and the resulting invocations dispatched to the component. All calls made to the output writer are captured and written back to text for comparison with the expected output file. The processed strings can be retrieved via expected() and actual().

Returns:

this tester for chaining

Throws:

IOException - if any of the files cannot be read

expected

public String expected()

Returns the contents of the expected output file after optional post-processing.

actual

public String actual()

Returns the text generated from running the component under test.