Package dev.restate.sdk.testing

Class RestateRunner

java.lang.Object

dev.restate.sdk.testing.RestateRunner

All Implemented Interfaces:

AutoCloseable, org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource

public class RestateRunner
extends Object
implements AutoCloseable, org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource

Manual runner for the Restate test infra, starting the Restate server container together with the provided services and automatically registering them. To start the infra use start() and to stop it use stop().

If you use JUnit 5, we suggest using RestateTest instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RestateRunner.Builder	Builder for RestateRunner.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	RESTATE_ADMIN_ENDPOINT_PORT
static final int	RESTATE_INGRESS_ENDPOINT_PORT

Method Summary

Modifier and Type	Method	Description
void	close()	Like stop().
static RestateRunner.Builder	from(Endpoint endpoint)	Create from Endpoint.
URL	getAdminUrl()	Get restate admin url to send HTTP requests to the admin API.
org.testcontainers.containers.GenericContainer<?>	getRestateContainer()	Get the restate container.
URL	getRestateUrl()	Get restate ingress url to send HTTP/gRPC requests to services.
void	start()	Run restate, run the embedded service endpoint server, and register the services.
void	stop()	Stop restate and the embedded service endpoint server.

Methods inherited from class java.lang.Object

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

Field Details

RESTATE_INGRESS_ENDPOINT_PORT

public static final int RESTATE_INGRESS_ENDPOINT_PORT

See Also:

• Constant Field Values

RESTATE_ADMIN_ENDPOINT_PORT

public static final int RESTATE_ADMIN_ENDPOINT_PORT

See Also:

• Constant Field Values

Method Details

from

public static RestateRunner.Builder from(Endpoint endpoint)

Create from Endpoint.

start

public void start()

Run restate, run the embedded service endpoint server, and register the services.

getRestateUrl

public URL getRestateUrl()

Get restate ingress url to send HTTP/gRPC requests to services.

Throws:

IllegalStateException - if the restate container is not running.

getAdminUrl

public URL getAdminUrl()

Get restate admin url to send HTTP requests to the admin API.

Throws:

IllegalStateException - if the restate container is not running.

getRestateContainer

public org.testcontainers.containers.GenericContainer<?> getRestateContainer()

Get the restate container.

stop

public void stop()

Stop restate and the embedded service endpoint server.

close

public void close()

Like stop().

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.junit.jupiter.api.extension.ExtensionContext.Store.CloseableResource