@grafana/plugin-e2e 0.0.2 → 0.0.3-canary.610.b925ceb.0

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { E2ESelectors } from './e2e-selectors/types';
 import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSource, ReadProvisionArgs } from './types';
-import { PanelEditPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage } from './models';
+import { PanelEditPage, GrafanaPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage } from './models';
 import { ExplorePage } from './models/ExplorePage';
 export type PluginOptions = {
     selectorRegistration: void;
@@ -37,5 +37,9 @@ export declare const expect: import("@playwright/test").Expect<{
         actual: boolean;
         message: () => string;
     }>;
+    toHaveAlert: (grafanaPage: GrafanaPage, severity: import("./matchers/toHaveAlert").AlertVariant, options?: import("./types").AlertPageOptions) => Promise<{
+        message: () => any;
+        pass: boolean;
+    }>;
 }>;
 export { selectors } from '@playwright/test';

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

@@ -10,7 +10,7 @@ export type APIs = {
         queryPattern: string;
         query: string;
         health: (uid: string, id: string) => string;
-        delete: (uid: string) => string;
+        datasourceByUID: (uid: string) => string;
     };
     Dashboard: {
         delete: (uid: string) => string;
@@ -190,7 +190,10 @@ export type Components = {
     AlertTab: {
         content: string;
     };
-    Alert: {};
+    Alert: {
+        alert: (severity: string) => string;
+        alertV2: (severity: string) => string;
+    };
     TransformTab: {
         content: string;
     };

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

@@ -17,7 +17,7 @@ export declare const versionedAPIs: {
             "9.5.0": (uid: string, _: string) => string;
             "8.0.0": (_: string, id: string) => string;
         };
-        delete: {
+        datasourceByUID: {
             "8.0.0": (uid: string) => string;
         };
     };

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

@@ -21,7 +21,7 @@ exports.versionedAPIs = {
             ['9.5.0']: (uid, _) => `/api/datasources/uid/${uid}/health`,
             [constants_1.MIN_GRAFANA_VERSION]: (_, id) => `/api/datasources/${id}/health`,
         },
-        delete: {
+        datasourceByUID: {
             [constants_1.MIN_GRAFANA_VERSION]: (uid) => `/api/datasources/uid/${uid}`,
         },
     },

package/dist/matchers/index.d.ts

@@ -16,5 +16,9 @@ declare const _default: {
         actual: boolean;
         message: () => string;
     }>;
+    toHaveAlert: (grafanaPage: import("../models").GrafanaPage, severity: import("./toHaveAlert").AlertVariant, options?: import("../types").AlertPageOptions) => Promise<{
+        message: () => any;
+        pass: boolean;
+    }>;
 };
 export default _default;

package/dist/matchers/index.js

@@ -6,8 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const toBeOK_1 = __importDefault(require("./toBeOK"));
 const toHavePanelError_1 = __importDefault(require("./toHavePanelError"));
 const toDisplayPreviews_1 = __importDefault(require("./toDisplayPreviews"));
+const toHaveAlert_1 = __importDefault(require("./toHaveAlert"));
 exports.default = {
     toBeOK: toBeOK_1.default,
     toHavePanelError: toHavePanelError_1.default,
     toDisplayPreviews: toDisplayPreviews_1.default,
+    toHaveAlert: toHaveAlert_1.default,
 };

package/dist/matchers/toHaveAlert.d.ts

@@ -0,0 +1,8 @@
+import { GrafanaPage } from '../models';
+import { AlertPageOptions } from '../types';
+export type AlertVariant = 'success' | 'warning' | 'error' | 'info';
+declare const toHaveAlert: (grafanaPage: GrafanaPage, severity: AlertVariant, options?: AlertPageOptions) => Promise<{
+    message: () => any;
+    pass: boolean;
+}>;
+export default toHaveAlert;

package/dist/matchers/toHaveAlert.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const test_1 = require("@playwright/test");
+const utils_1 = require("./utils");
+const toHaveAlert = async (grafanaPage, severity, options) => {
+    let pass = true;
+    let message = `An alert of variant ${severity} to be displayed on the page`;
+    try {
+        const filteredAlerts = grafanaPage
+            .getByTestIdOrAriaLabel(grafanaPage.ctx.selectors.components.Alert.alertV2(severity))
+            .filter({
+            hasText: options?.hasText,
+            hasNotText: options?.hasNotText,
+            has: options?.has,
+            hasNot: options?.hasNot,
+        });
+        await (0, test_1.expect)(filteredAlerts.first()).toBeVisible({ timeout: options?.timeout });
+    }
+    catch (err) {
+        message = (0, utils_1.getMessage)(message, `No alert was found on the page: ${err instanceof Error ? err.toString() : ''}`);
+        pass = false;
+    }
+    return {
+        message: () => message,
+        pass,
+    };
+};
+exports.default = toHaveAlert;

package/dist/models/DataSourceConfigPage.d.ts

@@ -1,4 +1,4 @@
-import { DataSource, PluginTestCtx } from '../types';
+import { DataSource, PluginTestCtx, TriggerQueryOptions } from '../types';
 import { GrafanaPage } from './GrafanaPage';
 export declare class DataSourceConfigPage extends GrafanaPage {
     private datasource;
@@ -6,5 +6,5 @@ export declare class DataSourceConfigPage extends GrafanaPage {
     deleteDataSource(): Promise<void>;
     goto(): Promise<void>;
     mockHealthCheckResponse<T = any>(json: T, status?: number): Promise<void>;
-    saveAndTest(): Promise<import("playwright-core").Response>;
+    saveAndTest(options?: TriggerQueryOptions): Promise<void | import("playwright-core").Response>;
 }

package/dist/models/DataSourceConfigPage.js

@@ -9,7 +9,7 @@ class DataSourceConfigPage extends GrafanaPage_1.GrafanaPage {
         this.datasource = datasource;
     }
     async deleteDataSource() {
-        await this.ctx.request.delete(this.ctx.selectors.apis.DataSource.delete(this.datasource.uid));
+        await this.ctx.request.delete(this.ctx.selectors.apis.DataSource.datasourceByUID(this.datasource.uid));
     }
     async goto() {
         await this.ctx.page.goto(this.ctx.selectors.pages.EditDataSource.url(this.datasource.uid), {
@@ -17,16 +17,20 @@ class DataSourceConfigPage extends GrafanaPage_1.GrafanaPage {
         });
     }
     async mockHealthCheckResponse(json, status = 200) {
-        await this.ctx.page.route(`${this.ctx.selectors.apis.DataSource.health}`, async (route) => {
+        await this.ctx.page.route(`${this.ctx.selectors.apis.DataSource.health(this.datasource.uid ?? '', this.datasource.id.toString() ?? '')}`, async (route) => {
             await route.fulfill({ json, status });
         });
     }
-    async saveAndTest() {
-        const responsePromise = this.ctx.page.waitForResponse((resp) => resp
+    async saveAndTest(options) {
+        if (options?.skipWaitForResponse) {
+            return this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.DataSource.saveAndTest).click();
+        }
+        const saveResponsePromise = this.ctx.page.waitForResponse((resp) => resp.url().includes(this.ctx.selectors.apis.DataSource.datasourceByUID(this.datasource.uid)));
+        const healthResponsePromise = this.ctx.page.waitForResponse((resp) => resp
             .url()
             .includes(this.ctx.selectors.apis.DataSource.health(this.datasource.uid ?? '', this.datasource.id.toString() ?? '')));
         await this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.DataSource.saveAndTest).click();
-        return responsePromise;
+        return saveResponsePromise.then(() => healthResponsePromise);
     }
 }
 exports.DataSourceConfigPage = DataSourceConfigPage;

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { PlaywrightTestArgs } from '@playwright/test';
+import { Locator, PlaywrightTestArgs } from '@playwright/test';
 import { E2ESelectors } from './e2e-selectors/types';
 export type PluginTestCtx = {
     grafanaVersion: string;
@@ -51,4 +51,15 @@ export type NavigateOptions = {
     waitUntil?: 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
     queryParams?: URLSearchParams;
 };
+export type TriggerQueryOptions = {
+    skipWaitForResponse: boolean;
+};
 export type Visualization = 'Alert list' | 'Bar gauge' | 'Clock' | 'Dashboard list' | 'Gauge' | 'Graph' | 'Heatmap' | 'Logs' | 'News' | 'Pie Chart' | 'Plugin list' | 'Polystat' | 'Stat' | 'Table' | 'Text' | 'Time series' | 'Worldmap Panel';
+export type AlertVariant = 'success' | 'warning' | 'error' | 'info';
+export interface AlertPageOptions {
+    timeout?: number;
+    has?: Locator;
+    hasNot?: Locator;
+    hasNotText?: string | RegExp;
+    hasText?: string | RegExp;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.0.2",
+  "version": "0.0.3-canary.610.b925ceb.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -44,5 +44,5 @@
     "semver": "^7.5.4",
     "uuid": "^9.0.1"
   },
-  "gitHead": "6ae82da1ba012e5741ec16077ddc0b0ec19f3d03"
+  "gitHead": "b925cebc8843c7fe06312fa52f3dfcc9b38ae475"
 }