Skip to content

Commit ce9e2fd

Browse files
authored
Update TESTING.asciidoc for recent REST test changes (#62841)
* Remove reference to Runner (no longer valid) * Remove tests.rest (no longer valid) * Add reference to javaRestTest * Brief mention of qa tests
1 parent cb17131 commit ce9e2fd

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

TESTING.asciidoc

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -308,20 +308,19 @@ The REST tests are run automatically when executing the "./gradlew check" comman
308308
YAML REST tests use the following command (modules and plugins may also include YAML REST tests):
309309

310310
---------------------------------------------------------------------------
311-
./gradlew :rest-api-spec:yamlRestTest
311+
./gradlew :rest-api-spec:yamlRestTest
312312
---------------------------------------------------------------------------
313313

314314
A specific test case can be run with the following command:
315315

316316
---------------------------------------------------------------------------
317-
./gradlew ':rest-api-spec:yamlRestTestRunner' \
317+
./gradlew ':rest-api-spec:yamlRestTest' \
318318
--tests "org.elasticsearch.test.rest.ClientYamlTestSuiteIT" \
319-
-Dtests.method="test {p0=cat.segments/10_basic/Help}"
319+
-Dtests.method="test {p0=cat.segments/10_basic/Help}"
320320
---------------------------------------------------------------------------
321321

322-
The REST tests support all the options provided by the randomized runner, plus the following:
322+
The YAML REST tests support all the options provided by the randomized runner, plus the following:
323323

324-
* `tests.rest[true|false]`: determines whether the REST tests need to be run (default) or not.
325324
* `tests.rest.suite`: comma separated paths of the test suites to be run
326325
(by default loaded from /rest-api-spec/test). It is possible to run only a subset
327326
of the tests providing a sub-folder or even a single yaml file (the default
@@ -331,6 +330,27 @@ e.g. -Dtests.rest.suite=index,get,create/10_with_id
331330
blacklisted and need to be skipped
332331
e.g. -Dtests.rest.blacklist=index/*/Index document,get/10_basic/*
333332

333+
Java REST tests can be run with the "javaRestTest" task.
334+
335+
For example :
336+
---------------------------------------------------------------------------
337+
./gradlew :modules:mapper-extras:javaRestTest
338+
---------------------------------------------------------------------------
339+
340+
A specific test case can be run with the following syntax (fqn.test {params}):
341+
342+
---------------------------------------------------------------------------
343+
./gradlew ':modules:mapper-extras:javaRestTest' \
344+
--tests "org.elasticsearch.index.mapper.TokenCountFieldMapperIntegrationIT.testSearchByTokenCount {storeCountedFields=true loadCountedFields=false}"
345+
---------------------------------------------------------------------------
346+
347+
yamlRestTest's and javaRestTest's are easy to identify, since they are found in a
348+
respective source directory. However, there are some more specialized REST tests
349+
that use custom task names. These are usually found in "qa" projects commonly
350+
use the "integTest" task.
351+
352+
If in doubt about which command to use, simply run <gradle path>:check
353+
334354
== Testing packaging
335355

336356
The packaging tests use Vagrant virtual machines or cloud instances to verify

0 commit comments

Comments
 (0)