Currently PlainBox has no graphical user interface. To use it you need to use the command line.
Basically there is just one command that does everything we can do so far, that is plainbox run. It has a number of options that tell it which job to run and what to do with results.
PlainBox has built-in help system so running plainbox run –help will give you instant information about all the various arguments and options that are available. This document is not intended to replace that.
To run a specific job pass it to the --include-pattern or -i option.
For example, to run the cpu/scaling_test job:
$ plainbox run -i cpu/scaling_test
The option -i can be provided any number of times.
To run a white list pass the --whitelist or -w option.
For example, to run the default white list run:
$ plainbox run -w /usr/share/checkbox/data/whitelists/default.whitelist
To generate an XML file that can be sent to the certification website you need to pass two additional options:
For example, to get the default certification tests ready to be submitted run this command:
$ plainbox run --whitelist=/usr/share/checkbox/data/whitelists/default.whitelist --output-format=xml --output-file=submission.xml
PlainBox has special support for running stable release updates tests in an automated manner. This runs all the jobs from the sru.whitelist and sends the results to the certification website.
To run SRU tests you will need to know the so-called Secure ID of the device you are testing. Once you know that all you need to do is run:
$ plainbox sru $secure_id submission.xml
The second argument, submission.xml, is a name of the fallback file that is only created when sending the data to the certification website fails to work for any reason.