* Add file upload x-pack plugin * Clean up * Remove unneeded cluster config * Remove unneeded test * First pass basic telemetry (not connected). * Basic telemetry connected * Review feedback * Revise telemetry to use savedObjectRepository. Capture metrics on app and file types * Lots of cleanup, consolidation of logic * Clean up, reorg * Update telem tests and telem functions * Add back import data model * Clean up and update telemetry tests * Fix telemetry test issues and update corresponding code * Up chunk limit to 30 MB * Add file upload telemetry to saved objects management builder * Missing space * Add descriptive comments to dynamic keys in telemetry fields * [Maps] [File upload] Geojson upload (#36410) * Client side basics * File added and default named correctly * Connect transient layer removal to file import component * Simplify transient layer removal * Move file import ui over to new file upload plugin and make more generic * Add post-processing option to file upload. Make component json-specific * Add flag for source indexing * Revise import layer workflow to be separate from add layer workflow * Differentiate between normal sources and import sources. Add back layer add/next button * Update indexing boolean in component after file upload & parse * First pass rough indexing from maps working on specific use cases * Update parsing logic to handle geojson formats * Index pattern added following index creation * Pass onsuccess callback to file_upload to add layer to maps app * Handle mulltipolygon type in es geo utils * Add functionality to make es layer permanent and switch to edit panel * Add to index if exists or create new * Make plugin API more intuitive. Set up to handle remove action * Pass transient removal call through to file import * Clean up layer viewing logic for temp and perm layers * Remove change source from import screen * Add option to provide mappings array and pass geo_point and geo_shape to array * Add support for multiple mappings select and index naming * Match style of import file button to add layer for now * Remove duplicate case handling resulting from merge * Move geo processing logic over to file upload plugin for reuse * Remove old geo_shape formatting from geo_point code * Set default index data type. Remove unneeded stringify request logic * Check for custom processor object which contains function * Move file picker to separate component * Some cleaning. Add geojson clean & validate code * Catch file parsing errors and notify user * Disable index type if valid file not referenced * Set error messaging on invalid index name used * Add index pattern checking logic and error handling * Dynamically populate geo index options * Set index data type earlier in the workflow. Don't duplicate requests * Pass back index ready status from plugin and connect to layer next button * Increase max bytes to ~50MB * Don't parse files over max size & warn user. Also, remove toasts and warn similarly to other components * Uploaded file default label: 'fileToImport' -> 'Import File' * Expand out feature properties for mapping * Pass through telemetry data to plugin back-end * Clean up indexing flow. Separate creation of index patterns. Add new index pattern create callbacks * Pass back info for indexing failures but don't connect to UI yet * Fix telemetry test issues and update corresponding code # Conflicts: # x-pack/plugins/file_upload/server/telemetry/telemetry.test.ts * Add file upload telemetry to saved objects management builder * Missing space * Add descriptive comments to dynamic keys in telemetry fields * Divide up the import layer add workflow on the maps side and tweak to avoid layer color change * Fix bug affecting file preview replacement not updating coordinate index type * Remove index pattern. Organize effects. General clean up * preIndexTransform -> transformDetails * Update proptypes * Cleaning, organizing * Add index name guidelines. Show conditionally * Add file size, type guidance. Filter on file size, not chunk size. Small tweaks to file/index tips * Zoom to layer extent on preview of imported data * Revert "Revise import layer workflow to be separate from add layer workflow" This reverts commit |
||
---|---|---|
.. | ||
.github | ||
build_chromium | ||
common | ||
dev-tools | ||
plugins | ||
scripts | ||
server/lib | ||
tasks | ||
test | ||
test_utils | ||
typings | ||
.gitignore | ||
.kibana-plugin-helpers.json | ||
gulpfile.js | ||
index.js | ||
package.json | ||
README.md | ||
tsconfig.json |
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.
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
By default, this will also set the password for native realm accounts to the password provided (changeme
by default). This includes that of the kibana
user which elasticsearch.username
defaults to in development. If you wish to specific a password for a given native realm account, you can do that like so: --password.kibana=notsecure
Testing
Running specific tests
Test runner | Test location | Runner command (working directory is kibana/x-pack) |
---|---|---|
Jest | x-pack/**/*.test.js x-pack/**/*.test.ts |
cd x-pack && node scripts/jest -t regexp [test path] |
Functional | x-pack/test/*integration/**/config.js x-pack/test/*functional/config.js |
node scripts/functional_tests_server --config x-pack/test/[directory]/config.js node scripts/functional_test_runner --config x-pack/test/[directory]/config.js --grep=regexp |
Examples:
- Run the jest test case whose description matches 'filtering should skip values of null':
cd x-pack && yarn test:jest -t 'filtering should skip values of null' plugins/ml/public/explorer/explorer_charts/explorer_charts_container_service.test.js
- Run the x-pack api integration test case whose description matches the given string:
node scripts/functional_tests_server --config x-pack/test/api_integration/config.js
node scripts/functional_test_runner --config x-pack/test/api_integration/config.js --grep='apis Monitoring Beats list with restarted beat instance should load multiple clusters'
In addition to to providing a regular expression argument, specific tests can also be run by appeding .only
to an it
or describe
function block. E.g. describe(
to describe.only(
.
Running all tests
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.
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), API integration tests (specified by this config), and SAML API integration tests (specified by this config).
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:
node scripts/functional_tests
Running UI tests
To run only the functional UI tests:
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:
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:
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.
node scripts/jest_integration
An example test exists at test_utils/jest/integration_tests/example_integration.test.ts
Running Reporting functional tests
See here 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:
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):
# 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.
For a deeper dive, read more about the way functional tests and servers work here.