- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.3
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
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 {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.
On this page