Skip to content

Commit b0bb120

Browse files
committed
[DOCS] Updates elasticsearch-api README about coverage and tests
1 parent 62898a5 commit b0bb120

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

elasticsearch-api/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Language clients are forward compatible; meaning that clients support communicat
1515

1616
Refer to [CONTRIBUTING](https://github.com/elastic/elasticsearch-ruby/blob/main/CONTRIBUTING.md).
1717

18-
The integration tests on this project run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby/) library. This runs in CI against an Elasticsearch cluster in Docker. You can run a docker container with Elasticsearch with a Rake task from the root directory of this project:
18+
Use `bundle exec rake test:unit` to run Unit tests. Add the environment variable `COVERAGE` to see Simplecov test coverage.
19+
20+
The integration tests on this project run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby/) library. You can run a docker container with Elasticsearch with a Rake task from the root directory of this project:
1921

2022
```bash
2123
$ rake es:up
@@ -27,6 +29,8 @@ This will start whatever version of Elasticsearch is set in the Buildkite pipeli
2729
$ rake es:start[version,suite] # e.g. rake es:start[9.0.0-SNAPSHOT, free]
2830
```
2931

32+
You can run the integration tests with `bundle exec rake test:integration`.
33+
3034
### Code generation
3135

3236
The code for most of this library is automatically generated. See [./utils/README.md](utils/README.md) for more information.

0 commit comments

Comments
 (0)