workflows-management-jest-testing

name

workflows-management-jest-testing

description

Use the shared TestProvider in workflows_management Jest tests instead of hand-wiring KibanaContextProvider, QueryClientProvider, WorkflowsContextProvider, MemoryRouter, I18nProvider, and the Redux Provider. Use when writing or updating React/Jest tests under src/platform/plugins/shared/workflows_management/public/**, rendering components or hooks that touch Kibana services, the Redux store, react-query, routing, or i18n.

workflows_management Jest Testing

The workflows_management plugin ships a single shared test provider that wires up every context a component or hook in this plugin typically needs. Use it instead of composing providers by hand.

When to Use

Use TestProvider / getTestProvider for any Jest test under src/platform/plugins/shared/workflows_management/public/** that:

• renders a component or hook that reads from the Redux store,
• calls useKibana() / useStartServices() or otherwise consumes Kibana plugin services,
• uses @kbn/react-query (useQuery, useMutation, …),
• relies on react-router-dom (useHistory, useParams, links, …),
• uses i18n formatted messages,
• consumes WorkflowsContext.

If your test only exercises a pure function with no React tree, you don't need the provider.

Import

import {
  TestProvider,
  getTestProvider,
} from '../../../shared/mocks/test_providers';