org.apache.flink.statefun.testutils.function

Class FunctionTestHarness

java.lang.Object

org.apache.flink.statefun.testutils.function.FunctionTestHarness

public class FunctionTestHarness
extends java.lang.Object

The FunctionTestHarness provides a thin convenience wrapper around a StatefulFunction to capture its results under test.

The harness captures all messages sent using the Context from within the functions StatefulFunction.invoke(Context, Object) method and returns them. Values sent to an egress are also captured and can be queried via the getEgress(EgressIdentifier) method.

ImportantThis test harness is intended strictly for basic unit tests of functions. As such, Context.registerAsyncOperation(Object, CompletableFuture) awaits all futures. If you want to test in an asyncronous environment please consider using the the statefun-flink-harness.

 {@code @Test}
 public void test() {
     FunctionType type = new FunctionType("flink", "testfunc");
     FunctionTestHarness harness = TestHarness.test(new TestFunctionProvider(), type, "my-id");

     Assert.assertThat(
          harness.invoke("ping"),
          sent(
              messagesTo(
                  new Address(new FunctionType("flink", "func"), "id"), equalTo("pong"));
 }
 

Method Summary

Modifier and Type	Method and Description
<T> java.util.List<T>	getEgress(EgressIdentifier<T> identifier)
java.util.Map<Address,java.util.List<java.lang.Object>>	invoke(Address from, java.lang.Object message)
java.util.Map<Address,java.util.List<java.lang.Object>>	invoke(java.lang.Object message)
static FunctionTestHarness	test(StatefulFunctionProvider provider, FunctionType type, java.lang.String id) Creates a test harness, pinning the function to a particular address.
static FunctionTestHarness	test(StatefulFunctionProvider provider, FunctionType type, java.lang.String id, java.time.Instant startTime) Creates a test harness, pinning the function to a particular address.
java.util.Map<Address,java.util.List<java.lang.Object>>	tick(java.time.Duration duration) Advances the internal clock the harness and fires and pending timers.

Methods inherited from class java.lang.Object

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

Method Detail

test

public static FunctionTestHarness test(StatefulFunctionProvider provider,
                                       FunctionType type,
                                       java.lang.String id,
                                       java.time.Instant startTime)

Creates a test harness, pinning the function to a particular address.

Parameters:

provider - A provider for the function under test.

type - The type of the function.

id - The static id of the function for the duration of the test.

startTime - The initial timestamp of the internal clock.

Returns:

A fully configured test harness.

test

public static FunctionTestHarness test(StatefulFunctionProvider provider,
                                       FunctionType type,
                                       java.lang.String id)

Creates a test harness, pinning the function to a particular address.

Parameters:

provider - A provider for the function under test.

type - The type of the function.

id - The static id of the function for the duration of the test.

Returns:

A fully configured test harness.

invoke

public java.util.Map<Address,java.util.List<java.lang.Object>> invoke(java.lang.Object message)

Parameters:

message - A message that will be sent to the function.

Returns:

A responses sent from the function after invocation using Context.send(Address, Object).

invoke

public java.util.Map<Address,java.util.List<java.lang.Object>> invoke(Address from,
                                                                      java.lang.Object message)

Parameters:

message - A message that will be sent to the function.

from - The address of the function that sent the message.

Returns:

A responses sent from the function after invocation using Context.send(Address, Object).

tick

public java.util.Map<Address,java.util.List<java.lang.Object>> tick(java.time.Duration duration)

Advances the internal clock the harness and fires and pending timers.

Parameters:

duration - the amount of time to advance for this tick.

Returns:

A responses sent from the function after invocation.

getEgress

public <T> java.util.List<T> getEgress(EgressIdentifier<T> identifier)

Type Parameters:

T - the data type consumed by the egress.

Parameters:

identifier - An egress identifier

Returns:

All the messages sent to that egress.