io.temporal.testing.internal

Class SDKTestWorkflowRule

java.lang.Object

io.temporal.testing.internal.SDKTestWorkflowRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class SDKTestWorkflowRule
extends java.lang.Object
implements org.junit.rules.TestRule

Intended to be used only in the Java SDK test code. This Rule duplicates TestWorkflowRule and provides additional convenience methods for SDK development

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SDKTestWorkflowRule.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE
static boolean	REGENERATE_JSON_FILES
static java.lang.String	temporalServiceAddress
static boolean	useExternalService
static java.lang.String	UUID_REGEXP

Method Summary

Modifier and Type	Method and Description
<R> void	addWorkflowImplementationFactory(java.lang.Class<R> factoryImpl, io.temporal.workflow.Functions.Func<R> factoryFunc)
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)
void	assertHistoryEvent(io.temporal.api.common.v1.WorkflowExecution execution, io.temporal.api.enums.v1.EventType eventType) Asserts that an event of the given EventType is found in the history.
void	assertNoHistoryEvent(io.temporal.api.common.v1.WorkflowExecution execution, io.temporal.api.enums.v1.EventType eventType) Asserts that an event of the given EventType is not found in the history.
io.temporal.internal.common.WorkflowExecutionHistory	getExecutionHistory(io.temporal.api.common.v1.WorkflowExecution execution)
io.temporal.api.history.v1.History	getHistory(io.temporal.api.common.v1.WorkflowExecution execution)
io.temporal.api.history.v1.HistoryEvent	getHistoryEvent(io.temporal.api.common.v1.WorkflowExecution execution, io.temporal.api.enums.v1.EventType eventType) Returns the first event of the given EventType found in the history.
java.util.List<io.temporal.api.history.v1.HistoryEvent>	getHistoryEvents(io.temporal.api.common.v1.WorkflowExecution execution, io.temporal.api.enums.v1.EventType eventType) Returns list of all events of the given EventType found in the history.
<T extends io.temporal.common.interceptors.WorkerInterceptor> T	getInterceptor(java.lang.Class<T> type)
java.lang.String	getTaskQueue()
TestWorkflowEnvironment	getTestEnvironment()
io.temporal.worker.Worker	getWorker()
io.temporal.client.WorkflowClient	getWorkflowClient()
boolean	isUseExternalService()
static SDKTestWorkflowRule.Builder	newBuilder()
io.temporal.client.WorkflowStub	newUntypedWorkflowStub(java.lang.String workflow)
io.temporal.client.WorkflowStub	newUntypedWorkflowStubTimeoutOptions(java.lang.String workflow)
<T> T	newWorkflowStub(java.lang.Class<T> workflow)
<T> T	newWorkflowStub200sTimeoutOptions(java.lang.Class<T> workflow)
<T> T	newWorkflowStubTimeoutOptions(java.lang.Class<T> workflow)
void	regenerateHistoryForReplay(io.temporal.api.common.v1.WorkflowExecution execution, java.lang.String fileName)
void	registerDelayedCallback(java.time.Duration delay, java.lang.Runnable r)
protected void	shutdown()
void	sleep(java.time.Duration d)
static void	waitForOKQuery(io.temporal.client.WorkflowStub stub) Used to ensure that workflow first workflow task is executed.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

UUID_REGEXP

public static final java.lang.String UUID_REGEXP

See Also:

Constant Field Values

REGENERATE_JSON_FILES

public static final boolean REGENERATE_JSON_FILES

See Also:

Constant Field Values

useExternalService

public static final boolean useExternalService

temporalServiceAddress

public static final java.lang.String temporalServiceAddress

Method Detail

newBuilder

public static SDKTestWorkflowRule.Builder newBuilder()

apply

public org.junit.runners.model.Statement apply(@Nonnull
                                               org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)

Specified by:

apply in interface org.junit.rules.TestRule

getInterceptor

public <T extends io.temporal.common.interceptors.WorkerInterceptor> T getInterceptor(java.lang.Class<T> type)

getTaskQueue

public java.lang.String getTaskQueue()

getWorker

public io.temporal.worker.Worker getWorker()

getHistory

public io.temporal.api.history.v1.History getHistory(io.temporal.api.common.v1.WorkflowExecution execution)

getExecutionHistory

public io.temporal.internal.common.WorkflowExecutionHistory getExecutionHistory(io.temporal.api.common.v1.WorkflowExecution execution)

getHistoryEvents

public java.util.List<io.temporal.api.history.v1.HistoryEvent> getHistoryEvents(io.temporal.api.common.v1.WorkflowExecution execution,
                                                                                io.temporal.api.enums.v1.EventType eventType)

Returns list of all events of the given EventType found in the history.

getHistoryEvent

public io.temporal.api.history.v1.HistoryEvent getHistoryEvent(io.temporal.api.common.v1.WorkflowExecution execution,
                                                               io.temporal.api.enums.v1.EventType eventType)

Returns the first event of the given EventType found in the history.

assertHistoryEvent

public void assertHistoryEvent(io.temporal.api.common.v1.WorkflowExecution execution,
                               io.temporal.api.enums.v1.EventType eventType)

Asserts that an event of the given EventType is found in the history.

assertNoHistoryEvent

public void assertNoHistoryEvent(io.temporal.api.common.v1.WorkflowExecution execution,
                                 io.temporal.api.enums.v1.EventType eventType)

Asserts that an event of the given EventType is not found in the history.

getWorkflowClient

public io.temporal.client.WorkflowClient getWorkflowClient()

isUseExternalService

public boolean isUseExternalService()

getTestEnvironment

public TestWorkflowEnvironment getTestEnvironment()

newWorkflowStub

public <T> T newWorkflowStub(java.lang.Class<T> workflow)

newWorkflowStubTimeoutOptions

public <T> T newWorkflowStubTimeoutOptions(java.lang.Class<T> workflow)

newWorkflowStub200sTimeoutOptions

public <T> T newWorkflowStub200sTimeoutOptions(java.lang.Class<T> workflow)

newUntypedWorkflowStub

public io.temporal.client.WorkflowStub newUntypedWorkflowStub(java.lang.String workflow)

newUntypedWorkflowStubTimeoutOptions

public io.temporal.client.WorkflowStub newUntypedWorkflowStubTimeoutOptions(java.lang.String workflow)

waitForOKQuery

public static void waitForOKQuery(io.temporal.client.WorkflowStub stub)

Used to ensure that workflow first workflow task is executed.

addWorkflowImplementationFactory

public <R> void addWorkflowImplementationFactory(java.lang.Class<R> factoryImpl,
                                                 io.temporal.workflow.Functions.Func<R> factoryFunc)

regenerateHistoryForReplay

public void regenerateHistoryForReplay(io.temporal.api.common.v1.WorkflowExecution execution,
                                       java.lang.String fileName)

registerDelayedCallback

public void registerDelayedCallback(java.time.Duration delay,
                                    java.lang.Runnable r)

shutdown

protected void shutdown()
                 throws java.lang.Throwable

Throws:

java.lang.Throwable

sleep

public void sleep(java.time.Duration d)