com.spotify.helios.testing

Class HeliosSoloDeployment

java.lang.Object

com.spotify.helios.testing.HeliosSoloDeployment

All Implemented Interfaces:

HeliosDeployment, AutoCloseable

public class HeliosSoloDeployment
extends Object
implements HeliosDeployment

A HeliosSoloDeployment represents a deployment of Helios Solo, which is to say one Helios master and one Helios agent deployed in Docker. Helios Solo uses the Docker instance it is deployed on to run its jobs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeliosSoloDeployment.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOT2DOCKER_SIGNATURE
static String	HELIOS_CONTAINER_PREFIX
static String	HELIOS_ID_SUFFIX
static int	HELIOS_MASTER_PORT
static String	HELIOS_NAME_SUFFIX
static String	HELIOS_SOLO_PROFILE
static String	HELIOS_SOLO_PROFILES
static String	PROBE_IMAGE

Method Summary

Modifier and Type	Method and Description
com.google.common.net.HostAndPort	address() Returns the host and port information that the deployment is available at.
String	agentName()
static HeliosSoloDeployment.Builder	builder()
static HeliosSoloDeployment.Builder	builder(String profile)
HeliosClient	client()
void	close() Undeploy (shut down) this HeliosSoloDeployment.
static HeliosSoloDeployment.Builder	fromEnv()
static HeliosSoloDeployment.Builder	fromEnv(String profile)
String	heliosContainerId()
String	toString()
protected void	undeployLeftoverJobs() Undeploy jobs left over by TemporaryJobs.

Methods inherited from class java.lang.Object

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

Field Detail

BOOT2DOCKER_SIGNATURE

public static final String BOOT2DOCKER_SIGNATURE

See Also:

Constant Field Values

PROBE_IMAGE

public static final String PROBE_IMAGE

See Also:

Constant Field Values

HELIOS_NAME_SUFFIX

public static final String HELIOS_NAME_SUFFIX

See Also:

Constant Field Values

HELIOS_ID_SUFFIX

public static final String HELIOS_ID_SUFFIX

See Also:

Constant Field Values

HELIOS_CONTAINER_PREFIX

public static final String HELIOS_CONTAINER_PREFIX

See Also:

Constant Field Values

HELIOS_SOLO_PROFILE

public static final String HELIOS_SOLO_PROFILE

See Also:

Constant Field Values

HELIOS_SOLO_PROFILES

public static final String HELIOS_SOLO_PROFILES

See Also:

Constant Field Values

HELIOS_MASTER_PORT

public static final int HELIOS_MASTER_PORT

See Also:

Constant Field Values

Method Detail

address

public com.google.common.net.HostAndPort address()

Description copied from interface: HeliosDeployment

Returns the host and port information that the deployment is available at.

Specified by:

address in interface HeliosDeployment

agentName

public String agentName()

client

public HeliosClient client()

Specified by:

client in interface HeliosDeployment

Returns:

A helios client connected to the master of this HeliosSoloDeployment.

heliosContainerId

public String heliosContainerId()

Returns:

The container ID of the Helios Solo container.

close

public void close()

Undeploy (shut down) this HeliosSoloDeployment.

Specified by:

close in interface HeliosDeployment

Specified by:

close in interface AutoCloseable

undeployLeftoverJobs

protected void undeployLeftoverJobs()

Undeploy jobs left over by TemporaryJobs. TemporaryJobs should clean these up, but sometimes a few are left behind for whatever reason.

builder

public static HeliosSoloDeployment.Builder builder()

Returns:

A Builder that can be used to instantiate a HeliosSoloDeployment.

builder

public static HeliosSoloDeployment.Builder builder(String profile)

Parameters:

profile - A configuration profile used to populate builder options.

Returns:

A Builder that can be used to instantiate a HeliosSoloDeployment.

fromEnv

public static HeliosSoloDeployment.Builder fromEnv()

Returns:

a Builder with its Docker Client configured automatically using the DOCKER_HOST and DOCKER_CERT_PATH environment variables, or sensible defaults if they are absent.

fromEnv

public static HeliosSoloDeployment.Builder fromEnv(String profile)

Parameters:

profile - A configuration profile used to populate builder options.

Returns:

a Builder with its Docker Client configured automatically using the DOCKER_HOST and DOCKER_CERT_PATH environment variables, or sensible defaults if they are absent.

toString

public String toString()

Overrides:

toString in class Object