labgrid package

Subpackages

• labgrid.driver package
  • Subpackages
    • labgrid.driver.power package
      • Submodules
      • labgrid.driver.power.apc module
      • labgrid.driver.power.digipower module
      • labgrid.driver.power.gude module
      • labgrid.driver.power.netio module
  • Submodules
  • labgrid.driver.bareboxdriver module
  • labgrid.driver.commandmixin module
  • labgrid.driver.common module
  • labgrid.driver.consoleexpectmixin module
  • labgrid.driver.exception module
  • labgrid.driver.externalconsoledriver module
  • labgrid.driver.fake module
  • labgrid.driver.fastbootdriver module
  • labgrid.driver.infodriver module
  • labgrid.driver.onewiredriver module
  • labgrid.driver.powerdriver module
  • labgrid.driver.serialdriver module
  • labgrid.driver.shelldriver module
  • labgrid.driver.sshdriver module
  • labgrid.driver.ubootdriver module
  • labgrid.driver.usbloader module
  • labgrid.driver.usbstorage module
• labgrid.external package
  • Submodules
  • labgrid.external.hawkbit module
  • labgrid.external.usbstick module
• labgrid.protocol package
  • Submodules
  • labgrid.protocol.bootstrapprotocol module
  • labgrid.protocol.commandprotocol module
  • labgrid.protocol.consoleprotocol module
  • labgrid.protocol.digitaloutputprotocol module
  • labgrid.protocol.filesystemprotocol module
  • labgrid.protocol.filetransferprotocol module
  • labgrid.protocol.infoprotocol module
  • labgrid.protocol.linuxbootprotocol module
  • labgrid.protocol.mmioprotocol module
  • labgrid.protocol.powerprotocol module
• labgrid.provider package
  • Submodules
  • labgrid.provider.fileprovider module
  • labgrid.provider.mediafileprovider module
• labgrid.pytestplugin package
  • Submodules
  • labgrid.pytestplugin.fixtures module
  • labgrid.pytestplugin.reporter module
• labgrid.remote package
  • Submodules
  • labgrid.remote.authenticator module
  • labgrid.remote.client module
  • labgrid.remote.common module
  • labgrid.remote.config module
  • labgrid.remote.coordinator module
  • labgrid.remote.exporter module
• labgrid.resource package
  • Submodules
  • labgrid.resource.base module
  • labgrid.resource.common module
  • labgrid.resource.networkservice module
  • labgrid.resource.onewireport module
  • labgrid.resource.power module
  • labgrid.resource.remote module
  • labgrid.resource.serialport module
  • labgrid.resource.udev module
• labgrid.strategy package
  • Submodules
  • labgrid.strategy.bareboxstrategy module
  • labgrid.strategy.common module
  • labgrid.strategy.ubootstrategy module
• labgrid.util package
  • Submodules
  • labgrid.util.exceptions module
  • labgrid.util.expect module
  • labgrid.util.marker module
  • labgrid.util.timeout module
  • labgrid.util.yaml module

Submodules

labgrid.binding module

exception labgrid.binding.StateError(msg)

Bases: Exception

msg = Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

exception labgrid.binding.BindingError(msg)

Bases: Exception

msg = Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

class labgrid.binding.BindingState

Bases: enum.Enum

An enumeration.

error = -1

idle = 0

bound = 1

active = 2

class labgrid.binding.BindingMixin(target)

Bases: object

Handles the binding and activation of drivers and their supplying resources and drivers.

One client can be bound to many suppliers, and one supplier can be bound by many clients.

Conflicting access to one supplier can be avoided by deactivating conflicting clients before activation (using the resolve_conflicts callback).

bindings = {}

