Usage¶
Library¶
Labgrid can be used directly as a Python library, without the infrastructure provided by the pytest plugin.
Creating and Configuring Targets¶
The labgrid library provides two ways to configure targets with resources and
drivers: either create the Target
directly or use Environment
to
load a configuration file.
Targets¶
At the lower level, a Target
can be created directly:
>>> from labgrid import Target
>>> t = Target('example')
Next, the required Resources
can be created:
>>> from labgrid.resource import RawSerialPort
>>> rsp = RawSerialPort(t, port='/dev/ttyUSB0')
Then, a Driver
needs to be created on the Target:
>>> from labgrid.driver import SerialDriver
>>> sd = SerialDriver(t)
As the SerialDriver declares a binding to a SerialPort, the target binds it to the resource created above:
>>> sd.port
RawSerialPort(target=Target(name='example', env=None), state=<BindingState.active: 2>, avail=True, port='/dev/ttyUSB0', speed=115200)
>>> sd.port is rsp
True
Before the driver can be used, it needs to be activated:
>>> t.activate(sd)
>>> sd.write(b'test')
Environments¶
In practice, is is often useful to separate the Target configuration from the code which needs to control the board (such as a test case or installation script). For this use-case, labgrid can construct targets from a configuration file in YAML format:
targets:
example:
resources:
RawSerialPort:
port: '/dev/ttyUSB0'
drivers:
SerialDriver: {}
To parse this configuration file, use the Environment
class:
>>> from labgrid import Environment
>>> env = Environment('example-env.yaml')
Using Environment.get_target
, the configured Targets can be retrieved
by name.
Without an argument, get_target would default to ‘main’:
>>> t = env.get_target('example')
To access the target’s console, the correct driver object can be found by using
Target.get_driver
:
>>> from labgrid.protocol import ConsoleProtocol
>>> cp = t.get_driver(ConsoleProtocol)
>>> cp
SerialDriver(target=Target(name='example', env=Environment(config_file='example.yaml')), state=<BindingState.active: 2>)
>>> cp.write(b'test')
When using the get_driver
method, the driver is automatically activated.
The driver activation will also wait for unavailable resources when needed.
pytest Plugin¶
Labgrid includes a pytest plugin to simplify writing tests which involve embedded boards. The plugin is configured by providing an environment config file (via the –lg-env pytest option) and automatically creates the targets described in the environment.
Two pytest fixtures are provided:
- env (session scope)
- Used to access the
Environment
object created from the configuration file. This is mostly used for defining custom fixtures at the test suite level. - target (session scope)
- Used to access the ‘main’
Target
defined in the configuration file.
Simple Example¶
As a minimal example, we have a target connected via a USB serial converter
(‘/dev/ttyUSB0’) and booted to the Linux shell.
The following environment config file (shell-example.yaml
) describes how to
access this board:
targets:
main:
resources:
RawSerialPort:
port: '/dev/ttyUSB0'
drivers:
SerialDriver: {}
ShellDriver:
prompt: 'root@\w+:[^ ]+ '
login_prompt: ' login: '
username: 'root'
We then add the following test in a file called test_example.py
:
from labgrid.protocol import CommandProtocol
def test_echo(target):
command = t.get_driver(CommandProtocol)
result = command.run_check('echo OK')
assert 'OK' in result
To run this test, we simply execute pytest in the same directory with the environment config:
$ pytest --lg-env shell-example.yaml --verbose
============================= test session starts ==============================
platform linux -- Python 3.5.3, pytest-3.0.6, py-1.4.32, pluggy-0.4.0
…
collected 1 items
test_example.py::test_echo PASSED
=========================== 1 passed in 0.51 seconds ===========================
pytest has automatically found the test case and executed it on the target.
Custom Fixture Example¶
When writing many test cases which use the same driver, we can get rid of some
common code by wrapping the CommandProtocol in a fixture.
As pytest always executes the conftest.py
file in the test suite directory,
we can define additional fixtures there:
import pytest
from labgrid.protocol import CommandProtocol
@pytest.fixture(scope='session')
def command(target):
return target.get_driver(CommandProtocol)
With this fixture, we can simplify the test_example.py
file to:
def test_echo(command):
result = command.run_check('echo OK')
assert 'OK' in result
Strategy Fixture Example¶
When using a Strategy
to transition the target between states, it is
useful to define a function scope fixture per state in conftest.py
:
import pytest
from labgrid.protocol import CommandProtocol
from labgrid.strategy import BareboxStrategy
@pytest.fixture(scope='session')
def strategy(target):
try:
return target.get_driver(BareboxStrategy)
except NoDriverFoundError:
pytest.skip("strategy not found")
@pytest.fixture(scope='function')
def bootloader_command(target, strategy, capsys):
with capsys.disabled():
strategy.transition('barebox')
return target.get_active_driver(CommandProtocol)
@pytest.fixture(scope='function')
def shell_command(target, strategy, capsys):
with capsys.disabled():
strategy.transition('shell')
return target.get_active_driver(CommandProtocol)
Note
The capsys.disabled()
context manager is only needed when using the
ManualPowerDriver
, as it will not be able to access the console
otherwise.
See the corresponding pytest documentation for details.
With the fixtures defined above, switching between bootloader and Linux shells is easy:
def test_barebox_initial(bootloader_command):
stdout = bootloader_command.run_check('version')
assert 'barebox' in '\n'.join(stdout)
def test_shell(shell_command):
stdout = shell_command.run_check('cat /proc/version')
assert 'Linux' in stdout[0]
def test_barebox_after_reboot(bootloader_command):
bootloader_command.run_check('true')
Note
The bootloader_command and shell_command fixtures use
Target.get_active_driver
to get the currently active CommandProtocol
driver (either BareboxDriver
or ShellDriver
).
Activation and deactivation of drivers is handled by the
BareboxStrategy
in this example.
The Strategy needs additional drivers to control the target.
Adapt the following environment config file (strategy-example.yaml
) to your
setup:
targets:
main:
resources:
RawSerialPort:
port: '/dev/ttyUSB0'
drivers:
ManualPowerDriver:
name: 'example-board'
SerialDriver: {}
BareboxDriver:
prompt: 'barebox@[^:]+:[^ ]+ '
ShellDriver:
prompt: 'root@\w+:[^ ]+ '
login_prompt: ' login: '
username: 'root'
BareboxStrategy: {}
For this example, you should get a report similar to this:
$ pytest --lg-env strategy-example.yaml -v
============================= test session starts ==============================
platform linux -- Python 3.5.3, pytest-3.0.6, py-1.4.32, pluggy-0.4.0
…
collected 3 items
test_strategy.py::test_barebox_initial
main: CYCLE the target example-board and press enter
PASSED
test_strategy.py::test_shell PASSED
test_strategy.py::test_barebox_after_reboot
main: CYCLE the target example-board and press enter
PASSED
========================== 3 passed in 29.77 seconds ===========================
Test Reports¶
pytest-html¶
With the pytest-html plugin, the test results can be converted directly to a single-page HTML report:
$ pip install pytest-html
$ pytest --lg-env shell-example.yaml --html=report.html
JUnit XML¶
JUnit XML reports can be generated directly by pytest and are especially useful for use in CI systems such as Jenkins with the JUnit Plugin.
They can also be converted to other formats, such as HTML with junit2html tool:
$ pip install junit2html
$ pytest --lg-env shell-example.yaml --junit-xml=report.xml
$ junit2html report.xml
Command-Line¶
Labgrid contains some command line tools which are used for remote access to resources. See labgrid-client, labgrid-device-config and labgrid-exporter for more information.
USB stick emulation¶
Labgrid makes it posible to use a target as an emulated USB stick, allowing upload, modification, plug and unplug events. To use a target as an emulated USB stick, several requirements have to be met:
- OTG support on one of the device USB ports
- losetup from util-linux
- mount from util-linux
- A kernel build with CONFIG_USB_GADGETFS=m
- A network connection to the target to use the SSHDriver for file uploads
To use USB stick emulation, import USBStick
from labgrid.external and bind
it to the desired target:
from labgrid.external import USBStick
stick = USBStick(target, '/home/')
The above code block creates the stick and uses the /home directory to store the device images. USBStick images can now be uploaded using the upload_image method. Once an image is selected, files can be uploaded and retrived using the put_file and get_file methods. The plug_in and plug_out functions plug the emulated USB stick in and out.
hawkBit management API¶
Labgrid provides an interface to the hawkbit management API. This allows a labgrid test to create targets, rollouts and manage deployments.
from labgrid.external import HawkbitTestClient
client = HawkbitTestClient('local', '8080', 'admin', 'admin')
The above code connects to a running hawkbit instance on the local computer and
uses the default credentials to log in. The HawkbitTestClient
provides various
helper functions to add targets, define distribution sets and assign targets.