LAVA supports two methods of extracting data: the REST API and XML-RPC. Results are made available while the job is running via the results API. Direct links from the test log UI are not populated until after the job completes, due to performance issues.
In addition to these methods of pulling data out of LAVA, there are also two methods for pushing information about its activity: notifications and publishing events.
REST API is available with /api URL. The API is based on django-rest-framework. All of the docs from django-rest-framework apply. LAVA uses token based authentication. To obtain a token POST request has to be made to /api/<version>/token/ endpoint. The request has to contain username and password fields. These are the same as used for web UI authentication. Call returns either existing AuthToken or creates new one. The tokens used for REST API and XML-RPC API are the same objects. Example:
$ curl -d '{"username":"john.doe", "password":"FooBar"}' -H "Content-Type: application/json" -X POST "https://master.lavasoftware.org/api/v0.1/token/"
Reply will contain a token that identifies the user when using the REST API:
{"token":"ezwpm1wytdwwnbbu90e6eo02bligzw21b0ibyc1ikbc19zkin6639f3wodce5u9oc3lndoqn0asfewrw0bclfii4mgtweokrxa0mztohj46n2rdi0qinezsbobfauqf0"}
Currently there are 9 endpoints available:
In addition TestJob object (/api/v0.2/jobs/id/) contains following routes:
- logs (/api/v0.2/jobs/<job_id>/logs)
- metadata (/api/v0.2/jobs/<job_id>/metadata)
Following nested routes are available. The allow for filtering in suites and tests:
The results are also available in JUnit, TAP13, CSV or YAML formats at:
Additional actions are available on the following endpoints with GET request:
Additional actions are available on the following endpoints with POST request:
Objects in all endpoints can be filtered and sorted as described in django-rest-framework docs: http://www.django-rest-framework.org/api-guide/filtering/ Searching is currently disabled.
Examples specific to LAVA objects:
https://validation.linaro.org/restapi/v0.2/jobs/?health_check=true
Filtering fields
It is possible to filter objects using their relations. This is achieved by using double underscore notation from django. Example:
https://validation.linaro.org/restapi/v0.1/jobs/?requested_device_type__cores__name=kirin
In the example above requested_device_type comes from TestJob object. It’s a related field of DeviceType. DeviceType contains cores field which is of type Core. Core object contains name field. So the example above queries database for all TestJob objects which requested device type that use cores with name kirin.
https://validation.linaro.org/restapi/v0.1/jobs/?ordering=start_time
DjangoRestFramework allows to create and modify objects using POST and PUT http requests respectively. These operations require successful authentication and sufficient permissions. LAVA utilizes Token authentication using http request header. Example:
$ curl -H "Authorization: Token xxxxxx"
Same token is used for REST API and XML-RPC API authentication.
Sending a POST request on a /jobs/ endpoint will result in attempted job
submission in LAVA. There is only one argument which needs to be passed in the
request and that is definition. Example:
$ curl -H "Authorization: Token xxxxxx" -d '{"definition": "your-testjob-definition-here"}' -H "Content-Type: application/json" -X POST "https://your.lava.hostname/api/v0.2/jobs/"
Other database object can be created in a similar way. Different objects require different fields.
LAVA makes the test results available directly from the instance,
without needing to go through lavacli. The results for any test
job which the user can view can be downloaded in CSV or YAML format.
For example, the results for test job number 123 are available in CSV
format using: https://validation.linaro.org/results/123/csv. The
same results for job number 123 are available in YAML format using:
https://validation.linaro.org/results/123/yaml
If you know the test definition name, you can also download the
results for that specific test definition only in a similar way:
https://validation.linaro.org/results/123/0_singlenode-advanced/csv
for the data in CSV format and
https://validation.linaro.org/results/123/0_singlenode-advanced/yaml
for the YAML format.
Test definition names use a prefix to show the sequence within the
test job, for each namespace. The list of test definitions within a
test job can be retrieved using the Summary:
https://validation.linaro.org/results/123/yaml_summary
Some test jobs can be restricted to particular users or groups of users. The results of these test jobs will be restricted in the same way. To download these results, you will need to specify your username and one of your Authentication Tokens when using the REST API. Remember to quote the URL if using it on the command line, to avoid the & character being mis-interpreted by your shell, for example:
$ curl 'https://validation.linaro.org/results/123/0_singlenode-advanced/yaml?user=user.name&token=yourtokentextgoeshereononeverylongline'
Use the Username as specified in your Profile - this may differ from the username you use if logging in via LDAP.
Caution
Take care of your tokens - avoid using personal tokens in
scripts and test definitions, or any other files that end up in
public git repositories. Wherever supported, use https:// when
using a token to avoid it being sent in plain-text.
When jobs have a large number of test results in a particular test suite, it is advisable to use test case chunking, to provide pagination for downloading test cases via the REST API.
Two special query string arguments are supported for allowing users to chunk the test cases when downloading test suite results.
Limit and offset are supported only for test suite exports (both csv and yaml). Example:
$ curl 'https://validation.linaro.org/results/123/0_singlenode-advanced/yaml?limit=100&offset=200'
$ curl 'https://validation.linaro.org/results/123/0_singlenode-advanced/yaml?user=user.name&token=yourtokentextgoeshereononeverylongline&limit=100&offset=200'
To retrieve the full count of testcases in a single test suite (useful for pagination), you can use the testcase-count REST API method, like so:
$ curl 'https://validation.linaro.org/results/123/0_singlenode-advanced/+testcase-count?user=user.name&token=yourtokentextgoeshereononeverylongline'
Note
Test cases will be ordered by ID regardless of whether pagination is used or not. This applies to downloading test cases for a particular test suite only.
Lots of methods are available to query various information in LAVA.
Warning
When using XML-RPC to communicate with a remote server,
check whether https:// can be used to protect the
token. http:// connections to a remote XML-RPC server will
transmit the token in plain-text. Not all servers have https://
configured. If a token becomes compromised, log in to that LAVA
instance and delete the token before creating a new one.
The general structure of an XML-RPC call can be shown in this python snippet:
# Python3
import xmlrpc.client
import simplejson
config = simplejson.dumps({ ... })
server=xmlrpc.client.ServerProxy("http://username:API-Key@localhost:8001/RPC2/")
jobid=server.scheduler.submit_job(config)
XML-RPC can also be used to query data anonymously:
# Python3
import xmlrpc.client
server = xmlrpc.client.ServerProxy("http://sylvester.codehelp/RPC2")
print server.system.listMethods()
Individual XML-RPC commands are documented on the API Help page.
Users can request notifications about submitted test jobs by adding a notify block to their test job submission.
The basic setup of the notifications in job definitions will have criteria, verbosity, recipients and compare blocks.
Here is an example notification setup. For more detailed information see User notifications in LAVA.
notify: criteria: status: incomplete verbosity: quiet recipients: - to: user: neil.williams method: irc
Event notifications are handled by the lava-publisher service on
the master. By default, event notifications are disabled.
Note
lava-publisher is distinct from the publishing API. Publishing events covers status
changes for devices and test jobs. The publishing API covers
copying files from test jobs to external sites.
http://ivoire.dinauz.org/linaro/bus/ is the home of ReactOWeb. It
shows an example of the status change information which can be made
available using lava-publisher. Events include:
Event notifications are disabled by default and must be configured before being enabled.
See also
org.linaro.validation.staging.device)The topic field is configurable by lab administrators. Its
intended use is to allow receivers of events to filter incoming
events.
{
"device": "staging-qemu05",
"device_type": "qemu",
"health_status": "Pass",
"job": 156223,
"pipeline": true,
"status": "Idle"
}
{
'health_check': False,
'description': 'QEMU pipeline, first job',
'state': 'Scheduled',
'visibility': 'Publicly visible',
'priority': 50,
'submitter': 'default',
'job': 'http://calvin.codehelp/scheduler/1995',
'health': 'Unknown',
'device_type': 'qemu',
'submit_time': '2018-05-17T11:49:56.336847+00:00',
'device': 'qemu01'
}
2018-05-17T12:12:15.238331 .codehelp.calvin.worker lavaserver - [worker01] state=Online health=Active
Test writers can cause event notifications to be emitted under the control of a Lava Test Shell. This example uses an inline test definition.
- repository:
metadata:
format: Lava-Test Test Definition 1.0
name: apache-server
description: "test events"
os:
- debian
scope:
- functional
run:
steps:
- lava-test-event demonstration
from: inline
name: test-event
path: inline/test-event.yaml
2018-05-17T11:51:22.542416 org.linaro.validation.event lavaserver - {"message": "demonstration", "job": "1995"}
It is quite straightforward to communicate with lava-publisher to
listen for events. This example code shows how to connect and
subscribe to lava-publisher job events. It includes a simple
main function to run on the command line if you wish:
python zmq_client.py -j 357 --hostname tcp://127.0.0.1:5500 -t 1200
zmq_client.py script:
import sys
import ssl
import argparse
import yaml
import signal
import zmq
import xmlrpc.client
from urllib.parse import urlsplit
FINISHED_JOB_STATUS = ["Complete", "Incomplete", "Canceled"]
class JobEndTimeoutError(Exception):
""" Raise when the specified job does not finish in certain timeframe. """
class Timeout:
""" Timeout error class with ALARM signal. Accepts time in seconds. """
class TimeoutError(Exception):
pass
def __init__(self, sec=0):
self.sec = sec
def __enter__(self):
signal.signal(signal.SIGALRM, self.timeout_raise)
if not self.sec:
self.sec = 0
signal.alarm(self.sec)
def __exit__(self, *args):
signal.alarm(0)
def timeout_raise(self, *args):
raise Timeout.TimeoutError()
class JobListener:
def __init__(self, url):
self.context = zmq.Context.instance()
self.sock = self.context.socket(zmq.SUB)
self.sock.setsockopt(zmq.SUBSCRIBE, b"")
self.sock.connect(url)
def wait_for_job_end(self, job_id, timeout=None):
try:
with Timeout(timeout):
while True:
msg = self.sock.recv_multipart()
try:
(topic, uuid, dt, username, data) = msg[:]
except IndexError:
# Dropping invalid message
continue
data = yaml.safe_load(data)
if "job" in data:
if data["job"] == job_id:
if data["health"] in FINISHED_JOB_STATUS:
return data
except Timeout.TimeoutError:
raise JobEndTimeoutError(
"JobListener timed out after %s seconds." % timeout
)
def lookup_publisher(hostname, https):
"""
Lookup the publisher details using XML-RPC
on the specified hostname.
"""
xmlrpc_url = "http://%s/RPC2" % (hostname)
if https:
xmlrpc_url = "https://%s/RPC2" % (hostname)
server = xmlrpc.client.ServerProxy(xmlrpc_url)
try:
socket = server.scheduler.get_publisher_event_socket()
except ssl.SSLError as exc:
sys.stderr.write("ERROR %s\n" % exc)
return None
port = urlsplit(socket).port
listener_url = "tcp://%s:%s" % (hostname, port)
print("Using %s" % listener_url)
return listener_url
def main():
"""
Parse the command line
For simplicity, this script does not handle usernames
and tokens so needs a job ID. For support submitting
a test job as well as watching the events, use lavacli.
"""
parser = argparse.ArgumentParser()
parser.add_argument("-j", "--job-id", type=int, help="Job ID to wait for")
parser.add_argument(
"--https", action="store_true", help="Use https:// for this hostname"
)
parser.add_argument("-t", "--timeout", type=int, help="Timeout in seconds")
parser.add_argument("--hostname", required=True, help="hostname of the instance")
options = parser.parse_args()
try:
publisher = lookup_publisher(options.hostname, options.https)
except xmlrpc.client.ProtocolError as exc:
sys.stderr.write("ERROR %s\n" % exc)
return 1
if not publisher:
return 1
if options.job_id:
listener = JobListener(publisher)
print(listener.wait_for_job_end(options.job_id, options.timeout))
print("\n")
return 0
if __name__ == "__main__":
main()
Download or view the complete example: examples/source/zmq_client.py
If you are interested in using event notifications for a custom frontend, you may want also to look at the code for the ReactOWeb example website: https://github.com/ivoire/ReactOWeb