0003a32f56
* [ftr/percy] integrate percy with functional test runner * execute ftr within `percy exec` * share PERCY_BIN and GRUNT_BIN vars in setup * [license] whitelist `(Unlicense OR Apache-2.0)` * [percy] include pr/parallel info in env * echo the actual variable value * destructure required modules * [ci] calculate percy env in a script * remove outdated eslint overrides * oops, nonce should be the same for each build * take snapshots in context tests * add percy snapshots to some dashboard tests * account for extra execution of PERCY_BIN * remove usage of percy service * rename service to `visualTesting` * write a simple test * switch left-over percy test to visualTesting * set log level for percy agent * trigger ci * try using the system chrome install instead of downloading one * fix export definition * Don't skip chromium download * Add Spencer's fix to point to chrome installation * Attempting to split tests into own ci job and test files * Renumber job * Add tag to decorations file * Try new files with existing CI job * Try again to create a new CI job * Fix eslint problem with space * eslint updates * fix console test * make test names unique * Update ci group names * Try old name again * save * add separate visual_regression ci job * add visual regression ci job * add new job to jobs.yml * update path to take_percy_snapshot script * use fixed percy job total * fix common services import * move visual_create_and_add_embeddables to visual_regression project * finish moving create_and_add_embeddables * add x-pack visual regression job * migrate dashboard_snapshots tests to visual_regression * remove references to removed test files * restore some unnecessary changes * reimplement the login page tests * yarn.lock update * fix test * remove old CI_GROUP 100 block * update failed_tests trap * reduce yarn.lock changes * disable debug logging * disable visual-regression tests for now, we can enable them in specific prs |
||
|---|---|---|
| .. | ||
| elastic-datemath | ||
| eslint-config-kibana | ||
| kbn-babel-code-parser | ||
| kbn-babel-preset | ||
| kbn-config-schema | ||
| kbn-dev-utils | ||
| kbn-elastic-idx | ||
| kbn-es | ||
| kbn-es-query | ||
| kbn-eslint-import-resolver-kibana | ||
| kbn-eslint-plugin-eslint | ||
| kbn-expect | ||
| kbn-i18n | ||
| kbn-interpreter | ||
| kbn-maki | ||
| kbn-plugin-generator | ||
| kbn-plugin-helpers | ||
| kbn-pm | ||
| kbn-spec-to-console | ||
| kbn-test | ||
| kbn-test-subj-selector | ||
| kbn-ui-framework | ||
| README.md | ||
Kibana-related packages
This folder contains packages that are intended for use in Kibana and Kibana plugins.
tl;dr:
- Don't publish to npm registry
- Always use the
@kbnnamespace - Always set
"private": trueinpackage.json
Using these packages
We no longer publish these packages to the npm registry. Now, instead of specifying a version when including these packages, we rely on yarn workspaces, which sets up a symlink to the package.
For example if you want to use the @kbn/i18n package in Kibana itself, you
can specify the dependency like this:
"@kbn/i18n": "1.0.0"
However, if you want to use this from a Kibana plugin, you need to use a link:
dependency and account for the relative location of the Kibana repo, so it would
instead be:
"@kbn/i18n": "link:../../kibana/packages/kbn-i18n"
How all of this works is described in more detail in the
@kbn/pm docs.
Creating a new package
Create a new sub-folder. The name of the folder should mirror the name in the
package's package.json. E.g. if the name is @kbn/i18n the folder name
should be kbn-i18n.
All new packages should use the @kbn namespace, and should be marked with
"private": true.
Unit tests for a package
Currently there are two patterns used to test packages, one using Mocha and one using Jest. These patterns emerged out of convention and we'd like to make them more similar to each other in the near future.
1. Mocha
Today a package can follow the pattern of having a __tests__ directory in each source code directory of a package which contains the tests for that module. These are usually run by Mocha.
If a package's tests should be run with Mocha, you'll have to opt-in to run them by appending the package's test file pattern(s) to Kibana's tasks/config/simplemocha.js file. These will then be run by the unit test runner.
yarn testoryarn grunt testruns all unit tests.node scripts/mocharuns all Mocha tests.
2. Jest
A package can also follow the pattern of having .test.js files as siblings of the source code files, and these run by Jest.
A package using the .test.js naming convention will have those tests automatically picked up by Jest and run by the unit test runner, currently mapped to the Kibana test script in the root package.json.
yarn testoryarn grunt testruns all unit tests.node scripts/jestruns all Jest tests in Kibana.
Each package can also specify its own test script in the package's package.json, for cases where you'd prefer to run the tests from the local package directory.