@grafana/plugin-e2e 0.24.0 → 0.25.0

package/dist/fixtures/selectors.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.selectors = void 0;
 const e2e_selectors_1 = require("../e2e-selectors");
 const versioned_1 = require("../e2e-selectors/versioned");
 const apis_1 = require("../e2e-selectors/versioned/apis");
@@ -11,4 +12,4 @@ const selectors = async ({ grafanaVersion }, use) => {
     }, grafanaVersion);
     await use(selectors);
 };
-exports.default = selectors;
+exports.selectors = selectors;

package/dist/fixtures/variableEditPage.d.ts

@@ -1,7 +1,6 @@
 import { TestFixture } from '@playwright/test';
-import { PluginFixture, PluginOptions } from '../api';
-import { VariableEditPage } from '../models';
-import { PlaywrightCombinedArgs } from './types';
-type VariableEditPageFixture = TestFixture<VariableEditPage, PluginFixture & PluginOptions & PlaywrightCombinedArgs>;
-declare const variableEditPage: VariableEditPageFixture;
-export default variableEditPage;
+import { PlaywrightArgs } from '../types';
+import { VariableEditPage } from '../models/pages/VariableEditPage';
+type VariableEditPageFixture = TestFixture<VariableEditPage, PlaywrightArgs>;
+export declare const variableEditPage: VariableEditPageFixture;
+export {};

package/dist/fixtures/variableEditPage.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const models_1 = require("../models");
+exports.variableEditPage = void 0;
+const VariablePage_1 = require("../models/pages/VariablePage");
 const variableEditPage = async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
-    const variablePage = new models_1.VariablePage({ page, selectors, grafanaVersion, request, testInfo });
+    const variablePage = new VariablePage_1.VariablePage({ page, selectors, grafanaVersion, request, testInfo });
     await variablePage.goto();
     const variableEditPage = await variablePage.clickAddNew();
     await use(variableEditPage);
 };
-exports.default = variableEditPage;
+exports.variableEditPage = variableEditPage;

package/dist/index.d.ts

@@ -1,10 +1,50 @@
-import { GrafanaPage, VariableEditPage } from './models';
-import { AlertPageOptions, AlertVariant, ContainTextOptions } from './types';
-export { expect, test, type PluginFixture, type PluginOptions } from './api';
-export * from './e2e-selectors';
-export * from './fixtures';
-export * from './models';
+import { AlertPageOptions, AlertVariant, ContainTextOptions, PluginFixture, PluginOptions } from './types';
+import { GrafanaPage } from './models/pages/GrafanaPage';
+import { VariableEditPage } from './models/pages/VariableEditPage';
+export { DataSourcePicker } from './models/components/DataSourcePicker';
+export { Panel } from './models/components/Panel';
+export { TimeRange } from './models/components/TimeRange';
+export { AnnotationEditPage } from './models/pages/AnnotationEditPage';
+export { AnnotationPage } from './models/pages/AnnotationPage';
+export { DashboardPage } from './models/pages/DashboardPage';
+export { DataSourceConfigPage } from './models/pages/DataSourceConfigPage';
+export { ExplorePage } from './models/pages/ExplorePage';
+export { GrafanaPage } from './models/pages/GrafanaPage';
+export { PanelEditPage } from './models/pages/PanelEditPage';
+export { VariableEditPage } from './models/pages/VariableEditPage';
+export { VariablePage } from './models/pages/VariablePage';
+export { AppConfigPage } from './models/pages/AppConfigPage';
+export { PluginConfigPage } from './models/pages/PluginConfigPage';
+export { AppPage } from './models/pages/AppPage';
+export { Components, Pages, APIs, E2ESelectors } from './e2e-selectors/types';
+export { resolveSelectors } from './e2e-selectors/resolver';
 export * from './types';
