@grafana/plugin-e2e 0.10.2 → 0.10.3-canary.694.f97a4af.0

package/dist/api.js

@@ -8,8 +8,9 @@ const test_1 = require("@playwright/test");
 const fixtures_1 = __importDefault(require("./fixtures"));
 const matchers_1 = __importDefault(require("./matchers"));
 const selectorEngine_1 = require("./selectorEngine");
+const options_1 = __importDefault(require("./options"));
 // extend Playwright with Grafana plugin specific fixtures
-exports.test = test_1.test.extend(fixtures_1.default);
+exports.test = test_1.test.extend({ ...fixtures_1.default, ...options_1.default });
 exports.expect = test_1.expect.extend(matchers_1.default);
 /** Register a custom selector engine that resolves locators for Grafana E2E selectors
  *

package/dist/fixtures/grafanaVersion.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const grafanaVersion = async ({ page }, use) => {
-    let grafanaVersion = process.env.GRAFANA_VERSION;
+    let grafanaVersion = process.env.GRAFANA_VERSION ?? '';
     if (!grafanaVersion) {
         await page.goto('/');
         grafanaVersion = await page.evaluate('window.grafanaBootData.settings.buildInfo.version');

package/dist/fixtures/index.js

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
 const annotationEditPage_1 = __importDefault(require("./annotationEditPage"));
 const grafanaVersion_1 = __importDefault(require("./grafanaVersion"));
 const selectors_1 = __importDefault(require("./selectors"));
@@ -18,8 +17,6 @@ const explorePage_1 = __importDefault(require("./explorePage"));
 const isFeatureToggleEnabled_1 = __importDefault(require("./isFeatureToggleEnabled"));
 const page_1 = __importDefault(require("./page"));
 const fixtures = {
-    provisioningRootDir: [path_1.default.join(process.cwd(), 'provisioning'), { option: true, scope: 'worker' }],
-    featureToggles: [{}, { option: true, scope: 'worker' }],
     selectors: selectors_1.default,
     grafanaVersion: grafanaVersion_1.default,
     login: login_1.default,

package/dist/models/DashboardPage.js

@@ -21,12 +21,12 @@ class DashboardPage extends GrafanaPage_1.GrafanaPage {
     /**
      * Navigates to the dashboard page. If a dashboard uid was not provided, it's assumed that it's a new dashboard.
      */
-    async goto(options) {
+    async goto(options = {}) {
         let url = this.dashboard?.uid
             ? this.ctx.selectors.pages.Dashboard.url(this.dashboard.uid)
             : this.ctx.selectors.pages.AddDashboard.url;
         if (this.dashboard?.timeRange) {
-            options.queryParams = options.queryParams ?? new URLSearchParams();
+            options.queryParams = options?.queryParams ?? new URLSearchParams();
             options.queryParams.append('from', this.dashboard.timeRange.from);
             options.queryParams.append('to', this.dashboard.timeRange.to);
         }
@@ -58,13 +58,13 @@ class DashboardPage extends GrafanaPage_1.GrafanaPage {
             const urlParams = new URLSearchParams(window.location.search);
             return urlParams.get('editPanel');
         });
-        return new PanelEditPage_1.PanelEditPage(this.ctx, { dashboard: this.dashboard, id: panelId });
+        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));
+        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

package/dist/models/DataSourceConfigPage.js

@@ -9,13 +9,13 @@ class DataSourceConfigPage extends GrafanaPage_1.GrafanaPage {
         this.datasource = datasource;
     }
     async deleteDataSource() {
-        await this.ctx.request.delete(this.ctx.selectors.apis.DataSource.datasourceByUID(this.datasource.uid));
+        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);
+        return super.navigate(this.ctx.selectors.pages.EditDataSource.url(this.datasource.uid ?? ''), options);
     }
     /**
      * Mocks the response of the datasource health check call
@@ -23,7 +23,7 @@ class DataSourceConfigPage extends GrafanaPage_1.GrafanaPage {
      * @param status the HTTP status code to return. Defaults to 200
      */
     async mockHealthCheckResponse(json, status = 200) {
-        await this.ctx.page.route(`${this.ctx.selectors.apis.DataSource.health(this.datasource.uid ?? '', this.datasource.id.toString() ?? '')}`, 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 });
         });
     }
@@ -36,10 +36,10 @@ class DataSourceConfigPage extends GrafanaPage_1.GrafanaPage {
         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 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() ?? '')));
+            .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 saveResponsePromise.then(() => healthResponsePromise);
     }

package/dist/models/PanelEditPage.js

