Mocks for CoreStart, CoreSetup and PluginInitializerContext by rudolf · Pull Request #39351 · elastic/kibana

rudolf · 2019-06-20T15:00:16Z

Summary

Mocks for CoreStart, CoreSetup and PluginInitializerContext to make it easier to write plugin tests that depend on Core.

elasticmachine · 2019-06-20T15:00:37Z

Pinging @elastic/kibana-platform

rudolf · 2019-06-20T15:01:37Z

Closes #38679

elasticmachine · 2019-06-20T16:07:32Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-21T13:21:07Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-21T14:53:22Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

rudolf · 2019-06-21T19:14:35Z

@stacey-gammon I tested the mocks by using them in the embeddable tests, please review.

elasticmachine · 2019-06-24T09:49:21Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

stacey-gammon

Couple questions but generally, LGTM. did not pull down and test locally, code review only.

stacey-gammon · 2019-06-24T12:49:20Z

src/core/server/mocks.ts

+        prod: false,
+      },
+    },
+    config: pluginInitializerContextConfigMock(config)() as jest.Mocked<


Just curious, since the only place this is called is right here and the return value is used right away, why not just make it

export function createPluginInitializerContextConfigMock<T>(config: T) { const mock: jest.Mocked<PluginInitializerContext<T>['config']> = { create: jest.fn().mockReturnValue(of(config)), createIfExists: jest.fn().mockReturnValue(of(config)), }; return mock; }

But I notice you export that file so maybe you assume it will likely be used elsewhere, and in those cases, passed in a value parameter.

yeah, I based this on the tests in https://github.com/toddself/kibana/blob/proxy/x-pack/plugins/proxy/server/cluster_doc.test.ts#L23-L59 (not yet merged into master), which used default and then specific overrides for each of the tests.

Though looking at this again, it feels like this is easy enough for the specific test to implement themselves if they need it. It makes the mock a little weird to consume and developers will probably need to look at the source code to understand the signature, at which point having an additional Object.assign({}, mydefaults, value) is probably much easier to follow for anyone reading the code.

stacey-gammon · 2019-06-24T13:06:56Z

src/legacy/core_plugins/embeddable_api/public/np_core.test.mocks.ts

 */

-import { fatalErrorsServiceMock, notificationServiceMock } from '../../../../core/public/mocks';
+import { coreMock } from '../../../../core/public/mocks';


What do you think about having this file also be in NP so we don't even have to duplicate this everywhere? Then in your actual test files, you'd just import something like

import { coreMock } from '../../../../core/public/np_core.test.mocks';?

... though I suppose in this case I wouldn't want to mock the overlay functions for everyone... But it does seem like in most cases, just importing the single file is enough for folks who don't have to mock anything particular. 🤔 Just a thought!

...s/embeddable_api/public/panel/panel_header/panel_actions/add_panel/add_panel_flyout.test.tsx

src/core/public/mocks.ts

src/legacy/ui/public/notify/toasts/toast_notifications.test.ts

src/core/server/mocks.ts

elasticmachine · 2019-06-24T20:22:57Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-24T20:41:42Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-25T20:47:45Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-26T09:52:02Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

lizozom · 2019-06-26T13:44:31Z

FYI Just tried this out in one of my PRs, and it worked great.

This reverts commit 2d666fa.

elasticmachine · 2019-06-27T08:43:42Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

rudolf · 2019-06-27T08:49:11Z

retest

src/core/public/ui_settings/ui_settings_service.ts

elasticmachine · 2019-06-27T09:51:52Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2019-06-27T10:22:05Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

spalger

LGTM

rudolf · 2019-06-27T14:40:52Z

retest

elasticmachine · 2019-06-27T15:59:13Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

rudolf · 2019-06-28T07:33:26Z

retest

elasticmachine · 2019-06-28T08:25:47Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

…art-mocks

elasticmachine · 2019-06-28T11:02:08Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…39351) * Mocks for CoreStart, CoreSetup and PluginInitializerContext * Public CoreStart, CoreSetup mocks * Update api signature/docs * Convert embaddable_api tests to new core mocks * CR Feedback * Introduce ui_new_platform.test.mocks and refactor embedabble tests * Hack to get TS warnings for Core mocks * Core mocks types cleanup & hack to get TS warnings for Server Core mocks * Use __mocks__ new_platform * Remove accidently commited auto-mock * Introduce MockedKeys type for Core mocks * Better typing/docs for UiSettings * Revert "Use __mocks__ new_platform" This reverts commit 2d666fa. * Add missing mock to test * Cleanup UiSettings types

