Class TestWorkflowEnvironmentInternal

java.lang.Object

io.temporal.testing.TestWorkflowEnvironmentInternal

All Implemented Interfaces:

TestWorkflowEnvironment, Closeable, AutoCloseable

public final class TestWorkflowEnvironmentInternal
extends Object
implements TestWorkflowEnvironment

Constructor Summary

Constructors

Constructor	Description
TestWorkflowEnvironmentInternal(TestEnvironmentOptions testEnvironmentOptions)

Method Summary

Modifier and Type	Method	Description
void	awaitTermination(long timeout, 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).
io.temporal.api.nexus.v1.Endpoint	createNexusEndpoint(String name, String taskQueue)	Register a Nexus Endpoint with the server.
long	currentTimeMillis()	This time might not be equal to System.currentTimeMillis() due to time skipping.
void	deleteNexusEndpoint(io.temporal.api.nexus.v1.Endpoint endpoint)	Delete a Nexus Endpoint on the server.
io.temporal.client.ActivityClient	getActivityClient()	Creates an ActivityClient that is connected to the in-memory test Temporal service.
String	getDiagnostics()	Currently prints histories of all workflow instances stored in the service.
String	getNamespace()
io.temporal.serviceclient.OperatorServiceStubs	getOperatorServiceStubs()
io.temporal.worker.WorkerFactory	getWorkerFactory()
io.temporal.client.WorkflowClient	getWorkflowClient()	Creates a WorkflowClient that is connected to the in-memory test Temporal service.
io.temporal.common.WorkflowExecutionHistory	getWorkflowExecutionHistory(io.temporal.api.common.v1.WorkflowExecution execution)	Deprecated.
io.temporal.serviceclient.WorkflowServiceStubs	getWorkflowService()	Deprecated.
io.temporal.serviceclient.WorkflowServiceStubs	getWorkflowServiceStubs()
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()?
io.temporal.worker.Worker	newWorker(String taskQueue)	Creates a new Worker instance that is connected to the in-memory test Temporal service.
io.temporal.worker.Worker	newWorker(String taskQueue, io.temporal.worker.WorkerOptions options)	Creates a new Worker instance that is connected to the in-memory test Temporal service.
void	registerDelayedCallback(Duration delay, Runnable r)	Registers a callback to run after the specified delay according to the test Temporal service internal clock.
boolean	registerSearchAttribute(String name, io.temporal.api.enums.v1.IndexedValueType type)	Register a Search Attribute with the server.
void	shutdown()	Initiates an orderly shutdown in which polls are stopped and already received workflow and activity tasks are executed.
void	shutdownNow()	Initiates an orderly shutdown in which polls are stopped and already received workflow and activity tasks are attempted to be stopped.
void	shutdownTestService()	Deprecated.
void	sleep(Duration duration)	Wait until internal test Temporal 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

Constructor Details

TestWorkflowEnvironmentInternal

public TestWorkflowEnvironmentInternal(@Nullable
 TestEnvironmentOptions testEnvironmentOptions)

Method Details

newWorker

public io.temporal.worker.Worker newWorker(String taskQueue)

Description copied from interface: TestWorkflowEnvironment

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

Specified by:

newWorker in interface TestWorkflowEnvironment

Parameters:

taskQueue - task queue to poll.

newWorker

public io.temporal.worker.Worker newWorker(String taskQueue,
 io.temporal.worker.WorkerOptions options)

Description copied from interface: TestWorkflowEnvironment

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

Specified by:

newWorker in interface TestWorkflowEnvironment

Parameters:

taskQueue - task queue to poll.

getWorkflowClient

public io.temporal.client.WorkflowClient getWorkflowClient()

Description copied from interface: TestWorkflowEnvironment

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

Specified by:

getWorkflowClient in interface TestWorkflowEnvironment

getActivityClient

public io.temporal.client.ActivityClient getActivityClient()

Description copied from interface: TestWorkflowEnvironment

Creates an ActivityClient that is connected to the in-memory test Temporal service.

Specified by:

getActivityClient in interface TestWorkflowEnvironment

currentTimeMillis

public long currentTimeMillis()

Description copied from interface: TestWorkflowEnvironment

This time might not be equal to System.currentTimeMillis() due to time skipping.

Specified by:

currentTimeMillis in interface TestWorkflowEnvironment

