com.uber.cadence.internal.sync

Class TestWorkflowEnvironmentInternal

java.lang.Object

com.uber.cadence.internal.sync.TestWorkflowEnvironmentInternal

All Implemented Interfaces:

TestWorkflowEnvironment

public final class TestWorkflowEnvironmentInternal
extends java.lang.Object
implements TestWorkflowEnvironment

Constructor Summary

Constructors

Constructor and Description
TestWorkflowEnvironmentInternal(TestEnvironmentOptions options)

Method Summary

Modifier and Type	Method and Description
void	awaitTermination(long timeout, java.util.concurrent.TimeUnit unit) Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
void	close() Calls TestWorkflowEnvironment.shutdownNow() and TestWorkflowEnvironment.awaitTermination(long, TimeUnit).
long	currentTimeMillis() Returns the current in-memory test Cadence service time in milliseconds.
java.lang.String	getDiagnostics() Returns the diagnostic data about the internal service state.
java.lang.String	getDomain()
WorkerFactory	getWorkerFactory()
IWorkflowService	getWorkflowService() Returns the in-memory test Cadence service that is owned by this.
boolean	isShutdown() Was TestWorkflowEnvironment.shutdownNow() or TestWorkflowEnvironment.shutdown() called?
boolean	isStarted() Was TestWorkflowEnvironment.start() called?
boolean	isTerminated() Are all tasks done after TestWorkflowEnvironment.shutdownNow() or TestWorkflowEnvironment.shutdown()?
Worker	newWorker(java.lang.String taskList) Creates a new Worker instance that is connected to the in-memory test Cadence service.
Worker	newWorker(java.lang.String taskList, java.util.function.Function<WorkerOptions.Builder,WorkerOptions.Builder> overrideOptions) Creates a new Worker instance that is connected to the in-memory test Cadence service.
WorkflowClient	newWorkflowClient() Creates a WorkflowClient that is connected to the in-memory test Cadence service.
WorkflowClient	newWorkflowClient(WorkflowClientOptions options) Creates a WorkflowClient that is connected to the in-memory test Cadence service.
void	registerDelayedCallback(java.time.Duration delay, java.lang.Runnable r) Registers a callback to run after the specified delay according to the test Cadence service internal clock.
void	shutdown() Initiates an orderly shutdown in which polls are stopped and already received decision and activity tasks are executed.
void	shutdownNow() Initiates an orderly shutdown in which polls are stopped and already received decision and activity tasks are attempted to be stopped.
void	sleep(java.time.Duration duration) Wait until internal test Cadence service time passes the specified duration.
void	start() Start all workers created by this factory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.uber.cadence.testing.TestWorkflowEnvironment

newInstance, newInstance

Constructor Detail

TestWorkflowEnvironmentInternal

public TestWorkflowEnvironmentInternal(TestEnvironmentOptions options)

Method Detail

newWorker

public Worker newWorker(java.lang.String taskList)

Description copied from interface: TestWorkflowEnvironment

Creates a new Worker instance that is connected to the in-memory test Cadence service.

Specified by:

newWorker in interface TestWorkflowEnvironment

Parameters:

taskList - task list to poll.

newWorker

public Worker newWorker(java.lang.String taskList,
                        java.util.function.Function<WorkerOptions.Builder,WorkerOptions.Builder> overrideOptions)

Description copied from interface: TestWorkflowEnvironment

Creates a new Worker instance that is connected to the in-memory test Cadence service.

Specified by:

newWorker in interface TestWorkflowEnvironment

Parameters:

taskList - task list to poll.

overrideOptions - is used to override the default worker options.

newWorkflowClient

public WorkflowClient newWorkflowClient()

Description copied from interface: TestWorkflowEnvironment

Creates a WorkflowClient that is connected to the in-memory test Cadence service.

Specified by:

newWorkflowClient in interface TestWorkflowEnvironment

newWorkflowClient

public WorkflowClient newWorkflowClient(WorkflowClientOptions options)

Description copied from interface: TestWorkflowEnvironment

Creates a WorkflowClient that is connected to the in-memory test Cadence service.

Specified by:

newWorkflowClient in interface TestWorkflowEnvironment

Parameters:

options - options used to configure the client.

currentTimeMillis

public long currentTimeMillis()

Description copied from interface: TestWorkflowEnvironment

Returns the current in-memory test Cadence service time in milliseconds. This time might not be equal to System.currentTimeMillis() due to time skipping.