target = Attribute(name='target', default=NOTHING, validator=None, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

state = Attribute(name='state', default=<BindingState.idle: 0>, validator=None, repr=True, cmp=True, hash=True, init=False, convert=None, metadata=mappingproxy({}))

on_supplier_bound(supplier, name)

Called by the Target after a new supplier has been bound

on_client_bound(client)

Called by the Target after a new client has been bound

on_activate()

Called by the Target when this object has been activated

on_deactivate()

Called by the Target when this object has been deactivated

resolve_conflicts(client)

Called by the Target to allow this object to deactivate conflicting clients.

labgrid.config module

Config convenience class

This class encapsulates access functions to the environment configuration

class labgrid.config.Config(filename)

Bases: object

filename = Attribute(name='filename', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

resolve_path(path)

Resolve an absolute path

Parameters:path (str) – path to resolve Returns:the absolute path Return type:str

get_tool(tool)

Retrieve an entry from the tools subkey

Parameters:tool (str) – the tool to retrieve the path for Returns:path to the requested tools Return type:str

get_image_path(kind)

Retrieve an entry from the images subkey

Parameters:kind (str) – the kind of the image to retrieve the path for Returns:path to the image Return type:str Raises:KeyError – if the requested image can not be found in the configuration

get_option(name, default=None)

Retrieve an entry from the options subkey

Parameters:

• name (str) – name of the option
• default (str) – A default parameter in case the option can not be found

Returns:

value of the option or default parameter

Return type:

str

Raises:

KeyError – if the requested image can not be found in the configuration

get_targets()

labgrid.environment module

class labgrid.environment.Environment(config_file='config.yaml', interact=<built-in function input>)

Bases: object

An environment encapsulates targets.

config_file = Attribute(name='config_file', default='config.yaml', validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

interact = Attribute(name='interact', default=<built-in function input>, validator=None, repr=False, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

get_target(role: str = 'main') → labgrid.target.Target

Returns the specified target.

cleanup()

labgrid.exceptions module

exception labgrid.exceptions.NoConfigFoundError(msg)

Bases: Exception

msg = Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

exception labgrid.exceptions.NoSupplierFoundError(msg)

Bases: Exception

msg = Attribute(name='msg', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

exception labgrid.exceptions.NoDriverFoundError(msg)

Bases: labgrid.exceptions.NoSupplierFoundError

exception labgrid.exceptions.NoResourceFoundError(msg)

Bases: labgrid.exceptions.NoSupplierFoundError

labgrid.factory module

class labgrid.factory.TargetFactory

Bases: object

reg_resource(cls)

Register a resource with the factory.

Returns the class to allow using it as a decorator.

reg_driver(cls)

Register a driver with the factory.

Returns the class to allow using it as a decorator.

make_resource(target, resource, args)

make_target(name, config, *, env=None)

labgrid.step module

class labgrid.step.Steps

Bases: object

get_current()

get_new(title)

push(step)

pop(step)

subscribe(callback)

notify(event)

class labgrid.step.StepEvent(step, data, *, resource=None, stream=False)

Bases: object

merge(other)

age

class labgrid.step.Step(title, level)

Bases: object

duration

status

is_active

is_done

start()

skip(reason)

stop()

labgrid.step.step(*, title=None, args=[], result=False)

labgrid.stepreporter module

class labgrid.stepreporter.StepReporter

Bases: object

instance = None

classmethod start()

notify(event)

labgrid.target module

class labgrid.target.Target(name, env=None)

Bases: object

name = Attribute(name='name', default=NOTHING, validator=<instance_of validator for type <class 'str'>>, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

env = Attribute(name='env', default=None, validator=None, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

interact(msg)

await_resources()

get_resource(cls)

Helper function to get a resource of the target. Returns the first valid resource found, otherwise None.

Arguments: cls – resource-class to return as a resource

get_driver(cls)

Helper function to get a driver of the target. Returns the first valid driver found, otherwise None.

Arguments: cls – driver-class to return as a resource

get_active_driver(cls)

Helper function to get the active driver of the target. Returns the active driver found, otherwise None.

Arguments: cls – driver-class to return as a resource

get(cls)

bind_resource(resource)

Bind the resource to this target.

bind_driver(client)

Bind the driver to all suppliers (resources and other drivers).

Currently, we only support binding all suppliers at once.

bind(bindable)

activate(client)

Activate the client by activating all bound suppliers. This may require deactivating other clients.

deactivate(client)

Recursively deactivate the client’s clients and itself.

This is needed to ensure that no client has an inactive supplier.

cleanup()

Clean up conntected drivers and resources in reversed order