The pipeline has retained compatibility with respect to the content of Lava-Test-Shell Test Definitions although the submission format has changed:
deploy
block is encountered.- test:
failure_retry: 3
Definitions are used for POSIX compliant operating
systems on the DUT. The deployed system is expected to support a POSIX
shell environment (/bin/ash
, /bin/dash
or /bin/bash
are the
most common) so that LAVA can execute the LAVA Test Shell Helper
scripts.
Interactive are used for non-POSIX compliant shell like bootloader (u-boot for instance) shells.
Monitors are used for devices which have no POSIX shell and start the test immediately, for example IoT boards.
Currently, there is no support for executing arbitrary commands on DUTs which cannot offer a full POSIX environment. This is being investigated for a future release.
See also
Contents
A publicly readable repository location.
The type of the repository is not guessed, it must be specified
explicitly. Support is available for bzr
and git
. Support is planned
for url
and tar
.
A simple test definition present in the same file as the job submission,
instead of from a separate file or VCS repository. This allows tests to be run
based on a single file. When combined with file://
URLs to the deploy
parameters, this allows tests to run without needing external access. See
Inline test definition example.
(optional): Pass parameters to the Lava Test Shell Definition. The format is a YAML dictionary - the key is the name of the variable to be made available to the test shell, the value is the value of that variable.
definitions:
- repository: https://git.linaro.org/lava-team/hacking-session.git
from: git
path: hacking-session-debian.yaml
name: hacking
params:
IRC_USER: ""
PUB_KEY: ""
definitions:
- repository: git://git.linaro.org/lava-team/lava-functional-tests.git
from: git
path: lava-test-shell/smoke-tests-basic.yaml
name: smoke-tests
- repository: https://git.linaro.org/lava-team/lava-functional-tests.git
from: git
path: lava-test-shell/single-node/singlenode03.yaml
name: singlenode-advanced
When a single test definition is to be used across multiple deployment types
(e.g. Debian and OpenEmbedded), it may become necessary to only perform certain
actions within that definition in specific jobs. The skip_install
support
has been migrated from V1 for compatibility. Other methods of optimising test
definitions for specific deployments may be implemented in V2 later.
The available steps which can be (individually) skipped are:
skip running lava-install-packages
for the deps:
list of the
install:
section of the definition.
skip running lava-add-sources
for the sources:
list of the install:
section of the definition.
identical to ['deps', 'keys', 'sources', 'steps']
Example syntax:
- test:
failure_retry: 3
name: kvm-basic-singlenode
timeout:
minutes: 5
definitions:
- repository: git://git.linaro.org/lava-team/lava-functional-tests.git
from: git
path: lava-test-shell/smoke-tests-basic.yaml
name: smoke-tests
- repository: http://git.linaro.org/lava-team/lava-functional-tests.git
skip_install:
- all
from: git
path: lava-test-shell/single-node/singlenode03.yaml
name: singlenode-advanced
The following will skip dependency installation and key addition in the same definition:
- test:
failure_retry: 3
name: kvm-basic-singlenode
timeout:
minutes: 5
definitions:
- repository: git://git.linaro.org/lava-team/lava-functional-tests.git
from: git
path: lava-test-shell/smoke-tests-basic.yaml
name: smoke-tests
- repository: http://git.linaro.org/lava-team/lava-functional-tests.git
skip_install:
- deps
- keys
from: git
path: lava-test-shell/single-node/singlenode03.yaml
name: singlenode-advanced
https://git.lavasoftware.org/lava/lava/blob/master/lava_dispatcher/tests/sample_jobs/kvm-inline.yaml
- test:
failure_retry: 3
name: kvm-basic-singlenode # is not present, use "test $N"
definitions:
- repository:
metadata:
format: Lava-Test Test Definition 1.0
name: smoke-tests-basic
description: "Basic system test command for Linaro Ubuntu images"
os:
- ubuntu
scope:
- functional
devices:
- panda
- panda-es
- arndale
- vexpress-a9
- vexpress-tc2
run:
steps:
- lava-test-case linux-INLINE-pwd --shell pwd
- lava-test-case linux-INLINE-uname --shell uname -a
- lava-test-case linux-INLINE-vmstat --shell vmstat
- lava-test-case linux-INLINE-ifconfig --shell ifconfig -a
- lava-test-case linux-INLINE-lscpu --shell lscpu
- lava-test-case linux-INLINE-lsusb --shell lsusb
- lava-test-case linux-INLINE-lsb_release --shell lsb_release -a
from: inline
name: smoke-tests-inline
path: inline/smoke-tests-basic.yaml
The V2 dispatcher supports some additional elements in Lava Test Shell which will not be supported in the older V1 dispatcher.
LAVA collects results from internal operations as well as from the submitted
test definitions, these form the lava
test suite results. The full set of
results for a job are available at:
results/1234
LAVA records when a submitted test definition starts execution on the test
device. If the number of test definitions which started is not the same as the
number of test definitions submitted (allowing for the lava
test suite
results), a warning will be displayed on this page.
A TestSet is a group of lava test cases which will be collated within the LAVA Results. This allows queries to look at a set of related test cases within a single definition.
name: testset-def
run:
steps:
- lava-test-set start first_set
- lava-test-case date --shell ntpdate-debian
- ls /
- lava-test-case mount --shell mount
- lava-test-set stop
- lava-test-case uname --shell uname -a
This results in the date
and mount
test cases being included into a
first_set
TestSet, independent of other test cases. The TestSet is
concluded with the lava-test-set stop
command, meaning that the uname
test case has no test set, providing a structure like:
results:
first_set:
date: pass
mount: pass
uname: pass
{'results': {'first_set': {'date': 'pass', 'mount': 'pass'}, 'uname': 'pass'}}
Each TestSet name must be valid as a URL, which is consistent with the requirements for test definition names and test case names in the V1 dispatcher.
For TestJob 1234
, the uname
test case would appear as:
results/1234/testset-def/uname
The date
and mount
test cases are referenced via the TestSet:
results/1234/testset-def/first_set/date
results/1234/testset-def/first_set/mount
A single test definition can start and stop different TestSets in sequence, as long as the name of each TestSet is unique for that test definition.
An interactive test action allows to interact with a non-POSIX test shell. For instance a u-boot shell.
The workflow of the interactive test shell is:
* send the command to the DUT
* wait for the prompts or the messages
* if a name is defined, log the result for this command (as soon a a prompt or a message is matched)
* if a message was matched and this is not the last command, wait for the prompts
Note
if the command
is None (“command:” in yaml), the test shell will
wait for the prompts and messages without sending anything to the device.
Note
the interactive shell is expecting the prompt to be already matched
before it starts. If this is not the case, then wait for the prompt by
adding a None
command
.
A u-boot interactive test might look like:
- name: network
prompts: ["=>", "/ # "]
script:
- name: dhcp
command: dhcp
successes:
- message: "DHCP client bound to address"
failures:
- message: "TIMEOUT"
exception: InfrastructureError
error: "dhcp failed"
- name: setenv
command: "setenv serverip {SERVER_IP}"
- name: wait for the prompt
command:
A script is a list of commands to send:
command
: the command to type in the shellname
: if present, log the result of this command under the given namefailures
and successes
: if present, check the logs for the given patternssuccesses
should be a list of dictionaries with only one key:
message
: the string (or regexp) to matchNote
if LAVA matches one of the prompt and successes
is defined, an
error will be recorded. If successes
is not defined, then matching a prompt
will generate a passing result.
failures
should be a list of dictionaries with:
message
: the string (or regexp) to matchexception
: If the message indicates a fatal problem, an exception can be raised:
error
: if defined, the exception messageWarning
by default, an error is not fatal.
Note
without a name
the result of a command will not be recorded in the
test job results.
Note
whenever needed, the command can use variables that will be
subtituted with live data like {SERVER_IP}
.
Test jobs using Monitors must:
start
string:end
string:start
and end
strings will match part of a line but make sure
that each string is long enough that it can only match once per boot.
If start
does not match, the job will timeout with no results.
If end
does not match, the job will timeout but the results (of
the current boot) will already have been reported.
The name of the test suite.
- name: tests
start: BOOTING ZEPHYR
end: PROJECT EXECUTION SUCCESSFUL
pattern: '(?P<test_case_id>\d+ *- [^-]+) (?P<measurement>\d+) tcs = [0-9]+ nsec'
fixupdict:
PASS: pass
FAIL: fail
If the device output is of the form:
***** BOOTING ZEPHYR OS v1.7.99 - BUILD: Apr 18 2018 10:00:55 *****
|-----------------------------------------------------------------------------|
| Latency Benchmark |
|-----------------------------------------------------------------------------|
| tcs = timer clock cycles: 1 tcs is 12 nsec |
|-----------------------------------------------------------------------------|
| 1 - Measure time to switch from ISR back to interrupted thread |
| switching time is 107 tcs = 1337 nsec |
|-----------------------------------------------------------------------------|
...
PROJECT EXECUTION SUCCESSFUL
The above regular expression can result in test case names like:
1_measure_time_to_switch_from_isr_back_to_interrupted_thread_switching_time_is
The raw data will be logged as:
test_case_id: 1 - Measure time to switch from ISR back to interrupted thread |
| switching time is
Caution
Notice how the regular expression has not closed the match at the end of the “line” but has continued on to the first non-matching character. The test case name then concatenates all whitespace and invalid characters to a single underscore.
r'(?P<test_case_id>\d+ *- [^-]+) (?P<measurement>\d+) tcs = [0-9]+ nsec'
The test_case_id will be formed from the match of the expression \d+
*- [^-]+
followed by a single space - but only if the rest of the
expression matches as well.
The measurement will be taken from the match of the expression \d+
preceded by a single space and followed by the exact string tcs =
`` which itself must be followed by a number of digits, then a single
space and finally the **exact** string ``nsec
- but only if the rest
of the expression also matches.
See also