Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about certification_status_overrides test plan field (infra) #1552

Merged
merged 3 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/how-to/nested-test-plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ The jobs execution order is:
How to change category or certification status of jobs coming from nested parts?
--------------------------------------------------------------------------------

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

Expand Down
45 changes: 42 additions & 3 deletions docs/reference/units/test-plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,9 @@ copy such constructs when working on a new test plan from scratch

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

.. _Test Plan category-overrides field:
.. _Test Plan category_overrides field:

``category-overrides``:
``category_overrides``:
A multi-line list of category override statements.

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

apply CATEGORY-IDENTIFIER to JOB-DEFINITION-PATTERN

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

.. _Test Plan certification_status_overrides field:

``certification_status_overrides``:
A multi-line list of certification status override statements.

Similar to the :ref:`category_overrides<Test Plan category_overrides field>`
field, this field can be used to modify the certification status of the
jobs matching the given regular expression.

The possible values are the same as for the
:ref:`certification-status<Job certification-status field>` job field.

For instance, the following will force every wireless job to become a
certification blocker::

apply blocker to .*wireless.*

.. note::

This override mechanism “bubbles up”, meaning if it is used in a
:ref:`nested part<nested-test-plan>`, all the jobs selected as part of
the whole test plan will be impacted, not only the jobs in that
specific nested part.

.. warning::

If no namespace is provided, Checkbox will add the namespace of the
current provider to the regular expression that is provided. This can
be a problem if the override has to work across different providers
with different namespaces. In that case, instead of using::

apply blocker to .*

the following should be used::

apply blocker to .*::.*

to apply the override to every job of every namespaces.

.. _Test Plan estimated_duration field:

``estimated_duration``:
Expand Down
Loading