← Back to branch summary

~jocave/checkbox/hybrid-amd-gpu-mods

« back to all changes in this revision

Viewing changes to checkbox-ng/docs/profiles.rst

  • Committer: Sylvain Pineau
  • Date: 2014-07-29 16:05:54 UTC
  • mto: This revision was merged to the branch mainline in revision 3149.
  • Revision ID: sylvain.pineau@canonical.com-20140729160554-qev8887xbunn9tmi
checkbox-ng:launchers:checkbox-cli: The checkbox-cli launcher

Running the default whitelist (with the suite selection screen skipped)

Show diffs side-by-side

added added

removed removed

Lines of Context:
checkbox-ng/docs/profiles.rst
1
1
Profiles configuration
2
2
^^^^^^^^^^^^^^^^^^^^^^
3
3
 
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
8
 
parameters.
9
 
 
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
12
 
key/values.
13
 
 
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`.
18
 
 
19
 
Syntax
20
 
======
 
4
Checkbox-gui supports execution profiles via a predefined set of configuration
 
5
options that allow customization of the welcome screen, displayed whitelists as
 
6
well as saving results locally or sending the submission file to Launchpad or
 
7
to the Certification database/HEXR.
 
8
 
 
9
The profile settings are part of a launcher script and use checkbox-gui as a
 
10
shebang to interpret the key/values.
21
11
 
22
12
As checkbox-gui is a Qt application, settings must follow the INI-style rules
23
13
of the `QSettings <http://qt-project.org/doc/qt-5/QSettings.html>`_ class.
44
34
 
45
35
    settings->value("category/key", app.tr("default_value"))
46
36
 
47
 
Conversely, checkbox-launcher-specific launchers must follow `Python
48
 
ConfigParser
49
 
<https://docs.python.org/3/library/configparser.html#supported-ini-file-structure>`_
50
 
syntax.
51
 
 
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.
54
 
 
55
37
Supported Settings
56
38
==================
57
39
 
58
40
welcome/title
59
 
    QML application title and welcome screen header. Defaults to ``System
60
 
    Testing``.
 
41
-------------
 
42
 
 
43
QML application title and welcome screen header. Defaults to ``System
 
44
Testing``.
61
45
 
62
46
welcome/text
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>
65
 
    [...]``
 
47
------------
 
48
 
 
49
Welcome message to display on the first screen (Rich text allowing HTML-style
 
50
markup). Defaults to ``<p>Welcome to System Testing.</p> [...]``
66
51
 
67
52
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.
71
 
 
72
 
 
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)
76
 
 
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.
80
 
    (CLI only).
81
 
 
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)
 
53
----------------------
 
54
 
 
55
Regular expression to match a subset of whitelist filenames. Defaults to ``.*``
85
56
 
86
57
submission/message
87
 
    Header text of the submission pop-up , shown to the
88
 
    user after submission has completed. (GUI only)
 
58
------------------
 
59
 
 
60
Header text of the submission pop-up
89
61
 
90
62
submission/input_type
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``.
94
 
    (GUI only)
 
63
---------------------
 
64
 
 
65
Show a Text input field to enter the secure ID or the LP address (default). 
 
66
To just save the results to disk, must use the ``none`` value.
95
67
 
96
68
submission/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 ``.*``
 
69
----------------
 
70
 
 
71
RegExpValidator, default ``.*``
100
72
 
101
73
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)
 
74
----------------------------
 
75
 
 
76
``Launchpad E-Mail Address`` (default) or ``Secure ID (15 or 18 characters)``
105
77
 
106
78
submission/secure_id
107
 
    Preconfigured secure_id to fill in the text field.
 
79
--------------------
 
80
 
 
81
Preset value of the secure ID
108
82
 
109
83
submission/ok_btn_text
110
 
    The label for the "Send" button. ``Submit Results`` (default) or
111
 
    ``Save Results``. (GUI only)
 
84
----------------------
 
85
 
 
86
``Submit Results`` (default) or ``Save Results``
112
87
 
113
88
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)
 
89
-------------------------
 
90
 
 
91
You are about to exit this test run without saving your results report. Do you
 
92
want to save the report?
117
93
 
118
94
submission/submit_to_hexr
119
 
    Boolean, add an extra header to also send the results to HEXR
120
 
    (works with the certification transport)
 
95
-------------------------
 
96
 
 
97
Boolean, add an extra header to also send the results to HEXR (works with the
 
98
certification transport)
121
99
 
122
100
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``
126
 
    (GUI only)
 
101
------------------------
 
102
 
 
103
Location to save the XML submission file, if set to an empty string will open a
 
104
file save dialog. Default: ``/tmp/submission.xml``
127
105
 
128
106
transport/submit_to
129
 
    Transport endpoint. Defaults to ``<none>``.  Supports submission
130
 
    to LP (the default, value ``launchpad``), ``certification``, or
131
 
    ``local`` (save to disk)
132
 
 
133
 
transport/submit_url
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
137
 
    value.
138
 
 
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)
142
 
 
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.
146
 
    (CLI only)
147
 
 
148
 
 
 
107
-------------------
 
108
 
 
109
Transport endpoint. Defaults to ``<none>``.  Supports submission to LP (the
 
110
default), ``certification``, or ``local`` (save to disk)