Specified by:

currentTimeMillis in interface TestWorkflowEnvironment

sleep

public void sleep(java.time.Duration duration)

Description copied from interface: TestWorkflowEnvironment

Wait until internal test Cadence service time passes the specified duration. This call also indicates that workflow time might jump forward (if none of the activities are running) up to the specified duration.

Specified by:

sleep in interface TestWorkflowEnvironment

registerDelayedCallback

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

Description copied from interface: TestWorkflowEnvironment

Registers a callback to run after the specified delay according to the test Cadence service internal clock.

Specified by:

registerDelayedCallback in interface TestWorkflowEnvironment

getWorkflowService

public IWorkflowService getWorkflowService()

Description copied from interface: TestWorkflowEnvironment

Returns the in-memory test Cadence service that is owned by this.

Specified by:

getWorkflowService in interface TestWorkflowEnvironment

getDomain

public java.lang.String getDomain()

Specified by:

getDomain in interface TestWorkflowEnvironment

getDiagnostics

public java.lang.String getDiagnostics()

Description copied from interface: TestWorkflowEnvironment

Returns the diagnostic data about the internal service state. Currently prints histories of all workflow instances stored in the service. This is useful information to print in the case of a unit test failure. A convenient way to achieve this is to add the following Rule to a unit test:

   @Rule
   public TestWatcher watchman =
       new TestWatcher() {
         @Override
         protected void failed(Throwable e, Description description) {
           System.err.println(testEnvironment.getDiagnostics());
           testEnvironment.close();
         }
       };
 

Specified by:

getDiagnostics in interface TestWorkflowEnvironment

close

public void close()

Description copied from interface: TestWorkflowEnvironment

Calls TestWorkflowEnvironment.shutdownNow() and TestWorkflowEnvironment.awaitTermination(long, TimeUnit).

Specified by:

close in interface TestWorkflowEnvironment

start

public void start()

Description copied from interface: TestWorkflowEnvironment

Start all workers created by this factory.

Specified by:

start in interface TestWorkflowEnvironment

isStarted

public boolean isStarted()

Description copied from interface: TestWorkflowEnvironment

Was TestWorkflowEnvironment.start() called?

Specified by:

isStarted in interface TestWorkflowEnvironment

isShutdown

public boolean isShutdown()

Description copied from interface: TestWorkflowEnvironment

Was TestWorkflowEnvironment.shutdownNow() or TestWorkflowEnvironment.shutdown() called?

Specified by:

isShutdown in interface TestWorkflowEnvironment

isTerminated

public boolean isTerminated()

Description copied from interface: TestWorkflowEnvironment

Are all tasks done after TestWorkflowEnvironment.shutdownNow() or TestWorkflowEnvironment.shutdown()?

Specified by:

isTerminated in interface TestWorkflowEnvironment

shutdown

public void shutdown()

Description copied from interface: TestWorkflowEnvironment

Initiates an orderly shutdown in which polls are stopped and already received decision and activity tasks are executed. After the shutdown calls to Activity.heartbeat(Object) start throwing ActivityWorkerShutdownException. Invocation has no additional effect if already shut down. This method does not wait for previously received tasks to complete execution. Use TestWorkflowEnvironment.awaitTermination(long, TimeUnit) to do that.

Specified by:

shutdown in interface TestWorkflowEnvironment

shutdownNow

public void shutdownNow()

Description copied from interface: TestWorkflowEnvironment

Initiates an orderly shutdown in which polls are stopped and already received decision and activity tasks are attempted to be stopped. This implementation cancels tasks via Thread.interrupt(), so any task that fails to respond to interrupts may never terminate. Also after the shutdownNow calls to Activity.heartbeat(Object) start throwing ActivityWorkerShutdownException. Invocation has no additional effect if already shut down. This method does not wait for previously received tasks to complete execution. Use TestWorkflowEnvironment.awaitTermination(long, TimeUnit) to do that.

Specified by:

shutdownNow in interface TestWorkflowEnvironment

awaitTermination

public void awaitTermination(long timeout,
                             java.util.concurrent.TimeUnit unit)

Description copied from interface: TestWorkflowEnvironment

Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Specified by:

awaitTermination in interface TestWorkflowEnvironment

getWorkerFactory

public WorkerFactory getWorkerFactory()

Specified by:

getWorkerFactory in interface TestWorkflowEnvironment