Skip to content

Commit

Permalink
Update docs with new behavior on skip conditions (#111640)
Browse files Browse the repository at this point in the history
#111585 and #111268 change the behavior to skip on any node having the feature/capability, not all nodes
  • Loading branch information
thecoop authored Aug 7, 2024
1 parent ff04511 commit b0c82f4
Showing 1 changed file with 4 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ A `skip` section, on the other hand, defines certain conditions that, if met, wi
- `features`: Only kept for a transition period, please use <<requires_test_runner_features, `test_runner_features`>>
in the `requires` section instead.

Note that `skip` with `capabilities` or `cluster_features` will skip the test if *any* node in the cluster
has the feature or capability. `requires` will only run the test if *all* of the nodes in the cluster
have the feature or capability.

`requires` and `skip` sections must specify at least one of the options mentioned above.
Unless only `test_runner_features` or legacy test runner `features` are specified, a `reason` must be given.

Expand Down Expand Up @@ -142,13 +146,6 @@ other test runners to skip tests if they do not support the capabilities API yet

The `capabilities` field is an array containing one or several capabilities checks.

*NOTE: If planning to `skip` on capabilities, keep in mind this might lead to unexpected results in _mixed cluster_
tests!* A test is only skipped if *all* nodes support the requested capabilities, in _mixed clusters_ this might not be
the case: such a cluster can consist of a mix of nodes where some support respective capabilities and others don't,
additionally there might even be nodes that do not support the capabilities API at all.
In such cases the capabilities check will *not* succeed, hence the test is *not* skipped and might randomly hit one
of the nodes that actually support what you intended to skip on. This might then break your assumptions and fail the test.

Capabilities are declared as part of an implementation of `RestHandler`.
Override the `supportedQueryParameters` and/or the `supportedCapabilities` methods:

Expand Down

0 comments on commit b0c82f4

Please sign in to comment.