Package io.quarkus.devservices.deployment.compose

Class ComposeProject

java.lang.Object

io.quarkus.devservices.deployment.compose.ComposeProject

public class ComposeProject
extends Object

A wrapper around compose that starts and stops services defined a set of compose files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComposeProject.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_NETWORK_NAME

Constructor Summary

Constructors

Constructor

Description

ComposeProject(com.github.dockerjava.api.DockerClient dockerClient, ComposeFiles composeFiles, String executable, String project, Duration startupTimeout, Duration stopTimeout, boolean stopContainers, boolean ryukEnabled, boolean followContainerLogs, boolean removeVolumes, String removeImages, Boolean build, List<String> options, List<String> profiles, Map<String,Integer> scalingPreferences, Map<String,String> env)

Method Summary

Modifier and Type	Method	Description
void	addWaitStrategy(Map<String,org.testcontainers.containers.wait.strategy.WaitAllStrategy> strategies, String instanceName, org.testcontainers.containers.wait.strategy.WaitStrategy strategy)	can have multiple wait strategies for a single container, e.g. if waiting on several ports if no wait strategy is defined, the WaitAllStrategy will return immediately.
void	discoverServiceInstances(boolean checkForRequiredServices)
String	getDefaultNetworkId()
Map<String,String>	getEnvVarConfig()
Map<String,String>	getExposedPortConfig()
List<com.github.dockerjava.api.model.Network>	getNetworks()
String	getProject()
List<ComposeServiceWaitStrategyTarget>	getServices()
(package private) Map<String,org.testcontainers.containers.wait.strategy.WaitAllStrategy>	getWaitStrategies()
void	runWithCompose(String cmd, Map<String,String> env)
void	start()
void	startAndWaitUntilServicesReady(Executor waitOn)
void	stop()	Stops the services defined in the docker-compose file.
void	waitUntilServicesReady(Executor waitOn)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NETWORK_NAME

public static final String DEFAULT_NETWORK_NAME

See Also:

• Constant Field Values

Constructor Details

ComposeProject

public ComposeProject(com.github.dockerjava.api.DockerClient dockerClient,
 ComposeFiles composeFiles,
 String executable,
 String project,
 Duration startupTimeout,
 Duration stopTimeout,
 boolean stopContainers,
 boolean ryukEnabled,
 boolean followContainerLogs,
 boolean removeVolumes,
 String removeImages,
 Boolean build,
 List<String> options,
 List<String> profiles,
 Map<String,Integer> scalingPreferences,
 Map<String,String> env)

Method Details

addWaitStrategy

public void addWaitStrategy(Map<String,org.testcontainers.containers.wait.strategy.WaitAllStrategy> strategies,
 String instanceName,
 org.testcontainers.containers.wait.strategy.WaitStrategy strategy)

can have multiple wait strategies for a single container, e.g. if waiting on several ports if no wait strategy is defined, the WaitAllStrategy will return immediately. The WaitAllStrategy uses the startup timeout for everything as a global maximum, but we expect timeouts to be handled by the inner strategies.

getProject

public String getProject()

Returns:

the project name

getWaitStrategies

Map<String,org.testcontainers.containers.wait.strategy.WaitAllStrategy> getWaitStrategies()

start

public void start()

waitUntilServicesReady

public void waitUntilServicesReady(Executor waitOn)

startAndWaitUntilServicesReady

public void startAndWaitUntilServicesReady(Executor waitOn)

discoverServiceInstances

public void discoverServiceInstances(boolean checkForRequiredServices)

stop

public void stop()

Stops the services defined in the docker-compose file.

runWithCompose

public void runWithCompose(String cmd,
 Map<String,String> env)

getServices

public List<ComposeServiceWaitStrategyTarget> getServices()

getEnvVarConfig

public Map<String,String> getEnvVarConfig()

getExposedPortConfig

public Map<String,String> getExposedPortConfig()

getNetworks

public List<com.github.dockerjava.api.model.Network> getNetworks()

getDefaultNetworkId

public String getDefaultNetworkId()