Skip to content

Commit 87bcbc5

Browse files
authored
Add documentation about certification_status_overrides test plan field (infra) (#1552)
Fix #1492
1 parent 60b6702 commit 87bcbc5

File tree

2 files changed

+43
-4
lines changed

2 files changed

+43
-4
lines changed

docs/how-to/nested-test-plan.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ The jobs execution order is:
196196
How to change category or certification status of jobs coming from nested parts?
197197
--------------------------------------------------------------------------------
198198

199-
The :ref:`test plan override mechanism<Test Plan category-overrides field>`
199+
The :ref:`test plan override mechanism<Test Plan category_overrides field>`
200200
still works with nested parts. For example the ``hello`` job from the Baz
201201
provider was defined as a blocker and did not have a category.
202202

docs/reference/units/test-plan.rst

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,9 @@ copy such constructs when working on a new test plan from scratch
184184

185185
When a job is both included and excluded, exclusion always takes priority.
186186

187-
.. _Test Plan category-overrides field:
187+
.. _Test Plan category_overrides field:
188188

189-
``category-overrides``:
189+
``category_overrides``:
190190
A multi-line list of category override statements.
191191

192192
This optional field can be used to alter the natural job definition
@@ -218,7 +218,7 @@ copy such constructs when working on a new test plan from scratch
218218

219219
apply CATEGORY-IDENTIFIER to JOB-DEFINITION-PATTERN
220220

221-
Both 'apply' and 'to' are literal strings. CATEGORY-IDENTIFIER is
221+
Both ``apply`` and ``to`` are literal strings. CATEGORY-IDENTIFIER is
222222
the identifier of a category unit. The JOB-DEFINITION-PATTERN has the
223223
same syntax as the ``include`` field does. That is, it can be either
224224
a simple string or a regular expression that is being compared to
@@ -236,6 +236,45 @@ copy such constructs when working on a new test plan from scratch
236236
The job definition with the partial identifier ``foo`` will be associated
237237
with the ``cat-2`` category.
238238

239+
.. _Test Plan certification_status_overrides field:
240+
241+
``certification_status_overrides``:
242+
A multi-line list of certification status override statements.
243+
244+
Similar to the :ref:`category_overrides<Test Plan category_overrides field>`
245+
field, this field can be used to modify the certification status of the
246+
jobs matching the given regular expression.
247+
248+
The possible values are the same as for the
249+
:ref:`certification-status<Job certification-status field>` job field.
250+
251+
For instance, the following will force every wireless job to become a
252+
certification blocker::
253+
254+
apply blocker to .*wireless.*
255+
256+
.. note::
257+
258+
This override mechanism “bubbles up”, meaning if it is used in a
259+
:ref:`nested part<nested-test-plan>`, all the jobs selected as part of
260+
the whole test plan will be impacted, not only the jobs in that
261+
specific nested part.
262+
263+
.. warning::
264+
265+
If no namespace is provided, Checkbox will add the namespace of the
266+
current provider to the regular expression that is provided. This can
267+
be a problem if the override has to work across different providers
268+
with different namespaces. In that case, instead of using::
269+
270+
apply blocker to .*
271+
272+
the following should be used::
273+
274+
apply blocker to .*::.*
275+
276+
to apply the override to every job of every namespaces.
277+
239278
.. _Test Plan estimated_duration field:
240279

241280
``estimated_duration``:

0 commit comments

Comments
 (0)