From edfe690ea2c4fa722b272b7c8b68daa4eea9d6ba Mon Sep 17 00:00:00 2001 From: Tom Ratcliffe Date: Wed, 14 May 2025 14:50:34 +0100 Subject: [PATCH] Chore: Move Mock API into separate package (#104644) --- package.json | 1 + packages/grafana-test-utils/CHANGELOG.md | 0 packages/grafana-test-utils/LICENSE_APACHE2 | 202 ++++++++++++++++++ packages/grafana-test-utils/README.md | 3 + packages/grafana-test-utils/package.json | 56 +++++ packages/grafana-test-utils/project.json | 8 + .../src/handlers/all-handlers.ts | 5 + .../grafana-test-utils/src/handlers/index.ts | 1 + packages/grafana-test-utils/src/index.ts | 8 + .../grafana-test-utils/src/server/index.ts | 36 ++++ packages/grafana-test-utils/src/unstable.ts | 1 + .../grafana-test-utils/src/worker/index.ts | 7 + packages/grafana-test-utils/tsconfig.json | 19 ++ .../rule-editor/DashboardPicker.test.tsx | 59 ++--- .../rule-viewer/RuleViewer.test.tsx | 4 +- .../state-history/LokiStateHistory.test.tsx | 2 +- .../ruleGroup/useDeleteRuleFromGroup.test.tsx | 3 +- .../app/features/alerting/unified/mockApi.ts | 18 +- .../unified/mocks/server/all-handlers.ts | 1 + .../unified/mocks/server/configure.ts | 2 +- .../alerting/unified/mocks/server/events.ts | 2 +- .../handlers/plugins/configure-plugins.ts | 2 +- public/app/mock-api-utils.ts | 6 +- yarn.lock | 12 ++ 24 files changed, 408 insertions(+), 50 deletions(-) create mode 100644 packages/grafana-test-utils/CHANGELOG.md create mode 100644 packages/grafana-test-utils/LICENSE_APACHE2 create mode 100644 packages/grafana-test-utils/README.md create mode 100644 packages/grafana-test-utils/package.json create mode 100644 packages/grafana-test-utils/project.json create mode 100644 packages/grafana-test-utils/src/handlers/all-handlers.ts create mode 100644 packages/grafana-test-utils/src/handlers/index.ts create mode 100644 packages/grafana-test-utils/src/index.ts create mode 100644 packages/grafana-test-utils/src/server/index.ts create mode 100644 packages/grafana-test-utils/src/unstable.ts create mode 100644 packages/grafana-test-utils/src/worker/index.ts create mode 100644 packages/grafana-test-utils/tsconfig.json diff --git a/package.json b/package.json index c6f553c907e..030ce866d8b 100644 --- a/package.json +++ b/package.json @@ -85,6 +85,7 @@ "@grafana/eslint-config": "8.0.0", "@grafana/eslint-plugin": "link:./packages/grafana-eslint-rules", "@grafana/plugin-e2e": "2.0.0", + "@grafana/test-utils": "workspace:*", "@grafana/tsconfig": "^2.0.0", "@manypkg/get-packages": "^2.2.0", "@npmcli/package-json": "^5.2.0", diff --git a/packages/grafana-test-utils/CHANGELOG.md b/packages/grafana-test-utils/CHANGELOG.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/packages/grafana-test-utils/LICENSE_APACHE2 b/packages/grafana-test-utils/LICENSE_APACHE2 new file mode 100644 index 00000000000..373dde574a0 --- /dev/null +++ b/packages/grafana-test-utils/LICENSE_APACHE2 @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2015 Grafana Labs + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/grafana-test-utils/README.md b/packages/grafana-test-utils/README.md new file mode 100644 index 00000000000..2e864d4ad7b --- /dev/null +++ b/packages/grafana-test-utils/README.md @@ -0,0 +1,3 @@ +# Grafana test utils + +This package is a collection of test utils and a mock API (using MSW) for use with core Grafana UI development. diff --git a/packages/grafana-test-utils/package.json b/packages/grafana-test-utils/package.json new file mode 100644 index 00000000000..45722bcf530 --- /dev/null +++ b/packages/grafana-test-utils/package.json @@ -0,0 +1,56 @@ +{ + "author": "Grafana Labs", + "license": "Apache-2.0", + "name": "@grafana/test-utils", + "version": "12.0.0-pre", + "private": true, + "description": "Grafana test utils & Mock API", + "keywords": [ + "grafana", + "typescript", + "msw", + "mock api" + ], + "sideEffects": false, + "repository": { + "type": "git", + "url": "http://github.com/grafana/grafana.git", + "directory": "packages/grafana-test-utils" + }, + "main": "src/index.ts", + "types": "src/index.ts", + "module": "src/index.ts", + "exports": { + ".": { + "import": "./src/index.ts", + "require": "./src/index.ts" + }, + "./server": { + "import": "./src/server/index.ts", + "require": "./src/server/index.ts" + }, + "./worker": { + "import": "./src/worker/index.ts", + "require": "./src/worker/index.ts" + }, + "./handlers": { + "import": "./src/handlers/index.ts", + "require": "./src/handlers/index.ts" + }, + "./unstable": { + "import": "./src/unstable.ts", + "require": "./src/unstable.ts" + } + }, + "scripts": { + "typecheck": "tsc --emitDeclarationOnly false --noEmit" + }, + "dependencies": { + "msw": "2.7.0" + }, + "devDependencies": { + "@grafana/tsconfig": "^2.0.0", + "@types/node": "22.12.0", + "typescript": "5.7.3" + } +} diff --git a/packages/grafana-test-utils/project.json b/packages/grafana-test-utils/project.json new file mode 100644 index 00000000000..9d13669dada --- /dev/null +++ b/packages/grafana-test-utils/project.json @@ -0,0 +1,8 @@ +{ + "$schema": "../../node_modules/nx/schemas/project-schema.json", + "projectType": "library", + "tags": ["scope:package", "type:ui"], + "targets": { + "build": {} + } +} diff --git a/packages/grafana-test-utils/src/handlers/all-handlers.ts b/packages/grafana-test-utils/src/handlers/all-handlers.ts new file mode 100644 index 00000000000..be4d730a128 --- /dev/null +++ b/packages/grafana-test-utils/src/handlers/all-handlers.ts @@ -0,0 +1,5 @@ +import { HttpHandler } from 'msw'; + +const allHandlers: HttpHandler[] = []; + +export default allHandlers; diff --git a/packages/grafana-test-utils/src/handlers/index.ts b/packages/grafana-test-utils/src/handlers/index.ts new file mode 100644 index 00000000000..cb0ff5c3b54 --- /dev/null +++ b/packages/grafana-test-utils/src/handlers/index.ts @@ -0,0 +1 @@ +export {}; diff --git a/packages/grafana-test-utils/src/index.ts b/packages/grafana-test-utils/src/index.ts new file mode 100644 index 00000000000..f5d42f308b0 --- /dev/null +++ b/packages/grafana-test-utils/src/index.ts @@ -0,0 +1,8 @@ +/** + * Package containing testing utilities for Grafana, including test render helpers + * and mock API using MSW. + * + * @packageDocumentation + */ + +export {}; diff --git a/packages/grafana-test-utils/src/server/index.ts b/packages/grafana-test-utils/src/server/index.ts new file mode 100644 index 00000000000..746f81cdc5c --- /dev/null +++ b/packages/grafana-test-utils/src/server/index.ts @@ -0,0 +1,36 @@ +import { HttpHandler } from 'msw'; +import { setupServer } from 'msw/node'; + +import allHandlers from '../handlers/all-handlers'; + +const server = setupServer(...allHandlers); + +/** + * Sets up `afterEach`, `beforeAll` and `afterAll` hooks for mock Grafana API server + */ +export function setupMockServer( + /** + * Additional handlers to add to server initialisation. Handlers will be `.use`d in a `beforeEach` hook + */ + additionalHandlers?: HttpHandler[] +) { + if (additionalHandlers) { + beforeEach(() => { + server.use(...additionalHandlers); + }); + } + + afterEach(() => { + server.resetHandlers(); + }); + + beforeAll(() => { + server.listen({ onUnhandledRequest: 'error' }); + }); + + afterAll(() => { + server.close(); + }); +} + +export default server; diff --git a/packages/grafana-test-utils/src/unstable.ts b/packages/grafana-test-utils/src/unstable.ts new file mode 100644 index 00000000000..cb0ff5c3b54 --- /dev/null +++ b/packages/grafana-test-utils/src/unstable.ts @@ -0,0 +1 @@ +export {}; diff --git a/packages/grafana-test-utils/src/worker/index.ts b/packages/grafana-test-utils/src/worker/index.ts new file mode 100644 index 00000000000..f8edb725d6a --- /dev/null +++ b/packages/grafana-test-utils/src/worker/index.ts @@ -0,0 +1,7 @@ +import { setupWorker } from 'msw/browser'; + +import allHandlers from '../handlers/all-handlers'; + +const worker = setupWorker(...allHandlers); + +export default worker; diff --git a/packages/grafana-test-utils/tsconfig.json b/packages/grafana-test-utils/tsconfig.json new file mode 100644 index 00000000000..e787763a1ca --- /dev/null +++ b/packages/grafana-test-utils/tsconfig.json @@ -0,0 +1,19 @@ +{ + "compilerOptions": { + "jsx": "react-jsx", + "declarationDir": "./compiled", + "emitDeclarationOnly": true, + "isolatedModules": true, + "rootDirs": ["."], + "moduleResolution": "bundler" + }, + "ts-node": { + "compilerOptions": { + "module": "ESNext", + "moduleResolution": "Node" + } + }, + "exclude": ["dist/**/*"], + "extends": "@grafana/tsconfig", + "include": ["src/**/*.ts*"] +} diff --git a/public/app/features/alerting/unified/components/rule-editor/DashboardPicker.test.tsx b/public/app/features/alerting/unified/components/rule-editor/DashboardPicker.test.tsx index 0644dc95480..72b3c65cfc8 100644 --- a/public/app/features/alerting/unified/components/rule-editor/DashboardPicker.test.tsx +++ b/public/app/features/alerting/unified/components/rule-editor/DashboardPicker.test.tsx @@ -21,40 +21,41 @@ jest.mock('react-virtualized-auto-sizer', () => { const server = setupMswServer(); -mockDashboardApi(server).search([ - mockDashboardSearchItem({ uid: 'dash-1', type: DashboardSearchItemType.DashDB, title: 'Dashboard 1' }), - mockDashboardSearchItem({ uid: 'dash-2', type: DashboardSearchItemType.DashDB, title: 'Dashboard 2' }), - mockDashboardSearchItem({ uid: 'dash-3', type: DashboardSearchItemType.DashDB, title: 'Dashboard 3' }), -]); - -mockDashboardApi(server).dashboard( - mockDashboardDto({ - uid: 'dash-2', - title: 'Dashboard 2', - panels: [ - { - type: 'graph', - }, - { - type: 'timeseries', - }, - // this one is a library panel - { - type: undefined, - libraryPanel: { - name: 'my library panel', - uid: 'abc123', - }, - }, - ], - }) -); - const ui = { dashboardButton: (name: RegExp) => byRole('button', { name }), }; describe('DashboardPicker', () => { + beforeEach(() => { + mockDashboardApi(server).search([ + mockDashboardSearchItem({ uid: 'dash-1', type: DashboardSearchItemType.DashDB, title: 'Dashboard 1' }), + mockDashboardSearchItem({ uid: 'dash-2', type: DashboardSearchItemType.DashDB, title: 'Dashboard 2' }), + mockDashboardSearchItem({ uid: 'dash-3', type: DashboardSearchItemType.DashDB, title: 'Dashboard 3' }), + ]); + + mockDashboardApi(server).dashboard( + mockDashboardDto({ + uid: 'dash-2', + title: 'Dashboard 2', + panels: [ + { + type: 'graph', + }, + { + type: 'timeseries', + }, + // this one is a library panel + { + type: undefined, + libraryPanel: { + name: 'my library panel', + uid: 'abc123', + }, + }, + ], + }) + ); + }); it('Renders panels without ids', async () => { render(); diff --git a/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.test.tsx b/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.test.tsx index c5923c00c02..35221269d59 100644 --- a/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.test.tsx +++ b/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.test.tsx @@ -84,7 +84,7 @@ const openSilenceDrawer = async () => { await screen.findByText(/Configure silences/i); }; -beforeAll(() => { +beforeEach(() => { grantPermissionsHelper([ AccessControlAction.AlertingRuleCreate, AccessControlAction.AlertingRuleRead, @@ -137,7 +137,7 @@ describe('RuleViewer', () => { ); const mockRuleIdentifier = ruleId.fromCombinedRule('grafana', mockRule); - beforeAll(() => { + beforeEach(() => { grantPermissionsHelper([ AccessControlAction.AlertingRuleCreate, AccessControlAction.AlertingRuleRead, diff --git a/public/app/features/alerting/unified/components/rules/state-history/LokiStateHistory.test.tsx b/public/app/features/alerting/unified/components/rules/state-history/LokiStateHistory.test.tsx index efe536d8fc4..929a17d14af 100644 --- a/public/app/features/alerting/unified/components/rules/state-history/LokiStateHistory.test.tsx +++ b/public/app/features/alerting/unified/components/rules/state-history/LokiStateHistory.test.tsx @@ -33,7 +33,7 @@ jest.mock('react-use', () => { }; }); -beforeAll(() => { +beforeEach(() => { server.use( http.get('/api/v1/rules/history', () => HttpResponse.json({ diff --git a/public/app/features/alerting/unified/hooks/ruleGroup/useDeleteRuleFromGroup.test.tsx b/public/app/features/alerting/unified/hooks/ruleGroup/useDeleteRuleFromGroup.test.tsx index 990f450e5e2..538d02d1a38 100644 --- a/public/app/features/alerting/unified/hooks/ruleGroup/useDeleteRuleFromGroup.test.tsx +++ b/public/app/features/alerting/unified/hooks/ruleGroup/useDeleteRuleFromGroup.test.tsx @@ -2,10 +2,11 @@ import { HttpResponse } from 'msw'; import { render } from 'test/test-utils'; import { byRole, byText } from 'testing-library-selector'; +import server from '@grafana/test-utils/server'; import { AccessControlAction } from 'app/types'; import { CombinedRule } from 'app/types/unified-alerting'; -import server, { setupMswServer } from '../../mockApi'; +import { setupMswServer } from '../../mockApi'; import { grantUserPermissions, mockCombinedRule, diff --git a/public/app/features/alerting/unified/mockApi.ts b/public/app/features/alerting/unified/mockApi.ts index 3a9260d44ba..ae0e9c385b0 100644 --- a/public/app/features/alerting/unified/mockApi.ts +++ b/public/app/features/alerting/unified/mockApi.ts @@ -1,7 +1,8 @@ import { HttpResponse, http } from 'msw'; -import { SetupServer, setupServer } from 'msw/node'; +import { SetupServer } from 'msw/node'; import { setBackendSrv } from '@grafana/runtime'; +import server, { setupMockServer } from '@grafana/test-utils/server'; import allHandlers from 'app/features/alerting/unified/mocks/server/all-handlers'; import { setupAlertmanagerConfigMapDefaultState, @@ -239,31 +240,22 @@ export function mockDashboardApi(server: SetupServer) { }; } -const server = setupServer(...allHandlers); - /** - * Sets up beforeAll, afterAll and beforeEach handlers for mock server + * Sets up MSW server with additional handlers for Alerting tests */ export function setupMswServer() { + setupMockServer(allHandlers); + beforeAll(() => { setBackendSrv(backendSrv); - server.listen({ onUnhandledRequest: 'error' }); }); afterEach(() => { - server.resetHandlers(); - // Reset any other necessary mock entities/state setupAlertmanagerConfigMapDefaultState(); setupAlertmanagerStatusMapDefaultState(); resetRoutingTreeMap(); }); - afterAll(() => { - server.close(); - }); - return server; } - -export default server; diff --git a/public/app/features/alerting/unified/mocks/server/all-handlers.ts b/public/app/features/alerting/unified/mocks/server/all-handlers.ts index dea8ac60454..3ba917541e8 100644 --- a/public/app/features/alerting/unified/mocks/server/all-handlers.ts +++ b/public/app/features/alerting/unified/mocks/server/all-handlers.ts @@ -22,6 +22,7 @@ import silenceHandlers from 'app/features/alerting/unified/mocks/server/handlers /** * Array of all mock handlers that are required across Alerting tests + * @deprecated Move to `@grafana/test-utils` instead */ const allHandlers = [ ...accessControlHandlers, diff --git a/public/app/features/alerting/unified/mocks/server/configure.ts b/public/app/features/alerting/unified/mocks/server/configure.ts index ceed4471e0c..dd6a1fc0eb6 100644 --- a/public/app/features/alerting/unified/mocks/server/configure.ts +++ b/public/app/features/alerting/unified/mocks/server/configure.ts @@ -1,7 +1,7 @@ import { HttpResponse, HttpResponseResolver, PathParams, http } from 'msw'; import { config } from '@grafana/runtime'; -import server from 'app/features/alerting/unified/mockApi'; +import server from '@grafana/test-utils/server'; import { mockDataSource, mockFolder } from 'app/features/alerting/unified/mocks'; import { getAlertmanagerConfigHandler, diff --git a/public/app/features/alerting/unified/mocks/server/events.ts b/public/app/features/alerting/unified/mocks/server/events.ts index a3729a14c61..0607077e5b3 100644 --- a/public/app/features/alerting/unified/mocks/server/events.ts +++ b/public/app/features/alerting/unified/mocks/server/events.ts @@ -1,7 +1,7 @@ import { HttpHandler, matchRequestUrl } from 'msw'; import { JsonValue } from 'type-fest'; -import server from 'app/features/alerting/unified/mockApi'; +import server from '@grafana/test-utils/server'; type PredicateFn = (request: Request) => boolean; diff --git a/public/app/features/alerting/unified/mocks/server/handlers/plugins/configure-plugins.ts b/public/app/features/alerting/unified/mocks/server/handlers/plugins/configure-plugins.ts index 1168241eaca..9f5edafd26a 100644 --- a/public/app/features/alerting/unified/mocks/server/handlers/plugins/configure-plugins.ts +++ b/public/app/features/alerting/unified/mocks/server/handlers/plugins/configure-plugins.ts @@ -1,5 +1,5 @@ +import server from '@grafana/test-utils/server'; import { OnCallIntegrationDTO } from 'app/features/alerting/unified/api/onCallApi'; -import server from 'app/features/alerting/unified/mockApi'; import { getFeaturesHandler, getOnCallIntegrationsHandler, diff --git a/public/app/mock-api-utils.ts b/public/app/mock-api-utils.ts index 7141b62b2d3..b530978d013 100644 --- a/public/app/mock-api-utils.ts +++ b/public/app/mock-api-utils.ts @@ -22,7 +22,11 @@ export const toggleMockApiAndReload = () => { export const potentiallySetupMockApi = async () => { const mockApiEnabled = currentMockApiState(); if (process.env.NODE_ENV === 'development' && mockApiEnabled) { - const { default: worker } = await import('test/mock-api/worker'); + const { default: worker } = await import('@grafana/test-utils/worker'); + + // TODO: Generalise and move Alerting handlers into @grafana/test-utils or @grafana/alerting package + const { default: alertingHandlers } = await import('./features/alerting/unified/mocks/server/all-handlers'); + worker.use(...alertingHandlers); worker.start({ onUnhandledRequest: 'bypass' }); } diff --git a/yarn.lock b/yarn.lock index 3339a92e741..7f27a5d7b99 100644 --- a/yarn.lock +++ b/yarn.lock @@ -3575,6 +3575,17 @@ __metadata: languageName: unknown linkType: soft +"@grafana/test-utils@workspace:*, @grafana/test-utils@workspace:packages/grafana-test-utils": + version: 0.0.0-use.local + resolution: "@grafana/test-utils@workspace:packages/grafana-test-utils" + dependencies: + "@grafana/tsconfig": "npm:^2.0.0" + "@types/node": "npm:22.12.0" + msw: "npm:2.7.0" + typescript: "npm:5.7.3" + languageName: unknown + linkType: soft + "@grafana/tsconfig@npm:^2.0.0": version: 2.0.0 resolution: "@grafana/tsconfig@npm:2.0.0" @@ -17704,6 +17715,7 @@ __metadata: "@grafana/scenes-react": "npm:6.10.4" "@grafana/schema": "workspace:*" "@grafana/sql": "workspace:*" + "@grafana/test-utils": "workspace:*" "@grafana/tsconfig": "npm:^2.0.0" "@grafana/ui": "workspace:*" "@hello-pangea/dnd": "npm:17.0.0"