Package com.linecorp.centraldogma.testing.junit

Class CentralDogmaExtension

java.lang.Object

com.linecorp.centraldogma.testing.junit.AbstractAllOrEachExtension

com.linecorp.centraldogma.testing.junit.CentralDogmaExtension

All Implemented Interfaces:

AfterAllCallback, AfterEachCallback, BeforeAllCallback, BeforeEachCallback, Extension

public class CentralDogmaExtension
extends AbstractAllOrEachExtension

A JUnit Extension that starts an embedded Central Dogma server.

 > class MyTest {
 >     @RegisterExtension
 >     static final CentralDogmaExtension extension = new CentralDogmaExtension();
 >
 >     @Test
 >     void test() throws Exception {
 >         CentralDogma dogma = extension.client();
 >         dogma.push(...).join();
 >         ...
 >     }
 > }
 

Constructor Summary

Constructors

Constructor	Description
CentralDogmaExtension()	Creates a new instance with TLS disabled.
CentralDogmaExtension(boolean useTls)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	after(ExtensionContext context)	A method that should be run at the end of a test lifecycle.
void	before(ExtensionContext context)	A method that should be run at the beginning of a test lifecycle.
final BlockingWebClient	blockingHttpClient()	Returns the blocking HTTP client.
final CentralDogma	client()	Returns the HTTP-based CentralDogma client.
protected void	configure(CentralDogmaBuilder builder)	Override this method to configure the server.
protected void	configureClient(ArmeriaCentralDogmaBuilder builder)	Override this method to configure the HTTP-based CentralDogma client builder.
protected void	configureClient(LegacyCentralDogmaBuilder builder)	Override this method to configure the Thrift-based CentralDogma client builder.
protected void	configureHttpClient(WebClientBuilder builder)	Override this method to configure the WebClient builder.
final Path	dataDir()	Returns the Path to the server's data directory.
final CentralDogma	dogma()	Returns the server.
final WebClient	httpClient()	Returns the HTTP client.
final CentralDogma	legacyClient()	Returns the Thrift-based CentralDogma client.
final MirroringService	mirroringService()	Returns the MirroringService of the server.
ProjectManager	projectManager()	Returns the ProjectManager of the server.
protected void	scaffold(CentralDogma client)	Override this method to perform the initial updates on the server, such as creating a repository and populating sample data.
final InetSocketAddress	serverAddress()	Returns the server address.
final void	start()	Creates a new server, configures it with configure(CentralDogmaBuilder) and starts the server.
final CompletableFuture<Void>	startAsync()	Creates a new server, configures it with configure(CentralDogmaBuilder), and starts the server asynchronously.
final void	stop()	Stops the server and deletes the temporary files created by the server.
final CompletableFuture<Void>	stopAsync()	Stops the server and deletes the temporary files created by the server.
boolean	useTls()	Returns whether the server is running over TLS or not.

Methods inherited from class com.linecorp.centraldogma.testing.junit.AbstractAllOrEachExtension

afterAll, afterEach, beforeAll, beforeEach, runForEachTest

Methods inherited from class java.lang.Object

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

Constructor Details

CentralDogmaExtension

public CentralDogmaExtension()

Creates a new instance with TLS disabled.

CentralDogmaExtension

public CentralDogmaExtension(boolean useTls)

Creates a new instance.

Method Details

before

public void before(ExtensionContext context)
            throws Exception

Description copied from class: AbstractAllOrEachExtension

A method that should be run at the beginning of a test lifecycle. If AbstractAllOrEachExtension.runForEachTest() returns false, this is run once before all tests, otherwise it is run before each test method.

Specified by:

before in class AbstractAllOrEachExtension

Throws:

Exception

after

public void after(ExtensionContext context)
           throws Exception

Description copied from class: AbstractAllOrEachExtension

A method that should be run at the end of a test lifecycle. If AbstractAllOrEachExtension.runForEachTest() returns false, this is run once after all tests, otherwise it is run after each test method.

Specified by:

after in class AbstractAllOrEachExtension

Throws:

Exception

dataDir

@UnstableApi
public final Path dataDir()

Returns the Path to the server's data directory.

Throws:

IllegalStateException - if the data directory is not created yet

start

public final void start()

Creates a new server, configures it with configure(CentralDogmaBuilder) and starts the server. Note that you don't need to call this method if you did not stop the server with stop(), because the server is automatically started up by JUnit.

startAsync

public final CompletableFuture<Void> startAsync()

Creates a new server, configures it with configure(CentralDogmaBuilder), and starts the server asynchronously.

stop

public final void stop()

Stops the server and deletes the temporary files created by the server. Note that you don't usually need to call this method manually because the server is automatically stopped at the end by JUnit.

stopAsync

public final CompletableFuture<Void> stopAsync()

Stops the server and deletes the temporary files created by the server. Note that you don't usually need to call this method manually because the server is automatically stopped at the end by JUnit.

useTls

public boolean useTls()

Returns whether the server is running over TLS or not.

dogma

public final CentralDogma dogma()

Returns the server.

Throws:

IllegalStateException - if Central Dogma did not start yet

projectManager

public ProjectManager projectManager()

Returns the ProjectManager of the server.

Throws:

IllegalStateException - if Central Dogma did not start yet

mirroringService

public final MirroringService mirroringService()

Returns the MirroringService of the server.

Throws:

IllegalStateException - if Central Dogma did not start yet

client

public final CentralDogma client()

Returns the HTTP-based CentralDogma client.

Throws:

IllegalStateException - if Central Dogma did not start yet

legacyClient

public final CentralDogma legacyClient()

Returns the Thrift-based CentralDogma client.

Throws:

IllegalStateException - if Central Dogma did not start yet

httpClient

public final WebClient httpClient()

Returns the HTTP client.

Throws:

IllegalStateException - if Central Dogma did not start yet

blockingHttpClient

public final BlockingWebClient blockingHttpClient()

Returns the blocking HTTP client.

Throws:

IllegalStateException - if Central Dogma did not start yet

serverAddress

public final InetSocketAddress serverAddress()

Returns the server address.

Throws:

IllegalStateException - if Central Dogma did not start yet

configure

protected void configure(CentralDogmaBuilder builder)

Override this method to configure the server.

configureClient

protected void configureClient(ArmeriaCentralDogmaBuilder builder)

Override this method to configure the HTTP-based CentralDogma client builder.

configureClient

protected void configureClient(LegacyCentralDogmaBuilder builder)

Override this method to configure the Thrift-based CentralDogma client builder.

configureHttpClient

protected void configureHttpClient(WebClientBuilder builder)

Override this method to configure the WebClient builder.

scaffold

protected void scaffold(CentralDogma client)

Override this method to perform the initial updates on the server, such as creating a repository and populating sample data.