com.mesosphere.sdk.testing

Class ServiceTestRunner

java.lang.Object

com.mesosphere.sdk.testing.ServiceTestRunner

public class ServiceTestRunner
extends java.lang.Object

Exercises the service's packaging and Service Specification YAML file by building a Scheduler object against it, then optionally running a series of SimulationTicks against the result.

Constructor Summary

Constructors

Constructor and Description
ServiceTestRunner() Creates a new instance against the default svc.yml Service Specification YAML file.
ServiceTestRunner(java.io.File specPath) Creates a new instance against the provided Service Specification YAML path.
ServiceTestRunner(java.lang.String specDistFilename) Creates a new instance against the provided Service Specification YAML filename within the service's src/main/dist directory.

Method Summary

Modifier and Type	Method and Description
static java.io.File	getDistDir() Returns a File object for the service's src/main/dist directory.
static java.io.File	getDistFile(java.lang.String specFilePath) Returns a File object for a provided filename or relative path within the service's src/main/dist directory.
ServiceTestResult	run() Exercises the service's packaging and resulting Service Specification YAML file without running any simulation afterwards.
ServiceTestResult	run(java.util.Collection<SimulationTick> ticks) Exercises the service's packaging and resulting Service Specification YAML file, then runs the provided simulation ticks, if any are provided.
ServiceTestRunner	setBuildTemplateParams(java.util.Map<java.lang.String,java.lang.String> paramMap) Equivalent of setBuildTemplateParams(String...) for a Map instead of string pairs.
ServiceTestRunner	setBuildTemplateParams(java.lang.String... paramKeyVals) Configures the test with custom template parameters to be applied against the Universe packaging, as would be provided via TEMPLATE_X envvars when building the service.
ServiceTestRunner	setConfigTemplateDir(java.io.File configTemplateDir) Configures the test with a custom configuration template location.
ServiceTestRunner	setCustomValidators(ConfigValidator<ServiceSpec>... validators)
ServiceTestRunner	setOptions(java.util.Map<java.lang.String,java.lang.String> optionMap) Equivalent of setOptions(String...) for a Map instead of string pairs.
ServiceTestRunner	setOptions(java.lang.String... optionKeyVals) Configures the test with custom options as would be provided via an options.json file.
ServiceTestRunner	setPodEnv(java.lang.String podType, java.util.Map<java.lang.String,java.lang.String> podEnvMap) Equivalent of setPodEnv(String, String...) for a Map instead of string pairs.
ServiceTestRunner	setPodEnv(java.lang.String podType, java.lang.String... podEnvKeyVals) Configures the test with additional environment variables in the specified Pod, beyond those which would be included by the Scheduler or by Mesos.
ServiceTestRunner	setRecoveryManagerFactory(RecoveryPlanOverriderFactory recoveryManagerFactory) Allows the specification of custom recovery logic just as in SchedulerBuilder.setRecoveryManagerFactory(RecoveryPlanOverriderFactory).
ServiceTestRunner	setSchedulerEnv(java.util.Map<java.lang.String,java.lang.String> schedulerEnvMap) Equivalent of setSchedulerEnv(String...) for a Map instead of string pairs.
ServiceTestRunner	setSchedulerEnv(java.lang.String... schedulerEnvKeyVals) Configures the test with additional environment variables in the Scheduler beyond those which would be included by the service's marathon.json.mustache.
ServiceTestRunner	setState(ServiceTestResult serviceTestResult) Configures the test with the provided state from a prior run.
ServiceTestRunner	setUseCustomExecutor() Simulates DC/OS 1.9 behavior of using a custom executor instead of the default executor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceTestRunner

public ServiceTestRunner()

Creates a new instance against the default svc.yml Service Specification YAML file.

WARNING: If you do not invoke the run() method, your test will not run!

ServiceTestRunner

public ServiceTestRunner(java.lang.String specDistFilename)

Creates a new instance against the provided Service Specification YAML filename within the service's src/main/dist directory.

WARNING: If you do not invoke the run() method, your test will not run!

Parameters:

specDistFilename - path to the Service Specification YAML file, relative to the src/main/dist directory

ServiceTestRunner

public ServiceTestRunner(java.io.File specPath)

Creates a new instance against the provided Service Specification YAML path.

WARNING: If you do not invoke the run() method, your test will not run!

Parameters:

specPath - path to the Service Specification YAML file, relative to the dist directory

Method Detail

getDistDir

public static java.io.File getDistDir()

Returns a File object for the service's src/main/dist directory. Does not check if the directory actually exists.

getDistFile

public static java.io.File getDistFile(java.lang.String specFilePath)

Returns a File object for a provided filename or relative path within the service's src/main/dist directory. Does not check if the specified path actually exists.

setOptions

