Update APM readme (#95383)

* Update APM readme

* Update readme.md

* Update x-pack/plugins/apm/readme.md

Co-authored-by: Cauê Marcondes <55978943+cauemarcondes@users.noreply.github.com>

Co-authored-by: Cauê Marcondes <55978943+cauemarcondes@users.noreply.github.com>
This commit is contained in:
Søren Louv-Jansen 2021-03-25 21:19:48 +01:00 committed by GitHub
parent 724e21e007
commit bd3f5d4863
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -31,19 +31,19 @@ _Docker Compose is required_
## Testing
### E2E (Cypress) tests
### Cypress tests
```sh
x-pack/plugins/apm/e2e/run-e2e.sh
node x-pack/plugins/apm/scripts/ftr_e2e/cypress_run.js
```
_Starts Kibana (:5701), APM Server (:8201) and Elasticsearch (:9201). Ingests sample data into Elasticsearch via APM Server and runs the Cypress tests_
### Unit testing
### Jest tests
Note: Run the following commands from `kibana/x-pack/plugins/apm`.
#### Run unit tests
#### Run
```
npx jest --watch
@ -82,8 +82,11 @@ For debugging access Elasticsearch on http://localhost:9220` (elastic/changeme)
### API integration tests
Our tests are separated in two suites: one suite runs with a basic license, and the other
with a trial license (the equivalent of gold+). This requires separate test servers and test runners.
API tests are separated in two suites:
- a basic license test suite
- a trial license test suite (the equivalent of gold+)
This requires separate test servers and test runners.
**Basic**
@ -109,7 +112,10 @@ node scripts/functional_test_runner --config x-pack/test/apm_api_integration/tri
The API tests for "trial" are located in `x-pack/test/apm_api_integration/trial/tests`.
For debugging access Elasticsearch on http://localhost:9220` (elastic/changeme)
**API Test tips**
- For debugging access Elasticsearch on http://localhost:9220` (elastic/changeme)
- To update snapshots append `--updateSnapshots` to the functional_test_runner command
## Linting