Package io.quarkus.test.bootstrap

Class BaseService<T extends Service>

java.lang.Object

io.quarkus.test.bootstrap.BaseService<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultService, RestService

public class BaseService<T extends Service>
extends Object
implements Service

Field Summary

Fields

Modifier and Type	Field	Description
protected ServiceContext	context
static String	DELETE_FOLDER_ON_EXIT
static String	SERVICE_STARTUP_TIMEOUT
static Duration	SERVICE_STARTUP_TIMEOUT_DEFAULT

Constructor Summary

Constructors

Constructor	Description
BaseService()

Method Summary

Modifier and Type	Method	Description
void	close()	Let JUnit close remaining resources.
Configuration	getConfiguration()
String	getDisplayName()
String	getHost()	Deprecated.
String	getHost(Protocol protocol)	Deprecated.
List<String>	getLogs()
String	getName()
Integer	getPort()	Deprecated.
Integer	getPort(Protocol protocol)	Deprecated.
Map<String,String>	getProperties()
String	getProperty(String property, String defaultValue)
<U> U	getPropertyFromContext(String key)
String	getScenarioId()
Path	getServiceFolder()
URILike	getURI()
URILike	getURI(Protocol protocol)
void	init(ManagedResourceBuilder managedResourceBuilder)
boolean	isAutoStart()
boolean	isRunning()
LogsVerifier	logs()
T	onPostStart(Action action)
T	onPreStart(Action action)
ServiceContext	register(String serviceName, ScenarioContext context)
void	restart()
void	restartAndWaitUntilServiceIsStarted()
T	setAutoStart(boolean autoStart)
void	start()	Start the managed resource.
void	stop()	Stop the Quarkus application.
T	withProperties(String... propertiesFiles)	The runtime configuration property to be used if the built artifact is configured to be run.
T	withProperty(String key, String value)	The runtime configuration property to be used if the built artifact is configured to be run.
T	withProperty(String key, Supplier<String> value)	The runtime configuration property to be used if the built artifact is configured to be run.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.test.bootstrap.Service

getProperty, validate

Field Detail

SERVICE_STARTUP_TIMEOUT

public static final String SERVICE_STARTUP_TIMEOUT

See Also:

Constant Field Values

SERVICE_STARTUP_TIMEOUT_DEFAULT

public static final Duration SERVICE_STARTUP_TIMEOUT_DEFAULT

DELETE_FOLDER_ON_EXIT

public static final String DELETE_FOLDER_ON_EXIT

See Also:

Constant Field Values

context

protected ServiceContext context

Constructor Detail

BaseService

public BaseService()

Method Detail

getScenarioId

public String getScenarioId()

Specified by:

getScenarioId in interface Service

getName

public String getName()

Specified by:

getName in interface Service

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Service

getConfiguration

public Configuration getConfiguration()

Specified by:

getConfiguration in interface Service

isAutoStart

public boolean isAutoStart()

Specified by:

isAutoStart in interface Service

onPreStart

public T onPreStart(Action action)

onPostStart

public T onPostStart(Action action)

setAutoStart

public T setAutoStart(boolean autoStart)

withProperties

public T withProperties(String... propertiesFiles)

The runtime configuration property to be used if the built artifact is configured to be run.

withProperty

public T withProperty(String key,
                      String value)

The runtime configuration property to be used if the built artifact is configured to be run.

Specified by:

withProperty in interface Service

withProperty

public T withProperty(String key,
                      Supplier<String> value)

The runtime configuration property to be used if the built artifact is configured to be run.

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Service

getURI

public URILike getURI(Protocol protocol)

getURI

public URILike getURI()

getHost

@Deprecated
public String getHost()

Deprecated.

getHost

@Deprecated
public String getHost(Protocol protocol)

Deprecated.

getPort

@Deprecated
public Integer getPort()

Deprecated.

getPort

@Deprecated
public Integer getPort(Protocol protocol)

Deprecated.

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface Service

getLogs

public List<String> getLogs()

Specified by:

getLogs in interface Service

getProperty

public String getProperty(String property,
                          String defaultValue)

Specified by:

getProperty in interface Service

start

public void start()

Start the managed resource. If the managed resource is running, it does nothing.

Specified by:

start in interface Service

Throws:

RuntimeException - when application errors at startup.

stop

public void stop()

Stop the Quarkus application.

Specified by:

stop in interface Service

close

public void close()

Let JUnit close remaining resources.

Specified by:

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

Specified by:

close in interface Service

register

public ServiceContext register(String serviceName,
                               ScenarioContext context)

Specified by:

register in interface Service

init

public void init(ManagedResourceBuilder managedResourceBuilder)

Specified by:

init in interface Service

restart

public void restart()

restartAndWaitUntilServiceIsStarted

public void restartAndWaitUntilServiceIsStarted()

logs

public LogsVerifier logs()

Specified by:

logs in interface Service

getServiceFolder

public Path getServiceFolder()

getPropertyFromContext

public <U> U getPropertyFromContext(String key)