object ZTestWorkflowEnvironment
- Alphabetic
- By Inheritance
- ZTestWorkflowEnvironment
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- final class ActivityRunOptionsWithZIOPartiallyApplied[R] extends AnyVal
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def activityRunOptions[R](implicit arg0: Tag[R]): URIO[ZTestWorkflowEnvironment[R], ZActivityRunOptions[R]]
- def activityRunOptionsWithZIO[R]: ActivityRunOptionsWithZIOPartiallyApplied[R]
Access activity options
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def currentTimeMillis: URIO[ZTestWorkflowEnvironment[Any], ZCurrentTimeMillis]
This time might not be equal to java.lang.System.currentTimeMillis() due to time skipping.
This time might not be equal to java.lang.System.currentTimeMillis() due to time skipping.
- returns
the current in-memory test Temporal service time in milliseconds or java.lang.System.currentTimeMillis() if an external service without time skipping support is used
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getDiagnostics: URIO[ZTestWorkflowEnvironment[Any], String]
Currently prints histories of all workflow instances stored in the service.
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.
- returns
the diagnostic data about the internal service state.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def make[R](implicit arg0: Tag[R]): URLayer[R with ZTestEnvironmentOptions, ZTestWorkflowEnvironment[R]]
Creates a new instance of ZTestWorkflowEnvironment
Creates a new instance of ZTestWorkflowEnvironment
- returns
managed instance of test environment
- See also
TestWorkflowEnvironment.newInstance
- def makeDefault[R](implicit arg0: Tag[R]): URLayer[R, ZTestWorkflowEnvironment[R]]
Creates a new instance of ZTestWorkflowEnvironment with default options
Creates a new instance of ZTestWorkflowEnvironment with default options
- returns
managed instance of test environment
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newUntypedWorkflowStub(workflowId: String, runId: Option[String]): URIO[ZTestWorkflowEnvironment[Any], Untyped]
Creates workflow untyped client stub for a known execution.
Creates workflow untyped client stub for a known execution.
- workflowId
workflow id and optional run id for execution
- runId
runId of the workflow execution. If not provided the last workflow with the given workflowId is assumed.
- returns
Stub that can be used to start workflow and later to signal or query it.
- def newUntypedWorkflowStub(workflowType: String, options: ZWorkflowOptions): URIO[ZTestWorkflowEnvironment[Any], Untyped]
Creates workflow untyped client stub that can be used to start a single workflow execution.
Creates workflow untyped client stub that can be used to start a single workflow execution. After workflow is started it can be also used to send signals or queries to it.
- workflowType
name of the workflow type
- options
options used to start a workflow through returned stub
- returns
builder instance
- def newWorker(taskQueue: String, options: ZWorkerOptions = ZWorkerOptions.default): URIO[ZTestWorkflowEnvironment[Any], ZWorker]
Creates a new Worker instance that is connected to the in-memory test Temporal service.
Creates a new Worker instance that is connected to the in-memory test Temporal service.
- taskQueue
task queue to poll.
- def newWorkflowStub[A](workflowId: String, runId: Option[String] = None)(implicit arg0: ClassTag[A], arg1: IsWorkflow[A]): URIO[ZTestWorkflowEnvironment[Any], workflow.ZWorkflowStub.Of[A]]
Creates workflow client stub for a known execution.
Creates workflow client stub for a known execution.
- A
interface that given workflow implements.
- workflowId
Workflow id.
- runId
Run id of the workflow execution.
- returns
Stub that implements workflowInterface and can be used to signal or query it.
- def newWorkflowStub[A](options: ZWorkflowOptions)(implicit arg0: ClassTag[A], arg1: IsWorkflow[A]): URIO[ZTestWorkflowEnvironment[Any], workflow.ZWorkflowStub.Of[A]]
Creates workflow client stub that can be used to start a single workflow execution.
Creates workflow client stub that can be used to start a single workflow execution. The first call must be to a method annotated with @zio.temporal.workflowMethod. After workflow is started it can be also used to send signals or queries to it. one.
- A
workflow interface
- options
options used to start a workflow through returned stub
- returns
builder instance
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def setup(options: ZAwaitTerminationOptions = ZAwaitTerminationOptions.testDefault): URIO[ZTestWorkflowEnvironment[Any] with Scope, Unit]
Setup test environment with a guaranteed finalization.
Setup test environment with a guaranteed finalization.
- options
await options with polling interval and poll delay
- def sleep(duration: zio.Duration): URIO[ZTestWorkflowEnvironment[Any], Unit]
Wait until internal test Temporal service time passes the specified duration.
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 if an external service without time skipping support is used
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def workflowClientWithZIO[R, E, A](f: (ZWorkflowClient) => ZIO[R, E, A])(implicit arg0: Tag[R]): ZIO[ZTestWorkflowEnvironment[Any] with R, E, A]
Access a WorkflowClient that is connected to the in-memory test Temporal service.
- def workflowServiceStubs: URIO[ZTestWorkflowEnvironment[Any], ZWorkflowServiceStubs]
Returns the in-memory test Temporal service that is owned by this.
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def newUntypedWorkflowStub(workflowType: String): ZWorkflowStubBuilderTaskQueueDsl[URIO[ZTestWorkflowEnvironment[Any], Untyped]]
Creates new untyped type workflow stub builder
Creates new untyped type workflow stub builder
- workflowType
name of the workflow type
- returns
builder instance
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Use newUntypedWorkflowStub accepting ZWorkerOptions
- def newWorkflowStub[A](implicit arg0: ClassTag[A], arg1: IsWorkflow[A]): ZWorkflowStubBuilderTaskQueueDsl[URIO[ZTestWorkflowEnvironment[Any], workflow.ZWorkflowStub.Of[A]]]
Creates new typed workflow stub builder
Creates new typed workflow stub builder
- A
workflow interface
- returns
builder instance
- Annotations
- @deprecated
- Deprecated
(Since version 0.6.0) Use newWorkflowStub accepting ZWorkerOptions