diff --git a/.eslintrc.js b/.eslintrc.js index a57ea5e03865a1..2c55dd2528ef14 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -470,11 +470,6 @@ module.exports = { errorMessage: 'Server modules cannot be imported into client modules or shared modules.', }, - { - target: ['src/**/*'], - from: ['x-pack/**/*'], - errorMessage: 'OSS cannot import x-pack files.', - }, { target: ['src/core/**/*'], from: ['plugins/**/*', 'src/plugins/**/*'], diff --git a/.i18nrc.json b/.i18nrc.json index 68bb343092f259..235b65d7502f4f 100644 --- a/.i18nrc.json +++ b/.i18nrc.json @@ -9,6 +9,7 @@ "data": "src/plugins/data", "embeddableApi": "src/plugins/embeddable", "embeddableExamples": "examples/embeddable_examples", + "fieldFormats": "src/plugins/field_formats", "uiActionsExamples": "examples/ui_action_examples", "share": "src/plugins/share", "home": "src/plugins/home", @@ -35,6 +36,7 @@ "monaco": "packages/kbn-monaco/src", "esQuery": "packages/kbn-es-query/src", "presentationUtil": "src/plugins/presentation_util", + "indexPatternEditor": "src/plugins/index_pattern_editor", "indexPatternFieldEditor": "src/plugins/index_pattern_field_editor", "indexPatternManagement": "src/plugins/index_pattern_management", "interactiveSetup": "src/plugins/interactive_setup", diff --git a/api_docs/timelines.json b/api_docs/timelines.json index f273ee5fc24ba5..42943819522168 100644 --- a/api_docs/timelines.json +++ b/api_docs/timelines.json @@ -10918,7 +10918,7 @@ "label": "alertConsumers", "description": [], "signature": [ - "ALERTS_CONSUMERS", + "AlertConsumers", "[] | undefined" ], "path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts", diff --git a/dev_docs/tutorials/testing_plugins.mdx b/dev_docs/tutorials/testing_plugins.mdx new file mode 100644 index 00000000000000..96e13555a36a26 --- /dev/null +++ b/dev_docs/tutorials/testing_plugins.mdx @@ -0,0 +1,1367 @@ +--- +id: kibDevTutorialTestingPlugins +slug: /kibana-dev-docs/tutorial/testing-plugins +title: Testing Kibana Plugins +summary: Learn how to test different aspects of Kibana plugins +date: 2021-07-05 +tags: ['kibana', 'onboarding', 'dev', 'architecture', 'testing'] +--- + +This document outlines best practices and patterns for testing Kibana Plugins. + +## Strategy + +In general, we recommend three tiers of tests: +- Unit tests: small, fast, exhaustive, make heavy use of mocks for external dependencies +- Integration tests: higher-level tests that verify interactions between systems (eg. HTTP APIs, Elasticsearch API calls, calling other plugin contracts). +- End-to-end tests (e2e): tests that verify user-facing behavior through the browser + +These tiers should roughly follow the traditional ["testing pyramid"](https://martinfowler.com/articles/practical-test-pyramid.html), where there are more exhaustive testing at the unit level, fewer at the integration level, and very few at the functional level. + +## Core Integrations + +### Core Mocks + +When testing a plugin's integration points with Core APIs, it is heavily recommended to utilize the mocks provided in `src/core/server/mocks` and `src/core/public/mocks`. The majority of these mocks are dumb `jest` mocks that mimic the interface of their respective Core APIs, however they do not return realistic return values. + +If the unit under test expects a particular response from a Core API, the test will need to set this return value explicitly. The return values are type checked to match the Core API where possible to ensure that mocks are updated when Core APIs changed. + +#### Example + +```typescript +import { elasticsearchServiceMock } from 'src/core/server/mocks'; + +test('my test', async () => { + // Setup mock and faked response + const esClient = elasticsearchServiceMock.createScopedClusterClient(); + esClient.callAsCurrentUser.mockResolvedValue(/** insert ES response here */); + + // Call unit under test with mocked client + const result = await myFunction(esClient); + + // Assert that client was called with expected arguments + expect(esClient.callAsCurrentUser).toHaveBeenCalledWith(/** expected args */); + // Expect that unit under test returns expected value based on client's response + expect(result).toEqual(/** expected return value */) +}); +``` + +## Strategies for specific Core APIs + +### HTTP Routes +The HTTP API interface is another public contract of Kibana, although not every Kibana endpoint is for external use. When evaluating the required level of test coverage for an HTTP resource, make your judgment based on whether an endpoint is considered to be public or private. Public API is expected to have a higher level of test coverage. +Public API tests should cover the **observable behavior** of the system, therefore they should be close to the real user interactions as much as possible, ideally by using HTTP requests to communicate with the Kibana server as a real user would do. + +##### Preconditions +We are going to add tests for `myPlugin` plugin that allows to format user-provided text, store and retrieve it later. +The plugin has *thin* route controllers isolating all the network layer dependencies and delegating all the logic to the plugin model. + +```typescript +class TextFormatter { + public static async format(text: string, sanitizer: Deps['sanitizer']) { + // sanitizer.sanitize throws MisformedTextError when passed text contains HTML markup + const sanitizedText = await sanitizer.sanitize(text); + return sanitizedText; + } + + public static async save(text: string, savedObjectsClient: SavedObjectsClient) { + const { id } = await savedObjectsClient.update('myPlugin-type', 'myPlugin', { + userText: text + }); + return { id }; + } + + public static async getById(id: string, savedObjectsClient: SavedObjectsClient) { + const { attributes } = await savedObjectsClient.get('myPlugin-type', id); + return { text: attributes.userText }; + } +} +router.get( + { + path: '/myPlugin/formatter', + validate: { + query: schema.object({ + text: schema.string({ maxLength: 100 }), + }), + }, + }, + async (context, request, response) => { + try { + const formattedText = await TextFormatter.format(request.query.text, deps.sanitizer); + return response.ok({ body: formattedText }); + } catch(error) { + if (error instanceof MisformedTextError) { + return response.badRequest({ body: error.message }) + } + + throw e; + } + } +); +router.post( + { + path: '/myPlugin/formatter/text', + validate: { + body: schema.object({ + text: schema.string({ maxLength: 100 }), + }), + }, + }, + async (context, request, response) => { + try { + const { id } = await TextFormatter.save(request.query.text, context.core.savedObjects.client); + return response.ok({ body: { id } }); + } catch(error) { + if (SavedObjectsErrorHelpers.isConflictError(error)) { + return response.conflict({ body: error.message }) + } + throw e; + } + } +); + +router.get( + { + path: '/myPlugin/formatter/text/{id}', + validate: { + params: schema.object({ + id: schema.string(), + }), + }, + }, + async (context, request, response) => { + try { + const { text } = await TextFormatter.getById(request.params.id, context.core.savedObjects.client); + return response.ok({ + body: text + }); + } catch(error) { + if (SavedObjectsErrorHelpers.isNotFoundError(error)) { + return response.notFound() + } + throw e; + } + } +); +``` + +#### Unit testing +Unit tests provide the simplest and fastest way to test the logic in your route controllers and plugin models. +Use them whenever adding an integration test is hard and slow due to complex setup or the number of logic permutations. +Since all external core and plugin dependencies are mocked, you don't have the guarantee that the whole system works as +expected. + +Pros: +- fast +- easier to debug + +Cons: +- doesn't test against real dependencies +- doesn't cover integration with other plugins + +###### Example +You can leverage existing unit-test infrastructure for this. You should add `*.test.ts` file and use dependencies mocks to cover the functionality with a broader test suit that covers: +- input permutations +- input edge cases +- expected exception +- interaction with dependencies +```typescript +// src/plugins/my_plugin/server/formatter.test.ts +describe('TextFormatter', () => { + describe('format()', () => { + const sanitizer = sanitizerMock.createSetup(); + sanitizer.sanitize.mockImplementation((input: string) => `sanitizer result:${input}`); + + it('formats text to a ... format', async () => { + expect(await TextFormatter.format('aaa', sanitizer)).toBe('...'); + }); + + it('calls Sanitizer.sanitize with correct arguments', async () => { + await TextFormatter.format('aaa', sanitizer); + expect(sanitizer.sanitize).toHaveBeenCalledTimes(1); + expect(sanitizer.sanitize).toHaveBeenCalledWith('aaa'); + }); + + it('throws MisformedTextError if passed string contains banned symbols', async () => { + sanitizer.sanitize.mockRejectedValueOnce(new MisformedTextError()); + await expect(TextFormatter.format('any', sanitizer)).rejects.toThrow(MisformedTextError); + }); + // ... other tests + }); +}); +``` + +#### Integration tests +Depending on the number of external dependencies, you can consider implementing several high-level integration tests. +They would work as a set of [smoke tests](https://en.wikipedia.org/wiki/Smoke_testing_(software)) for the most important functionality. + +Main subjects for tests should be: +- authenticated / unauthenticated access to an endpoint. +- endpoint validation (params, query, body). +- main business logic. +- dependencies on other plugins. + +##### Functional Test Runner +If your plugin relies on the elasticsearch server to store data and supports additional configuration, you can leverage the Functional Test Runner(FTR) to implement integration tests. +FTR bootstraps an elasticsearch and a Kibana instance and runs the test suite against it. + +Pros: +- runs the whole Elastic stack +- tests cross-plugin integration +- emulates a real user interaction with the stack +- allows adjusting config values + +Cons: +- slow start +- hard to debug +- brittle tests + +###### Example +You can reuse existing [api_integration](https://github.com/elastic/kibana/blob/master/test/api_integration/config.js) setup by registering a test file within a +[test loader](https://github.com/elastic/kibana/blob/master/test/api_integration/apis/index.ts). More about the existing FTR setup in the +[contribution guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md#running-specific-kibana-tests) + +The tests cover: +- authenticated / non-authenticated user access (when applicable) +```typescript +// test/api_integration/apis/my_plugin/something.ts +export default function({ getService }: FtrProviderContext) { + const supertest = getService('supertest'); + const security = getService('security'); + + describe('myPlugin', () => { + it('returns limited info when not authenticated', async () => { + await security.logout(); + const response = await supertest + .get('/myPlugin/health') + .set('content-type', 'application/json') + .expect(200); + + expect(response.body).to.have.property('basicInfo'); + expect(response.body).not.to.have.property('detailedInfo'); + }); + + it('returns detailed info when authenticated', async () => { + await security.loginAsSuperUser(); + const response = await supertest + .get('/myPlugin/health') + .set('content-type', 'application/json') + .expect(200); + + expect(response.body).to.have.property('basicInfo'); + expect(response.body).to.have.property('detailedInfo'); + }); + }); +``` +- request validation +```typescript +// test/api_integration/apis/my_plugin/something.ts +export default function({ getService }: FtrProviderContext) { + const supertest = getService('supertest'); + + describe('myPlugin', () => { + it('validate params before to store text', async () => { + const response = await supertest + .post('/myPlugin/formatter/text') + .set('content-type', 'application/json') + .send({ text: 'aaa'.repeat(100) }) + .expect(400); + + expect(response.body).to.have.property('message'); + expect(response.body.message).to.contain('must have a maximum length of [100]'); + }); + }); +``` +- the main logic of the plugin +```typescript +export default function({ getService }: FtrProviderContext) { + const supertest = getService('supertest'); + describe('myPlugin', () => { + it('stores text', async () => { + const response = await supertest + .post('/myPlugin/formatter/text') + .set('content-type', 'application/json') + .send({ text: 'aaa' }) + .expect(200); + + expect(response.body).to.have.property('id'); + expect(response.body.id).to.be.a('string'); + }); + + it('retrieves text', async () => { + const { body } = await supertest + .post('/myPlugin/formatter/text') + .set('content-type', 'application/json') + .send({ text: 'bbb' }) + .expect(200); + + const response = await supertest.get(`/myPlugin/formatter/text/${body.id}`).expect(200); + expect(response.text).be('bbb'); + }); + + it('returns NotFound error when cannot find a text', async () => { + await supertest + .get('/myPlugin/something/missing') + .expect(404, 'Saved object [myPlugin-type/missing] not found'); + }); + }); +``` + +##### TestUtils +It can be utilized if your plugin doesn't interact with the elasticsearch server or mocks the own methods doing so. +Runs tests against real Kibana server instance. + +Pros: +- runs the real Kibana instance +- tests cross-plugin integration +- emulates a real user interaction with the HTTP resources + +Cons: +- faster than FTR because it doesn't run elasticsearch instance, but still slow +- hard to debug +- doesn't cover Kibana CLI logic + +###### Example +To have access to Kibana TestUtils, you should create `integration_tests` folder and import `test_utils` within a test file: +```typescript +// src/plugins/my_plugin/server/integration_tests/formatter.test.ts +import * as kbnTestServer from 'src/core/test_helpers/kbn_server'; + +describe('myPlugin', () => { + describe('GET /myPlugin/formatter', () => { + let root: ReturnType; + beforeAll(async () => { + root = kbnTestServer.createRoot(); + await root.preboot(); + await root.setup(); + await root.start(); + }, 30000); + + afterAll(async () => await root.shutdown()); + it('validates given text', async () => { + const response = await kbnTestServer.request + .get(root, '/myPlugin/formatter') + .query({ text: 'input string'.repeat(100) }) + .expect(400); + + expect(response.body).toHaveProperty('message'); + }); + + it('formats given text', async () => { + const response = await kbnTestServer.request + .get(root, '/myPlugin/formatter') + .query({ text: 'input string' }) + .expect(200); + + expect(response.text).toBe('...'); + }); + + it('returns BadRequest if passed string contains banned symbols', async () => { + await kbnTestServer.request + .get(root, '/myPlugin/formatter') + .query({ text: '