4
Execution profiles, or launchers, allow specifying a predefined set of
5
configuration options that allow customization of the welcome screen, displayed
6
whitelists as well as saving results locally or sending the submission file to
7
Launchpad or to the Certification database/HEXR, as well as some other
10
The profile settings are part of a launcher script and use either checkbox-gui
11
or checkbox-launcher (in text-mode/CLI) as a shebang to interpret the
14
This document provides a reference on launcher functionality and syntax. To
15
understand the design and concepts and see several examples, you may want to
16
read the :doc:`tutorial</launcher-tutorial>` on how to create launchers and
17
their relationship with legacy :term:`Checkbox`.
22
As checkbox-gui is a Qt application, settings must follow the INI-style rules
23
of the `QSettings <http://qt-project.org/doc/qt-5/QSettings.html>`_ class.
25
Multiple-line values are supported but must be enclosed in doubles quotes and
26
extra lines must start with one space, e.g:
39
settings.value("category/key", i18n.tr("default_value"))
45
settings->value("category/key", app.tr("default_value"))
47
Conversely, checkbox-launcher-specific launchers must follow `Python
49
<https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_
52
Also, some settings only make sense for either GUI or CLI, and are thus not
53
understood by the other. These are noted below.
59
QML application title and welcome screen header. Defaults to ``System
63
Welcome message to display on the first screen (checkbox-gui supports Rich text
64
allowing HTML-style markup). Defaults to ``<p>Welcome to System Testing.</p>
67
suite/whitelist_filter
68
Regular expression to match a subset of whitelist filenames. On
69
checkbox-gui it defaults to ``.*``. For checkbox-launcher it has no default
70
and *must* be defined.
73
suite/whitelist_selection
74
Pattern that whitelists need to match to be preselected. Python regular
75
expression. It has no default and *must* be defined. (CLI only)
77
suite/skip_whitelist_selection
78
If set to true, user will not receive a choice of whitelist. Only
79
the preselected ones (see whitelist_selection) will be selected.
82
suite/skip_test_selection
83
If set to true, user will not be allowed to deselect tests prior to run:
84
all tests in the selected whitelist will be run. (CLI only)
87
Header text of the submission pop-up , shown to the
88
user after submission has completed. (GUI only)
91
Show a Text input field to enter the secure ID or the LP address
92
(default). To just save the results to disk, must use the
93
``none`` value. To validate using a regex, must be ``regex``.
97
Regular expression to validate input in submission field (e.g.
98
email, secure_id) if input_type is regex. (GUI only).
99
RegExpValidator, default ``.*``
101
submission/input_placeholder
102
Temporary text to put in input field, used to guide the user.
103
``Launchpad E-Mail Address`` (default) or ``Secure ID (15 or 18
104
characters)``. (GUI only)
107
Preconfigured secure_id to fill in the text field.
109
submission/ok_btn_text
110
The label for the "Send" button. ``Submit Results`` (default) or
111
``Save Results``. (GUI only)
113
submission/cancel_warning
114
Show to the user if he wants to exit without having saved the
115
report. You are about to exit this test run without saving your
116
results report. Do you want to save the report? (GUI only)
118
submission/submit_to_hexr
119
Boolean, add an extra header to also send the results to HEXR
120
(works with the certification transport)
122
exporter/xml_export_path
123
Location to save the XML submission file, if set to an empty
124
string will open a file save dialog. Default:
125
``/tmp/submission.xml``
129
Transport endpoint. Defaults to ``<none>``. Supports submission
130
to LP (the default, value ``launchpad``), ``certification``, or
131
``local`` (save to disk)
134
URL to submit results to. This allows to upload to different
135
websites, for example it can upload directly to hexr, or to the
136
staging sites. Used only with the ``certification`` submit_to
139
transport/config_filename
140
Name of a custom config file to load. Config files are mainly
141
used to define environment variables. (CLI only)
143
transport/dont_suppress_output
144
If set, resources, local jobs and attachments will be output to
145
screen, this generates a lot of text and is mainly for debugging.
added
removed
checkbox-ng/docs/profiles.rst
