From 8ae7f8f3325e60e4459b2085d16cee7ad9ec06a8 Mon Sep 17 00:00:00 2001 From: Robert Oskamp Date: Thu, 12 Nov 2020 10:08:36 +0100 Subject: [PATCH 1/2] [ML] Add basic license test run details to ML+Transform READMEs --- x-pack/plugins/ml/readme.md | 32 +++++++++++++++++++++--------- x-pack/plugins/transform/readme.md | 32 +++++++++++++++++++++--------- 2 files changed, 46 insertions(+), 18 deletions(-) diff --git a/x-pack/plugins/ml/readme.md b/x-pack/plugins/ml/readme.md index 0e50867e57ad6..f25d0c55ff8c9 100644 --- a/x-pack/plugins/ml/readme.md +++ b/x-pack/plugins/ml/readme.md @@ -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 2ee2a7b70c5f1..9726d942c4ea6 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`. From eed632dcf3cf71948da996f62f0dd6b31ba9409b Mon Sep 17 00:00:00 2001 From: Robert Oskamp Date: Thu, 12 Nov 2020 16:52:34 +0100 Subject: [PATCH 2/2] Capitalize license names (Trial, Basic) --- x-pack/plugins/ml/readme.md | 18 +++++++++--------- x-pack/plugins/transform/readme.md | 16 ++++++++-------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/x-pack/plugins/ml/readme.md b/x-pack/plugins/ml/readme.md index f25d0c55ff8c9..2369f3d077037 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). @@ -103,33 +103,33 @@ Run the following commands from the `x-pack` directory and use separate terminal for test server and test runner. The test server command starts an Elasticsearch and Kibana instance that the tests will be run against. -1. Functional UI tests with `trial` license (default config): +1. Functional UI tests with `Trial` license (default config): 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`. + ML functional `Trial` license tests are located in `x-pack/test/functional/apps/ml`. -1. Functional UI tests with `basic` license: +1. Functional UI tests with `Basic` license: 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 - ML functional `basic` license tests are located in `x-pack/test/functional_basic/apps/ml`. + ML functional `Basic` license tests are located in `x-pack/test/functional_basic/apps/ml`. -1. API integration tests with `trial` license: +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 `trial` license 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. API integration tests with `basic` license: +1. API integration tests with `Basic` license: 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 API integration `basic` license tests are located in `x-pack/test/api_integration_basic/apis/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 9726d942c4ea6..07500876f55c2 100644 --- a/x-pack/plugins/transform/readme.md +++ b/x-pack/plugins/transform/readme.md @@ -102,30 +102,30 @@ Run the following commands from the `x-pack` directory and use separate terminal for test server and test runner. The test server command starts an Elasticsearch and Kibana instance that the tests will be run against. -1. Functional UI tests with `trial` license (default config): +1. Functional UI tests with `Trial` license (default config): 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`. + Transform functional `Trial` license tests are located in `x-pack/test/functional/apps/transform`. -1. Functional UI tests with `basic` license: +1. Functional UI tests with `Basic` license: 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 - Transform functional `basic` license tests are located in `x-pack/test/functional_basic/apps/transform`. + Transform functional `Basic` license tests are located in `x-pack/test/functional_basic/apps/transform`. -1. API integration tests with `trial` license: +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 - Transform API integration `trial` license 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. API integration tests with `basic` license: +1. API integration tests with `Basic` license: 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 - Transform API integration `basic` license tests are located in `x-pack/test/api_integration_basic/apis/ml`. + Transform API integration `Basic` license tests are located in `x-pack/test/api_integration_basic/apis/ml`.