Skip to content

Commit d3f4356

Browse files
committedApr 9, 2024
[DOCS] Updates README
1 parent 9055693 commit d3f4356

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed
 

‎README.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,32 @@ This repository holds common tests for Elasticsearch Clients.
66

77
The tests are specified using the Elasticsearch YAML format reported [here](https://github.com/elastic/elasticsearch/blob/main/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc).
88

9-
All the tests for serverless are located in the [tests](tests) folder. Each API endpoint has a folder
10-
containing the tests to be executed. All the files must be executed in order, they are enumerated with
11-
a digit prefix.
9+
All the tests are located in the [tests](tests) folder. Each API endpoint has a folder containing the tests to be executed. All the files must be executed in order, they are enumerated with a digit prefix.
10+
11+
## Test Sections
12+
13+
### `requires`
14+
15+
This section should define if a test is available for the stack client, serverless client or both with the following format:
16+
```yaml
17+
---
18+
requires:
19+
serverless: true
20+
stack: true
21+
```
22+
23+
This helps us differentiate tests for a particular client and define tests in common for both.
1224
1325
### `setup` and `teardown`
1426

1527
Pre-requisites to run a test (e.g. creating an index, populating an index with data) are declared in a `setup` section. The list of commands in the `setup` section has to run before the test section.
1628

1729
Cleanup is declared in a `teardown` section. This list of commands will run after the tests. **Please add a `teardown` section to your test to remove any created artifacts and data**. This will keep our test clusters clean and our test suite sane.
30+
31+
## APIs Report
32+
33+
[This report](https://github.com/elastic/elasticsearch-clients-tests/blob/main/apis_report.md) contains information from each specification:
34+
- [Elasticsearch REST API JSON specification](https://github.com/elastic/elasticsearch/tree/main/rest-api-spec)
35+
- [Elasticsearch API Specification](https://github.com/elastic/elasticsearch-specification/)
36+
37+
It also contains information on test coverage in this project for Serverless and Stack APIs. The report is automatically generated when code is pushed in a [GitHub Action](https://github.com/elastic/elasticsearch-clients-tests/blob/main/.github/workflows/report.yml). It can also be triggered manually. The source code for the report is in the [./report/](./report) directory.

0 commit comments

Comments
 (0)