Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ML] Add basic license test run details to ML+Transform READMEs #83259

Merged
merged 3 commits into from
Nov 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions x-pack/plugins/ml/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Elastic.
## Requirements

To use machine learning features, you must have a Platinum or Enterprise license
or a free 14-day trial. File Data Visualizer requires a Basic license. For more
or a free 14-day Trial. File Data Visualizer requires a Basic license. For more
info, refer to
[Set up machine learning features](https://www.elastic.co/guide/en/machine-learning/master/setup.html).

Expand Down Expand Up @@ -99,23 +99,37 @@ node scripts/jest plugins/ml --verbose
Before running the test server, make sure to quit all other instances of
Elasticsearch.

1. From one terminal, in the x-pack directory, run:
Run the following commands from the `x-pack` directory and use separate terminals
for test server and test runner. The test server command starts an Elasticsearch
and Kibana instance that the tests will be run against.

node scripts/functional_tests_server.js --config test/functional/config.js
1. Functional UI tests with `Trial` license (default config):

This command starts an Elasticsearch and Kibana instance that the tests will be run against.
node scripts/functional_tests_server.js
node scripts/functional_test_runner.js --include-tag mlqa

ML functional `Trial` license tests are located in `x-pack/test/functional/apps/ml`.

1. Functional UI tests with `Basic` license:

1. In another tab, run the following command to perform API integration tests (from the x-pack directory):
node scripts/functional_tests_server.js --config test/functional_basic/config.ts
node scripts/functional_test_runner.js --config test/functional_basic/config.ts --include-tag mlqa

node scripts/functional_test_runner.js --include-tag mlqa --config test/api_integration/config
ML functional `Basic` license tests are located in `x-pack/test/functional_basic/apps/ml`.

1. API integration tests with `Trial` license:

node scripts/functional_tests_server.js
node scripts/functional_test_runner.js --config test/api_integration/config.ts --include-tag mlqa

ML API integration tests are located in `x-pack/test/api_integration/apis/ml`.
ML API integration `Trial` license tests are located in `x-pack/test/api_integration/apis/ml`.

1. In another tab, run the following command to perform UI functional tests (from the x-pack directory):
1. API integration tests with `Basic` license:

node scripts/functional_test_runner.js --include-tag mlqa
node scripts/functional_tests_server.js --config test/api_integration_basic/config.ts
node scripts/functional_test_runner.js --config test/api_integration_basic/config.ts --include-tag mlqa

ML functional tests are located in `x-pack/test/functional/apps/ml`.
ML API integration `Basic` license tests are located in `x-pack/test/api_integration_basic/apis/ml`.

## Shared functions

Expand Down
32 changes: 23 additions & 9 deletions x-pack/plugins/transform/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,20 +98,34 @@ node scripts/jest plugins/transform --verbose
Before running the test server, make sure to quit all other instances of
Elasticsearch.

1. From one terminal, in the x-pack directory, run:
Run the following commands from the `x-pack` directory and use separate terminals
for test server and test runner. The test server command starts an Elasticsearch
and Kibana instance that the tests will be run against.

node scripts/functional_tests_server.js --config test/functional/config.js
1. Functional UI tests with `Trial` license (default config):

This command starts an Elasticsearch and Kibana instance that the tests will be run against.
node scripts/functional_tests_server.js
node scripts/functional_test_runner.js --include-tag transform

Transform functional `Trial` license tests are located in `x-pack/test/functional/apps/transform`.

1. Functional UI tests with `Basic` license:

1. In another tab, run the following command to perform API integration tests (from the x-pack directory):
node scripts/functional_tests_server.js --config test/functional_basic/config.ts
node scripts/functional_test_runner.js --config test/functional_basic/config.ts --include-tag transform

node scripts/functional_test_runner.js --include-tag transform --config test/api_integration/config
Transform functional `Basic` license tests are located in `x-pack/test/functional_basic/apps/transform`.

1. API integration tests with `Trial` license:

node scripts/functional_tests_server.js
node scripts/functional_test_runner.js --config test/api_integration/config.ts --include-tag transform

The transform API integration tests are located in `x-pack/test/api_integration/apis/transform`.
Transform API integration `Trial` license tests are located in `x-pack/test/api_integration/apis/transform`.

1. In another tab, run the following command to perform UI functional tests (from the x-pack directory):
1. API integration tests with `Basic` license:

node scripts/functional_test_runner.js --include-tag transform
node scripts/functional_tests_server.js --config test/api_integration_basic/config.ts
node scripts/functional_test_runner.js --config test/api_integration_basic/config.ts --include-tag transform

The transform functional tests are located in `x-pack/test/functional/apps/transform`.
Transform API integration `Basic` license tests are located in `x-pack/test/api_integration_basic/apis/ml`.