@grafana/plugin-e2e 0.21.1 → 0.22.0-canary.821.518e194.0

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { E2ESelectors } from './e2e-selectors/types';
-import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSourceSettings, ReadProvisionedDashboardArgs, ReadProvisionedDataSourceArgs, CreateUserArgs, Dashboard, DashboardPageArgs, DashboardEditViewArgs, GotoAppConfigPageArgs } from './types';
-import { PanelEditPage, GrafanaPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage, AppConfigPage } from './models';
+import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSourceSettings, ReadProvisionedDashboardArgs, ReadProvisionedDataSourceArgs, CreateUserArgs, Dashboard, DashboardPageArgs, DashboardEditViewArgs, GotoAppConfigPageArgs, GotoAppPageArgs } from './types';
+import { PanelEditPage, GrafanaPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage, AppConfigPage, AppPage } from './models';
 import { ExplorePage } from './models/pages/ExplorePage';
 export type PluginOptions = {
     /**
@@ -221,6 +221,10 @@ export type PluginFixture = {
      * Fixture command that navigates to the AppConfigPage for a given plugin.
      */
     gotoAppConfigPage: (args: GotoAppConfigPageArgs) => Promise<AppConfigPage>;
+    /**
+     * Fixture command that navigates to an AppPage for a given plugin.
+     */
+    gotoAppPage: (args: GotoAppPageArgs) => Promise<AppPage>;
 };
 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<{

package/dist/fixtures/commands/gotoAppPage.d.ts

@@ -0,0 +1,7 @@
+import { TestFixture } from '@playwright/test';
+import { PluginFixture, PluginOptions } from '../../api';
+import { PlaywrightCombinedArgs } from '../types';
+import { AppPage, GotoAppPageArgs } from '../..';
+type GotoAppPageFixture = TestFixture<(args: GotoAppPageArgs) => Promise<AppPage>, PluginFixture & PluginOptions & PlaywrightCombinedArgs>;
+export declare const gotoAppPage: GotoAppPageFixture;
+export default gotoAppPage;

package/dist/fixtures/commands/gotoAppPage.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gotoAppPage = void 0;
+const __1 = require("../..");
+const gotoAppPage = async ({ page, selectors, grafanaVersion, request }, use, testInfo) => {
+    await use(async ({ pluginId, path }) => {
+        const appPage = new __1.AppPage({ page, selectors, grafanaVersion, request, testInfo }, { pluginId });
+        await appPage.goto({ path });
+        return appPage;
+    });
+};
+exports.gotoAppPage = gotoAppPage;
+exports.default = exports.gotoAppPage;

package/dist/fixtures/index.d.ts

@@ -19,6 +19,7 @@ declare const fixtures: {
     gotoVariableEditPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: (args: import("..").DashboardEditViewArgs<string>) => Promise<import("..").VariableEditPage>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
     gotoAnnotationEditPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: (args: import("..").DashboardEditViewArgs<string>) => Promise<import("..").AnnotationEditPage>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
     gotoDataSourceConfigPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: (uid: string) => Promise<import("..").DataSourceConfigPage>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
-    gotoAppConfigPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: (args: import("..").PluginConfigPageArgs) => Promise<import("..").AppConfigPage>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
+    gotoAppConfigPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: (args: import("..").PluginPageArgs) => Promise<import("..").AppConfigPage>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
+    gotoAppPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: (args: import("..").GotoAppPageArgs) => Promise<import("..").AppPage>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
 };
 export default fixtures;

package/dist/fixtures/index.js

@@ -24,6 +24,7 @@ const gotoVariableEditPage_1 = __importDefault(require("./commands/gotoVariableE
 const gotoAnnotationEditPage_1 = __importDefault(require("./commands/gotoAnnotationEditPage"));
 const gotoDataSourceConfigPage_1 = __importDefault(require("./commands/gotoDataSourceConfigPage"));
 const gotoAppConfigPage_1 = __importDefault(require("./commands/gotoAppConfigPage"));
+const gotoAppPage_1 = __importDefault(require("./commands/gotoAppPage"));
 const fixtures = {
     selectors: selectors_1.default,
     grafanaVersion: grafanaVersion_1.default,
@@ -46,5 +47,6 @@ const fixtures = {
     gotoAnnotationEditPage: gotoAnnotationEditPage_1.default,
     gotoDataSourceConfigPage: gotoDataSourceConfigPage_1.default,
     gotoAppConfigPage: gotoAppConfigPage_1.default,
+    gotoAppPage: gotoAppPage_1.default,
 };
 exports.default = fixtures;

package/dist/models/index.d.ts

@@ -12,3 +12,4 @@ export { Panel } from './components/Panel';
 export { TimeRange } from './components/TimeRange';
 export { AppConfigPage } from './pages/AppConfigPage';
 export { PluginConfigPage } from './pages/PluginConfigPage';
+export { AppPage } from './pages/AppPage';

package/dist/models/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluginConfigPage = exports.AppConfigPage = exports.TimeRange = exports.Panel = exports.DataSourcePicker = exports.VariablePage = exports.VariableEditPage = exports.PanelEditPage = exports.GrafanaPage = exports.ExplorePage = exports.DataSourceConfigPage = exports.DashboardPage = exports.AnnotationPage = exports.AnnotationEditPage = void 0;
+exports.AppPage = exports.PluginConfigPage = exports.AppConfigPage = exports.TimeRange = exports.Panel = exports.DataSourcePicker = exports.VariablePage = exports.VariableEditPage = exports.PanelEditPage = exports.GrafanaPage = exports.ExplorePage = exports.DataSourceConfigPage = exports.DashboardPage = exports.AnnotationPage = exports.AnnotationEditPage = void 0;
 var AnnotationEditPage_1 = require("./pages/AnnotationEditPage");
 Object.defineProperty(exports, "AnnotationEditPage", { enumerable: true, get: function () { return AnnotationEditPage_1.AnnotationEditPage; } });
 var AnnotationPage_1 = require("./pages/AnnotationPage");
@@ -29,3 +29,5 @@ var AppConfigPage_1 = require("./pages/AppConfigPage");
 Object.defineProperty(exports, "AppConfigPage", { enumerable: true, get: function () { return AppConfigPage_1.AppConfigPage; } });
 var PluginConfigPage_1 = require("./pages/PluginConfigPage");
 Object.defineProperty(exports, "PluginConfigPage", { enumerable: true, get: function () { return PluginConfigPage_1.PluginConfigPage; } });
+var AppPage_1 = require("./pages/AppPage");
+Object.defineProperty(exports, "AppPage", { enumerable: true, get: function () { return AppPage_1.AppPage; } });

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

@@ -1,10 +1,10 @@
 import { Response as PlaywrightResponse } from '@playwright/test';
-import { PluginConfigPageArgs, PluginTestCtx } from '../../types';
+import { PluginPageArgs, PluginTestCtx } from '../../types';
 import { PluginConfigPage } from './PluginConfigPage';
 export declare class AppConfigPage extends PluginConfigPage {
     readonly ctx: PluginTestCtx;
-    readonly args: PluginConfigPageArgs;
-    constructor(ctx: PluginTestCtx, args: PluginConfigPageArgs);
+    readonly args: PluginPageArgs;
+    constructor(ctx: PluginTestCtx, args: PluginPageArgs);
     /**
      * Will wait for the settings endpoint to be called e.g. when saving settings
      */

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

@@ -0,0 +1,12 @@
+import { AppPageNavigateOptions, PluginPageArgs, PluginTestCtx } from '../../types';
+import { GrafanaPage } from '..';
+export declare class AppPage extends GrafanaPage {
+    readonly ctx: PluginTestCtx;
+    readonly args: PluginPageArgs;
+    constructor(ctx: PluginTestCtx, args: PluginPageArgs);
+    /**
+     * Will append the `/a/${pluginId}` before the provided path and then
+     * navigate to the page.
+     */
+    goto(options?: AppPageNavigateOptions): Promise<void>;
+}

package/dist/models/pages/AppPage.js

@@ -0,0 +1,47 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppPage = void 0;
+const nodePath = __importStar(require("path"));
+const __1 = require("..");
+class AppPage extends __1.GrafanaPage {
+    ctx;
+    args;
+    constructor(ctx, args) {
+        super(ctx);
+        this.ctx = ctx;
+        this.args = args;
+    }
+    /**
+     * Will append the `/a/${pluginId}` before the provided path and then
+     * navigate to the page.
+     */
+    goto(options) {
+        const path = options?.path ?? '';
+        const url = nodePath.join('/a/', this.args.pluginId, path);
+        return super.navigate(url, options);
+    }
+}
+exports.AppPage = AppPage;

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

@@ -1,9 +1,9 @@
-import { PluginConfigPageArgs, NavigateOptions, PluginTestCtx } from '../../types';
+import { PluginPageArgs, NavigateOptions, PluginTestCtx } from '../../types';
 import { GrafanaPage } from './GrafanaPage';
 export declare class PluginConfigPage extends GrafanaPage {
     readonly ctx: PluginTestCtx;
-    readonly args: PluginConfigPageArgs;
-    constructor(ctx: PluginTestCtx, args: PluginConfigPageArgs);
+    readonly args: PluginPageArgs;
+    constructor(ctx: PluginTestCtx, args: PluginPageArgs);
     /**
      * Navigates to the app plugin config page.
      */

package/dist/types.d.ts

@@ -173,6 +173,9 @@ export type NavigateOptions = {
      */
     queryParams?: URLSearchParams;
 };
+export type AppPageNavigateOptions = NavigateOptions & {
+    path?: string;
+};
 export type GetByTestIdOrAriaLabelOptions = {
     /**
      *Optional root locator to search within. If no locator is provided, the page will be used
@@ -246,7 +249,10 @@ export interface ContainTextOptions {
      */
     useInnerText?: boolean;
 }
-export type PluginConfigPageArgs = {
+export type PluginPageArgs = {
     pluginId: string;
 };
-export type GotoAppConfigPageArgs = PluginConfigPageArgs;
+export type GotoAppConfigPageArgs = PluginPageArgs;
+export type GotoAppPageArgs = PluginPageArgs & {
+    path?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.21.1",
+  "version": "0.22.0-canary.821.518e194.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -55,5 +55,5 @@
       "start": "cls || clear"
     }
   },
-  "gitHead": "b8e8992b5515564b3c6aabd98696d1b32f9d7baa"
+  "gitHead": "518e1941e100a497366c4e969792e84c7efcc99d"
 }