Skip to content

Updating docs for test classes #134076

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 3, 2025
Merged

Updating docs for test classes #134076

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f3e7607
Updating docs for test classes
pabloem Sep 3, 2025
028fef1
comments
pabloem Sep 3, 2025
2778ef8
Update TESTING.asciidoc
pabloem Sep 3, 2025
bcaedb7
Merge branch 'main' into pabloem-testingupdate0925
pabloem Sep 3, 2025
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
9 changes: 3 additions & 6 deletions TESTING.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -681,12 +681,9 @@ There are multiple base classes for tests:
directly by unit tests.
* **`ESSingleNodeTestCase`**: This test case sets up a cluster that has a
single node.
* **`ESIntegTestCase`**: An integration test case that creates a cluster that
might have multiple nodes.
* **`ESRestTestCase`**: An integration tests that interacts with an external
cluster via the REST API. This is used for Java based REST tests.
* **`ESClientYamlSuiteTestCase` **: A subclass of `ESRestTestCase` used to run
YAML based REST tests.
* **`ESIntegTestCase`**: An internal integration test that starts nodes within the same JVM as the test. These tests are excellent for testing internal functionality that is not exposed via the REST API, or for verifying a certain internal state. Additionally, you can easily simulate tricky distributed setups that are difficult to do in REST tests. If you only need to start one node, use `ESSingleNodeTestCase` instead, which is a much lighter test setup.
* **`ESRestTestCase`**: This should be the first choice for writing integration tests. These tests run in a much more realistic setup, and rely on REST APIs to talk to ES.
* **`ESClientYamlSuiteTestCase` **: A subclass of `ESRestTestCase` used to run YAML based REST tests.

=== Good practices

Expand Down