Skip to content

Commit cf7f1b0

Browse files
committed
[TEST] clarified skip features usage
1 parent 0cce4e3 commit cf7f1b0

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

rest-api-spec/test/README.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ The skip section can also be used to list new features that need to be
8888
supported in order to run a test. This way the up-to-date runners will
8989
run the test, while the ones that don't support the feature yet can
9090
temporarily skip it, and avoid having lots of test failures in the meantime.
91+
Once all runners have implemented the feature, it can be declared supported
92+
by default, thus the related skip sections can be removed from the tests.
9193

9294
....
9395
"Parent":

src/test/java/org/elasticsearch/test/rest/support/Features.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
* Allows to register additional features supported by the tests runner.
2828
* This way any runner can add extra features and use proper skip sections to avoid
2929
* breaking others runners till they have implemented the new feature as well.
30+
*
31+
* Once all runners have implemented the feature, it can be removed from the list
32+
* and the related skip sections can be removed from the tests as well.
3033
*/
3134
public final class Features {
3235

0 commit comments

Comments
 (0)