github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[docs] Fix kbn-test README issue breaking docs (#138940)

Browse source
This commit is contained in:
Brian Seeders 2022-08-16 12:41:20 -04:00 • committed by GitHub
parent 3ad0484d3e
commit 28f7c425d9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

14
packages/kbn-test/README.mdx
View file

@ -1,19 +1,17 @@
---
id: kibDevDocsOpsTest
slug: /kibana-dev-docs/ops/test
title: "@kbn/test"
title: '@kbn/test'
description: A package provide ways to run tests
date: 2022-08-15
tags: ['kibana', 'dev', 'contributor', 'operations', 'cli', 'dev', 'mode', 'test']
---
Kibana Testing Library
======================
# Kibana Testing Library
The @kbn/test package provides ways to run tests. Currently only functional testing is provided by this library, with unit and other testing possibly added here.
Functional Testing
-------------------
## Functional Testing
### Dependencies
@ -21,14 +19,16 @@ Functional testing methods exist in the `src/functional_tests` directory. They d
### Exposed methods
#### runTests(configPaths: Array<string>)
#### `runTests(configPaths: Array<string>)`
For each config file specified in configPaths, starts Elasticsearch and Kibana once, runs tests specified in that config file, and shuts down Elasticsearch and Kibana once completed. (Repeats for every config file.)
`configPaths`: array of strings, each an absolute path to a config file that looks like [this](../../test/functional/config.base.js), following the config schema specified [here](../../src/functional_test_runner/lib/config/schema.js).
Internally the method that starts Elasticsearch comes from [kbn-es](../../packages/kbn-es).
#### startServers(configPath: string)
#### `startServers(configPath: string)`
Starts Elasticsearch and Kibana servers given a specified config.
`configPath`: absolute path to a config file that looks like [this](../../test/functional/config.base.js), following the config schema specified [here](../../src/functional_test_runner/lib/config/schema.js).