Welcome to the Checkbox Kivu project!

This repository contains the Checkbox Kivu Provider (Kivu-specific test cases and test plans for Checkbox) as well as everything that is required to build the checkbox-kivu-classic snap in the snapstore.

Checkbox Kivu Provider

Located in the checkbox-provider-kivu directory, it contains:

• the test cases (also called "jobs" in the Checkbox jargon) and test plans to be run by Checkbox (in the units directory)
• the scripts required by some of the test cases (in the bin directory)
• the data (sample video, HTML pages) required by some of the test cases (in the data directory)
• unit tests for the scripts (in the tests directory)

Installation

Two devices are needed:

• a host to control the testing (any computer running Ubuntu)
• a device to test (aka DUT for "Device Under Test")

On the host, install the Checkbox snaps:

sudo snap install checkbox22
sudo snap install checkbox --classic

On the DUT, install the Checkbox runtime and the Checkbox Kivu snaps:

sudo snap install checkbox22
sudo snap install checkbox-kivu-classic --classic

Then, from the host, run:

checkbox.checkbox-cli remote <IP of the DUT>

You will be presented with a long list of available test plans. You can filter this out using the / key to search for Kivu. Select the Kivu test plan, and follow the instructions on screen to start the test run.

Develop the Checkbox Kivu provider

Since snaps are immutable, it is not possible to modify the content of the scripts or the test cases. Fortunately, Checkbox provides a functionality to side-load a provider on the DUT.

Therefore, if you want to edit a job definition, a script or a test plan, run the following commands on the DUT:

cd $HOME
git clone [email protected]:canonical/checkbox-kivu.git
mkdir /var/tmp/checkbox-providers
cp -r $HOME/checkbox-kivu/checkbox-provider-kivu /var/tmp/checkbox-providers/

You can then modify the content of the provider in /var/tmp/checkbox-providers/checkbox-provider-kivu/, and it's this version that will be used when you run checkbox.checkbox-cli remote <IP of the DUT> on the host.

Please refer to the Checkbox documentation on side-loading providers for more information.