avocado_i2n.cartgraph.object module

Utility for the main test suite substructures like test objects.

SUMMARY

Copyright: Intra2net AG

INTERFACE

class avocado_i2n.cartgraph.object.TestObject(suffix: str, recipe: Reparsable)

Bases: object

A wrapper for a test object used in one or more test nodes.

property params: Params

Parameters (cache) property.

property component_form: str

Component form of the test object name.

property long_suffix: str

Sufficiently unique suffix to identify a variantless test object.

property id: str

Use unique ID to identify a test object.

is_flat() → bool

Check if the test object is flat and does not yet have components to evaluate.

is_permanent() → bool

Check if the object is permanent.

If permanent, it can only be created manually (possibly through the use of manual setup steps).

On states on permanent test object are treated differently than on states on normal test object since they are preserved through test runs and even host shutdowns.

object_typed_params(params: Params) → Params

Return object and type filtered parameters using the current object type.

Parameters:

params – whether to show generated parameter dictionaries

update_restrs(object_restrs: dict[str, str]) → None

Update any restrictions with further filters.

Parameters:

object_restrs – multi-line object restrictions to append

regenerate_params(verbose: bool = False) → None

Regenerate all parameters from the current reparsable recipe.

Parameters:

verbose – whether to show generated parameter dictionaries

class avocado_i2n.cartgraph.object.NetObject(name: str, recipe: Reparsable)

Bases: TestObject

A Net wrapper for a test object used in one or more test nodes.

property component_form: str

Component form of the test object name.

class avocado_i2n.cartgraph.object.VMObject(name: str, recipe: Reparsable)

Bases: TestObject

A VM wrapper for a test object used in one or more test nodes.

class avocado_i2n.cartgraph.object.ImageObject(name: str, recipe: Reparsable)

Bases: TestObject

An image wrapper for a test object used in one or more test nodes.

property id: str

Sufficiently unique ID to identify a test object.

property component_form: str

Component form of the test object name.