org.apache.brooklyn.test.framework

Interface TestSshCommand

All Superinterfaces:

BaseTest, BrooklynObject, Configurable, Entity, Identifiable, Startable, TargetableTestComponent

All Known Subinterfaces:

SimpleShellCommandTest

All Known Implementing Classes:

SimpleShellCommandTestImpl, TestSshCommandImpl

public interface TestSshCommand
extends BaseTest

Tests ssh command execution, against the SshMachineLocation of the target entity.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<java.lang.Object>	ASSERT_ERR Assertions on the standard error of the command as a String.
static ConfigKey<java.lang.Object>	ASSERT_OUT Assertions on the standard output of the command as a String.
static ConfigKey<java.lang.Object>	ASSERT_STATUS Assertions on the exit code of the simple command.
static ConfigKey<Duration>	BACKOFF_TO_PERIOD
static ConfigKey<java.lang.String>	COMMAND Supply the command to invoke directly.
static java.util.Map<java.lang.String,java.lang.Object>	DEFAULT_ASSERTION If no assertions are configured in the test then the default is this assertion that exit status of the command is zero (successful).
static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>	DOWNLOAD_URL Download a script to invoke.
static ConfigKey<java.lang.Integer>	MAX_ATTEMPTS The maximum number of times to execute the ssh command, before throwing an exception.
static ConfigKey<java.lang.String>	RUN_DIR The working directory that the script will be run from on the target machine.
static ConfigKey<java.lang.String>	SCRIPT_DIR Where the script will be downloaded on the target machine.
static ConfigKey<java.util.Map<java.lang.String,java.lang.Object>>	SHELL_ENVIRONMENT
static java.lang.String	TMP_DEFAULT Default location for temporary files.

Fields inherited from interface org.apache.brooklyn.test.framework.BaseTest

ASSERTIONS, ITERATION_LIMIT, TIMEOUT

Fields inherited from interface org.apache.brooklyn.test.framework.TargetableTestComponent

TARGET_ENTITY, TARGET_ENTITY_ID, TARGET_ENTITY_NAME, TARGET_ENTITY_TYPE, TARGET_ID, TARGET_RESOLUTION_TIMEOUT

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Method Summary

Methods inherited from interface org.apache.brooklyn.test.framework.TargetableTestComponent

resolveTarget

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addChild, addChild, addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

restart, start, stop

Field Detail

TMP_DEFAULT

static final java.lang.String TMP_DEFAULT

Default location for temporary files.

See Also:

Constant Field Values

BACKOFF_TO_PERIOD

static final ConfigKey<Duration> BACKOFF_TO_PERIOD

COMMAND

static final ConfigKey<java.lang.String> COMMAND

Supply the command to invoke directly. Cannot be used together with DOWNLOAD_URL.

DOWNLOAD_URL

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> DOWNLOAD_URL

Download a script to invoke. Cannot be used together with COMMAND.

SHELL_ENVIRONMENT

static final ConfigKey<java.util.Map<java.lang.String,java.lang.Object>> SHELL_ENVIRONMENT

SCRIPT_DIR

static final ConfigKey<java.lang.String> SCRIPT_DIR

Where the script will be downloaded on the target machine.

RUN_DIR

static final ConfigKey<java.lang.String> RUN_DIR

The working directory that the script will be run from on the target machine.

DEFAULT_ASSERTION

static final java.util.Map<java.lang.String,java.lang.Object> DEFAULT_ASSERTION

If no assertions are configured in the test then the default is this assertion that exit status of the command is zero (successful).

ASSERT_STATUS

static final ConfigKey<java.lang.Object> ASSERT_STATUS

Assertions on the exit code of the simple command. If not explicitly configured, the default assertion is a non-zero exit code.

ASSERT_OUT

static final ConfigKey<java.lang.Object> ASSERT_OUT

Assertions on the standard output of the command as a String.

ASSERT_ERR

static final ConfigKey<java.lang.Object> ASSERT_ERR

Assertions on the standard error of the command as a String.

MAX_ATTEMPTS

static final ConfigKey<java.lang.Integer> MAX_ATTEMPTS

The maximum number of times to execute the ssh command, before throwing an exception.