forked from elastic/kibana
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Endpoint] Host Details Policy Response Panel (elastic#63518)
* Added link to Policy status that updates URL and show details panel * Custom Styled Flyout Panel sub-header component to display sub-headers * Move Middleware spy utils under `store/` for re-use * Changed `appStoreFactory()` to accept optional `additionalMiddleware` prop * `waitForAction` middleware test utility now return Action on Promise resolve * Updated PageView component to remove bottom margin
- Loading branch information
1 parent
eb56bfe
commit 0473378
Showing
16 changed files
with
516 additions
and
213 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
x-pack/plugins/endpoint/public/applications/endpoint/store/test_utils.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import { Dispatch } from 'redux'; | ||
| import { AppAction, GlobalState, MiddlewareFactory } from '../types'; | ||
|
|
||
| /** | ||
| * Utilities for testing Redux middleware | ||
| */ | ||
| export interface MiddlewareActionSpyHelper<S = GlobalState, A extends AppAction = AppAction> { | ||
| /** | ||
| * Returns a promise that is fulfilled when the given action is dispatched or a timeout occurs. | ||
| * The `action` will given to the promise `resolve` thus allowing for checks to be done. | ||
| * The use of this method instead of a `sleep()` type of delay should avoid test case instability | ||
| * especially when run in a CI environment. | ||
| * | ||
| * @param actionType | ||
| */ | ||
| waitForAction: <T extends A['type']>(actionType: T) => Promise<A extends { type: T } ? A : never>; | ||
| /** | ||
| * A property holding the information around the calls that were processed by the internal | ||
| * `actionSpyMiddelware`. This property holds the information typically found in Jets's mocked | ||
| * function `mock` property - [see here for more information](https://jestjs.io/docs/en/mock-functions#mock-property) | ||
| * | ||
| * **Note**: this property will only be set **after* the `actionSpyMiddlware` has been | ||
| * initialized (ex. via `createStore()`. Attempting to reference this property before that time | ||
| * will throw an error. | ||
| * Also - do not hold on to references to this property value if `jest.clearAllMocks()` or | ||
| * `jest.resetAllMocks()` is called between usages of the value. | ||
| */ | ||
| dispatchSpy: jest.Mock<Dispatch<A>>['mock']; | ||
| /** | ||
| * Redux middleware that enables spying on the action that are dispatched through the store | ||
| */ | ||
| actionSpyMiddleware: ReturnType<MiddlewareFactory<S>>; | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new instance of middleware action helpers | ||
| * Note: in most cases (testing concern specific middleware) this function should be given | ||
| * the state type definition, else, the global state will be used. | ||
| * | ||
| * @example | ||
| * // Use in Policy List middleware testing | ||
| * const middlewareSpyUtils = createSpyMiddleware<PolicyListState>(); | ||
| * store = createStore( | ||
| * policyListReducer, | ||
| * applyMiddleware( | ||
| * policyListMiddlewareFactory(fakeCoreStart, depsStart), | ||
| * middlewareSpyUtils.actionSpyMiddleware | ||
| * ) | ||
| * ); | ||
| * // Reference `dispatchSpy` ONLY after creating the store that includes `actionSpyMiddleware` | ||
| * const { waitForAction, dispatchSpy } = middlewareSpyUtils; | ||
| * // | ||
| * // later in test | ||
| * // | ||
| * it('...', async () => { | ||
| * //... | ||
| * await waitForAction('serverReturnedPolicyListData'); | ||
| * // do assertions | ||
| * // or check how action was called | ||
| * expect(dispatchSpy.calls.length).toBe(2) | ||
| * }); | ||
| */ | ||
| export const createSpyMiddleware = < | ||
| S = GlobalState, | ||
| A extends AppAction = AppAction | ||
| >(): MiddlewareActionSpyHelper<S, A> => { | ||
| type ActionWatcher = (action: A) => void; | ||
|
|
||
| const watchers = new Set<ActionWatcher>(); | ||
| let spyDispatch: jest.Mock<Dispatch<A>>; | ||
|
|
||
| return { | ||
| waitForAction: async actionType => { | ||
| type ResolvedAction = A extends { type: typeof actionType } ? A : never; | ||
|
|
||
| // Error is defined here so that we get a better stack trace that points to the test from where it was used | ||
| const err = new Error(`action '${actionType}' was not dispatched within the allocated time`); | ||
|
|
||
| return new Promise<ResolvedAction>((resolve, reject) => { | ||
| const watch: ActionWatcher = action => { | ||
| if (action.type === actionType) { | ||
| watchers.delete(watch); | ||
| clearTimeout(timeout); | ||
| resolve(action as ResolvedAction); | ||
| } | ||
| }; | ||
|
|
||
| // We timeout before jest's default 5s, so that a better error stack is returned | ||
| const timeout = setTimeout(() => { | ||
| watchers.delete(watch); | ||
| reject(err); | ||
| }, 4500); | ||
| watchers.add(watch); | ||
| }); | ||
| }, | ||
|
|
||
| get dispatchSpy() { | ||
| if (!spyDispatch) { | ||
| throw new Error( | ||
| 'Spy Middleware has not been initialized. Access this property only after using `actionSpyMiddleware` in a redux store' | ||
| ); | ||
| } | ||
| return spyDispatch.mock; | ||
| }, | ||
|
|
||
| actionSpyMiddleware: api => { | ||
| return next => { | ||
| spyDispatch = jest.fn(action => { | ||
| next(action); | ||
| // loop through the list of watcher (if any) and call them with this action | ||
| for (const watch of watchers) { | ||
| watch(action); | ||
| } | ||
| return action; | ||
| }); | ||
| return spyDispatch; | ||
| }; | ||
| }, | ||
| }; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.