@grafana/plugin-e2e 0.12.0 → 0.12.2

package/dist/api.d.ts

@@ -0,0 +1,178 @@
+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;
+    } | {
+        message: () => string;
+        pass: boolean;
+        actual: undefined;
+    }>;
+    toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: (string | RegExp)[], options?: import("./types").ContainTextOptions | undefined) => Promise<{
+        pass: boolean;
+        actual: boolean;
+        message: () => string;
+    } | {
+        message: () => string;
+        pass: boolean;
+        actual: undefined;
+    }>;
+    toHaveAlert: (grafanaPage: GrafanaPage, severity: import("./matchers/toHaveAlert").AlertVariant, options?: import("./types").AlertPageOptions | undefined) => Promise<{
+        message: () => any;
+        pass: boolean;
+    }>;
+}>;
+export { selectors } from '@playwright/test';

package/dist/auth/auth.setup.d.ts

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

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

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

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

@@ -0,0 +1,10 @@
+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

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

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

@@ -0,0 +1,174 @@
+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

@@ -0,0 +1,29 @@
+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;
+        };
+    };
+};

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

@@ -0,0 +1,154 @@
+export declare const versionedComponents: {
+    TimePicker: {
+        openButton: {
+            '8.1.0': string;
+            "8.0.0": string;
+        };
+        fromField: {
+            '10.2.3': string;
+            "8.0.0": string;
+        };
+        toField: {
+            '10.2.3': string;
+            "8.0.0": string;
+        };
+        applyTimeRange: {
+            '8.1.0': string;
+            "8.0.0": string;
+        };
+        absoluteTimeRangeTitle: {
+            "8.0.0": string;
+        };
+    };
+    Panels: {
+        Panel: {
+            title: {
+                '8.1.2': (title: string) => string;
+                "8.0.0": (title: string) => string;
+            };
+            headerCornerInfo: {
+                "8.0.0": (mode: string) => string;
+            };
+            status: {
+                "10.2.0": (status: string) => string;
+                "8.0.0": (_: string) => string;
+            };
+        };
+        Visualization: {
+            Table: {
+                header: {
+                    "8.0.0": string;
+                };
+                footer: {
+                    "8.0.0": string;
+                };
+                body: {
+                    '10.2.0': string;
+                };
+            };
+        };
+    };
+    PanelEditor: {
+        General: {
+            content: {
+                "8.0.0": string;
+            };
+        };
+        applyButton: {
+            '9.2.0': string;
+            "8.0.0": string;
+        };
+        toggleVizPicker: {
+            '10.0.0': string;
+            "8.0.0": string;
+        };
+    };
+    RefreshPicker: {
+        runButtonV2: {
+            "8.3.0": string;
+            "8.0.0": string;
+        };
+    };
+    QueryEditorRows: {
+        rows: {
+            "8.0.0": string;
+        };
+    };
+    QueryEditorRow: {
+        title: {
+            "8.0.0": (refId: string) => string;
+        };
+    };
+    Alert: {
+        alertV2: {
+            '8.3.0': (severity: string) => string;
+            "8.0.0": (severity: string) => string;
+        };
+    };
+    PageToolbar: {
+        item: {
+            "8.0.0": (tooltip: string) => string;
+        };
+        shotMoreItems: {
+            "8.0.0": string;
+        };
+        itemButton: {
+            "9.5.0": (title: string) => string;
+        };
+        itemButtonTitle: {
+            '10.1.0': string;
+            "8.0.0": string;
+        };
+    };
+    QueryEditorToolbarItem: {
+        button: {
+            "8.0.0": (title: string) => string;
+        };
+    };
+    OptionsGroup: {
+        group: {
+            "8.0.0": (title?: string) => string;
+        };
+        toggle: {
+            "8.0.0": (title?: string) => string;
+        };
+        groupTitle: {
+            "8.0.0": string;
+        };
+    };
+    PluginVisualization: {
+        item: {
+            "8.0.0": (title: string) => string;
+        };
+    };
+    Select: {
+        option: {
+            "8.0.0": string;
+        };
+        input: {
+            '8.3.0': () => string;
+            "8.0.0": () => string;
+        };
+        singleValue: {
+            "8.0.0": () => string;
+        };
+    };
+    DataSourcePicker: {
+        container: {
+            '10.0.0': string;
+            '8.3.0': string;
+        };
+    };
+    TimeZonePicker: {
+        containerV2: {
+            '8.3.0': string;
+            "8.0.0": string;
+        };
+    };
+    CodeEditor: {
+        container: {
+            '10.2.3': string;
+            "8.0.0": string;
+        };
+    };
+};

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

