IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Functional Tests for Plugins outside the Kibana repo
editFunctional Tests for Plugins outside the Kibana repo
editPlugins 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
editEvery 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
:
import { resolve } from 'path'; import { REPO_ROOT } from '@kbn/utils'; import { MyServiceProvider } from './services/my_service'; import { MyAppPageProvider } from './services/my_app_page'; // the default export of config files must be a config provider // that returns an object with the projects config values export default async function ({ readConfigFile }) { // read the {kib} config file so that we can utilize some of // its services and PageObjects const kibanaConfig = await readConfigFile(resolve(REPO_ROOT, 'test/functional/config.base.js')); return { // list paths to the files that contain your plugins tests testFiles: [ resolve(__dirname, './my_test_file.js'), ], // define the name and providers for services that should be // available to your tests. If you don't specify anything here // only the built-in services will be available services: { ...kibanaConfig.get('services'), myService: MyServiceProvider, }, // just like services, PageObjects are defined as a map of // names to Providers. Merge in {kib}'s or pick specific ones pageObjects: { management: kibanaConfig.get('pageObjects.management'), myApp: MyAppPageProvider, }, // the apps section defines the urls that // `PageObjects.common.navigateTo(appKey)` will use. // Merge urls for your plugin with the urls defined in // {kib}'s config in order to use this helper apps: { ...kibanaConfig.get('apps'), myApp: { pathname: '/app/my_app', } }, // choose where screenshots should be saved screenshots: { directory: resolve(__dirname, './tmp/screenshots'), } // more settings, like timeouts, mochaOpts, etc are // defined in the config schema. See {kibana-blob}src/functional_test_runner/lib/config/schema.js[src/functional_test_runner/lib/config/schema.js] }; }
From the root of your repo you should now be able to run the FunctionalTestRunner
script from your plugin project.
node ../../kibana/scripts/functional_test_runner
Using esArchiver
editWe’re working on documentation for this, but for now the best place to look is the original pull request.