Class RestateContainer

Hierarchy

GenericContainer
- RestateContainer

Index

Constructors

Properties

archivesToCopy autoRemove contentsToCopy copyToContainerOptions createOpts directoriesToCopy environment exposedPorts filesToCopy healthCheck? hostConfig imageName logConsumer? networkAliases networkMode? pullPolicy reuse startupTimeoutMs? waitStrategy

Constructors

constructor

new RestateContainer(version?: string): RestateContainer
Parameters
- version: string = "latest"
Returns RestateContainer
Overrides GenericContainer.constructor
- Defined in packages/libs/restate-sdk-testcontainers/src/restate_test_environment.ts:314

Properties

`Protected`archivesToCopy

archivesToCopy: ArchiveToCopy[]

`Protected`autoRemove

autoRemove: boolean

`Protected`contentsToCopy

contentsToCopy: ContentToCopy[]

`Protected`copyToContainerOptions

copyToContainerOptions: CopyToContainerOptions

`Protected`createOpts

createOpts: ContainerCreateOptions

`Protected`directoriesToCopy

directoriesToCopy: FileToCopy[]

`Protected`environment

environment: Record<string, string>

`Protected`exposedPorts

exposedPorts: PortWithOptionalBinding[]

`Protected`filesToCopy

filesToCopy: FileToCopy[]

`Protected` `Optional`healthCheck

healthCheck?: HealthCheck

`Protected`hostConfig

hostConfig: HostConfig

`Protected`imageName

imageName: ImageName

`Protected` `Optional`logConsumer

logConsumer?: (stream: Readable) => unknown

`Protected`networkAliases

networkAliases: string[]

`Protected` `Optional`networkMode

networkMode?: string

`Protected`pullPolicy

pullPolicy: ImagePullPolicy

`Protected`reuse

reuse: boolean

`Protected` `Optional`startupTimeoutMs

startupTimeoutMs?: number

`Protected`waitStrategy

waitStrategy: WaitStrategy

Methods

alwaysReplay

alwaysReplay(): this
Forces restate-server to always replay on a suspension point. This is useful to hunt non-deterministic bugs that might prevent your code from replaying correctly.

Returns this
- Defined in packages/libs/restate-sdk-testcontainers/src/restate_test_environment.ts:323

`Protected` `Optional`beforeContainerCreated

beforeContainerCreated?(): Promise<void>
Returns Promise<void>
Inherited from GenericContainer.beforeContainerCreated
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:35

`Protected` `Optional`containerCreated

containerCreated?(containerId: string): Promise<void>
Parameters
- containerId: string
Returns Promise<void>
Inherited from GenericContainer.containerCreated
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:36

`Protected` `Optional`containerStarted

containerStarted?(
    container: StartedTestContainer,
    inspectResult: InspectResult,
    reused: boolean,
): Promise<void>
Parameters
- container: StartedTestContainer
- inspectResult: InspectResult
- reused: boolean
Returns Promise<void>
Inherited from GenericContainer.containerStarted
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:44

`Protected` `Optional`containerStarting

containerStarting?(inspectResult: InspectResult, reused: boolean): Promise<void>
Parameters
- inspectResult: InspectResult
- reused: boolean
Returns Promise<void>
Inherited from GenericContainer.containerStarting
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:37

disableRetries

disableRetries(): this
Disables retries in the restate-server invoker. This is useful in tests so that failures surface immediately instead of hanging through retry backoff.

Returns this
- Defined in packages/libs/restate-sdk-testcontainers/src/restate_test_environment.ts:335

start

start(): Promise<StartedTestContainer>
Returns Promise<StartedTestContainer>
Inherited from GenericContainer.start
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:38

withAddedCapabilities

withAddedCapabilities(...capabilities: string[]): this
Parameters
- ...capabilities: string[]
Returns this
Inherited from GenericContainer.withAddedCapabilities
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:54

withAutoRemove

withAutoRemove(autoRemove: boolean): this
Parameters
- autoRemove: boolean
Returns this
Inherited from GenericContainer.withAutoRemove
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:69

withBindMounts

withBindMounts(bindMounts: BindMount[]): this
Parameters
- bindMounts: BindMount[]
Returns this
Inherited from GenericContainer.withBindMounts
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:61

withCommand

withCommand(command: string[]): this
Parameters
- command: string[]
Returns this
Inherited from GenericContainer.withCommand
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:45

withCopyArchivesToContainer