@@ -88,7 +88,7 @@ class PanelEditPage extends GrafanaPage_1.GrafanaPage {
         const section = this.getByTestIdOrAriaLabel(this.ctx.selectors.components.OptionsGroup.group(categoryName));
         await (0, test_1.expect)(section, `Could not find any section for category: ${categoryName}`).toBeVisible();
         const sectionToggle = this.getByTestIdOrAriaLabel(this.ctx.selectors.components.OptionsGroup.toggle(categoryName));
-        const expandedAttr = await sectionToggle.getAttribute('aria-expanded');
+        const expandedAttr = (await sectionToggle.getAttribute('aria-expanded')) ?? '';
         if (/false/.test(expandedAttr)) {
             await section.click();
         }

package/dist/options/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
+const options = {
+    featureToggles: [{}, { option: true, scope: 'worker' }],
+    provisioningRootDir: [path.join(process.cwd(), 'provisioning'), { option: true, scope: 'worker' }],
+};
+exports.default = options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.10.2",
+  "version": "0.10.3-canary.694.f97a4af.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -25,7 +25,7 @@
     "lint:fix": "npm run lint -- --fix",
     "server": "docker-compose up --build",
     "typecheck": "tsc --emitDeclarationOnly false --noEmit",
-    "test": "jest",
+    "test": "vitest",
     "playwright:test": "npx playwright test",
     "playwright:test:ui": "npx playwright test --ui",
     "playwright:showreport": "npx playwright show-report"
@@ -45,5 +45,5 @@
     "semver": "^7.5.4",
     "uuid": "^9.0.1"
   },
-  "gitHead": "a17ddbed56fd03f5b90a7ae764532d7da3f60d46"
+  "gitHead": "f97a4af609f8d9b4fd498d88f6811f26725e4ca8"
 }

package/dist/api.d.ts

