PHP Class DataSift\Storyplayer\DefinitionLib\TestEnvironment_GroupDefinition

See link: http://datasift.github.io/storyplayer
Author: Stuart Herbert ([email protected])
Afficher le fichier Open project: datasift/storyplayer Class Usage Examples

Protected Properties

Свойство Type Description
$groupAdapter Storyplayer\TestEnvironments\GroupAdapter the code that understands what's special about this type of group
$groupId integer | string which group are we?
$hosts array a list of all of the hosts in this group
$parentEnv TestEnvironment_Definition the test environment that we belong to
$provisioningAdapters array a list of provisioning adapters to use for this group

Méthodes publiques

Méthode Description
__construct ( TestEnvironment_Definition $parent, $groupId, Storyplayer\TestEnvironments\GroupAdapter $groupAdapter )
addProvisioningAdapter ( Storyplayer\TestEnvironments\ProvisioningAdapter $adapter ) add a provisioning adapter to our list
getBaseFolder ( ) : string which folder contains all of our supporting files?
getGroupAdapter ( ) : Storyplayer\TestEnvironments\GroupAdapter get the plugin we use to start and stop this test environment
getGroupId ( ) : integer | string what is our group ID?
getGroupType ( ) : string what type of group are we?
getHostAdapterValidator ( ) : Storyplayer\TestEnvironments\HostAdapterValidator what should we use to validate a host adapter that is being added to one of the hosts in this group?
getHosts ( ) : array what hosts exist in this group?
getHostsAsConfig ( ) : DataSift\Stone\ObjectLib\BaseObject return our hosts, as SPv2.0-style config tree
getProvisioningAdapters ( ) : array how should we provision this environment?
getProvisioningAsConfig ( ) : DataSift\Stone\ObjectLib\BaseObject return our first provisioning adapter, as SPv2.0-style config tree
getTestEnvironmentName ( ) : string which test environment do we belong to?
hasProvisioningAdapters ( ) : boolean do we have any provisioning adapters?
newHost ( string $hostId, Storyplayer\TestEnvironments\HostAdapter $hostAdapter ) : TestEnvironment_HostDefinition start the definition of a host in this group
setGroupAdapter ( Storyplayer\TestEnvironments\GroupAdapter $groupAdapter ) : TestEnvironment_GroupDefinition tell us which plugin to use to start and stop this test environment

Méthodes protégées

Méthode Description
requireGroupAdapter ( ) : void throws an exception if we don't have a valid group adapter to use

Method Details

__construct() public méthode

public __construct ( TestEnvironment_Definition $parent, $groupId, Storyplayer\TestEnvironments\GroupAdapter $groupAdapter )
$parent TestEnvironment_Definition
$groupAdapter Storyplayer\TestEnvironments\GroupAdapter

addProvisioningAdapter() public méthode

our list can have as many provisioning adapters as you would like they are executed in the order that you add them
public addProvisioningAdapter ( Storyplayer\TestEnvironments\ProvisioningAdapter $adapter )
$adapter Storyplayer\TestEnvironments\ProvisioningAdapter the provisioning adapter to add

getBaseFolder() public méthode

which folder contains all of our supporting files?
public getBaseFolder ( ) : string
Résultat string

getGroupAdapter() public méthode

get the plugin we use to start and stop this test environment
public getGroupAdapter ( ) : Storyplayer\TestEnvironments\GroupAdapter
Résultat Storyplayer\TestEnvironments\GroupAdapter

getGroupId() public méthode

what is our group ID?
public getGroupId ( ) : integer | string
Résultat integer | string

getGroupType() public méthode

this is the name of the class (without namespace) that our group adapter uses
public getGroupType ( ) : string
Résultat string

getHostAdapterValidator() public méthode

what should we use to validate a host adapter that is being added to one of the hosts in this group?
public getHostAdapterValidator ( ) : Storyplayer\TestEnvironments\HostAdapterValidator
Résultat Storyplayer\TestEnvironments\HostAdapterValidator

getHosts() public méthode

what hosts exist in this group?
public getHosts ( ) : array
Résultat array

getHostsAsConfig() public méthode

return our hosts, as SPv2.0-style config tree
public getHostsAsConfig ( ) : DataSift\Stone\ObjectLib\BaseObject
Résultat DataSift\Stone\ObjectLib\BaseObject

getProvisioningAdapters() public méthode

how should we provision this environment?
public getProvisioningAdapters ( ) : array
Résultat array

getProvisioningAsConfig() public méthode

return our first provisioning adapter, as SPv2.0-style config tree
public getProvisioningAsConfig ( ) : DataSift\Stone\ObjectLib\BaseObject
Résultat DataSift\Stone\ObjectLib\BaseObject

getTestEnvironmentName() public méthode

which test environment do we belong to?
public getTestEnvironmentName ( ) : string
Résultat string

hasProvisioningAdapters() public méthode

do we have any provisioning adapters?
public hasProvisioningAdapters ( ) : boolean
Résultat boolean

newHost() public méthode

start the definition of a host in this group
public newHost ( string $hostId, Storyplayer\TestEnvironments\HostAdapter $hostAdapter ) : TestEnvironment_HostDefinition
$hostId string the ID of this host
$hostAdapter Storyplayer\TestEnvironments\HostAdapter the plugin for this kind of host
Résultat TestEnvironment_HostDefinition the empty host definition, for you to complete

requireGroupAdapter() protected méthode

throws an exception if we don't have a valid group adapter to use
protected requireGroupAdapter ( ) : void
Résultat void

setGroupAdapter() public méthode

tell us which plugin to use to start and stop this test environment
public setGroupAdapter ( Storyplayer\TestEnvironments\GroupAdapter $groupAdapter ) : TestEnvironment_GroupDefinition
$groupAdapter Storyplayer\TestEnvironments\GroupAdapter the adapter to use for this group
Résultat TestEnvironment_GroupDefinition

Property Details

$groupAdapter protected_oe property

the code that understands what's special about this type of group
protected GroupAdapter,Storyplayer\TestEnvironments $groupAdapter
Résultat Storyplayer\TestEnvironments\GroupAdapter

$groupId protected_oe property

which group are we?
protected int|string $groupId
Résultat integer | string

$hosts protected_oe property

a list of all of the hosts in this group
protected array $hosts
Résultat array

$parentEnv protected_oe property

the test environment that we belong to
protected TestEnvironment_Definition,DataSift\Storyplayer\DefinitionLib $parentEnv
Résultat TestEnvironment_Definition

$provisioningAdapters protected_oe property

a list of provisioning adapters to use for this group
protected array $provisioningAdapters
Résultat array