Skip to content

Commit 66c4925

Browse files
authored
[ML] Add basic license test run details to ML+Transform READMEs (#83259) (#83400)
This PR updates the READMEs of the ml and transform plugins to include instructions how to run basic license tests.
1 parent 6d3aff8 commit 66c4925

File tree

2 files changed

+47
-19
lines changed

2 files changed

+47
-19
lines changed

x-pack/plugins/ml/readme.md

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Elastic.
66
## Requirements
77

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

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

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

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

106-
This command starts an Elasticsearch and Kibana instance that the tests will be run against.
108+
node scripts/functional_tests_server.js
109+
node scripts/functional_test_runner.js --include-tag mlqa
110+
111+
ML functional `Trial` license tests are located in `x-pack/test/functional/apps/ml`.
112+
113+
1. Functional UI tests with `Basic` license:
107114

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

110-
node scripts/functional_test_runner.js --include-tag mlqa --config test/api_integration/config
118+
ML functional `Basic` license tests are located in `x-pack/test/functional_basic/apps/ml`.
119+
120+
1. API integration tests with `Trial` license:
121+
122+
node scripts/functional_tests_server.js
123+
node scripts/functional_test_runner.js --config test/api_integration/config.ts --include-tag mlqa
111124
112-
ML API integration tests are located in `x-pack/test/api_integration/apis/ml`.
125+
ML API integration `Trial` license tests are located in `x-pack/test/api_integration/apis/ml`.
113126

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

116-
node scripts/functional_test_runner.js --include-tag mlqa
129+
node scripts/functional_tests_server.js --config test/api_integration_basic/config.ts
130+
node scripts/functional_test_runner.js --config test/api_integration_basic/config.ts --include-tag mlqa
117131
118-
ML functional tests are located in `x-pack/test/functional/apps/ml`.
132+
ML API integration `Basic` license tests are located in `x-pack/test/api_integration_basic/apis/ml`.
119133

120134
## Shared functions
121135

x-pack/plugins/transform/readme.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -98,20 +98,34 @@ node scripts/jest plugins/transform --verbose
9898
Before running the test server, make sure to quit all other instances of
9999
Elasticsearch.
100100

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

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

105-
This command starts an Elasticsearch and Kibana instance that the tests will be run against.
107+
node scripts/functional_tests_server.js
108+
node scripts/functional_test_runner.js --include-tag transform
109+
110+
Transform functional `Trial` license tests are located in `x-pack/test/functional/apps/transform`.
111+
112+
1. Functional UI tests with `Basic` license:
106113

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

109-
node scripts/functional_test_runner.js --include-tag transform --config test/api_integration/config
117+
Transform functional `Basic` license tests are located in `x-pack/test/functional_basic/apps/transform`.
118+
119+
1. API integration tests with `Trial` license:
120+
121+
node scripts/functional_tests_server.js
122+
node scripts/functional_test_runner.js --config test/api_integration/config.ts --include-tag transform
110123
111-
The transform API integration tests are located in `x-pack/test/api_integration/apis/transform`.
124+
Transform API integration `Trial` license tests are located in `x-pack/test/api_integration/apis/transform`.
112125

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

115-
node scripts/functional_test_runner.js --include-tag transform
128+
node scripts/functional_tests_server.js --config test/api_integration_basic/config.ts
129+
node scripts/functional_test_runner.js --config test/api_integration_basic/config.ts --include-tag transform
116130
117-
The transform functional tests are located in `x-pack/test/functional/apps/transform`.
131+
Transform API integration `Basic` license tests are located in `x-pack/test/api_integration_basic/apis/ml`.

0 commit comments

Comments
 (0)