@grafana/plugin-e2e 1.3.2 → 1.4.0-canary.779.878465c.0

package/dist/e2e-selectors/types.d.ts

@@ -4,6 +4,9 @@ export type E2ESelectors = {
     apis: APIs;
 };
 export type APIs = {
+    Alerting: {
+        eval: string;
+    };
     DataSource: {
         resourcePattern: string;
         resourceUIDPattern: string;
@@ -78,11 +81,27 @@ export type Components = {
     RefreshPicker: {
         runButtonV2: string;
     };
+    QueryTab: {
+        addQuery: string;
+        addExpression: string;
+    };
     QueryEditorRows: {
         rows: string;
     };
     QueryEditorRow: {
         title: (refId: string) => string;
+        actionButton: (title: string) => string;
+    };
+    AlertRules: {
+        previewButton: string;
+        ruleNameField: string;
+        newFolderButton: string;
+        newFolderNameCreateButton: string;
+        newEvaluationGroupButton: string;
+        newFolderNameField: string;
+        newEvaluationGroupName: string;
+        newEvaluationGroupInterval: string;
+        newEvaluationGroupCreate: string;
     };
     Alert: {
         alertV2: (severity: string) => string;
@@ -130,6 +149,14 @@ export type Pages = {
     Home: {
         url: string;
     };
+    Alerting: {
+        AddAlertRule: {
+            url: string;
+        };
+        EditAlertRule: {
+            url: (alertRuleUid: string) => string;
+        };
+    };
     DataSource: {
         name: string;
         delete: string;

package/dist/e2e-selectors/versioned/apis.d.ts

@@ -1,4 +1,9 @@
 export declare const versionedAPIs: {
+    Alerting: {
+        eval: {
+            "8.0.0": string;
+        };
+    };
     DataSource: {
         resourcePattern: {
             "8.0.0": string;

package/dist/e2e-selectors/versioned/apis.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.versionedAPIs = void 0;
 const constants_1 = require("./constants");
 exports.versionedAPIs = {
+    Alerting: {
+        eval: {
+            [constants_1.MIN_GRAFANA_VERSION]: '/api/v1/eval',
+        },
+    },
     DataSource: {
         resourcePattern: {
             [constants_1.MIN_GRAFANA_VERSION]: '/api/datasources/*/resources',

package/dist/e2e-selectors/versioned/components.d.ts

@@ -128,6 +128,16 @@ export declare const versionedComponents: {
             "8.0.0": string;
         };
     };
+    QueryTab: {
+        addQuery: {
+            '10.2.0': string;
+            "8.0.0": string;
+        };
+        addExpression: {
+            '11.0.0': string;
+            '9.5.2': string;
+        };
+    };
     QueryEditorRows: {
         rows: {
             "8.0.0": string;
@@ -137,6 +147,39 @@ export declare const versionedComponents: {
         title: {
             "8.0.0": (refId: string) => string;
         };
+        actionButton: {
+            '10.4.0': (title: string) => string;
+            "8.0.0": (title: string) => string;
+        };
+    };
+    AlertRules: {
+        previewButton: {
+            '11.1.0': string;
+        };
+        ruleNameField: {
+            '11.1.0': string;
+        };
+        newFolderButton: {
+            '11.1.0': string;
+        };
+        newFolderNameField: {
+            '11.1.0': string;
+        };
+        newFolderNameCreateButton: {
+            '11.1.0': string;
+        };
+        newEvaluationGroupButton: {
+            '11.1.0': string;
+        };
+        newEvaluationGroupName: {
+            '11.1.0': string;
+        };
+        newEvaluationGroupInterval: {
+            '11.1.0': string;
+        };
+        newEvaluationGroupCreate: {
+            '11.1.0': string;
+        };
     };
     Alert: {
         alertV2: {

package/dist/e2e-selectors/versioned/components.js

@@ -127,6 +127,16 @@ exports.versionedComponents = {
             [constants_1.MIN_GRAFANA_VERSION]: 'RefreshPicker run button',
         },
     },
+    QueryTab: {
+        addQuery: {
+            '10.2.0': 'data-testid query-tab-add-query',
+            [constants_1.MIN_GRAFANA_VERSION]: 'Query editor add query button',
+        },
+        addExpression: {
+            '11.0.0': 'data-testid query-tab-add-expression',
+            '9.5.2': 'query-tab-add-expression',
+        },
+    },
     QueryEditorRows: {
         rows: {
             [constants_1.MIN_GRAFANA_VERSION]: 'Query editor row',
@@ -136,6 +146,21 @@ exports.versionedComponents = {
         title: {
             [constants_1.MIN_GRAFANA_VERSION]: (refId) => `Query editor row title ${refId}`,
         },
+        actionButton: {
+            '10.4.0': (title) => `data-testid ${title}`,
+            [constants_1.MIN_GRAFANA_VERSION]: (title) => `${title}`,
+        },
+    },
+    AlertRules: {
+        previewButton: { '11.1.0': 'data-testid alert-rule preview-button' },
+        ruleNameField: { '11.1.0': 'data-testid alert-rule name-field' },
+        newFolderButton: { '11.1.0': 'data-testid alert-rule new-folder-button' },
+        newFolderNameField: { '11.1.0': 'data-testid alert-rule name-folder-name-field' },
+        newFolderNameCreateButton: { '11.1.0': 'data-testid alert-rule name-folder-name-create-button' },
+        newEvaluationGroupButton: { '11.1.0': 'data-testid alert-rule new-evaluation-group-button' },
+        newEvaluationGroupName: { '11.1.0': 'data-testid alert-rule new-evaluation-group-name' },
+        newEvaluationGroupInterval: { '11.1.0': 'data-testid alert-rule new-evaluation-group-interval' },
+        newEvaluationGroupCreate: { '11.1.0': 'data-testid alert-rule new-evaluation-group-create-button' },
     },
     Alert: {
         alertV2: {

package/dist/e2e-selectors/versioned/pages.d.ts

@@ -4,6 +4,19 @@ export declare const versionedPages: {
             "8.0.0": string;
         };
     };
+    Alerting: {
+        AddAlertRule: {
+            url: {
+                "10.1.0": string;
+                "8.0.0": string;
+            };
+        };
+        EditAlertRule: {
+            url: {
+                "8.0.0": (alertRuleUid: string) => string;
+            };
+        };
+    };
     DataSource: {
         saveAndTest: {
             '10.0.0': string;

package/dist/e2e-selectors/versioned/pages.js

@@ -8,6 +8,19 @@ exports.versionedPages = {
             [constants_1.MIN_GRAFANA_VERSION]: '/',
         },
     },
+    Alerting: {
+        AddAlertRule: {
+            url: {
+                ['10.1.0']: '/alerting/new/alerting',
+                [constants_1.MIN_GRAFANA_VERSION]: '/alerting/new',
+            },
+        },
+        EditAlertRule: {
+            url: {
+                [constants_1.MIN_GRAFANA_VERSION]: (alertRuleUid) => `alerting/${alertRuleUid}/edit`,
+            },
+        },
+    },
     DataSource: {
         saveAndTest: {
             '10.0.0': 'data-testid Data source settings page Save and Test button',

package/dist/fixtures/alertRuleEditPage.d.ts

@@ -0,0 +1,6 @@
+import { TestFixture } from '@playwright/test';
+import { AlertRuleEditPage } from '../models/pages/AlertRuleEditPage';
+import { PlaywrightArgs } from '../types';
+type AlertRuleEditPageFixture = TestFixture<AlertRuleEditPage, PlaywrightArgs>;
+export declare const alertRuleEditPage: AlertRuleEditPageFixture;
+export {};

package/dist/fixtures/alertRuleEditPage.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.alertRuleEditPage = void 0;
+const semver = __importStar(require("semver"));
+const AlertRuleEditPage_1 = require("../models/pages/AlertRuleEditPage");
+const alertRuleEditPage = async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
+    if (semver.lt(grafanaVersion, '9.5.0')) {
+        console.log('Testing alert rules with plugin-e2e is only supported for Grafana 9.5.0 and later. Checkout https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/test-a-data-source-plugin/annotation-queries#test-the-entire-annotation-query-execution-flow to see how to skip tests for a range of Grafana versions.');
+    }
+    const alertRuleEditPage = new AlertRuleEditPage_1.AlertRuleEditPage({ page, selectors, grafanaVersion, request, testInfo });
+    await alertRuleEditPage.goto();
+    await use(alertRuleEditPage);
+};
+exports.alertRuleEditPage = alertRuleEditPage;

package/dist/fixtures/commands/gotoAlertRuleEditPage.d.ts

@@ -0,0 +1,6 @@
+import { TestFixture } from '@playwright/test';
+import { AlertRuleArgs, PlaywrightArgs } from '../../types';
+import { AlertRuleEditPage } from '../../models/pages/AlertRuleEditPage';
+type GotoAlertRuleEditPageFixture = TestFixture<(args: AlertRuleArgs) => Promise<AlertRuleEditPage>, PlaywrightArgs>;
+export declare const gotoAlertRuleEditPage: GotoAlertRuleEditPageFixture;
+export {};

package/dist/fixtures/commands/gotoAlertRuleEditPage.js

@@ -0,0 +1,39 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gotoAlertRuleEditPage = void 0;
+const semver = __importStar(require("semver"));
+const AlertRuleEditPage_1 = require("../../models/pages/AlertRuleEditPage");
+const gotoAlertRuleEditPage = async ({ request, page, selectors, grafanaVersion }, use, testInfo) => {
+    await use(async (args) => {
+        if (semver.lt(grafanaVersion, '9.5.0')) {
+            console.log('Testing alert rules with plugin-e2e is only supported for Grafana 9.4.0 and later. Checkout https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/test-a-data-source-plugin/annotation-queries#test-the-entire-annotation-query-execution-flow to see how to skip tests for a range of Grafana versions.');
+        }
+        const alertRuleEditPage = new AlertRuleEditPage_1.AlertRuleEditPage({ page, selectors, grafanaVersion, request, testInfo }, args);
+        await alertRuleEditPage.goto();
+        return alertRuleEditPage;
+    });
+};
+exports.gotoAlertRuleEditPage = gotoAlertRuleEditPage;

package/dist/fixtures/commands/readProvisionedAlertRule.d.ts

@@ -0,0 +1,5 @@
+import { TestFixture } from '@playwright/test';
+import { AlertRule, PlaywrightArgs, ReadProvisionedAlertRuleArgs } from '../../types';
+type ReadProvisionedAlertRuleFixture = TestFixture<(args: ReadProvisionedAlertRuleArgs) => Promise<AlertRule>, PlaywrightArgs>;
+export declare const readProvisionedAlertRule: ReadProvisionedAlertRuleFixture;
+export {};

package/dist/fixtures/commands/readProvisionedAlertRule.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readProvisionedAlertRule = void 0;
+const path_1 = __importDefault(require("path"));
+const yaml_1 = require("yaml");
+const fs_1 = require("fs");
+const ALERTING_DIR = 'alerting';
+const readProvisionedAlertRule = async ({ provisioningRootDir }, use) => {
+    await use(async ({ fileName, groupName, ruleTitle }) => {
+        const resolvedPath = path_1.default.resolve(path_1.default.join(provisioningRootDir, ALERTING_DIR, fileName));
+        const contents = await fs_1.promises.readFile(resolvedPath, 'utf8');
+        const yml = (0, yaml_1.parse)(contents);
+        let group = yml.groups[0];
+        if (groupName) {
+            group = yml.groups.find((group) => group.name === groupName);
+        }
+        let rule = group.rules[0];
+        if (ruleTitle) {
+            rule = group.rules.find((rule) => rule.title === ruleTitle);
+        }
+        return rule;
+    });
+};
+exports.readProvisionedAlertRule = readProvisionedAlertRule;

package/dist/index.js

@@ -26,10 +26,12 @@ const gotoAppPage_1 = require("./fixtures/commands/gotoAppPage");
 const gotoDashboardPage_1 = require("./fixtures/commands/gotoDashboardPage");
 const gotoDataSourceConfigPage_1 = require("./fixtures/commands/gotoDataSourceConfigPage");
 const gotoPanelEditPage_1 = require("./fixtures/commands/gotoPanelEditPage");
+const gotoAlertRuleEditPage_1 = require("./fixtures/commands/gotoAlertRuleEditPage");
 const gotoVariableEditPage_1 = require("./fixtures/commands/gotoVariableEditPage");
 const login_1 = require("./fixtures/commands/login");
 const readProvisionedDashboard_1 = require("./fixtures/commands/readProvisionedDashboard");
 const readProvisionedDataSource_1 = require("./fixtures/commands/readProvisionedDataSource");
+const readProvisionedAlertRule_1 = require("./fixtures/commands/readProvisionedAlertRule");
 const dashboardPage_1 = require("./fixtures/dashboardPage");
 const explorePage_1 = require("./fixtures/explorePage");
 const grafanaVersion_1 = require("./fixtures/grafanaVersion");
@@ -38,6 +40,7 @@ const page_1 = require("./fixtures/page");
 const panelEditPage_1 = require("./fixtures/panelEditPage");
 const selectors_1 = require("./fixtures/selectors");
 const variableEditPage_1 = require("./fixtures/variableEditPage");
+const alertRuleEditPage_1 = require("./fixtures/alertRuleEditPage");
 const options_1 = require("./options");
 const toHaveAlert_1 = require("./matchers/toHaveAlert");
 const toDisplayPreviews_1 = require("./matchers/toDisplayPreviews");
@@ -87,9 +90,11 @@ exports.test = test_1.test.extend({
     panelEditPage: panelEditPage_1.panelEditPage,
     variableEditPage: variableEditPage_1.variableEditPage,
     annotationEditPage: annotationEditPage_1.annotationEditPage,
+    alertRuleEditPage: alertRuleEditPage_1.alertRuleEditPage,
     explorePage: explorePage_1.explorePage,
     createDataSource: createDataSource_1.createDataSource,
     readProvisionedDataSource: readProvisionedDataSource_1.readProvisionedDataSource,
+    readProvisionedAlertRule: readProvisionedAlertRule_1.readProvisionedAlertRule,
     readProvisionedDashboard: readProvisionedDashboard_1.readProvisionedDashboard,
     isFeatureToggleEnabled: isFeatureToggleEnabled_1.isFeatureToggleEnabled,
     createUser: createUser_1.createUser,
@@ -97,6 +102,7 @@ exports.test = test_1.test.extend({
     gotoPanelEditPage: gotoPanelEditPage_1.gotoPanelEditPage,
     gotoVariableEditPage: gotoVariableEditPage_1.gotoVariableEditPage,
     gotoAnnotationEditPage: gotoAnnotationEditPage_1.gotoAnnotationEditPage,
+    gotoAlertRuleEditPage: gotoAlertRuleEditPage_1.gotoAlertRuleEditPage,
     gotoDataSourceConfigPage: gotoDataSourceConfigPage_1.gotoDataSourceConfigPage,
     gotoAppConfigPage: gotoAppConfigPage_1.gotoAppConfigPage,
     gotoAppPage: gotoAppPage_1.gotoAppPage,

package/dist/models/components/AlertRuleQuery.d.ts

@@ -0,0 +1,11 @@
+import { DataSourcePicker } from './DataSourcePicker';
+import { getByGrafanaSelectorOptions, PluginTestCtx } from '../../types';
+import { GrafanaPage } from '../pages/GrafanaPage';
+import { Locator } from '@playwright/test';
+export declare class AlertRuleQuery extends GrafanaPage {
+    readonly ctx: PluginTestCtx;
+    readonly locator: Locator;
+    datasource: DataSourcePicker;
+    constructor(ctx: PluginTestCtx, locator: Locator);
+    getByGrafanaSelector(selector: string, options?: getByGrafanaSelectorOptions): Locator;
+}

package/dist/models/components/AlertRuleQuery.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertRuleQuery = void 0;
+const DataSourcePicker_1 = require("./DataSourcePicker");
+const GrafanaPage_1 = require("../pages/GrafanaPage");
+class AlertRuleQuery extends GrafanaPage_1.GrafanaPage {
+    ctx;
+    locator;
+    datasource;
+    constructor(ctx, locator) {
+        super(ctx);
+        this.ctx = ctx;
+        this.locator = locator;
+        this.datasource = new DataSourcePicker_1.DataSourcePicker(ctx, locator);
+    }
+    getByGrafanaSelector(selector, options = {}) {
+        return super.getByGrafanaSelector(selector, {
+            root: this.locator,
+            ...options,
+        });
+    }
+}
+exports.AlertRuleQuery = AlertRuleQuery;

package/dist/models/components/DataSourcePicker.d.ts

@@ -1,7 +1,9 @@
+import { Locator } from '@playwright/test';
 import { PluginTestCtx } from '../../types';
 import { GrafanaPage } from '../pages/GrafanaPage';
 export declare class DataSourcePicker extends GrafanaPage {
-    constructor(ctx: PluginTestCtx);
+    private root?;
+    constructor(ctx: PluginTestCtx, root?: Locator | undefined);
     /**
      * Sets the data source picker to the provided name
      */

package/dist/models/components/DataSourcePicker.js

@@ -3,14 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataSourcePicker = void 0;
 const GrafanaPage_1 = require("../pages/GrafanaPage");
 class DataSourcePicker extends GrafanaPage_1.GrafanaPage {
-    constructor(ctx) {
+    root;
+    constructor(ctx, root) {
         super(ctx);
+        this.root = root;
     }
     /**
      * Sets the data source picker to the provided name
      */
     async set(name) {
-        await this.getByGrafanaSelector(this.ctx.selectors.components.DataSourcePicker.container)
+        await this.getByGrafanaSelector(this.ctx.selectors.components.DataSourcePicker.container, { root: this.root })
             .locator('input')
             .fill(name);
         // this is a hack to get the selection to work in 10.ish versions of Grafana.

package/dist/models/components/Panel.js

@@ -70,11 +70,11 @@ class Panel extends GrafanaPage_1.GrafanaPage {
         // before 9.5.0, there were no proper selectors for the panel menu items
         if (semver.lt(this.ctx.grafanaVersion, '9.5.0')) {
             panelMenu = this.locator.getByRole('heading');
-            parentMenuItem = this.ctx.page.getByText(options?.parentItem ?? '');
-            menuItem = this.ctx.page.getByRole('menu').getByText(item);
+            this.ctx.page.locator(`[aria-label="Panel header item ${options?.parentItem}"]`);
+            this.ctx.page.locator(`[aria-label="Panel header item ${item}"]`);
         }
         await panelMenu.click({ force: true });
-        options?.parentItem && (await parentMenuItem.hover());
+        options?.parentItem && parentMenuItem.hover();
         await menuItem.click();
     }
     /**

package/dist/models/pages/AlertRuleEditPage.d.ts

@@ -0,0 +1,34 @@
+import { AlertRuleArgs, NavigateOptions, PluginTestCtx, RequestOptions } from '../../types';
+import { GrafanaPage } from './GrafanaPage';
+import { AlertRuleQuery } from '../components/AlertRuleQuery';
+export declare class AlertRuleEditPage extends GrafanaPage {
+    readonly ctx: PluginTestCtx;
+    readonly args?: AlertRuleArgs | undefined;
+    constructor(ctx: PluginTestCtx, args?: AlertRuleArgs | undefined);
+    /**
+     * Navigates to the annotation edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
+    goto(options?: NavigateOptions): Promise<void>;
+    /**
+     * Returns a locator for hte alert rule name field
+     */
+    get alertRuleNameField(): import("playwright-core").Locator;
+    /**
+     * Returns an instance of the {@link AlertRuleQuery} class for the query row with the provided refId.
+     */
+    getAlertRuleQueryRow(refId: string): AlertRuleQuery;
+    /**
+     * Clicks the "Add query" button and returns an instance of the {@link AlertRuleQuery} class for the new query row.
+     */
+    clickAddQueryRow(): Promise<AlertRuleQuery>;
+    /**
+     * Clicks the evaluate button and waits for the evaluation to complete. If the evaluation is successful, the status code of the response is 200.
+     * If one or more queries are invalid, an error status code is returned.
+     *
+     * Note that this method intercepts the response of the alerting evaluation endpoint and returns the status code of the first failed query.
+     * This means that any mocks defined with page.route in your tests will be overriden.
+     *
+     * Only supported for Grafana version 9.5.0 ad later.
+     */
+    evaluate(options?: RequestOptions): Promise<import("playwright-core").Response>;
+}

package/dist/models/pages/AlertRuleEditPage.js

@@ -0,0 +1,119 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertRuleEditPage = void 0;
+const semver = __importStar(require("semver"));
+const GrafanaPage_1 = require("./GrafanaPage");
+const AlertRuleQuery_1 = require("../components/AlertRuleQuery");
+class AlertRuleEditPage extends GrafanaPage_1.GrafanaPage {
+    ctx;
+    args;
+    constructor(ctx, args) {
+        super(ctx);
+        this.ctx = ctx;
+        this.args = args;
+    }
+    /**
+     * Navigates to the annotation edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
+    async goto(options) {
+        const { AddAlertRule, EditAlertRule } = this.ctx.selectors.pages.Alerting;
+        const url = this.args?.uid ? EditAlertRule.url(this.args.uid) : AddAlertRule.url;
+        return super.navigate(url, options);
+    }
+    /**
+     * Returns a locator for hte alert rule name field
+     */
+    get alertRuleNameField() {
+        if (semver.gte(this.ctx.grafanaVersion, '11.1.0')) {
+            return this.getByGrafanaSelector(this.ctx.selectors.components.AlertRules.ruleNameField);
+        }
+        return this.ctx.page.getByPlaceholder('Give your alert rule a name');
+    }
+    /**
+     * Returns an instance of the {@link AlertRuleQuery} class for the query row with the provided refId.
+     */
+    getAlertRuleQueryRow(refId) {
+        const locator = this.getByGrafanaSelector(this.ctx.selectors.components.QueryEditorRows.rows).filter({
+            has: this.getByGrafanaSelector(this.ctx.selectors.components.QueryEditorRow.title(refId)),
+        });
+        return new AlertRuleQuery_1.AlertRuleQuery(this.ctx, locator);
+    }
+    /**
+     * Clicks the "Add query" button and returns an instance of the {@link AlertRuleQuery} class for the new query row.
+     */
+    async clickAddQueryRow() {
+        await this.getByGrafanaSelector(this.ctx.selectors.components.QueryTab.addQuery).click();
+        const locator = this.getByGrafanaSelector(this.ctx.selectors.components.QueryEditorRows.rows).last();
+        return new AlertRuleQuery_1.AlertRuleQuery(this.ctx, locator);
+    }
+    /**
+     * Clicks the evaluate button and waits for the evaluation to complete. If the evaluation is successful, the status code of the response is 200.
+     * If one or more queries are invalid, an error status code is returned.
+     *
+     * Note that this method intercepts the response of the alerting evaluation endpoint and returns the status code of the first failed query.
+     * This means that any mocks defined with page.route in your tests will be overriden.
+     *
+     * Only supported for Grafana version 9.5.0 ad later.
+     */
+    async evaluate(options) {
+        // it seems like when clicking the evaluate button to quickly after filling in the alert query form, form values have not been propagated to the state, so we wait a bit before clicking
+        await this.ctx.page.waitForTimeout(1000);
+        // Starting from Grafana 10.0.0, the alerting evaluation endpoint started returning errors in a different way.
+        // Even if one or many of the queries is failed, the status code for the http response is 200 so we have to check the status of each query instead.
+        // If at least one query is failed, we the response of the evaluate method is mapped to the status of the first failed query.
+        if (semver.gte(this.ctx.grafanaVersion, '10.0.0')) {
+            this.ctx.page.route(this.ctx.selectors.apis.Alerting.eval, async (route) => {
+                const response = await route.fetch();
+                if (!response.ok()) {
+                    return route.fulfill({ response });
+                }
+                let body = await response.json();
+                const statuses = Object.keys(body.results).map((key) => body.results[key].status);
+                route.fulfill({
+                    response,
+                    status: statuses.every((status) => status >= 200 && status < 300) ? 200 : statuses[0],
+                });
+            });
+        }
+        const responsePromise = this.ctx.page.waitForResponse((resp) => resp.url().includes(this.ctx.selectors.apis.Alerting.eval), options);
+        let evaluateButton = this.getByGrafanaSelector(this.ctx.selectors.components.AlertRules.previewButton);
+        if (semver.lt(this.ctx.grafanaVersion, '11.1.0')) {
+            evaluateButton = this.ctx.page.getByRole('button', { name: 'Preview', exact: true });
+        }
+        const evalReq = this.ctx.page
+            .waitForRequest((req) => req.url().includes(this.ctx.selectors.apis.Alerting.eval), {
+            timeout: 5000,
+        })
+            .catch(async () => {
+            // intermittently, the first click doesn't trigger the request, so in that case we click again
+            await evaluateButton.click();
+        });
+        await evaluateButton.click();
+        await evalReq;
+        return responsePromise;
+    }
+}
+exports.AlertRuleEditPage = AlertRuleEditPage;

package/dist/types.d.ts

@@ -8,6 +8,7 @@ import { DataSourceConfigPage } from './models/pages/DataSourceConfigPage';
 import { ExplorePage } from './models/pages/ExplorePage';
 import { PanelEditPage } from './models/pages/PanelEditPage';
 import { VariableEditPage } from './models/pages/VariableEditPage';
+import { AlertRuleEditPage } from './models/pages/AlertRuleEditPage';
 export type PluginOptions = {
     /**
      * When using the readProvisioning fixture, files will be read from this directory. If no directory is provided,
@@ -149,6 +150,16 @@ export type PluginFixture = {
      * If no name is provided, the first data source in the list of data sources will be returned.
      */
     readProvisionedDataSource<T = {}, S = {}>(args: ReadProvisionedDataSourceArgs): Promise<DataSourceSettings<T, S>>;
+    /**
+     * Fixture command that reads a yaml file in the provisioning/alerting directory.
+     *
+     * The file name should be the name of the file with the .yaml|.yml extension.
+     * If a group name is provided, the first group that matches the name will be returned.
+     * If no group name is provided, the first group in the list of groups will be returned.
+     * If a rule title is provided, the first rule that matches the title will be returned.
+     * If no rule title is provided, the first rule in the group will be returned.
+     */
+    readProvisionedAlertRule(args: ReadProvisionedAlertRuleArgs): Promise<AlertRule>;
     /**
      * Fixture command that reads a dashboard json file in the provisioning/dashboards directory.
      *
@@ -189,6 +200,13 @@ export type PluginFixture = {
      * To load an existing dashboard with an existing annotation, use the {@link gotoAnnotationEditPage} fixture.
      */
     annotationEditPage: AnnotationEditPage;
+    /**
+     * Isolated {@link AlertRuleEditPage} instance for each test.
+     *
+     * When using this fixture in a test, you will get an empty alert rule page form
+     * To load an existing alert rule, use the {@link gotoAlertRulePage} fixture.
+     */
+    alertRuleEditPage: AlertRuleEditPage;
     /**
      * Isolated {@link ExplorePage} instance for each test.
      */
@@ -216,6 +234,10 @@ export type PluginFixture = {
      * Fixture command that navigates an annotation edit page for an already existing annotation query in a dashboard.
      */
     gotoAnnotationEditPage: (args: DashboardEditViewArgs<string>) => Promise<AnnotationEditPage>;
+    /**
+     * Fixture command that navigates to an alert rule edit page for an already existing alert query.
+     */
+    gotoAlertRuleEditPage: (args: AlertRuleArgs) => Promise<AlertRuleEditPage>;
     /**
      * Fixture command that navigates a configuration page for an already existing data source instance.
      */
@@ -258,6 +280,15 @@ export interface DataSourceSettings<T = {}, S = {}> {
     jsonData: T;
     secureJsonData?: S;
 }
+export interface AlertRule {
+    uid: string;
+    title: string;
+    data: Array<{
+        refId: string;
+        datasourceUid: string;
+        model: any;
+    }>;
+}
 /**
  * The dashboard object
  */
@@ -356,19 +387,36 @@ export type DashboardEditViewArgs<T> = {
     dashboard?: DashboardPageArgs;
     id: T;
 };
+export type AlertRuleArgs = {
+    uid: string;
+};
 export type ReadProvisionedDashboardArgs = {
     /**
      * The path, relative to the provisioning folder, to the dashboard json file
      */
     fileName: string;
 };
+export type ReadProvisionedAlertRuleArgs = {
+    /**
+     * The name of the yaml file in the provisioning/alerting folder
+     */
+    fileName: string;
+    /**
+     * The name of the alert group in the groups list. Will use the first group if not provided
+     */
+    groupName?: string;
+    /**
+     * The name of the alert rule in the rules list. Will use the first rule in the group if not provided
+     */
+    ruleTitle?: string;
+};
 export type ReadProvisionedDataSourceArgs = {
     /**
-     * The path, relative to the provisioning folder, to the dashboard json file
+     * The name of the yaml file in the provisioning/datasources folder
      */
     fileName: string;
     /**
-     * The name of the data source in the datasources list
+     * The name of the data source in the datasources list. Will use the first data source if not provided
      */
     name?: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "1.3.2",
+  "version": "1.4.0-canary.779.878465c.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -55,5 +55,5 @@
       "start": "cls || clear"
     }
   },
-  "gitHead": "f40350d6158ef15563f72cf491e2b9eb3eceea15"
+  "gitHead": "878465cc433e2ad6520df388370fc7692542b8ce"
 }