…39894) * Mocks for CoreStart, CoreSetup and PluginInitializerContext * Public CoreStart, CoreSetup mocks * Update api signature/docs * Convert embaddable_api tests to new core mocks * CR Feedback * Introduce ui_new_platform.test.mocks and refactor embedabble tests * Hack to get TS warnings for Core mocks * Core mocks types cleanup & hack to get TS warnings for Server Core mocks * Use __mocks__ new_platform * Remove accidently commited auto-mock * Introduce MockedKeys type for Core mocks * Better typing/docs for UiSettings * Revert "Use __mocks__ new_platform" This reverts commit 2d666fa. * Add missing mock to test * Cleanup UiSettings types

rudolf added Feature:New Platform Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// labels Jun 20, 2019

rudolf force-pushed the core-setup-start-mocks branch from e970b27 to a9e37e6 Compare June 21, 2019 12:16

rudolf marked this pull request as ready for review June 21, 2019 19:13

rudolf requested a review from a team as a code owner June 21, 2019 19:13

rudolf requested a review from stacey-gammon June 21, 2019 19:14

rudolf added release_note:skip Skip the PR/issue when compiling release notes v7.3.0 v8.0.0 labels Jun 21, 2019

rudolf added 4 commits June 24, 2019 10:45

Mocks for CoreStart, CoreSetup and PluginInitializerContext

968fb71

Public CoreStart, CoreSetup mocks

f189fdc

Update api signature/docs

e9db29f

Convert embaddable_api tests to new core mocks

0d5fadf

rudolf force-pushed the core-setup-start-mocks branch from 498ca3d to 0d5fadf Compare June 24, 2019 08:46

stacey-gammon approved these changes Jun 24, 2019

View reviewed changes

mshustov reviewed Jun 24, 2019

View reviewed changes

rudolf added 5 commits June 24, 2019 20:06

CR Feedback

b038601

Introduce ui_new_platform.test.mocks and refactor embedabble tests

358d928

Hack to get TS warnings for Core mocks

bcf7630

Merge branch 'master' into core-setup-start-mocks

2be9ca7

Core mocks types cleanup & hack to get TS warnings for Server Core mocks

4f5331c

rudolf requested a review from spalger June 25, 2019 19:46

rudolf added 2 commits June 26, 2019 09:47

Introduce MockedKeys type for Core mocks

45d0887

Better typing/docs for UiSettings

c52707e

azasypkin mentioned this pull request Jun 26, 2019

Migrate authentication subsystem to the new platform. #39446

Merged

10 tasks

rudolf added 3 commits June 27, 2019 09:00

Revert "Use __mocks__ new_platform"

878c46a

This reverts commit 2d666fa.

Add missing mock to test

f6fd9d1

Merge branch 'master' into core-setup-start-mocks

f4082d8

mshustov approved these changes Jun 27, 2019

View reviewed changes

src/core/public/ui_settings/ui_settings_service.ts Outdated Show resolved Hide resolved

Cleanup UiSettings types

49aa1b5

spalger approved these changes Jun 27, 2019

View reviewed changes

Merge branch 'master' of github.com:elastic/kibana into core-setup-st…

96934a8

…art-mocks

rudolf merged commit da09a11 into elastic:master Jun 28, 2019

rudolf deleted the core-setup-start-mocks branch June 28, 2019 11:34

rudolf mentioned this pull request Jun 28, 2019

[7.x] Mocks for CoreStart, CoreSetup and PluginInitializerContext (#39351) #39894

Merged

This was referenced Jul 2, 2019

「AppArch」Interpreter 👉 New Platform #39329

Merged

Plugin mocks #40123

Merged

Conversation

rudolf commented Jun 20, 2019

Summary

Uh oh!

elasticmachine commented Jun 20, 2019

Uh oh!

rudolf commented Jun 20, 2019

Uh oh!

elasticmachine commented Jun 20, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 21, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 21, 2019

💔 Build Failed

Uh oh!

rudolf commented Jun 21, 2019

Uh oh!

elasticmachine commented Jun 24, 2019

💚 Build Succeeded

Uh oh!

stacey-gammon left a comment

Choose a reason for hiding this comment

Uh oh!

stacey-gammon Jun 24, 2019

Choose a reason for hiding this comment

Uh oh!

rudolf Jun 24, 2019

Choose a reason for hiding this comment

Uh oh!

stacey-gammon Jun 24, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Jun 24, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 24, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 25, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 26, 2019

💚 Build Succeeded

Uh oh!

lizozom commented Jun 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

rudolf commented Jun 27, 2019

Uh oh!

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

spalger left a comment

Choose a reason for hiding this comment

Uh oh!

rudolf commented Jun 27, 2019

Uh oh!

elasticmachine commented Jun 27, 2019

💔 Build Failed

Uh oh!

rudolf commented Jun 28, 2019

Uh oh!

elasticmachine commented Jun 28, 2019

💔 Build Failed

Uh oh!

elasticmachine commented Jun 28, 2019

💚 Build Succeeded

lizozom commented Jun 26, 2019 •

edited

Loading