From 01adcff8963309aca6bdfa24036609640127bcc3 Mon Sep 17 00:00:00 2001 From: Robert Oskamp Date: Mon, 16 Nov 2020 10:25:42 +0100 Subject: [PATCH] [ML] Add basic license test run details to ML+Transform READMEs (#83259) This PR updates the READMEs of the ml and transform plugins to include instructions how to run basic license tests. --- x-pack/plugins/ml/readme.md | 34 +++++++++++++++++++++--------- x-pack/plugins/transform/readme.md | 32 ++++++++++++++++++++-------- 2 files changed, 47 insertions(+), 19 deletions(-) diff --git a/x-pack/plugins/ml/readme.md b/x-pack/plugins/ml/readme.md index 0e50867e57ad..2369f3d07703 100644 --- a/x-pack/plugins/ml/readme.md +++ b/x-pack/plugins/ml/readme.md @@ -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). @@ -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 diff --git a/x-pack/plugins/transform/readme.md b/x-pack/plugins/transform/readme.md index 2ee2a7b70c5f..07500876f55c 100644 --- a/x-pack/plugins/transform/readme.md +++ b/x-pack/plugins/transform/readme.md @@ -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`.