@grafana/plugin-e2e 0.5.0-canary.641.7aa6686.0 → 0.6.0

package/dist/api.d.ts

@@ -141,7 +141,7 @@ export declare const expect: import("@playwright/test").Expect<{
         pass: boolean;
         actual: number;
     }>;
-    toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: (string | RegExp)[]) => Promise<{
+    toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: (string | RegExp)[], options?: import("./types").ContainTextOptions) => Promise<{
         pass: boolean;
         actual: boolean;
         message: () => string;

package/dist/index.d.ts

@@ -1,4 +1,32 @@
+import { GrafanaPage, VariableEditPage } from './models';
+import { AlertPageOptions, AlertVariant, ContainTextOptions, PanelError } from './types';
 export { expect, test, type PluginFixture, type PluginOptions } from './api';
 export * from './e2e-selectors';
 export * from './fixtures';
 export * from './models';
+declare global {
+    namespace PlaywrightTest {
+        const r: unique symbol;
+        const t: unique symbol;
+        interface Matchers<R, T> {
+            [r]: R;
+            [t]: T;
+            /**
+             * Await the response of a Playwright request and asserts the response was successful (status in the range 200-299).
+             */
+            toBeOK(this: Matchers<unknown, Promise<Response>>): R;
+            /**
+             * Asserts that preview text elements are displayed on the Variable Edit Page. You should make sure any variable queries are completed before calling this matcher.
+             */
+            toDisplayPreviews(this: Matchers<unknown, VariableEditPage>, previewTexts: Array<string | RegExp>, options: ContainTextOptions): R;
+            /**
+             * Asserts that a GrafanaPage contains an alert with the specified severity. Use the options to specify the timeout and to filter the alerts.
+             */
+            toHaveAlert(this: Matchers<unknown, GrafanaPage>, severity: AlertVariant, options?: AlertPageOptions): R;
+            /**
+             * Asserts that the number of panel errors displayed on the page is equal to 1.
+             */
+            toHavePanelError(this: Matchers<unknown, PanelError>): R;
+        }
+    }
+}

package/dist/matchers/index.d.ts

@@ -11,7 +11,7 @@ declare const _default: {
         pass: boolean;
         actual: number;
     }>;
-    toDisplayPreviews: (variableEditPage: import("..").VariableEditPage, previewTexts: (string | RegExp)[]) => Promise<{
+    toDisplayPreviews: (variableEditPage: import("..").VariableEditPage, previewTexts: (string | RegExp)[], options?: import("../types").ContainTextOptions) => Promise<{
         pass: boolean;
         actual: boolean;
         message: () => string;

package/dist/matchers/toDisplayPreviews.d.ts

@@ -1,5 +1,6 @@
 import { VariableEditPage } from '../models';
-declare const toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: Array<string | RegExp>) => Promise<{
+import { ContainTextOptions } from '../types';
+declare const toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: Array<string | RegExp>, options?: ContainTextOptions) => Promise<{
     pass: boolean;
     actual: boolean;
     message: () => string;

package/dist/matchers/toDisplayPreviews.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const test_1 = require("@playwright/test");
 const utils_1 = require("./utils");
-const toDisplayPreviews = async (variableEditPage, previewTexts) => {
+const toDisplayPreviews = async (variableEditPage, previewTexts, options) => {
     let pass = false;
     let actual;
     let message = `To find preview of values: ${previewTexts.join(', ')}}`;
     try {
-        await (0, test_1.expect)(variableEditPage.getByTestIdOrAriaLabel(variableEditPage.ctx.selectors.pages.Dashboard.Settings.Variables.Edit.General.previewOfValuesOption)).toContainText(previewTexts);
+        await (0, test_1.expect)(variableEditPage.getByTestIdOrAriaLabel(variableEditPage.ctx.selectors.pages.Dashboard.Settings.Variables.Edit.General.previewOfValuesOption)).toContainText(previewTexts, options);
         return {
             pass: true,
             actual: false,

package/dist/models/AnnotationEditPage.d.ts

@@ -6,6 +6,9 @@ export declare class AnnotationEditPage extends GrafanaPage {
     readonly args: DashboardEditViewArgs<string>;
     datasource: DataSourcePicker;
     constructor(ctx: PluginTestCtx, args: DashboardEditViewArgs<string>);
+    /**
+     * 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>;
     /**
      * Executes the annotation query defined in the annotation page and returns the response promise

package/dist/models/AnnotationEditPage.js

@@ -13,6 +13,9 @@ class AnnotationEditPage extends GrafanaPage_1.GrafanaPage {
         this.args = args;
         this.datasource = new DataSourcePicker_1.DataSourcePicker(ctx);
     }
+    /**
+     * 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 { Dashboard, AddDashboard } = this.ctx.selectors.pages;
         const url = this.args.dashboard?.uid

package/dist/models/AnnotationPage.d.ts

@@ -5,6 +5,12 @@ export declare class AnnotationPage extends GrafanaPage {
     readonly ctx: PluginTestCtx;
     readonly dashboard?: DashboardPageArgs;
     constructor(ctx: PluginTestCtx, dashboard?: DashboardPageArgs);
+    /**
+     * Navigates to the annotation list page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     goto(options?: NavigateOptions): Promise<void>;
+    /**
+     * Clicks the add new annotation button and returns the annotation edit page
+     */
     clickAddNew(): Promise<AnnotationEditPage>;
 }

package/dist/models/AnnotationPage.js

@@ -35,6 +35,9 @@ class AnnotationPage extends GrafanaPage_1.GrafanaPage {
         this.ctx = ctx;
         this.dashboard = dashboard;
     }
+    /**
+     * Navigates to the annotation list page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     async goto(options) {
         const { Dashboard, AddDashboard } = this.ctx.selectors.pages;
         let url = this.dashboard?.uid
@@ -42,6 +45,9 @@ class AnnotationPage extends GrafanaPage_1.GrafanaPage {
             : AddDashboard.Settings.Annotations.List.url;
         return super.navigate(url, options);
     }
+    /**
+     * Clicks the add new annotation button and returns the annotation edit page
+     */
     async clickAddNew() {
         const { Dashboard } = this.ctx.selectors.pages;
         if (!this.dashboard?.uid) {

package/dist/models/DashboardPage.d.ts

@@ -8,9 +8,26 @@ export declare class DashboardPage extends GrafanaPage {
     dataSourcePicker: any;
     timeRange: TimeRange;
     constructor(ctx: PluginTestCtx, dashboard?: DashboardPageArgs);
+    /**
+     * Navigates to the dashboard page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     goto(options?: NavigateOptions): Promise<void>;
+    /**
+     * Navigates to the panel edit page for the given panel id
+     *
+     * If the panel id does not exist in the dashboard, Grafana will redirect to the dashboard page
+     */
     gotoPanelEditPage(panelId: string): Promise<PanelEditPage>;
+    /**
+     * Clicks the buttons to add a new panel and returns the panel edit page for the new panel
+     */
     addPanel(): Promise<PanelEditPage>;
+    /**
+     * Deletes the dashboard
+     */
     deleteDashboard(): Promise<void>;
+    /**
+     * Clicks the run button in the refresh picker to refresh the dashboard
+     */
     refreshDashboard(): Promise<void>;
 }

package/dist/models/DashboardPage.js

@@ -18,6 +18,9 @@ class DashboardPage extends GrafanaPage_1.GrafanaPage {
         this.dataSourcePicker = new DataSourcePicker_1.DataSourcePicker(ctx);
         this.timeRange = new TimeRange_1.TimeRange(ctx);
     }
+    /**
+     * Navigates to the dashboard page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     async goto(options) {
         let url = this.dashboard?.uid
             ? this.ctx.selectors.pages.Dashboard.url(this.dashboard.uid)
@@ -29,11 +32,19 @@ class DashboardPage extends GrafanaPage_1.GrafanaPage {
         }
         return super.navigate(url, options);
     }
+    /**
+     * Navigates to the panel edit page for the given panel id
+     *
+     * If the panel id does not exist in the dashboard, Grafana will redirect to the dashboard page
+     */
     async gotoPanelEditPage(panelId) {
         const panelEditPage = new PanelEditPage_1.PanelEditPage(this.ctx, { dashboard: this.dashboard, id: panelId });
         await panelEditPage.goto();
         return panelEditPage;
     }
+    /**
+     * Clicks the buttons to add a new panel and returns the panel edit page for the new panel
+     */
     async addPanel() {
         const { components, pages } = this.ctx.selectors;
         if (gte(this.ctx.grafanaVersion, '10.0.0')) {
@@ -49,9 +60,15 @@ class DashboardPage extends GrafanaPage_1.GrafanaPage {
         });
         return new PanelEditPage_1.PanelEditPage(this.ctx, { dashboard: this.dashboard, id: panelId });
     }
+    /**
+     * Deletes the dashboard
+     */
     async deleteDashboard() {
         await this.ctx.request.delete(this.ctx.selectors.apis.Dashboard.delete(this.dashboard.uid));
     }
+    /**
+     * Clicks the run button in the refresh picker to refresh the dashboard
+     */
     async refreshDashboard() {
         await this.ctx.page.getByTestId(this.ctx.selectors.components.RefreshPicker.runButtonV2).click();
     }

package/dist/models/DataSourceConfigPage.d.ts

@@ -4,6 +4,9 @@ export declare class DataSourceConfigPage extends GrafanaPage {
     private datasource;
     constructor(ctx: PluginTestCtx, datasource: DataSource);
     deleteDataSource(): Promise<void>;
+    /**
+     * Navigates to the datasource edit page for an existing datasource
+     */
     goto(options?: NavigateOptions): Promise<void>;
     /**
      * Mocks the response of the datasource health check call

package/dist/models/DataSourceConfigPage.js

@@ -11,6 +11,9 @@ class DataSourceConfigPage extends GrafanaPage_1.GrafanaPage {
     async deleteDataSource() {
         await this.ctx.request.delete(this.ctx.selectors.apis.DataSource.datasourceByUID(this.datasource.uid));
     }
+    /**
+     * Navigates to the datasource edit page for an existing datasource
+     */
     async goto(options) {
         return super.navigate(this.ctx.selectors.pages.EditDataSource.url(this.datasource.uid), options);
     }

package/dist/models/DataSourcePicker.d.ts

@@ -2,5 +2,8 @@ import { PluginTestCtx } from '../types';
 import { GrafanaPage } from './GrafanaPage';
 export declare class DataSourcePicker extends GrafanaPage {
     constructor(ctx: PluginTestCtx);
+    /**
+     * Sets the data source picker to the provided name
+     */
     set(name: string): Promise<void>;
 }

package/dist/models/DataSourcePicker.js

@@ -6,6 +6,9 @@ class DataSourcePicker extends GrafanaPage_1.GrafanaPage {
     constructor(ctx) {
         super(ctx);
     }
+    /**
+     * Sets the data source picker to the provided name
+     */
     async set(name) {
         await this.getByTestIdOrAriaLabel(this.ctx.selectors.components.DataSourcePicker.container)
             .locator('input')

package/dist/models/ExplorePage.d.ts

@@ -6,7 +6,16 @@ export declare class ExplorePage extends GrafanaPage {
     datasource: DataSourcePicker;
     timeRange: any;
     constructor(ctx: PluginTestCtx);
+    /**
+     * Navigates to the explore page.
+     */
     goto(options?: NavigateOptions): Promise<void>;
+    /**
+     * Returns the locator for the query editor row with the given refId
+     */
     getQueryEditorRow(refId: string): Promise<Locator>;
+    /**
+     * Clicks the "Run Query" button in the refresh picker to run the query. Returns the response promise for the data query
+     */
     runQuery(options?: RequestOptions): Promise<import("@playwright/test").Response>;
 }

package/dist/models/ExplorePage.js

@@ -13,9 +13,15 @@ class ExplorePage extends GrafanaPage_1.GrafanaPage {
         this.datasource = new DataSourcePicker_1.DataSourcePicker(ctx);
         this.timeRange = new TimeRange_1.TimeRange(ctx);
     }
+    /**
+     * Navigates to the explore page.
+     */
     async goto(options) {
         await super.navigate(this.ctx.selectors.pages.Explore.url, options);
     }
+    /**
+     * Returns the locator for the query editor row with the given refId
+     */
     async getQueryEditorRow(refId) {
         const locator = this.getByTestIdOrAriaLabel(this.ctx.selectors.components.QueryEditorRows.rows).filter({
             has: this.getByTestIdOrAriaLabel(this.ctx.selectors.components.QueryEditorRow.title(refId)),
@@ -23,6 +29,9 @@ class ExplorePage extends GrafanaPage_1.GrafanaPage {
         await (0, test_1.expect)(locator).toBeVisible();
         return locator;
     }
+    /**
+     * Clicks the "Run Query" button in the refresh picker to run the query. Returns the response promise for the data query
+     */
     async runQuery(options) {
         const components = this.ctx.selectors.components;
         const responsePromise = this.ctx.page.waitForResponse((resp) => resp.url().includes(this.ctx.selectors.apis.DataSource.query), options);

package/dist/models/PanelEditPage.d.ts

@@ -9,6 +9,9 @@ export declare class PanelEditPage extends GrafanaPage implements PanelError {
     datasource: DataSourcePicker;
     timeRange: TimeRange;
     constructor(ctx: PluginTestCtx, args: DashboardEditViewArgs<string>);
+    /**
+     * Navigates to the panel edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     goto(options?: NavigateOptions): Promise<void>;
     /**
      * Sets the title of the panel. This method will open the panel options, set the title and close the panel options.
@@ -22,9 +25,24 @@ export declare class PanelEditPage extends GrafanaPage implements PanelError {
      * Expands the section for the given category name. If the section is already expanded, this method does nothing.
      */
     collapseSection(categoryName: string): Promise<void>;
+    /**
+     * Returns the name of the visualization currently selected in the panel editor
+     */
     getVisualizationName(): Locator;
+    /**
+     * Clicks the "Apply" button in the panel editor
+     */
     apply(): Promise<void>;
+    /**
+     * Returns the locator for the query editor row with the given refId
+     */
     getQueryEditorRow(refId: string): Promise<Locator>;
+    /**
+     * Returns the locator for the panel error (if any)
+     */
     getPanelError(): Locator;
+    /**
+     * CLicks the "Refresh" button in the panel editor. Returns the response promise for the data query
+     */
     refreshPanel(options?: RequestOptions): Promise<import("@playwright/test").Response>;
 }

package/dist/models/PanelEditPage.js

@@ -42,6 +42,9 @@ class PanelEditPage extends GrafanaPage_1.GrafanaPage {
         this.datasource = new DataSourcePicker_1.DataSourcePicker(ctx);
         this.timeRange = new TimeRange_1.TimeRange(ctx);
     }
+    /**
+     * Navigates to the panel edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     async goto(options) {
         const url = this.args.dashboard?.uid
             ? this.ctx.selectors.pages.Dashboard.url(this.args.dashboard.uid)
@@ -90,12 +93,21 @@ class PanelEditPage extends GrafanaPage_1.GrafanaPage {
             await section.click();
         }
     }
+    /**
+     * Returns the name of the visualization currently selected in the panel editor
+     */
     getVisualizationName() {
         return this.getByTestIdOrAriaLabel(this.ctx.selectors.components.PanelEditor.toggleVizPicker);
     }
+    /**
+     * Clicks the "Apply" button in the panel editor
+     */
     async apply() {
         await this.ctx.page.getByTestId(this.ctx.selectors.components.PanelEditor.applyButton).click();
     }
+    /**
+     * Returns the locator for the query editor row with the given refId
+     */
     async getQueryEditorRow(refId) {
         const locator = this.getByTestIdOrAriaLabel(this.ctx.selectors.components.QueryEditorRows.rows).filter({
             has: this.getByTestIdOrAriaLabel(this.ctx.selectors.components.QueryEditorRow.title(refId)),
@@ -103,6 +115,9 @@ class PanelEditPage extends GrafanaPage_1.GrafanaPage {
         await (0, test_1.expect)(locator).toBeVisible();
         return locator;
     }
+    /**
+     * Returns the locator for the panel error (if any)
+     */
     getPanelError() {
         // the selector (not the selector value) used to identify a panel error changed in 9.4.3
         if (semver.lte(this.ctx.grafanaVersion, '9.4.3')) {
@@ -110,6 +125,9 @@ class PanelEditPage extends GrafanaPage_1.GrafanaPage {
         }
         return this.getByTestIdOrAriaLabel(this.ctx.selectors.components.Panels.Panel.status(ERROR_STATUS));
     }
+    /**
+     * CLicks the "Refresh" button in the panel editor. Returns the response promise for the data query
+     */
     async refreshPanel(options) {
         const responsePromise = this.ctx.page.waitForResponse((resp) => resp.url().includes(this.ctx.selectors.apis.DataSource.query), options);
         // in older versions of grafana, the refresh button is rendered twice. this is a workaround to click the correct one

package/dist/models/TimeRange.d.ts

@@ -2,5 +2,8 @@ import { PluginTestCtx, TimeRangeArgs } from '../types';
 import { GrafanaPage } from './GrafanaPage';
 export declare class TimeRange extends GrafanaPage {
     constructor(ctx: PluginTestCtx);
+    /**
+     * Opens the time picker and sets the time range to the provided values
+     */
     set({ from, to, zone }: TimeRangeArgs): Promise<void>;
 }

package/dist/models/TimeRange.js

@@ -6,6 +6,9 @@ class TimeRange extends GrafanaPage_1.GrafanaPage {
     constructor(ctx) {
         super(ctx);
     }
+    /**
+     * Opens the time picker and sets the time range to the provided values
+     */
     async set({ from, to, zone }) {
         try {
             await this.getByTestIdOrAriaLabel(this.ctx.selectors.components.TimePicker.openButton).click();

package/dist/models/VariableEditPage.d.ts

@@ -7,7 +7,13 @@ export declare class VariableEditPage extends GrafanaPage {
     readonly args: DashboardEditViewArgs<string>;
     datasource: DataSourcePicker;
     constructor(ctx: PluginTestCtx, args: DashboardEditViewArgs<string>);
+    /**
+     * Navigates to the variable edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     goto(options?: NavigateOptions): Promise<void>;
+    /**
+     * Sets the type of variable in the 'Variable type' dropdown to the given type
+     */
     setVariableType(type: VariableType): Promise<void>;
     /**
      * Triggers the variable query to run. Note that unlike {@link PanelEditPage.refreshPanel}, this method doesn't

package/dist/models/VariableEditPage.js

@@ -14,6 +14,9 @@ class VariableEditPage extends GrafanaPage_1.GrafanaPage {
         this.args = args;
         this.datasource = new DataSourcePicker_1.DataSourcePicker(ctx);
     }
+    /**
+     * Navigates to the variable edit page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     async goto(options) {
         const { Dashboard, AddDashboard } = this.ctx.selectors.pages;
         const url = this.args.dashboard?.uid
@@ -21,6 +24,9 @@ class VariableEditPage extends GrafanaPage_1.GrafanaPage {
             : AddDashboard.Settings.Variables.Edit.url(this.args.id);
         await super.navigate(url, options);
     }
+    /**
+     * Sets the type of variable in the 'Variable type' dropdown to the given type
+     */
     async setVariableType(type) {
         await this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.Dashboard.Settings.Variables.Edit.General.generalTypeSelectV2)
             .locator('input')

package/dist/models/VariablePage.d.ts

@@ -5,6 +5,12 @@ export declare class VariablePage extends GrafanaPage {
     readonly ctx: PluginTestCtx;
     readonly dashboard?: DashboardPageArgs;
     constructor(ctx: PluginTestCtx, dashboard?: DashboardPageArgs);
+    /**
+     * Navigates to the variable list page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     goto(options?: NavigateOptions): Promise<void>;
+    /**
+     * Clicks the add new variable button and returns the variable edit page
+     */
     clickAddNew(): Promise<VariableEditPage>;
 }

package/dist/models/VariablePage.js

@@ -11,6 +11,9 @@ class VariablePage extends GrafanaPage_1.GrafanaPage {
         this.ctx = ctx;
         this.dashboard = dashboard;
     }
+    /**
+     * Navigates to the variable list page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
+     */
     async goto(options) {
         const { Dashboard, AddDashboard } = this.ctx.selectors.pages;
         let url = this.dashboard?.uid
@@ -18,6 +21,9 @@ class VariablePage extends GrafanaPage_1.GrafanaPage {
             : AddDashboard.Settings.Variables.List.url;
         return super.navigate(url, options);
     }
+    /**
+     * Clicks the add new variable button and returns the variable edit page
+     */
     async clickAddNew() {
         const { addVariableCTAV2, addVariableCTAV2Item, newButton } = this.ctx.selectors.pages.Dashboard.Settings.Variables.List;
         if (!this.dashboard?.uid) {

package/dist/types.d.ts

@@ -188,3 +188,18 @@ export interface AlertPageOptions {
      */
     hasText?: string | RegExp;
 }
+export interface ContainTextOptions {
+    /**
+     * Whether to perform case-insensitive match. `ignoreCase` option takes precedence over the corresponding regular
+     * expression flag if specified.
+     */
+    ignoreCase?: boolean;
+    /**
+     * Time to retry the assertion for in milliseconds. Defaults to `timeout` in `TestConfig.expect`.
+     */
+    timeout?: number;
+    /**
+     * Whether to use `element.innerText` instead of `element.textContent` when retrieving DOM node text.
+     */
+    useInnerText?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.5.0-canary.641.7aa6686.0",
+  "version": "0.6.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -44,5 +44,5 @@
     "semver": "^7.5.4",
     "uuid": "^9.0.1"
   },
-  "gitHead": "7aa668690dd1284344b04121717b18f43eacc169"
+  "gitHead": "e5eec7a28018662bec5b65e0980c3ff1fe2a358d"
 }