withCopyArchivesToContainer(archivesToCopy: ArchiveToCopy[]): this
Parameters
- archivesToCopy: ArchiveToCopy[]
Returns this
Inherited from GenericContainer.withCopyArchivesToContainer
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:75

withCopyContentToContainer

withCopyContentToContainer(contentsToCopy: ContentToCopy[]): this
Parameters
- contentsToCopy: ContentToCopy[]
Returns this
Inherited from GenericContainer.withCopyContentToContainer
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:74

withCopyDirectoriesToContainer

withCopyDirectoriesToContainer(directoriesToCopy: FileToCopy[]): this
Parameters
- directoriesToCopy: FileToCopy[]
Returns this
Inherited from GenericContainer.withCopyDirectoriesToContainer
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:73

withCopyFilesToContainer

withCopyFilesToContainer(filesToCopy: FileToCopy[]): this
Parameters
- filesToCopy: FileToCopy[]
Returns this
Inherited from GenericContainer.withCopyFilesToContainer
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:72

withCopyToContainerOptions

withCopyToContainerOptions(copyToContainerOptions: CopyToContainerOptions): this
Parameters
- copyToContainerOptions: CopyToContainerOptions
Returns this
Inherited from GenericContainer.withCopyToContainerOptions
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:76

withDefaultLogDriver

withDefaultLogDriver(): this
Returns this
Inherited from GenericContainer.withDefaultLogDriver
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:65

withDroppedCapabilities

withDroppedCapabilities(...capabilities: string[]): this
Parameters
- ...capabilities: string[]
Returns this
Inherited from GenericContainer.withDroppedCapabilities
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:55

withEntrypoint

withEntrypoint(entrypoint: string[]): this
Parameters
- entrypoint: string[]
Returns this
Inherited from GenericContainer.withEntrypoint
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:46

withEnvironment

withEnvironment(environment: Environment): this
Parameters
- environment: Environment
Returns this
Inherited from GenericContainer.withEnvironment
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:49

withExposedPorts

withExposedPorts(...ports: PortWithOptionalBinding[]): this
Parameters
- ...ports: PortWithOptionalBinding[]
Returns this
Inherited from GenericContainer.withExposedPorts
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:60

withExtraHosts

withExtraHosts(extraHosts: ExtraHost[]): this
Parameters
- extraHosts: ExtraHost[]
Returns this
Inherited from GenericContainer.withExtraHosts
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:59

withHealthCheck

withHealthCheck(healthCheck: HealthCheck): this
Parameters
- healthCheck: HealthCheck
Returns this
Inherited from GenericContainer.withHealthCheck
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:62

withHostname

withHostname(hostname: string): this
Parameters
- hostname: string
Returns this
Inherited from GenericContainer.withHostname
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:81

withIpcMode

withIpcMode(ipcMode: string): this
Parameters
- ipcMode: string
Returns this
Inherited from GenericContainer.withIpcMode
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:71

withLabels

withLabels(labels: Labels): this
Parameters
- labels: Labels
Returns this
Inherited from GenericContainer.withLabels
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:48

withLogConsumer

withLogConsumer(logConsumer: (stream: Readable) => unknown): this
Parameters
- logConsumer: (stream: Readable) => unknown
Returns this
Inherited from GenericContainer.withLogConsumer
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:80

withName

withName(name: string): this
Parameters
- name: string
Returns this
Inherited from GenericContainer.withName
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:47

withNetwork

withNetwork(network: StartedNetwork): this
Parameters
- network: StartedNetwork
Returns this
Inherited from GenericContainer.withNetwork
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:56

withNetworkAliases

withNetworkAliases(...networkAliases: string[]): this
Parameters
- ...networkAliases: string[]
Returns this
Inherited from GenericContainer.withNetworkAliases
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:58

withNetworkMode

withNetworkMode(networkMode: string): this
Parameters
- networkMode: string
Returns this
Inherited from GenericContainer.withNetworkMode
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:57

withPlatform

withPlatform(platform: string): this
Parameters
- platform: string
Returns this
Inherited from GenericContainer.withPlatform
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:50

withPrivilegedMode

withPrivilegedMode(): this
Returns this
Inherited from GenericContainer.withPrivilegedMode
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:66

withPullPolicy

withPullPolicy(pullPolicy: ImagePullPolicy): this
Parameters
- pullPolicy: ImagePullPolicy
Returns this
Inherited from GenericContainer.withPullPolicy
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:70

withResourcesQuota