@@ -1,177 +0,0 @@
-import { E2ESelectors } from './e2e-selectors/types';
-import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSource, ReadProvisionArgs } from './types';
-import { PanelEditPage, GrafanaPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage } from './models';
-import { ExplorePage } from './models/ExplorePage';
-export type PluginOptions = {
-    /**
-     * When using the readProvisioning fixture, files will be read from this directory. If no directory is provided,
-     * the 'provisioning' directory in the current working directory will be used.
-     *
-     * eg.
-     * export default defineConfig({
-        use: {
-          provisioningRootDir: 'path/to/provisioning',
-        },
-      });
-     *
-     */
-    provisioningRootDir: string;
-    /**
-     * Optionally, you can add or override feature toggles.
-     * The feature toggles you specify here will only work in the frontend. If you need a feature toggle to work across the entire stack, you
-     * need to need to enable the feature in the Grafana config. See https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#feature_toggles
-     *
-     * To override feature toggles globally in the playwright.config.ts file:
-     * export default defineConfig({
-        use: {
-          featureToggles: {
-            exploreMixedDatasource: true,
-            redshiftAsyncQueryDataSupport: false
-          },
-        },
-      });
-     *
-     * To override feature toggles for tests on a certain file:
-       test.use({
-        featureToggles: {
-          exploreMixedDatasource: true,
-        },
-     * });
-     */
-    featureToggles: Record<string, boolean>;
-};
-export type PluginFixture = {
-    /**
-     * The current Grafana version.
-     *
-     * If a GRAFANA_VERSION environment variable is set, this will be used. Otherwise,
-     * the version will be picked from window.grafanaBootData.settings.buildInfo.version.
-     */
-    grafanaVersion: string;
-    /**
-     * The E2E selectors to use for the current version of Grafana
-     */
-    selectors: E2ESelectors;
-    /**
-     * Isolated {@link DashboardPage} instance for each test.
-     *
-     * Navigates to a new dashboard page and adds a new panel.
-     *
-     * Use {@link PanelEditPage.setVisualization} to change the visualization
-     * Use {@link PanelEditPage.datasource.set} to change the datasource
-     * Use {@link PanelEditPage.getQueryEditorEditorRow} to retrieve the query
-     * editor row locator for a given query refId
-     */
-    newDashboardPage: DashboardPage;
-    /**
-     * Isolated {@link PanelEditPage} instance for each test.
-     *
-     * Navigates to a new dashboard page and adds a new panel.
-     *
-     * Use {@link PanelEditPage.setVisualization} to change the visualization
-     * Use {@link PanelEditPage.datasource.set} to change the datasource
-     * Use {@link ExplorePage.getQueryEditorEditorRow} to retrieve the query
-     * editor row locator for a given query refId
-     */
-    panelEditPage: PanelEditPage;
-    /**
-     * Isolated {@link VariableEditPage} instance for each test.
-     *
-     * Navigates to a new dashboard page and adds a new variable.
-     *
-     * Use {@link VariableEditPage.setVariableType} to change the variable type
-     */
-    variableEditPage: VariableEditPage;
-    /**
-     * Isolated {@link AnnotationEditPage} instance for each test.
-     *
-     * Navigates to a new dashboard page and adds a new annotation.
-     *
-     * Use {@link AnnotationEditPage.datasource.set} to change the datasource
-     */
-    annotationEditPage: AnnotationEditPage;
-    /**
-     * Isolated {@link ExplorePage} instance for each test.
-     *
-     * Navigates to a the explore page.
-     *
-     * Use {@link ExplorePage.datasource.set} to change the datasource
-     * Use {@link ExplorePage.getQueryEditorEditorRow} to retrieve the query editor
-     * row locator for a given query refId
-     */
-    explorePage: ExplorePage;
-    /**
-     * Fixture command that will create an isolated DataSourceConfigPage instance for a given data source type.
-     *
-     * The data source config page cannot be navigated to without a data source uid, so this fixture will create a new
-     * data source using the Grafana API, create a new DataSourceConfigPage instance and navigate to the page.
-     */
-    createDataSourceConfigPage: (args: CreateDataSourcePageArgs) => Promise<DataSourceConfigPage>;
-    /**
-     * Fixture command that creates a data source via the Grafana API.
-     *
-     * If you have tests that depend on the the existance of a data source,
-     * you may use this command in a setup project. Read more about setup projects
-     * here: https://playwright.dev/docs/auth#basic-shared-account-in-all-tests
-     */
-    createDataSource: (args: CreateDataSourceArgs) => Promise<DataSource>;
-    /**
-     * Fixture command that login to Grafana using the Grafana API.
-     * If the same credentials should be used in every test,
-     * invoke this fixture in a setup project.
-     * See https://playwright.dev/docs/auth#basic-shared-account-in-all-tests
-     *
-     * If no credentials are provided, the default admin/admin credentials will be used.
-     *
-     * The default credentials can be overridden in the playwright.config.ts file:
-     * eg.
-     * export default defineConfig({
-        use: {
-          httpCredentials: {
-            username: 'user',
-            password: 'pass',
-          },
-        },
-      });
-     *
-     * To override credentials in a single test:
-     * test.use({ httpCredentials: { username: 'admin', password: 'admin' } });
-     * To avoid authentication in a single test:
-     * test.use({ storageState: { cookies: [], origins: [] } });
-     */
-    login: () => Promise<void>;
-    /**
-     * Fixture command that reads a the yaml file for a provisioned dashboard
-     * or data source and returns it as json.
-     */
-    readProvision<T = any>(args: ReadProvisionArgs): Promise<T>;
-    /**
-     * Function that checks if a feature toggle is enabled. Only works for frontend feature toggles.
-     */
-    isFeatureToggleEnabled<T = object>(featureToggle: keyof T): Promise<boolean>;
-};
-export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & PluginFixture, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & PluginOptions>;
-export declare const expect: import("@playwright/test").Expect<{
-    toBeOK: (request: Promise<import("@playwright/test").Response>) => Promise<{
-        message: () => string;
-        pass: boolean;
-        actual: number;
-    }>;
-    toHavePanelError: (panelError: import("./types").PanelError, options?: {
-        timeout?: number;
-    }) => Promise<{
-        message: () => any;
-        pass: boolean;
-        actual: number;
-    }>;
-    toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: (string | RegExp)[], options?: import("./types").ContainTextOptions) => Promise<{
-        pass: boolean;
-        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/index.d.ts

@@ -1,2 +0,0 @@
-export { resolveSelectors } from './resolver';
-export * from './types';

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

@@ -1,10 +0,0 @@
-import { E2ESelectors } from './types';
-import { VersionedSelectors } from './versioned/types';
-/**
- * Resolves selectors based on the Grafana version
- *
- * If the selector has multiple versions, the last version that is less
- * than or equal to the Grafana version will be returned.
- * If the selector doesn't have a version, it will be returned as is.
- */
-export declare const resolveSelectors: (versionedSelectors: VersionedSelectors, grafanaVersion: string) => E2ESelectors;

package/dist/e2e-selectors/resolver.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,174 +0,0 @@
-export type E2ESelectors = {
-    pages: Pages;
-    components: Components;
-    apis: APIs;
-};
-export type APIs = {
-    DataSource: {
-        resourcePattern: string;
-        resourceUIDPattern: string;
-        queryPattern: string;
-        query: string;
-        health: (uid: string, id: string) => string;
-        datasourceByUID: (uid: string) => string;
-    };
-    Dashboard: {
-        delete: (uid: string) => string;
-    };
-};
-export type Components = {
-    TimePicker: {
-        openButton: string;
-        fromField: string;
-        toField: string;
-        applyTimeRange: string;
-        absoluteTimeRangeTitle: string;
-    };
-    Panels: {
-        Panel: {
-            title: (title: string) => string;
-            headerCornerInfo: (mode: string) => string;
-            status: (status: string) => string;
-        };
-        Visualization: {
-            Table: {
-                header: string;
-                footer: string;
-                body: string;
-            };
-        };
-    };
-    PanelEditor: {
-        General: {
-            content: string;
-        };
-        applyButton: string;
-        toggleVizPicker: string;
-    };
-    RefreshPicker: {
-        runButtonV2: string;
-    };
-    QueryEditorRows: {
-        rows: string;
-    };
-    QueryEditorRow: {
-        title: (refId: string) => string;
-    };
-    Alert: {
-        alertV2: (severity: string) => string;
-    };
-    PageToolbar: {
-        item: (tooltip: string) => string;
-        shotMoreItems: string;
-        itemButton: (title: string) => string;
-        itemButtonTitle: string;
-    };
-    OptionsGroup: {
-        group: (title?: string) => string;
-        toggle: (title?: string) => string;
-        groupTitle: string;
-    };
-    PluginVisualization: {
-        item: (title: string) => string;
-    };
-    Select: {
-        option: string;
-        input: () => string;
-        singleValue: () => string;
-    };
-    DataSourcePicker: {
-        container: string;
-    };
-    TimeZonePicker: {
-        containerV2: string;
-    };
-    CodeEditor: {
-        container: string;
-    };
-    Variables: {
-        variableOption: string;
-    };
-    Annotations: {
-        annotationsTypeInput: string;
-        annotationsChoosePanelInput: string;
-    };
-    Tooltip: {
-        container: string;
-    };
-};
-export type Pages = {
-    Home: {
-        url: string;
-    };
-    DataSource: {
-        name: string;
-        delete: string;
-        readOnly: string;
-        saveAndTest: string;
-        alert: string;
-    };
-    EditDataSource: {
-        url: (dataSourceUid: string) => string;
-    };
-    AddDashboard: {
-        url: string;
-        itemButton: (title: string) => string;
-        addNewPanel: string;
-        itemButtonAddViz: string;
-        Settings: {
-            Annotations: {
-                List: {
-                    url: string;
-                };
-                Edit: {
-                    url: (annotationIndex: string) => string;
-                };
-            };
-            Variables: {
-                List: {
-                    url: string;
-                };
-                Edit: {
-                    url: (variableIndex: string) => string;
-                };
-            };
-        };
-    };
-    Dashboard: {
-        url: (uid: string) => string;
-        Settings: {
-            Annotations: {
-                Edit: {
-                    url: (dashboardUid: string, annotationIndex: string) => string;
-                };
-                List: {
-                    url: (uid: string) => string;
-                    /**
-                     * @deprecated use addAnnotationCTAV2 from Grafana 8.3 instead
-                     */
-                    addAnnotationCTA: string;
-                    addAnnotationCTAV2: string;
-                };
-            };
-            Variables: {
-                List: {
-                    url: (dashboardUid: string) => string;
-                    newButton: string;
-                    addVariableCTAV2: (variableName: string) => string;
-                    addVariableCTAV2Item: string;
-                };
-                Edit: {
-                    url: (dashboardUid: string, editIndex: string) => string;
-                    General: {
-                        generalTypeSelectV2: string;
-                        previewOfValuesOption: string;
-                        submitButton: string;
-                    };
-                };
-            };
-        };
-    };
-    Explore: {
-        url: string;
-    };
-};

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

@@ -1,29 +0,0 @@
-export declare const versionedAPIs: {
-    DataSource: {
-        resourcePattern: {
-            "8.0.0": string;
-        };
-        resourceUIDPattern: {
-            '9.4.4': string;
-            "8.0.0": string;
-        };
-        queryPattern: {
-            "8.0.0": string;
-        };
-        query: {
-            "8.0.0": string;
-        };
-        health: {
-            "9.5.0": (uid: string, _: string) => string;
-            "8.0.0": (_: string, id: string) => string;
-        };
-        datasourceByUID: {
-            "8.0.0": (uid: string) => string;
-        };
-    };
-    Dashboard: {
-        delete: {
-            "8.0.0": (uid: string) => string;
-        };
-    };
-};