org.apache.flink.statefun.sdk.java.testing

Class TestContext

java.lang.Object

org.apache.flink.statefun.sdk.java.testing.TestContext

All Implemented Interfaces:

Context

public final class TestContext
extends java.lang.Object
implements Context

An implementation of Context to to make it easier to test StatefulFunctions in isolation. It can be instantiated with the address of the function under test and optionally the address of the caller.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Address>	caller()
void	cancelDelayedMessage(java.lang.String cancellationToken) Cancel a delayed message (a message that was send via Context.sendAfter(Duration, Message)).
static TestContext	forTarget(Address self)
static TestContext	forTargetWithCaller(Address self, Address caller)
java.util.List<SideEffects.SendAfterSideEffect>	getSentDelayedMessages()
java.util.List<SideEffects.EgressSideEffect>	getSentEgressMessages() This method returns a list of all egress messages sent by this function via Context.send(EgressMessage).
java.util.List<SideEffects.SendSideEffect>	getSentMessages() This method returns a list of all messages sent by this function via Context.send(Message) or Context.sendAfter(Duration, Message).
Address	self()
void	send(EgressMessage message) Sends out a EgressMessage to an egress.
void	send(Message message) Sends out a Message to another function.
void	sendAfter(java.time.Duration duration, Message message) Sends out a Message to another function, after a specified Duration delay.
void	sendAfter(java.time.Duration duration, java.lang.String cancellationToken, Message message) Sends out a Message to another function, after a specified Duration delay.
AddressScopedStorage	storage()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.statefun.sdk.java.Context

done

Method Detail

forTarget

public static TestContext forTarget(Address self)

forTargetWithCaller

public static TestContext forTargetWithCaller(Address self,
                                              Address caller)

self

public Address self()

Specified by:

self in interface Context

Returns:

The current invoked function instance's Address.

caller

public java.util.Optional<Address> caller()

Specified by:

caller in interface Context

Returns:

The caller function instance's Address, if applicable. This is Optional.empty() if the message was sent to this function via an ingress.

send

public void send(Message message)

Description copied from interface: Context

Sends out a Message to another function.

Specified by:

send in interface Context

Parameters:

message - the message to send.

sendAfter

public void sendAfter(java.time.Duration duration,
                      Message message)

Description copied from interface: Context

Sends out a Message to another function, after a specified Duration delay.

Specified by:

sendAfter in interface Context

Parameters:

duration - the amount of time to delay the message delivery.

message - the message to send.

sendAfter

public void sendAfter(java.time.Duration duration,
                      java.lang.String cancellationToken,
                      Message message)

Description copied from interface: Context

Sends out a Message to another function, after a specified Duration delay.

Specified by:

sendAfter in interface Context

Parameters:

duration - the amount of time to delay the message delivery. * @param cancellationToken

cancellationToken - the non-empty, non-null, unique token to attach to this message, to be used for message cancellation. (see Context.cancelDelayedMessage(String).)

message - the message to send.

cancelDelayedMessage

public void cancelDelayedMessage(java.lang.String cancellationToken)

Description copied from interface: Context

Cancel a delayed message (a message that was send via Context.sendAfter(Duration, Message)).

NOTE: this is a best-effort operation, since the message might have been already delivered. If the message was delivered, this is a no-op operation.

Specified by:

cancelDelayedMessage in interface Context

Parameters:

cancellationToken - the id of the message to un-send.

send

public void send(EgressMessage message)

Description copied from interface: Context

Sends out a EgressMessage to an egress.

Specified by:

send in interface Context

Parameters:

message - the message to send.

storage

public AddressScopedStorage storage()

Specified by:

storage in interface Context

Returns:

The AddressScopedStorage, providing access to stored values scoped to the current invoked function instance's Address (which is obtainable using Context.self()).

getSentMessages

public java.util.List<SideEffects.SendSideEffect> getSentMessages()

This method returns a list of all messages sent by this function via Context.send(Message) or Context.sendAfter(Duration, Message).

Messages are wrapped in an SideEffects.SendSideEffect that contains the message itself and the duration after which the message was sent. The Duration is Duration.ZERO for messages sent via Context.send(Message).

Returns:

the list of sent messages wrapped in SideEffects.SendSideEffects

getSentDelayedMessages

public java.util.List<SideEffects.SendAfterSideEffect> getSentDelayedMessages()

getSentEgressMessages

public java.util.List<SideEffects.EgressSideEffect> getSentEgressMessages()

This method returns a list of all egress messages sent by this function via Context.send(EgressMessage).

Returns:

the list of sent EgressMessages