@@ -0,0 +1 @@
+export declare const MIN_GRAFANA_VERSION = "8.0.0";

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

@@ -0,0 +1,2 @@
+export { versionedComponents } from './components';
+export { versionedPages } from './pages';

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

@@ -0,0 +1,125 @@
+export declare const versionedPages: {
+    Home: {
+        url: {
+            "8.0.0": string;
+        };
+    };
+    DataSource: {
+        saveAndTest: {
+            '10.0.0': string;
+            "8.0.0": string;
+        };
+    };
+    EditDataSource: {
+        url: {
+            '10.2.0': (dataSourceUid: string) => string;
+            "8.0.0": (dataSourceUid: string) => string;
+        };
+    };
+    AddDashboard: {
+        url: {
+            "8.0.0": string;
+        };
+        itemButton: {
+            '9.5.0': (title: string) => string;
+        };
+        addNewPanel: {
+            "8.0.0": string;
+        };
+        itemButtonAddViz: {
+            "8.0.0": string;
+        };
+        Settings: {
+            Annotations: {
+                List: {
+                    url: {
+                        "8.0.0": string;
+                    };
+                };
+                Edit: {
+                    url: {
+                        "8.0.0": (annotationIndex: string) => string;
+                    };
+                };
+            };
+            Variables: {
+                List: {
+                    url: {
+                        "8.0.0": string;
+                    };
+                };
+                Edit: {
+                    url: {
+                        "8.0.0": (annotationIndex: string) => string;
+                    };
+                };
+            };
+        };
+    };
+    Dashboard: {
+        url: {
+            "8.0.0": (uid: string) => string;
+        };
+        Settings: {
+            Annotations: {
+                Edit: {
+                    url: {
+                        "8.0.0": (dashboardUid: string, annotationIndex: string) => string;
+                    };
+                };
+                List: {
+                    url: {
+                        "8.0.0": (dashboardUid: string) => string;
+                    };
+                    addAnnotationCTA: string;
+                    addAnnotationCTAV2: {
+                        '8.3.0': string;
+                    };
+                };
+            };
+            Variables: {
+                List: {
+                    url: {
+                        "8.0.0": (dashboardUid: string) => string;
+                    };
+                    newButton: {
+                        "8.0.0": string;
+                    };
+                    table: {
+                        "8.0.0": string;
+                    };
+                    addVariableCTAV2: {
+                        "8.0.0": (name: string) => string;
+                    };
+                    addVariableCTAV2Item: {
+                        "8.0.0": string;
+                    };
+                };
+                Edit: {
+                    url: {
+                        "8.0.0": (dashboardUid: string, editIndex: string) => string;
+                    };
+                    General: {
+                        generalTypeSelectV2: {
+                            '8.5.0': string;
+                            "8.0.0": string;
+                        };
+                        previewOfValuesOption: {
+                            '10.4.0': string;
+                            "8.0.0": string;
+                        };
+                        submitButton: {
+                            '10.4.0': string;
+                            "8.0.0": string;
+                        };
+                    };
+                };
+            };
+        };
+    };
+    Explore: {
+        url: {
+            "8.0.0": string;
+        };
+    };
+};

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

@@ -0,0 +1,8 @@
+import { versionedAPIs } from './apis';
+import { versionedComponents } from './components';
+import { versionedPages } from './pages';
+export type VersionedSelectors = {
+    pages: typeof versionedPages;
+    components: typeof versionedComponents;
+    apis: typeof versionedAPIs;
+};