Checkbox

Differences between revisions 3 and 4
⇤ ← Revision 3 as of 2008-09-29 15:00:36 →
Size: 1181
Editor: 159
Comment:
← Revision 4 as of 2008-10-20 19:43:52 → ⇥
Size: 2625
Editor: modemcable178
Comment:
Deletions are marked like this. Additions are marked like this.
Line 12: Line 12:
Checkbox general configuration is stored at /etc/hwtest.d. Each way of calling hwtest (GUI, cli) has its own configuration file. Checkbox general configuration is stored at /etc/checkbox.d. Each way of calling checkbox (GUI, cli) has its own configuration file.
Line 14: Line 14:
=== hwtest.ini === === checkbox.ini ===
Line 16: Line 16:
This is the general config file. It will be inherit by all the hwtest flavours. This is the general config file. It will be inherit by all the checkbox flavours.
Line 20: Line 20:
  * plugins. Folder where hwtest plugins are stored.
  * registries. Folder where hwtest registries are stored.
 		   * plugins. Folder where checkbox plugins are stored.
  * registries. Folder where checkbox registries are stored.

== Tests ==

Test are defined in plain text files, that can be stored anywhere.

They consists in some required fields and some optional fields.

Let's look at one example:

{{{
name: audio
plugin: manual
categories: laptop, desktop
requires: alsa.type == 'control'
command: audio_playback $data_path/audio_playback.wav
description: Testing detected sound card: . $(audio_playback --view) . Did you hear a sound?
}}}

=== Tests fields ===

==== Required fields ====

|| '''Field''' || '''Explanation''' ||
|| name || Unique name for a test ||
|| plugin || Plugin name to handle this test ||
|| description || A description on what the test does ||

==== Optional fields ====

|| '''Field''' || '''Explanation''' ||
|| architectures || List of architectures for which this test is relevant: amd64, i386, powerpc and/or sparc ||
|| categories || List of categories for which this test is relevant: desktop, laptop and/or server ||
|| command || Command to run for the test. ||
|| depends || List of names of tests on which this test depends. So, if the other test fails, this test will be skipped. ||
|| requires || Registry expressions which are requirements for this test: 'input.mouse' in info.capabilities ||
|| timeout || Timeout for running the command. ||
|| optional || Boolean expression set to True if this test is optional or False if this test is required. ||
Line 26: Line 63:



[/TipsAndTricks]

Introduction

Checkbox (https://launchpad.net/checkbox) is a test runner for Ubuntu. It aims is to provide a common framework to run all types of tests, from hardware tests, to command line tests, unit tests or desktop tests and send their results to Launchpad, automatically.

General Configuration

Checkbox general configuration is stored at /etc/checkbox.d. Each way of calling checkbox (GUI, cli) has its own configuration file.

checkbox.ini

This is the general config file. It will be inherit by all the checkbox flavours.

  • [DEFAULT]. Under this section they are covered all general configuration properties.
    • version. The version of checkbox to use the configuration with.
    • plugins. Folder where checkbox plugins are stored.
    • registries. Folder where checkbox registries are stored.

Tests

Test are defined in plain text files, that can be stored anywhere.

They consists in some required fields and some optional fields.

Let's look at one example: 

name: audio
plugin: manual
categories: laptop, desktop
requires: alsa.type == 'control'
command: audio_playback $data_path/audio_playback.wav
description: Testing detected sound card: . $(audio_playback --view) . Did you hear a sound?

Tests fields

Required fields

Field

Explanation

name

Unique name for a test

plugin

Plugin name to handle this test

description

A description on what the test does

==== Optional fields ====

Field

Explanation

architectures

List of architectures for which this test is relevant: amd64, i386, powerpc and/or sparc

categories

List of categories for which this test is relevant: desktop, laptop and/or server

command

Command to run for the test.

depends

List of names of tests on which this test depends. So, if the other test fails, this test will be skipped.

requires

Registry expressions which are requirements for this test: 'input.mouse' in info.capabilities

timeout

Timeout for running the command.

optional

Boolean expression set to True if this test is optional or False if this test is required.

Plugins

Registries

[/TipsAndTricks]

Testing/Automation/Checkbox (last edited 2021-10-20 11:49:54 by sylvain-pineau)