labgrid.remote package

Submodules

labgrid.remote.authenticator module

class labgrid.remote.authenticator.AuthenticatorSession

Bases: sphinx.ext.autodoc.ApplicationSession

onJoin(details)

labgrid.remote.client module

The remote.client module contains the functionality to connect to a coordinator, acquire a place and interact with the connected resources

exception labgrid.remote.client.Error

Bases: Exception

exception labgrid.remote.client.UserError

Bases: labgrid.remote.client.Error

exception labgrid.remote.client.ServerError

Bases: labgrid.remote.client.Error

class labgrid.remote.client.ClientSession

Bases: sphinx.ext.autodoc.ApplicationSession

The ClientSession encapsulates all the actions a Client can Invoke on the coordinator.

onConnect()

Actions which are executed if a connection is successfully opened.

onChallenge(challenge)

onJoin(details)

on_resource_changed(exporter, group_name, resource_name, resource)

on_place_changed(name, config)

complete()

print_resources()

Print out the resources

print_places()

Print out the places

print_who()

Print acquired places by user

get_place(place=None)

get_idle_place(place=None)

get_acquired_place(place=None)

print_place()

Print out the current place and related resources

add_place()

Add a place to the coordinator

del_place()

Delete a place from the coordinator

add_alias()

Add an alias for a place on the coordinator

del_alias()

Delete an alias for a place from the coordinator

set_comment()

Set the comment on a place

add_match()

Add a match for a place, making fuzzy matching available to the client

del_match()

Delete a match for a place

acquire()

Acquire a place, marking it unavailable for other clients

release()

Release a previously acquired place

get_target_resources(place)

get_target_config(place)

env()

power()

console()

fastboot()

bootstrap()

labgrid.remote.client.start_session(url, realm, extra)

labgrid.remote.client.main()

labgrid.remote.common module

class labgrid.remote.common.ResourceEntry(data, acquired=None)

Bases: object

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

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

avail

cls

params

args

arguments for resource construction

extra

extra resource information

asdict()

class labgrid.remote.common.ResourceMatch(exporter, group, cls, name=None)

Bases: object

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

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

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

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

classmethod fromstr(pattern)

ismatch(resource_path)

class labgrid.remote.common.Place(name, aliases=NOTHING, comment='', matches=NOTHING, acquired=None, acquired_resources=NOTHING, created=NOTHING, changed=NOTHING)

Bases: object

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

aliases = Attribute(name='aliases', default=Factory(factory=<class 'set'>), validator=None, repr=True, cmp=True, hash=True, init=True, convert=<class 'set'>, metadata=mappingproxy({}))

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

matches = Attribute(name='matches', default=Factory(factory=<class 'list'>), validator=None, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

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

acquired_resources = Attribute(name='acquired_resources', default=Factory(factory=<class 'list'>), validator=None, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

created = Attribute(name='created', default=Factory(factory=<function Place.<lambda>>), validator=None, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

changed = Attribute(name='changed', default=Factory(factory=<function Place.<lambda>>), validator=None, repr=True, cmp=True, hash=True, init=True, convert=None, metadata=mappingproxy({}))

asdict()

show(level=0)

hasmatch(resource_path)

Return True if this place as a ResourceMatch object for the given resource path.

A resource_path has the structure (exporter, group, cls, name).

touch()

labgrid.remote.common.enable_tcp_nodelay(session)

asyncio/autobahn does not set TCP_NODELAY by default, so we need to do it like this for now.

labgrid.remote.config module

class labgrid.remote.config.ResourceConfig(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({}))

labgrid.remote.coordinator module

The coordinator module coordinates exported resources and clients accessing them.

class labgrid.remote.coordinator.Action

Bases: enum.Enum

An enumeration.

ADD = 0

DEL = 1

UPD = 2

class labgrid.remote.coordinator.RemoteSession

Bases: object

class encapsulating a session, used by ExporterSession and ClientSession

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

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

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

key

Key of the session

name

Name of the session

class labgrid.remote.coordinator.ExporterSession(coordinator, session, authid)

Bases: labgrid.remote.coordinator.RemoteSession

An ExporterSession is opened for each Exporter connecting to the coordinator, allowing the Exporter to get and set resources

groups = Attribute(name='groups', default=Factory(factory=<class 'dict'>), validator=None, repr=True, cmp=True, hash=True, init=False, convert=None, metadata=mappingproxy({}))

set_resource(groupname, resourcename, resource)

get_resources()

Method invoked by the exporter, get a resource from the coordinator

class labgrid.remote.coordinator.ClientSession(coordinator, session, authid)

Bases: labgrid.remote.coordinator.RemoteSession

acquired = Attribute(name='acquired', default=Factory(factory=<class 'list'>), validator=None, repr=True, cmp=True, hash=True, init=False, convert=None, metadata=mappingproxy({}))

class labgrid.remote.coordinator.CoordinatorComponent

Bases: sphinx.ext.autodoc.ApplicationSession

onConnect()

onChallenge(challenge)

onJoin(details)

save()

load()

on_session_join(session_details)

on_session_leave(session_id)

attach(name, details=None)

set_resource(groupname, resourcename, resource, details=None)

get_resources(details=None)

add_place(name, details=None)

del_place(name, details=None)

add_place_alias(placename, alias, details=None)

del_place_alias(placename, alias, details=None)

set_place_comment(placename, comment, details=None)

add_place_match(placename, pattern, details=None)

del_place_match(placename, pattern, details=None)

acquire_place(name, details=None)

release_place(name, details=None)

get_places(details=None)

labgrid.remote.exporter module

The remote.exporter module exports resources to the coordinator and makes them available to other clients on the same coordinator

labgrid.remote.exporter.get_free_port()

Helper function to always return an unused port.

class labgrid.remote.exporter.ResourceExport(data, acquired=None)

Bases: labgrid.remote.common.ResourceEntry

Represents a local resource exported via a specific protocol.

The ResourceEntry attributes contain the information for the client.

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

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

poll()

class labgrid.remote.exporter.USBSerialPortExport(data, acquired=None)

Bases: labgrid.remote.exporter.ResourceExport

ResourceExport for a USB SerialPort

class labgrid.remote.exporter.USBEthernetExport(data, acquired=None)

Bases: labgrid.remote.exporter.ResourceExport

ResourceExport for a USB ethernet interface

class labgrid.remote.exporter.USBGenericExport(data, acquired=None)

Bases: labgrid.remote.exporter.ResourceExport

ResourceExport for USB devices accessed directly from userspace

class labgrid.remote.exporter.ExporterSession

Bases: sphinx.ext.autodoc.ApplicationSession

onConnect()

Set up internal datastructures on successful connection: - Setup loop, name, authid and address - Join the coordinator as an exporter

onChallenge(challenge)

Function invoked on received challege, returns just a dummy ticket at the moment, authentication is not supported yet

onJoin(details)

On successful join: - export available resources - bail out if we are unsuccessful

onLeave(details)

Cleanup after leaving the coordinator connection

onDisconnect()

acquire(group_name, resource_name)

release(group_name, resource_name)

poll()

add_resource(group_name, resource_name, cls, params)

Add a resource to the exporter and update status on the coordinator

update_resource(group_name, resource_name)

Update status on the coordinator

labgrid.remote.exporter.main()