plainbox-category-units - syntax and semantics of Plainbox category unit type
This page documents the Plainbox category units syntax and runtime behavior
The category unit is a normalized implementation of a "test category"
concept. Using category units one can define logical groups of tests that deal
with some specific testing area (for example, suspend-resume or USB support).
Job definitions can be associated with at most one category. Categories can be
used by particular applications to facilitate test selection.
There are two fields that are used by the category unit:
- This field defines the partial identifier of the category.
It is similar to the id field on the job definition units.
This field is mandatory.
- This field defines a human readable name of the category.
It may be used in application user interfaces for displaying a group of
This field is translatable. This field is mandatory.
The unit is a separate entity so that it can be shipped separately of job
definitions and so that it can gain a localizable name that can still be
referred to uniquely by any job definition.
In the future it is likely that the unit will be extended with additional
fields, for example to define an icon.
Association between job definitions and categories can be overridden by a
particular test plan. Please refer to the test plan unit documentation for
Given the following definition of a category unit:
_name: Audio tests
And the following definition of a job unit:
_description: Plug in your headphones and ensure the system detected them
The job definition will be a part of the audio category.
Zygmunt Krynicki & Checkbox Contributors
2012-2014 Canonical Ltd