@grafana/plugin-e2e 1.1.1 → 1.2.0-canary.779.b3ed39b.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;
@@ -130,6 +133,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/pages.d.ts

@@ -4,6 +4,19 @@ export declare const versionedPages: {
             "8.0.0": string;
         };
     };
+    Alerting: {
+        AddAlertRule: {
+            url: {
+                "10.0.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.0.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,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.alertRuleEditPage = void 0;
+const AlertRuleEditPage_1 = require("../models/pages/AlertRuleEditPage");
+const alertRuleEditPage = async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
+    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,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gotoAlertRuleEditPage = void 0;
+const AlertRuleEditPage_1 = require("../../models/pages/AlertRuleEditPage");
+const gotoAlertRuleEditPage = async ({ request, page, selectors, grafanaVersion }, use, testInfo) => {
+    await use(async (args) => {
+        const alertRuleEditPage = new AlertRuleEditPage_1.AlertRuleEditPage({ page, selectors, grafanaVersion, request, testInfo }, args);
+        await alertRuleEditPage.goto();
+        return alertRuleEditPage;
+    });
+};
+exports.gotoAlertRuleEditPage = gotoAlertRuleEditPage;

package/dist/index.js

@@ -26,6 +26,7 @@ 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");
@@ -38,6 +39,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,6 +89,7 @@ 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,
@@ -97,6 +100,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);
+    }
+    getByGrafanaSelector(selector, options = {}) {
+        return super.getByGrafanaSelector(selector, {
+            root: this.locator,
+            ...options,
+        });
+    }
+}
+exports.AlertRuleQuery = AlertRuleQuery;

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

@@ -0,0 +1,14 @@
+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>;
+    getAlertRuleQueryRow(refId: string): AlertRuleQuery;
+    evaluate(options?: RequestOptions): Promise<import("playwright-core").Response>;
+}

package/dist/models/pages/AlertRuleEditPage.js

@@ -0,0 +1,69 @@
+"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);
+    }
+    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);
+    }
+    async evaluate(options) {
+        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();
+                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);
+        await this.ctx.page.getByRole('button', { name: 'Preview', exact: true }).click();
+        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,
@@ -96,6 +97,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.
      */
@@ -211,6 +219,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.
      */
@@ -350,6 +362,9 @@ 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "1.1.1",
+  "version": "1.2.0-canary.779.b3ed39b.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -55,5 +55,5 @@
       "start": "cls || clear"
     }
   },
-  "gitHead": "8abe46bc597ff004ad174903ec61a005edd262a3"
+  "gitHead": "b3ed39b4063d5ca56412b4014915402dffb94611"
 }