Add guidance for writing tests. #39318
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Pinging @elastic/es-core-infra |
jtibshirani
reviewed
Feb 22, 2019
TESTING.asciidoc
Outdated
| However it should not be used for coverage. For instance if you are testing a | ||
| piece of functionality that enters different code paths depending on whether | ||
| the index has 1 shards or 2+ shards, then we shouldn't just test against an | ||
| index with a random numder of shards: there should be one test for the 1-shard |
TESTING.asciidoc
Outdated
| to work in the early days of Elasticsearch. However the complexity of these | ||
| tests tends to make them hard to debug. Whenever the functionality that is | ||
| being tested isn't intimately dependent on how Elasticsearch behaves as a | ||
| cluster, it is recommented to write unit tests or REST tests instead. |
There was a problem hiding this comment.
recommented -> recommended
| 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 |
There was a problem hiding this comment.
Small comment: would it be worth clarifying that this includes YAML tests, as that is a very common way in which REST tests are encountered?
jtibshirani
approved these changes
Feb 27, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds more information about how to write tests for Elasticsearch.