Skip to content

Commit 6b5d91d

Browse files
committed
[DOCS] Adds environment variables info to running Rest API tests
1 parent e49da24 commit 6b5d91d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,16 @@ rake test:yaml
7272

7373
Check `rake -T` for more test tasks.
7474

75+
## Environment variables
76+
77+
You can use the following environment variables to customize running the Rest API tests:
78+
* `TEST_ES_SERVER` - the Elasticsearch endpoint where the tests will be run.
79+
* `ELASTIC_PASSWORD` - the endpoint password, default: `changeme`.
80+
* `ES_YAML_TESTS_BRANCH` - which branch from the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) suite to run.
81+
* `DEBUG` - if set, the Logger level will be set to `DEBUG`, otherwise the value will be `WARN`.
82+
* `QUIET` - this is used by the [test runner](https://github.com/elastic/es-test-runner-ruby). If set to `true`, display for passing tests will be more compact (not showing file/test names).
83+
* `SINGLE_TEST` - You can specify this value to run a single test from the suite, instead of the whole suite. E.g.: `SINGLE_TEST=migration/20_reindex.yml rake test:yaml`
84+
7585
## Testing Serverless
7686

7787
To run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) Serverless specific test suite, the following environment variables must be provided:

0 commit comments

Comments
 (0)