kibana/packages
Rashmi Kulkarni 89f9260da2
FTR configurable test users (#52431)
* initial implementation of configurable test users

* user superuser by default to match master

* referenced the configs in reporting and api integration

* setting the minimum number of default roles

* looking for x-pack tests with users and roles

* add testUserService in dashboard mode tests

* running only ciGroup7

* uncommenting - addign visualization

* re-enabling all CI groups to run on CI

* reinstating Jenkinsfile

* disable Test user for OIDC config

* improved logging and added Roles for OSS tests to get better info on the runs.

* disable test_user for auth tests

* don't fetch enabledPlugins when testuser disabled

* fix es-lint

* running oss tests with x-pack enabled

* [revertme] build default dist for oss tests

* updating NOTICE.txt file as it complained in the kibana intake tests

* changed to pick OSS builds

* trying a license change to trial

* switch back to xpack builds

* created a new sample data role and used it in homepage tests

* revert test/scripts/jenkins_ci_group.sh

* only refresh browser and wait for chrome if we are already on Kibana page

* fix large_string test to use minimum set of roles and privileges

* fix for date nanos custom timestamp with a configured role

* changes to the files with addition of new roles for the test_user

* reverting to OSS changes and few additions to the time_zone test to run as a test_user

* changes to security

* changes to the x-pack test to use elastic superuser

* fix for chart_types test

* fixes to area chart , input control test

* fix for dashboard filtering test and a new config role

* changes to handle the x-pack tests

* additional role for date nanos mixed

* added the logstash role to the accessibility tests

* removed telemetry setting

* docs+few changes to the tests

* removed Page navigation

* removed pageNavigation which was unused

* test/accessibility/apps/management.ts

* update management.ts

* aria label, and other changes

* accidentally checked in a piped file with results.

* accidentally checked in a piped file with results.

* accidentally checked in a piped file with results.

* accidentally checked in a piped file with results.

* accidentally checked in a piped file with results.

* accidentally checked in a piped file with results.

* accidentally checked in a piped file with results.

* accidentally checked in a piped file with results.

* reverted

* unloading of logstash data, fixing aria label

* aria-label

* added the required role

* fix for tsvb chart

* fix for sample data test reverted home_page pageobject file

* changes to sample data test and visualize index file to incorporate OSS changes

* changes to describe() and some more changes to incorporate in settings_page

* re-adding the after()

* removed unwanted roles

* replaced kibana_user with kibana_admin

* added the check of deprecated kibana_user

* testing with kibana_admin  role

* fix for discover test

* incorporated the review comments

* incorporated the review comments

* incorporate review comments and added restoreDefaults()

* removed describe.only

* reverted the OSS logic change I had here- pulled into seperate PR

* incorporated the review comments

* incorporated review changes

* adding hidden=true to find hidden kibanaChrome

* change field.test.tsx to be same as that of master branch

Co-authored-by: spalger <spalger@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-03-17 10:41:23 -07:00
..
elastic-datemath Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05:00
eslint-config-kibana Update eslint related packages (#54107) 2020-01-07 19:08:36 +01:00
kbn-analytics [Telemetry] Application Usage implemented in @kbn/analytics (#58401) 2020-02-28 16:52:35 +00:00
kbn-babel-code-parser Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05:00
kbn-babel-preset chore(NA): use the same polyfill between the dev environment and the jest env (#57467) 2020-02-12 18:36:29 +00:00
kbn-config-schema Allow kbn-config-schema to ignore unknown keys (#59560) 2020-03-17 12:30:17 -04:00
kbn-dev-utils Add UiSettings validation & Kibana default route redirection (#59694) 2020-03-16 14:30:20 +01:00
kbn-es Updating tree-kill to 1.2.2 (#55889) 2020-02-05 13:53:01 -08:00
kbn-eslint-import-resolver-kibana build immutable bundles for new platform plugins (#53976) 2020-02-12 19:42:42 -07:00
kbn-eslint-plugin-eslint Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05:00
kbn-expect [kbn-expect] add optional error message (#48895) 2019-10-26 15:51:45 +02:00
kbn-i18n Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05:00
kbn-interpreter Move canvas to use NP Expressions service (#58387) 2020-03-10 09:11:58 -04:00
kbn-optimizer [kbn/optimizer] add test to verify that dynamic imports keep w… (#59065) 2020-03-03 08:15:32 -07:00
kbn-plugin-generator Downgrade "setting up plugin" log to debug (#58776) 2020-03-02 13:20:18 -07:00
kbn-plugin-helpers Refactor test entry by runner (#44679) 2020-02-18 16:21:36 -06:00
kbn-pm Add UiSettings validation & Kibana default route redirection (#59694) 2020-03-16 14:30:20 +01:00
kbn-spec-to-console Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05:00
kbn-storybook [Drilldowns] <ActionWizard/> Component (#59032) 2020-03-06 19:46:47 +01:00
kbn-test FTR configurable test users (#52431) 2020-03-17 10:41:23 -07:00
kbn-test-subj-selector Update eslint related packages (#48513) 2019-10-21 16:32:31 -07:00
kbn-ui-framework Updating to @elastic/lodash@3.10.1-kibana4 (#54662) 2020-02-21 07:27:40 -08:00
kbn-ui-shared-deps Upgrade EUI to v20.0.2 (#59199) 2020-03-05 12:27:52 -07:00
kbn-utility-types [resubmit] Prep agg types for new platform (#58893) 2020-02-28 11:15:43 -07:00
README.md [test] remove x-pack mocha configuration (#42979) 2019-08-15 12:21:42 -05:00

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 @kbn namespace
  • Always set "private": true in package.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 src/dev/mocha/run_mocha_cli.js file. These will then be run by the unit test runner.

  • yarn test or yarn grunt test runs all unit tests.
  • node scripts/mocha runs 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 test or yarn grunt test runs all unit tests.
  • node scripts/jest runs 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.