avocado_i2n.states.setup module

Utility to manage off and on test object states.

SUMMARY

Copyright: Intra2net AG

INTERFACE

avocado_i2n.states.setup.BACKENDS = {}

available state backend implementations

avocado_i2n.states.setup.ROOTS = ['root', '0root', 'boot', '0boot']

keywords reserved for root states

avocado_i2n.states.setup.show_states(run_params: Params, env: Env = None) → list[str][source]

Return a list of available states of a specific type.

Parameters:

  • run_params – configuration parameters

  • env – test environment or nothing if not needed

Returns:

list of detected states

avocado_i2n.states.setup.check_states(run_params: Params, env: Env = None) → bool[source]

Check whether a given state exits.

Parameters:

run_params – configuration parameters

Returns:

whether the given state exists

Note

We can check for multiple states of multiple objects at the same time through our choice of configuration.

avocado_i2n.states.setup.get_states(run_params: Params, env: Env = None) → None[source]

Retrieve a state disregarding the current changes.

Parameters:

run_params – configuration parameters

Raises:

exceptions.TestAbortError if the retrieved state doesn’t exist, the vm is unavailable from the env, or snapshot exists in passive mode (abort)

Raises:

exceptions.TestError if invalid policy was used

avocado_i2n.states.setup.set_states(run_params: Params, env: Env = None) → None[source]

Store a state saving the current changes.

Parameters:

run_params – configuration parameters

Raises:

exceptions.TestAbortError if unexpected/missing snapshot in passive mode (abort)

Raises:

exceptions.TestError if invalid policy was used

avocado_i2n.states.setup.unset_states(run_params: Params, env: Env = None) → None[source]

Remove a state with previous changes.

Parameters:

run_params – configuration parameters

Raises:

exceptions.TestAbortError if missing snapshot in passive mode (abort)

Raises:

exceptions.TestError if invalid policy was used

avocado_i2n.states.setup.push_states(run_params: Params, env: Env = None) → None[source]

Identical to the set operation but used within the push/pop pair.

Parameters:

run_params – configuration parameters

avocado_i2n.states.setup.pop_states(run_params: Params, env: Env = None) → None[source]

Retrieve and remove a state/snapshot.

Parameters:

run_params – configuration parameters