Returns:

the current in-memory test Temporal service time in milliseconds or System.currentTimeMillis() if an external service without time skipping support is used

sleep

public void sleep(Duration duration)

Description copied from interface: TestWorkflowEnvironment

Wait until internal test Temporal 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.

This method falls back to Thread.sleep(long) if an external service without time skipping support is used

Specified by:

sleep in interface TestWorkflowEnvironment

registerDelayedCallback

public void registerDelayedCallback(Duration delay,
 Runnable r)

Description copied from interface: TestWorkflowEnvironment

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

Specified by:

registerDelayedCallback in interface TestWorkflowEnvironment

registerSearchAttribute

public boolean registerSearchAttribute(String name,
 io.temporal.api.enums.v1.IndexedValueType type)

Description copied from interface: TestWorkflowEnvironment

Register a Search Attribute with the server.

Specified by:

registerSearchAttribute in interface TestWorkflowEnvironment

Parameters:

name - Search Attribute name

type - Search Attribute type to be used for an elastic search index

Returns:

true if the search attribute was registered, false if it was registered already

See Also:

• How to create custom Search Attributes

createNexusEndpoint

public io.temporal.api.nexus.v1.Endpoint createNexusEndpoint(String name,
 String taskQueue)

Description copied from interface: TestWorkflowEnvironment

Register a Nexus Endpoint with the server.

Specified by:

createNexusEndpoint in interface TestWorkflowEnvironment

Parameters:

name - Nexus Endpoint name

taskQueue - Task Queue to be used for the endpoint

Returns:

Endpoint object

deleteNexusEndpoint

public void deleteNexusEndpoint(io.temporal.api.nexus.v1.Endpoint endpoint)

Description copied from interface: TestWorkflowEnvironment

Delete a Nexus Endpoint on the server.

Specified by:

deleteNexusEndpoint in interface TestWorkflowEnvironment

Parameters:

endpoint - current endpoint to be deleted

getWorkflowService

@Deprecated
public io.temporal.serviceclient.WorkflowServiceStubs getWorkflowService()

Deprecated.

Specified by:

getWorkflowService in interface TestWorkflowEnvironment

Returns:

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

getWorkflowServiceStubs

public io.temporal.serviceclient.WorkflowServiceStubs getWorkflowServiceStubs()

Specified by:

getWorkflowServiceStubs in interface TestWorkflowEnvironment

Returns:

WorkflowServiceStubs connected to the test server (in-memory or external)

getOperatorServiceStubs

public io.temporal.serviceclient.OperatorServiceStubs getOperatorServiceStubs()

Specified by:

getOperatorServiceStubs in interface TestWorkflowEnvironment

Returns:

OperatorServiceStubs connected to the test server

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface TestWorkflowEnvironment

getDiagnostics

public String getDiagnostics()

Description copied from interface: TestWorkflowEnvironment

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

Returns:

the diagnostic data about the internal service state.

getWorkflowExecutionHistory

@Deprecated
public io.temporal.common.WorkflowExecutionHistory getWorkflowExecutionHistory(@Nonnull
 io.temporal.api.common.v1.WorkflowExecution execution)

Deprecated.

Specified by:

getWorkflowExecutionHistory in interface TestWorkflowEnvironment

Parameters:

execution - identifies the workflowId and runId (optionally) to reach the history for

Returns:

history of the execution

close

public void close()

Description copied from interface: TestWorkflowEnvironment

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

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

shutdownTestService

@Deprecated
public void shutdownTestService()

Deprecated.

Description copied from interface: TestWorkflowEnvironment

Initiates Test Service shutdown. This method is temporarily exposed to solve long poll thread shutdown for io.temporal.workflow.interceptorsTests.InterceptorExceptionTests#testExceptionOnStart(). See issue: https://github.com/temporalio/sdk-java/issues/608

Specified by:

shutdownTestService in interface TestWorkflowEnvironment

shutdown

public void shutdown()

Description copied from interface: TestWorkflowEnvironment

Initiates an orderly shutdown in which polls are stopped and already received workflow and activity tasks are executed. After the shutdown calls to ActivityExecutionContext.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 workflow 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 ActivityExecutionContext.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,
 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 io.temporal.worker.WorkerFactory getWorkerFactory()

Specified by:

getWorkerFactory in interface TestWorkflowEnvironment