Functional Tests for Plugins outside the Kibana repo

Plugins use the FunctionalTestRunner by running it out of the Kibana repo. Ensure that your Kibana Development Environment is setup properly before continuing.

Writing your own configuration

Every project or plugin should have its own FunctionalTestRunner config file. Just like Kibana’s, this config file will define all of the test files to load, providers for Services and PageObjects, as well as configuration options for certain services.

To get started copy and paste this example to test/functional/config.js:

  1. import { resolve } from 'path';
  2. import { resolveKibanaPath } from '@kbn/plugin-helpers';
  4. import { MyServiceProvider } from './services/my_service';
  5. import { MyAppPageProvider } from './services/my_app_page';
  7. // the default export of config files must be a config provider
  8. // that returns an object with the projects config values
  9. export default async function ({ readConfigFile }) {
  11.   // read the {kib} config file so that we can utilize some of
  12.   // its services and PageObjects
  13.   const kibanaConfig = await readConfigFile(resolveKibanaPath('test/functional/config.js'));
  15.   return {
  16.     // list paths to the files that contain your plugins tests
  17.     testFiles: [
  18.       resolve(__dirname, './my_test_file.js'),
  19.     ],
  21.     // define the name and providers for services that should be
  22.     // available to your tests. If you don't specify anything here
  23.     // only the built-in services will be available
  24.     services: {
  25.       ...kibanaConfig.get('services'),
  26.       myService: MyServiceProvider,
  27.     },
  29.     // just like services, PageObjects are defined as a map of
  30.     // names to Providers. Merge in {kib}'s or pick specific ones
  31.     pageObjects: {
  32.       management: kibanaConfig.get('pageObjects.management'),
  33.       myApp: MyAppPageProvider,
  34.     },
  36.     // the apps section defines the urls that
  37.     // `PageObjects.common.navigateTo(appKey)` will use.
  38.     // Merge urls for your plugin with the urls defined in
  39.     // {kib}'s config in order to use this helper
  40.     apps: {
  41.       ...kibanaConfig.get('apps'),
  42.       myApp: {
  43.         pathname: '/app/my_app',
  44.       }
  45.     },
  47.     // choose where esArchiver should load archives from
  48.     esArchiver: {
  49.       directory: resolve(__dirname, './es_archives'),
  50.     },
  52.     // choose where screenshots should be saved
  53.     screenshots: {
  54.       directory: resolve(__dirname, './tmp/screenshots'),
  55.     }
  57.     // more settings, like timeouts, mochaOpts, etc are
  58.     // defined in the config schema. See {blob}src/functional_test_runner/lib/config/schema.js[src/functional_test_runner/lib/config/schema.js]
  59.   };
  60. }

From the root of your repo you should now be able to run the FunctionalTestRunner script from your plugin project.

  1. node ../../kibana/scripts/functional_test_runner

Using esArchiver

We’re working on documentation for this, but for now the best place to look is the original pull request.

Most Popular