mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
7cc7147cd5
* progress * progress * cleanup and elastic configs * make upgrades to support adding aditional users, with * use defaultDeep to ensure settings pass correctly * move needed configs to start servers into kbn_server (except x-pack plugin paths and users) * move xpack config to an export * add more time * diff rollbacks * roll back prettier diff * revert setupUsers signature * remove more bluebird * update bluebird for fixes with jest compatability * fix ts errors * dont allow jest to keep going making errors confising * Separates configs for jest integration core/x-pack. * Pass nested kbn config parameters. * Adds example x-pack integration test using live es. * Cloud detectors should be configurable for tests. * Cloud detectors should use native promises only. * No erroneous comments... * Util is only for promisify, duh! * New tests should have docuementation to help those looking to utilize them. * Doc section headings should be consistent with each other. * With git there is no need to commit commented code.
139 lines
5.5 KiB
Markdown
139 lines
5.5 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`
|
|
|
|
# Testing
|
|
|
|
## Running unit tests_bundle
|
|
|
|
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.
|
|
```
|
|
|
|
#### Running single test file
|
|
Edit test file, changing top level `describe` to `describe.only`. Run tests with normal commands.
|
|
|
|
#### Running Jest Unit Tests
|
|
```bash
|
|
# from x-pack folder
|
|
node scripts/jest
|
|
```
|
|
|
|
#### 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
|
|
|
|
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
|
|
```
|
|
|
|
#### Running UI tests
|
|
|
|
To run _only_ the functional UI tests:
|
|
|
|
```sh
|
|
node scripts/functional_tests --config test/functional/config
|
|
```
|
|
|
|
It does the same as the previous command, except that it only does setup/test/teardown for the UI tests.
|
|
|
|
#### 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 and building 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.
|
|
|
|
#### Developing functional 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
|
|
# Make sure you are in the x-pack directory
|
|
cd x-pack
|
|
|
|
# Invoke the functional_test_runner from Kibana. Try sending --help to learn more
|
|
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).
|