135 lines
7 KiB
Markdown
135 lines
7 KiB
Markdown
# Elastic License Functionality
|
|
|
|
This directory tree contains files subject to the Elastic License. The files subject
|
|
to the Elastic License are grouped in this directory to clearly separate them
|
|
from files licensed under the Apache License 2.0.
|
|
|
|
# Development
|
|
|
|
By default, Kibana will run with X-Pack installed as mentioned in the [contributing guide](../CONTRIBUTING.md).
|
|
|
|
Elasticsearch will run with a basic license. To run with a trial license, including security, you can specifying that with the `yarn es` command.
|
|
|
|
Example: `yarn es snapshot --license trial --password changeme`
|
|
|
|
By default, this will also set the password for native realm accounts to the password provided (`changeme` by default). This includes that of the `kibana` user which `elasticsearch.username` defaults to in development. If you wish to specific a password for a given native realm account, you can do that like so: `--password.kibana=notsecure`
|
|
|
|
# Testing
|
|
## Running specific tests
|
|
| Test runner | Test location | Runner command (working directory is kibana/x-pack) |
|
|
| ------------ | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
| Jest | `x-pack/**/*.test.js`<br>`x-pack/**/*.test.ts` | `cd x-pack && node scripts/jest -t regexp [test path]` |
|
|
| Functional | `x-pack/test/*integration/**/config.js`<br>`x-pack/test/*functional/config.js` | `node scripts/functional_tests_server --config x-pack/test/[directory]/config.js`<br>`node scripts/functional_test_runner --config x-pack/test/[directory]/config.js --grep=regexp` |
|
|
|
|
Examples:
|
|
- Run the jest test case whose description matches 'filtering should skip values of null':
|
|
`cd x-pack && yarn test:jest -t 'filtering should skip values of null' plugins/ml/public/explorer/explorer_charts/explorer_charts_container_service.test.js`
|
|
- Run the x-pack api integration test case whose description matches the given string:
|
|
`node scripts/functional_tests_server --config x-pack/test/api_integration/config.js`
|
|
`node scripts/functional_test_runner --config x-pack/test/api_integration/config.js --grep='apis Monitoring Beats list with restarted beat instance should load multiple clusters'`
|
|
|
|
In addition to to providing a regular expression argument, specific tests can also be run by appeding `.only` to an `it` or `describe` function block. E.g. `describe(` to `describe.only(`.
|
|
|
|
## Running all tests
|
|
|
|
You can run unit tests by running:
|
|
|
|
```
|
|
yarn test
|
|
```
|
|
|
|
If you want to run tests only for a specific plugin (to save some time), you can run:
|
|
|
|
```
|
|
yarn test --plugins <plugin>[,<plugin>]* # where <plugin> is "reporting", etc.
|
|
```
|
|
|
|
#### Debugging browser tests
|
|
```
|
|
yarn test:browser:dev
|
|
```
|
|
Initializes an environment for debugging the browser tests. Includes an dedicated instance of the kibana server for building the test bundle, and a karma server. When running this task the build is optimized for the first time and then a karma-owned instance of the browser is opened. Click the "debug" button to open a new tab that executes the unit tests.
|
|
|
|
Run single tests by appending `grep` parameter to the end of the URL. For example `http://localhost:9876/debug.html?grep=ML%20-%20Explorer%20Controller` will only run tests with 'ML - Explorer Controller' in the describe block.
|
|
|
|
#### Running server unit tests
|
|
You can run server-side unit tests by running:
|
|
|
|
```
|
|
yarn test:server
|
|
```
|
|
|
|
#### Running functional tests
|
|
|
|
For more info, see [the Elastic functional test development guide](https://www.elastic.co/guide/en/kibana/current/development-functional-tests.html).
|
|
|
|
The functional UI tests, the API integration tests, and the SAML API integration tests are all run against a live browser, Kibana, and Elasticsearch install. Each set of tests is specified with a unique config that describes how to start the Elasticsearch server, the Kibana server, and what tests to run against them. The sets of tests that exist today are *functional UI tests* ([specified by this config](test/functional/config.js)), *API integration tests* ([specified by this config](test/api_integration/config.js)), and *SAML API integration tests* ([specified by this config](test/saml_api_integration/config.js)).
|
|
|
|
The script runs all sets of tests sequentially like so:
|
|
* builds Elasticsearch and X-Pack
|
|
* runs Elasticsearch with X-Pack
|
|
* starts up the Kibana server with X-Pack
|
|
* runs the functional UI tests against those servers
|
|
* tears down the servers
|
|
* repeats the same process for the API and SAML API integration test configs.
|
|
|
|
To do all of this in a single command run:
|
|
|
|
```sh
|
|
node scripts/functional_tests
|
|
```
|
|
|
|
#### Developing functional UI tests
|
|
|
|
If you are **developing functional tests** then you probably don't want to rebuild Elasticsearch and wait for all that setup on every test run, so instead use this command to build and start just the Elasticsearch and Kibana servers:
|
|
|
|
```sh
|
|
node scripts/functional_tests_server
|
|
```
|
|
|
|
After the servers are started, open a new terminal and run this command to run just the tests (without tearing down Elasticsearch or Kibana):
|
|
|
|
```sh
|
|
node scripts/functional_test_runner
|
|
```
|
|
|
|
For both of the above commands, it's crucial that you pass in `--config` to specify the same config file to both commands. This makes sure that the right tests will run against the right servers. Typically a set of tests and server configuration go together.
|
|
|
|
Read more about how the scripts work [here](../scripts/README.md).
|
|
|
|
For a deeper dive, read more about the way functional tests and servers work [here](../packages/kbn-test/README.md).
|
|
|
|
#### Running API integration tests
|
|
|
|
API integration tests are run with a unique setup usually without UI assets built for the Kibana server.
|
|
|
|
API integration tests are intended to test _only programmatic API exposed by Kibana_. There is no need to run browser and simulate user actions, which significantly reduces execution time. In addition, the configuration for API integration tests typically sets `optimize.enabled=false` for Kibana because UI assets are usually not needed for these tests.
|
|
|
|
To run _only_ the API integration tests:
|
|
|
|
```sh
|
|
node scripts/functional_tests --config test/api_integration/config
|
|
```
|
|
|
|
#### Running SAML API integration tests
|
|
|
|
We also have SAML API integration tests which set up Elasticsearch and Kibana with SAML support. Run _only_ API integration tests with SAML enabled like so:
|
|
|
|
```sh
|
|
node scripts/functional_tests --config test/saml_api_integration/config
|
|
```
|
|
|
|
#### Running Jest integration tests
|
|
|
|
Jest integration tests can be used to test behavior with Elasticsearch and the Kibana server.
|
|
|
|
```sh
|
|
node scripts/jest_integration
|
|
```
|
|
|
|
An example test exists at [test_utils/jest/integration_tests/example_integration.test.ts](test_utils/jest/integration_tests/example_integration.test.ts)
|
|
|
|
#### Running Reporting functional tests
|
|
|
|
See [here](test/reporting/README.md) for more information on running reporting tests.
|