Submit
Path:
~
/
/
usr
/
share
/
grafana
/
public
/
app
/
features
/
alerting
/
unified
/
File Content:
CloneRuleEditor.test.tsx
import 'whatwg-fetch'; import { render, waitFor, waitForElementToBeRemoved, within } from '@testing-library/react'; import { setupServer } from 'msw/node'; import React from 'react'; import { FormProvider, useForm } from 'react-hook-form'; import { TestProvider } from 'test/helpers/TestProvider'; import { byRole, byTestId, byText } from 'testing-library-selector'; import { selectors } from '@grafana/e2e-selectors/src'; import { config, setBackendSrv, setDataSourceSrv } from '@grafana/runtime'; import { backendSrv } from 'app/core/services/backend_srv'; import { DashboardSearchItem, DashboardSearchItemType } from 'app/features/search/types'; import { AlertManagerCortexConfig } from 'app/plugins/datasource/alertmanager/types'; import { RuleWithLocation } from 'app/types/unified-alerting'; import { RulerAlertingRuleDTO, RulerGrafanaRuleDTO, RulerRecordingRuleDTO, RulerRuleDTO, } from '../../../types/unified-alerting-dto'; import { cloneRuleDefinition, CloneRuleEditor } from './CloneRuleEditor'; import { ExpressionEditorProps } from './components/rule-editor/ExpressionEditor'; import { mockSearchApi } from './mockApi'; import { mockDataSource, MockDataSourceSrv, mockRulerAlertingRule, mockRulerGrafanaRule, mockRulerRuleGroup, mockStore, } from './mocks'; import { mockAlertmanagerConfigResponse } from './mocks/alertmanagerApi'; import { mockRulerRulesApiResponse, mockRulerRulesGroupApiResponse } from './mocks/rulerApi'; import { AlertingQueryRunner } from './state/AlertingQueryRunner'; import { RuleFormValues } from './types/rule-form'; import { Annotation } from './utils/constants'; import { GRAFANA_RULES_SOURCE_NAME } from './utils/datasource'; import { getDefaultFormValues } from './utils/rule-form'; import { hashRulerRule } from './utils/rule-id'; jest.mock('./components/rule-editor/ExpressionEditor', () => ({ // eslint-disable-next-line react/display-name ExpressionEditor: ({ value, onChange }: ExpressionEditorProps) => ( <input value={value} data-testid="expr" onChange={(e) => onChange(e.target.value)} /> ), })); // For simplicity of the test we mock the NotificationPreview component // Otherwise we would need to mock a few more HTTP api calls which are not relevant for these tests jest.mock('./components/rule-editor/notificaton-preview/NotificationPreview', () => ({ NotificationPreview: () => <div />, })); jest.spyOn(AlertingQueryRunner.prototype, 'run').mockImplementation(() => Promise.resolve()); const server = setupServer(); beforeAll(() => { setBackendSrv(backendSrv); server.listen({ onUnhandledRequest: 'error' }); }); beforeEach(() => { server.resetHandlers(); }); afterAll(() => { server.close(); }); const ui = { inputs: { name: byRole('textbox', { name: 'name' }), expr: byTestId('expr'), folderContainer: byTestId(selectors.components.FolderPicker.containerV2), namespace: byTestId('namespace-picker'), group: byTestId('group-picker'), annotationValue: (idx: number) => byTestId(`annotation-value-${idx}`), labelValue: (idx: number) => byTestId(`label-value-${idx}`), }, loadingIndicator: byText('Loading the rule'), }; function getProvidersWrapper() { return function Wrapper({ children }: React.PropsWithChildren<{}>) { const store = mockStore((store) => { store.unifiedAlerting.dataSources['grafana'] = { loading: false, dispatched: true, result: { id: 'grafana', name: 'grafana', rulerConfig: { dataSourceName: 'grafana', apiVersion: 'legacy', }, }, }; store.unifiedAlerting.dataSources['my-prom-ds'] = { loading: false, dispatched: true, result: { id: 'my-prom-ds', name: 'my-prom-ds', rulerConfig: { dataSourceName: 'my-prom-ds', apiVersion: 'config', }, }, }; }); const formApi = useForm<RuleFormValues>({ defaultValues: getDefaultFormValues() }); return ( <TestProvider store={store}> <FormProvider {...formApi}>{children}</FormProvider> </TestProvider> ); }; } const amConfig: AlertManagerCortexConfig = { alertmanager_config: { receivers: [{ name: 'default' }, { name: 'critical' }], route: { receiver: 'default', group_by: ['alertname'], routes: [ { matchers: ['env=prod', 'region!=EU'], }, ], }, templates: [], }, template_files: {}, }; describe('CloneRuleEditor', function () { describe('Grafana-managed rules', function () { it('should populate form values from the existing alert rule', async function () { setDataSourceSrv(new MockDataSourceSrv({})); const originRule: RulerGrafanaRuleDTO = mockRulerGrafanaRule( { for: '1m', labels: { severity: 'critical', region: 'nasa' }, annotations: { [Annotation.summary]: 'This is a very important alert rule' }, }, { uid: 'grafana-rule-1', title: 'First Grafana Rule', data: [] } ); mockRulerRulesApiResponse(server, 'grafana', { 'folder-one': [{ name: 'group1', interval: '20s', rules: [originRule] }], }); mockSearchApi(server).search([ mockDashboardSearchItem({ title: 'folder-one', uid: '123', type: DashboardSearchItemType.DashDB }), ]); mockAlertmanagerConfigResponse(server, GRAFANA_RULES_SOURCE_NAME, amConfig); render(<CloneRuleEditor sourceRuleId={{ uid: 'grafana-rule-1', ruleSourceName: 'grafana' }} />, { wrapper: getProvidersWrapper(), }); await waitForElementToBeRemoved(ui.loadingIndicator.query()); await waitFor(() => { expect(within(ui.inputs.group.get()).queryByTestId('Spinner')).not.toBeInTheDocument(); }); await waitFor(() => { expect(ui.inputs.name.get()).toHaveValue('First Grafana Rule (copy)'); expect(ui.inputs.folderContainer.get()).toHaveTextContent('folder-one'); expect(ui.inputs.group.get()).toHaveTextContent('group1'); expect(ui.inputs.labelValue(0).get()).toHaveTextContent('critical'); expect(ui.inputs.labelValue(1).get()).toHaveTextContent('nasa'); expect(ui.inputs.annotationValue(0).get()).toHaveTextContent('This is a very important alert rule'); }); }); }); describe('Cloud rules', function () { it('should populate form values from the existing alert rule', async function () { const dsSettings = mockDataSource({ name: 'my-prom-ds', uid: 'my-prom-ds', }); config.datasources = { 'my-prom-ds': dsSettings, }; setDataSourceSrv(new MockDataSourceSrv({ 'my-prom-ds': dsSettings })); const originRule = mockRulerAlertingRule({ for: '1m', alert: 'First Ruler Rule', expr: 'vector(1) > 0', labels: { severity: 'critical', region: 'nasa' }, annotations: { [Annotation.summary]: 'This is a very important alert rule' }, }); mockRulerRulesApiResponse(server, 'my-prom-ds', { 'namespace-one': [{ name: 'group1', interval: '20s', rules: [originRule] }], }); mockRulerRulesGroupApiResponse(server, 'my-prom-ds', 'namespace-one', 'group1', { name: 'group1', interval: '20s', rules: [originRule], }); mockSearchApi(server).search([ mockDashboardSearchItem({ title: 'folder-one', uid: '123', type: DashboardSearchItemType.DashDB, folderTitle: 'folder-one', folderUid: '123', }), ]); mockAlertmanagerConfigResponse(server, GRAFANA_RULES_SOURCE_NAME, amConfig); render( <CloneRuleEditor sourceRuleId={{ ruleSourceName: 'my-prom-ds', namespace: 'namespace-one', groupName: 'group1', ruleName: 'First Ruler Rule', rulerRuleHash: hashRulerRule(originRule), }} />, { wrapper: getProvidersWrapper(), } ); await waitForElementToBeRemoved(ui.loadingIndicator.query()); await waitFor(() => { expect(ui.inputs.name.get()).toHaveValue('First Ruler Rule (copy)'); expect(ui.inputs.expr.get()).toHaveValue('vector(1) > 0'); expect(ui.inputs.namespace.get()).toHaveTextContent('namespace-one'); expect(ui.inputs.group.get()).toHaveTextContent('group1'); expect(ui.inputs.labelValue(0).get()).toHaveTextContent('critical'); expect(ui.inputs.labelValue(1).get()).toHaveTextContent('nasa'); expect(ui.inputs.annotationValue(0).get()).toHaveTextContent('This is a very important alert rule'); }); }); }); describe('cloneRuleDefinition', () => { it("Should change the cloned rule's name accordingly for Grafana rules", () => { const rule: RulerGrafanaRuleDTO = mockRulerGrafanaRule( { for: '1m', labels: { severity: 'critical', region: 'nasa' }, annotations: { [Annotation.summary]: 'This is a very important alert rule' }, }, { uid: 'grafana-rule-1', title: 'First Grafana Rule', data: [] } ); const originalRule: RuleWithLocation<RulerGrafanaRuleDTO> = { ruleSourceName: 'my-prom-ds', namespace: 'namespace-one', group: mockRulerRuleGroup(), rule, }; const clonedRule: RuleWithLocation<RulerRuleDTO> = cloneRuleDefinition(originalRule); const grafanaRule: RulerGrafanaRuleDTO = clonedRule.rule as RulerGrafanaRuleDTO; expect(originalRule.rule.grafana_alert.title).toEqual('First Grafana Rule'); expect(grafanaRule.grafana_alert.title).toEqual('First Grafana Rule (copy)'); }); it("Should change the cloned rule's name accordingly for Ruler rules", () => { const rule: RulerAlertingRuleDTO = mockRulerAlertingRule({ for: '1m', alert: 'First Ruler Rule', expr: 'vector(1) > 0', labels: { severity: 'critical', region: 'nasa' }, annotations: { [Annotation.summary]: 'This is a very important alert rule' }, }); const originalRule: RuleWithLocation<RulerAlertingRuleDTO> = { ruleSourceName: 'my-prom-ds', namespace: 'namespace-one', group: mockRulerRuleGroup(), rule, }; const clonedRule: RuleWithLocation<RulerRuleDTO> = cloneRuleDefinition(originalRule); const alertingRule: RulerAlertingRuleDTO = clonedRule.rule as RulerAlertingRuleDTO; expect(originalRule.rule.alert).toEqual('First Ruler Rule'); expect(alertingRule.alert).toEqual('First Ruler Rule (copy)'); }); it("Should change the cloned rule's name accordingly for Recording rules", () => { const rule: RulerRecordingRuleDTO = { record: 'instance:node_num_cpu:sum', expr: 'count without (cpu) (count without (mode) (node_cpu_seconds_total{job="integrations/node_exporter"}))', labels: { type: 'cpu' }, }; const originalRule: RuleWithLocation<RulerRecordingRuleDTO> = { ruleSourceName: 'my-prom-ds', namespace: 'namespace-one', group: mockRulerRuleGroup(), rule, }; const clonedRule: RuleWithLocation<RulerRuleDTO> = cloneRuleDefinition(originalRule); const recordingRule: RulerRecordingRuleDTO = clonedRule.rule as RulerRecordingRuleDTO; expect(originalRule.rule.record).toEqual('instance:node_num_cpu:sum'); expect(recordingRule.record).toEqual('instance:node_num_cpu:sum (copy)'); }); it('Should remove the group for provisioned Grafana rules', () => { const rule: RulerGrafanaRuleDTO = mockRulerGrafanaRule( { for: '1m', labels: { severity: 'critical', region: 'nasa' }, annotations: { [Annotation.summary]: 'This is a very important alert rule' }, }, { uid: 'grafana-rule-1', title: 'First Grafana Rule', data: [], provenance: 'foo' } ); const originalRule: RuleWithLocation<RulerGrafanaRuleDTO> = { ruleSourceName: 'my-prom-ds', namespace: 'namespace-one', group: mockRulerRuleGroup(), rule, }; const clonedRule: RuleWithLocation<RulerRuleDTO> = cloneRuleDefinition(originalRule); expect(originalRule.group.name).toEqual('group1'); expect(clonedRule.group.name).toEqual(''); }); it('The cloned rule should not contain a UID property', () => { const rule: RulerGrafanaRuleDTO = mockRulerGrafanaRule( { for: '1m', labels: { severity: 'critical', region: 'nasa' }, annotations: { [Annotation.summary]: 'This is a very important alert rule' }, }, { uid: 'grafana-rule-1', title: 'First Grafana Rule', data: [] } ); const originalRule: RuleWithLocation<RulerGrafanaRuleDTO> = { ruleSourceName: 'my-prom-ds', namespace: 'namespace-one', group: mockRulerRuleGroup(), rule, }; const clonedRule: RuleWithLocation<RulerRuleDTO> = cloneRuleDefinition(originalRule); const grafanaRule: RulerGrafanaRuleDTO = clonedRule.rule as RulerGrafanaRuleDTO; expect(originalRule.rule.grafana_alert.uid).toEqual('grafana-rule-1'); expect(grafanaRule.grafana_alert.uid).toEqual(''); }); }); }); function mockDashboardSearchItem(searchItem: Partial<DashboardSearchItem>) { return { title: '', uid: '', type: DashboardSearchItemType.DashDB, url: '', uri: '', items: [], tags: [], slug: '', isStarred: false, ...searchItem, }; }
Submit
FILE
FOLDER
INFO
Name
Size
Permission
Action
__mocks__
---
0755
__snapshots__
---
0755
api
---
0755
components
---
0755
home
---
0755
hooks
---
0755
insights
---
0755
integration
---
0755
mocks
---
0755
search
---
0755
state
---
0755
styles
---
0755
testSetup
---
0755
types
---
0755
utils
---
0755
Admin.tsx
950 bytes
0644
AlertGroups.test.tsx
7318 bytes
0644
AlertGroups.tsx
4151 bytes
0644
AlertWarning.tsx
643 bytes
0644
AlertsFolderView.test.tsx
5384 bytes
0644
AlertsFolderView.tsx
6841 bytes
0644
Analytics.test.ts
1283 bytes
0644
Analytics.ts
6136 bytes
0644
CloneRuleEditor.test.tsx
13662 bytes
0644
CloneRuleEditor.tsx
2563 bytes
0644
ExistingRuleEditor.tsx
2070 bytes
0644
GrafanaRuleQueryViewer.test.tsx
2163 bytes
0644
GrafanaRuleQueryViewer.tsx
15211 bytes
0644
MuteTimings.test.tsx
8845 bytes
0644
MuteTimings.tsx
3375 bytes
0644
NotificationPolicies.test.tsx
28082 bytes
0644
NotificationPolicies.tsx
14112 bytes
0644
PanelAlertTab.tsx
634 bytes
0644
PanelAlertTabContent.test.tsx
10087 bytes
0644
PanelAlertTabContent.tsx
2915 bytes
0644
Receivers.tsx
2183 bytes
0644
RedirectToRuleViewer.test.tsx
6476 bytes
0644
RedirectToRuleViewer.tsx
5092 bytes
0644
RuleEditor.tsx
3860 bytes
0644
RuleEditorCloudOnlyAllowed.test.tsx
7164 bytes
0644
RuleEditorCloudRules.test.tsx
7118 bytes
0644
RuleEditorExisting.test.tsx
8764 bytes
0644
RuleEditorGrafanaRules.test.tsx
8187 bytes
0644
RuleEditorRecordingRule.test.tsx
7031 bytes
0644
RuleList.test.tsx
30652 bytes
0644
RuleList.tsx
7456 bytes
0644
RuleViewer.tsx
2939 bytes
0644
Silences.test.tsx
14125 bytes
0644
Silences.tsx
4613 bytes
0644
TESTING.md
1445 bytes
0644
TODO.md
1411 bytes
0644
createRouteGroupsMatcherWorker.ts
296 bytes
0644
initAlerting.tsx
1151 bytes
0644
mockApi.ts
13689 bytes
0644
mockGrafanaNotifiers.ts
66886 bytes
0644
mocks.ts
18877 bytes
0644
routeGroupsMatcher.ts
2098 bytes
0644
routeGroupsMatcher.worker.ts
338 bytes
0644
useRouteGroupsMatcher.test.tsx
1384 bytes
0644
useRouteGroupsMatcher.ts
3343 bytes
0644
N4ST4R_ID | Naxtarrr