public ServiceTestRunner setOptions(java.util.Map<java.lang.String,java.lang.String> optionMap)

Equivalent of setOptions(String...) for a Map instead of string pairs.

See Also:

setOptions(String...)

setOptions

public ServiceTestRunner setOptions(java.lang.String... optionKeyVals)

Configures the test with custom options as would be provided via an options.json file. If this is not invoked then the service defaults from config.json are used for the test.

Parameters:

optionKeyVals - an even number of strings which will be unpacked as (key, value, key, value, ...), where the keys should be in section1.section2.section3.name form as an options.json file would have

Returns:

this

setBuildTemplateParams

public ServiceTestRunner setBuildTemplateParams(java.util.Map<java.lang.String,java.lang.String> paramMap)

Equivalent of setBuildTemplateParams(String...) for a Map instead of string pairs.

See Also:

setBuildTemplateParams(String...)

setBuildTemplateParams

public ServiceTestRunner setBuildTemplateParams(java.lang.String... paramKeyVals)

Configures the test with custom template parameters to be applied against the Universe packaging, as would be provided via TEMPLATE_X envvars when building the service. These are applied onto config.json and resource.json for the test

Parameters:

paramKeyVals - an even number of strings which will be unpacked as (key, value, key, value, ...)

Returns:

this

setConfigTemplateDir

public ServiceTestRunner setConfigTemplateDir(java.io.File configTemplateDir)

Configures the test with a custom configuration template location. By default config templates are expected to be in the same directory as the Service Specification YAML file.

Returns:

this

setState

public ServiceTestRunner setState(ServiceTestResult serviceTestResult)

Configures the test with the provided state from a prior run. This may be used to initialize a second simulation with the state of a first simulation. Otherwise the simulation will be performed with empty state, simulating an initial install.

Parameters:

serviceTestResult - the result from a previous simulation, from which state will be retrieved

Returns:

this

setSchedulerEnv

public ServiceTestRunner setSchedulerEnv(java.util.Map<java.lang.String,java.lang.String> schedulerEnvMap)

Equivalent of setSchedulerEnv(String...) for a Map instead of string pairs.

See Also:

setSchedulerEnv(String...)

setSchedulerEnv

public ServiceTestRunner setSchedulerEnv(java.lang.String... schedulerEnvKeyVals)

Configures the test with additional environment variables in the Scheduler beyond those which would be included by the service's marathon.json.mustache. This may be useful for tests against custom Service Specification YAML files which reference envvars that aren't also present in the packaging's Marathon definition. These values will override any produced by the service's packaging.

Parameters:

schedulerEnvKeyVals - an even number of strings which will be unpacked as (key, value, key, value, ...)

Returns:

this

setPodEnv

public ServiceTestRunner setPodEnv(java.lang.String podType,
                                   java.util.Map<java.lang.String,java.lang.String> podEnvMap)

Equivalent of setPodEnv(String, String...) for a Map instead of string pairs.

See Also:

setPodEnv(String, String...)

setPodEnv

public ServiceTestRunner setPodEnv(java.lang.String podType,
                                   java.lang.String... podEnvKeyVals)

Configures the test with additional environment variables in the specified Pod, beyond those which would be included by the Scheduler or by Mesos. This may be useful for services whose tasks configure environment variables before rendering config files via execution of bootstrap.

Parameters:

podType - the pod to set the environment against

podEnvKeyVals - an even number of strings which will be unpacked as (key, value, key, value, ...)

Returns:

this

setRecoveryManagerFactory

public ServiceTestRunner setRecoveryManagerFactory(RecoveryPlanOverriderFactory recoveryManagerFactory)

Allows the specification of custom recovery logic just as in SchedulerBuilder.setRecoveryManagerFactory(RecoveryPlanOverriderFactory).

setCustomValidators

public ServiceTestRunner setCustomValidators(ConfigValidator<ServiceSpec>... validators)

setUseCustomExecutor

public ServiceTestRunner setUseCustomExecutor()

Simulates DC/OS 1.9 behavior of using a custom executor instead of the default executor. Individual services shouldn't need to use this, it's more for testing of the SDK itself.

run

public ServiceTestResult run()
                      throws java.lang.Exception

Exercises the service's packaging and resulting Service Specification YAML file without running any simulation afterwards.

Returns:

a ServiceTestResult containing the resulting scheduler environment and spec information

Throws:

java.lang.Exception - if the test failed

run

public ServiceTestResult run(java.util.Collection<SimulationTick> ticks)
                      throws java.lang.Exception

Exercises the service's packaging and resulting Service Specification YAML file, then runs the provided simulation ticks, if any are provided.

Returns:

a ServiceTestResult containing the resulting scheduler environment and spec information

Throws:

java.lang.Exception - if the test failed