+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<{
+    toHaveAlert: (grafanaPage: GrafanaPage, severity: import("./matchers/toHaveAlert").AlertVariant, options?: AlertPageOptions | undefined) => Promise<{
+        message: () => any;
+        pass: boolean;
+    }>;
+    toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: (string | RegExp)[], options?: ContainTextOptions | undefined) => Promise<{
+        pass: boolean;
+        actual: boolean;
+        message: () => string;
+    } | {
+        message: () => string;
+        pass: boolean;
+        actual: undefined;
+    }>;
+    toBeOK: (request: Promise<import("@playwright/test").Response>) => Promise<{
+        message: () => string;
+        pass: boolean;
+        actual: number;
+    } | {
+        message: () => string;
+        pass: boolean;
+        actual: undefined;
+    }>;
+}>;
+export { selectors } from '@playwright/test';
 declare global {
     interface Window {
         monaco: any;

package/dist/index.js

@@ -14,11 +14,109 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.test = exports.expect = void 0;
-var api_1 = require("./api");
-Object.defineProperty(exports, "expect", { enumerable: true, get: function () { return api_1.expect; } });
-Object.defineProperty(exports, "test", { enumerable: true, get: function () { return api_1.test; } });
-__exportStar(require("./e2e-selectors"), exports);
-__exportStar(require("./fixtures"), exports);
-__exportStar(require("./models"), exports);
+exports.selectors = exports.expect = exports.test = exports.resolveSelectors = exports.AppPage = exports.PluginConfigPage = exports.AppConfigPage = exports.VariablePage = exports.VariableEditPage = exports.PanelEditPage = exports.GrafanaPage = exports.ExplorePage = exports.DataSourceConfigPage = exports.DashboardPage = exports.AnnotationPage = exports.AnnotationEditPage = exports.TimeRange = exports.Panel = exports.DataSourcePicker = void 0;
+const test_1 = require("@playwright/test");
+const annotationEditPage_1 = require("./fixtures/annotationEditPage");
+const createDataSource_1 = require("./fixtures/commands/createDataSource");
+const createDataSourceConfigPage_1 = require("./fixtures/commands/createDataSourceConfigPage");
+const createUser_1 = require("./fixtures/commands/createUser");
+const gotoAnnotationEditPage_1 = require("./fixtures/commands/gotoAnnotationEditPage");
+const gotoAppConfigPage_1 = require("./fixtures/commands/gotoAppConfigPage");
+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 gotoVariableEditPage_1 = require("./fixtures/commands/gotoVariableEditPage");
+const login_1 = require("./fixtures/commands/login");
+const readProvisionedDashboard_1 = require("./fixtures/commands/readProvisionedDashboard");
+const readProvisionedDataSource_1 = require("./fixtures/commands/readProvisionedDataSource");
+const dashboardPage_1 = require("./fixtures/dashboardPage");
+const explorePage_1 = require("./fixtures/explorePage");
+const grafanaVersion_1 = require("./fixtures/grafanaVersion");
+const isFeatureToggleEnabled_1 = require("./fixtures/isFeatureToggleEnabled");
+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 options_1 = require("./options");
+const selectorEngine_1 = require("./selectorEngine");
+const toHaveAlert_1 = require("./matchers/toHaveAlert");
+const toDisplayPreviews_1 = require("./matchers/toDisplayPreviews");
+const toBeOK_1 = require("./matchers/toBeOK");
+// models
+var DataSourcePicker_1 = require("./models/components/DataSourcePicker");
+Object.defineProperty(exports, "DataSourcePicker", { enumerable: true, get: function () { return DataSourcePicker_1.DataSourcePicker; } });
+var Panel_1 = require("./models/components/Panel");
+Object.defineProperty(exports, "Panel", { enumerable: true, get: function () { return Panel_1.Panel; } });
+var TimeRange_1 = require("./models/components/TimeRange");
+Object.defineProperty(exports, "TimeRange", { enumerable: true, get: function () { return TimeRange_1.TimeRange; } });
+var AnnotationEditPage_1 = require("./models/pages/AnnotationEditPage");
+Object.defineProperty(exports, "AnnotationEditPage", { enumerable: true, get: function () { return AnnotationEditPage_1.AnnotationEditPage; } });
+var AnnotationPage_1 = require("./models/pages/AnnotationPage");
+Object.defineProperty(exports, "AnnotationPage", { enumerable: true, get: function () { return AnnotationPage_1.AnnotationPage; } });
+var DashboardPage_1 = require("./models/pages/DashboardPage");
+Object.defineProperty(exports, "DashboardPage", { enumerable: true, get: function () { return DashboardPage_1.DashboardPage; } });
+var DataSourceConfigPage_1 = require("./models/pages/DataSourceConfigPage");
+Object.defineProperty(exports, "DataSourceConfigPage", { enumerable: true, get: function () { return DataSourceConfigPage_1.DataSourceConfigPage; } });
+var ExplorePage_1 = require("./models/pages/ExplorePage");
+Object.defineProperty(exports, "ExplorePage", { enumerable: true, get: function () { return ExplorePage_1.ExplorePage; } });
+var GrafanaPage_1 = require("./models/pages/GrafanaPage");
+Object.defineProperty(exports, "GrafanaPage", { enumerable: true, get: function () { return GrafanaPage_1.GrafanaPage; } });
+var PanelEditPage_1 = require("./models/pages/PanelEditPage");
+Object.defineProperty(exports, "PanelEditPage", { enumerable: true, get: function () { return PanelEditPage_1.PanelEditPage; } });
+var VariableEditPage_1 = require("./models/pages/VariableEditPage");
+Object.defineProperty(exports, "VariableEditPage", { enumerable: true, get: function () { return VariableEditPage_1.VariableEditPage; } });
+var VariablePage_1 = require("./models/pages/VariablePage");
+Object.defineProperty(exports, "VariablePage", { enumerable: true, get: function () { return VariablePage_1.VariablePage; } });
+var AppConfigPage_1 = require("./models/pages/AppConfigPage");
+Object.defineProperty(exports, "AppConfigPage", { enumerable: true, get: function () { return AppConfigPage_1.AppConfigPage; } });
+var PluginConfigPage_1 = require("./models/pages/PluginConfigPage");
+Object.defineProperty(exports, "PluginConfigPage", { enumerable: true, get: function () { return PluginConfigPage_1.PluginConfigPage; } });
+var AppPage_1 = require("./models/pages/AppPage");
+Object.defineProperty(exports, "AppPage", { enumerable: true, get: function () { return AppPage_1.AppPage; } });
+var resolver_1 = require("./e2e-selectors/resolver");
+Object.defineProperty(exports, "resolveSelectors", { enumerable: true, get: function () { return resolver_1.resolveSelectors; } });
+// types
 __exportStar(require("./types"), exports);
+exports.test = test_1.test.extend({
+    selectors: selectors_1.selectors,
+    grafanaVersion: grafanaVersion_1.grafanaVersion,
+    login: login_1.login,
+    createDataSourceConfigPage: createDataSourceConfigPage_1.createDataSourceConfigPage,
+    page: page_1.page,
+    dashboardPage: dashboardPage_1.dashboardPage,
+    panelEditPage: panelEditPage_1.panelEditPage,
+    variableEditPage: variableEditPage_1.variableEditPage,
+    annotationEditPage: annotationEditPage_1.annotationEditPage,
+    explorePage: explorePage_1.explorePage,
+    createDataSource: createDataSource_1.createDataSource,
+    readProvisionedDataSource: readProvisionedDataSource_1.readProvisionedDataSource,
+    readProvisionedDashboard: readProvisionedDashboard_1.readProvisionedDashboard,
+    isFeatureToggleEnabled: isFeatureToggleEnabled_1.isFeatureToggleEnabled,
+    createUser: createUser_1.createUser,
+    gotoDashboardPage: gotoDashboardPage_1.gotoDashboardPage,
+    gotoPanelEditPage: gotoPanelEditPage_1.gotoPanelEditPage,
+    gotoVariableEditPage: gotoVariableEditPage_1.gotoVariableEditPage,
+    gotoAnnotationEditPage: gotoAnnotationEditPage_1.gotoAnnotationEditPage,
+    gotoDataSourceConfigPage: gotoDataSourceConfigPage_1.gotoDataSourceConfigPage,
+    gotoAppConfigPage: gotoAppConfigPage_1.gotoAppConfigPage,
+    gotoAppPage: gotoAppPage_1.gotoAppPage,
+    ...options_1.options,
+});
+exports.expect = test_1.expect.extend({
+    toHaveAlert: toHaveAlert_1.toHaveAlert,
+    toDisplayPreviews: toDisplayPreviews_1.toDisplayPreviews,
+    toBeOK: toBeOK_1.toBeOK,
+});
+/** Register a custom selector engine that resolves locators for Grafana E2E selectors
+ *
+ * The same functionality is available in the {@link GrafanaPage.getByTestIdOrAriaLabel} method. However,
+ * by registering the selector engine, one can resolve locators by Grafana E2E selectors also within a locator.
+ *
+ * Example:
+ * const queryEditorRow = await panelEditPage.getQueryEditorRow('A'); // returns a locator
+ * queryEditorRow.locator(`selector=${selectors.components.TimePicker.openButton}`).click();
+ * */
+test_1.selectors.register('selector', selectorEngine_1.grafanaE2ESelectorEngine);
+var test_2 = require("@playwright/test");
+Object.defineProperty(exports, "selectors", { enumerable: true, get: function () { return test_2.selectors; } });

package/dist/matchers/toBeOK.d.ts

@@ -1,5 +1,5 @@
 import { Response } from '@playwright/test';
-declare const toBeOK: (request: Promise<Response>) => Promise<{
+export declare const toBeOK: (request: Promise<Response>) => Promise<{
     message: () => string;
     pass: boolean;
     actual: number;
@@ -8,4 +8,3 @@ declare const toBeOK: (request: Promise<Response>) => Promise<{
     pass: boolean;
     actual: undefined;
 }>;
-export default toBeOK;

package/dist/matchers/toBeOK.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.toBeOK = void 0;
 const utils_1 = require("./utils");
 const toBeOK = async (request) => {
     let pass = false;
@@ -21,4 +22,4 @@ const toBeOK = async (request) => {
         };
     }
 };
-exports.default = toBeOK;
+exports.toBeOK = toBeOK;

package/dist/matchers/toDisplayPreviews.d.ts

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

package/dist/matchers/toDisplayPreviews.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.toDisplayPreviews = void 0;
 const test_1 = require("@playwright/test");
 const utils_1 = require("./utils");
 const toDisplayPreviews = async (variableEditPage, previewTexts, options) => {
@@ -22,4 +23,4 @@ const toDisplayPreviews = async (variableEditPage, previewTexts, options) => {
         };
     }
 };
-exports.default = toDisplayPreviews;
+exports.toDisplayPreviews = toDisplayPreviews;

package/dist/matchers/toHaveAlert.d.ts

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

package/dist/matchers/toHaveAlert.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.toHaveAlert = void 0;
 const test_1 = require("@playwright/test");
 const utils_1 = require("./utils");
 const toHaveAlert = async (grafanaPage, severity, options) => {
@@ -25,4 +26,4 @@ const toHaveAlert = async (grafanaPage, severity, options) => {
         pass,
     };
 };
-exports.default = toHaveAlert;
+exports.toHaveAlert = toHaveAlert;

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

@@ -1,5 +1,5 @@
 import { AppPageNavigateOptions, PluginPageArgs, PluginTestCtx } from '../../types';
-import { GrafanaPage } from '..';
+import { GrafanaPage } from './GrafanaPage';
 export declare class AppPage extends GrafanaPage {
     readonly ctx: PluginTestCtx;
     readonly args: PluginPageArgs;

package/dist/models/pages/AppPage.js

@@ -25,8 +25,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppPage = void 0;
 const nodePath = __importStar(require("path"));
-const __1 = require("..");
-class AppPage extends __1.GrafanaPage {
+const GrafanaPage_1 = require("./GrafanaPage");
+class AppPage extends GrafanaPage_1.GrafanaPage {
     ctx;
     args;
     constructor(ctx, args) {

package/dist/options.d.ts

@@ -0,0 +1,3 @@
+import { Fixtures } from '@playwright/test';
+import { PluginOptions } from './types';
+export declare const options: Fixtures<{}, PluginOptions>;

package/dist/{options/index.js → options.js}

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