withResourcesQuota(__namedParameters: ResourcesQuota): this
Parameters
- __namedParameters: ResourcesQuota
Returns this
Inherited from GenericContainer.withResourcesQuota
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:78

withReuse

withReuse(): this
Returns this
Inherited from GenericContainer.withReuse
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:68

withSecurityOpt

withSecurityOpt(...securityOptions: string[]): this
Parameters
- ...securityOptions: string[]
Returns this
Inherited from GenericContainer.withSecurityOpt
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:53

withSharedMemorySize

withSharedMemorySize(bytes: number): this
Parameters
- bytes: number
Returns this
Inherited from GenericContainer.withSharedMemorySize
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:79

withStartupTimeout

withStartupTimeout(startupTimeoutMs: number): this
Parameters
- startupTimeoutMs: number
Returns this
Inherited from GenericContainer.withStartupTimeout
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:63

withTmpFs

withTmpFs(tmpFs: TmpFs): this
Parameters
- tmpFs: TmpFs
Returns this
Inherited from GenericContainer.withTmpFs
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:51

withUlimits

withUlimits(ulimits: Ulimits): this
Parameters
- ulimits: Ulimits
Returns this
Inherited from GenericContainer.withUlimits
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:52

withUser

withUser(user: string): this
Parameters
- user: string
Returns this
Inherited from GenericContainer.withUser
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:67

withWaitStrategy

withWaitStrategy(waitStrategy: WaitStrategy): this
Parameters
- waitStrategy: WaitStrategy
Returns this
Inherited from GenericContainer.withWaitStrategy
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:64

withWorkingDir

withWorkingDir(workingDir: string): this
Parameters
- workingDir: string
Returns this
Inherited from GenericContainer.withWorkingDir
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:77

`Static`fromDockerfile

fromDockerfile(
context: string,
dockerfileName?: string,
): GenericContainerBuilder
Parameters
- context: string
- OptionaldockerfileName: string
Returns GenericContainerBuilder
Inherited from GenericContainer.fromDockerfile
- Defined in node_modules/.pnpm/testcontainers@11.13.0/node_modules/testcontainers/build/generic-container/generic-container.d.ts:12

Class RestateContainer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RestateContainer

Properties

ProtectedarchivesToCopy

ProtectedautoRemove

ProtectedcontentsToCopy

ProtectedcopyToContainerOptions

ProtectedcreateOpts

ProtecteddirectoriesToCopy

Protectedenvironment

ProtectedexposedPorts

ProtectedfilesToCopy

Protected OptionalhealthCheck

ProtectedhostConfig

ProtectedimageName

Protected OptionallogConsumer

ProtectednetworkAliases

Protected OptionalnetworkMode

ProtectedpullPolicy

Protectedreuse

Protected OptionalstartupTimeoutMs

ProtectedwaitStrategy

Methods

alwaysReplay

Returns this

Protected OptionalbeforeContainerCreated

Returns Promise<void>

Protected OptionalcontainerCreated

Parameters

Returns Promise<void>

Protected OptionalcontainerStarted

Parameters

Returns Promise<void>

Protected OptionalcontainerStarting

Parameters

Returns Promise<void>

disableRetries

Returns this

start

Returns Promise<StartedTestContainer>

withAddedCapabilities

Parameters

Returns this

withAutoRemove

Parameters

Returns this

withBindMounts

Parameters

Returns this

withCommand

Parameters

Returns this

withCopyArchivesToContainer

Parameters

Returns this

withCopyContentToContainer

Parameters

Returns this

withCopyDirectoriesToContainer

Parameters

Returns this

withCopyFilesToContainer

Parameters

Returns this

withCopyToContainerOptions

Parameters

Returns this

withDefaultLogDriver

Returns this

withDroppedCapabilities

Parameters

Returns this

`Protected`archivesToCopy

`Protected`autoRemove

`Protected`contentsToCopy

`Protected`copyToContainerOptions

`Protected`createOpts

`Protected`directoriesToCopy

`Protected`environment

`Protected`exposedPorts

`Protected`filesToCopy

`Protected` `Optional`healthCheck

`Protected`hostConfig

`Protected`imageName

`Protected` `Optional`logConsumer

`Protected`networkAliases

`Protected` `Optional`networkMode

`Protected`pullPolicy

`Protected`reuse

`Protected` `Optional`startupTimeoutMs

`Protected`waitStrategy

`Protected` `Optional`beforeContainerCreated

`Protected` `Optional`containerCreated

`Protected` `Optional`containerStarted

`Protected` `Optional`containerStarting