@grafana/plugin-e2e 0.16.0 → 0.17.0

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { E2ESelectors } from './e2e-selectors/types';
-import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSourceSettings, ReadProvisionedDataSourceArgs, CreateUserArgs } from './types';
+import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSourceSettings, ReadProvisionedDashboardArgs, ReadProvisionedDataSourceArgs, CreateUserArgs, Dashboard } from './types';
 import { PanelEditPage, GrafanaPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage } from './models';
 import { ExplorePage } from './models/pages/ExplorePage';
 export type PluginOptions = {
@@ -192,6 +192,12 @@ export type PluginFixture = {
      * If no name is provided, the first data source in the list of data sources will be returned.
      */
     readProvisionedDataSource<T = {}, S = {}>(args: ReadProvisionedDataSourceArgs): Promise<DataSourceSettings<T, S>>;
+    /**
+     * Fixture command that reads a dashboard json file in the provisioning/dashboards directory.
+     *
+     * Can be useful when navigating to a provisioned dashboard and you don't want to hard code the dashboard UID.
+     */
+    readProvisionedDashboard(args: ReadProvisionedDashboardArgs): Promise<Dashboard>;
     /**
      * Function that checks if a feature toggle is enabled. Only works for frontend feature toggles.
      */

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

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

package/dist/fixtures/commands/{readProvision.js → readProvisionedDashboard.js}

@@ -3,14 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
-const yaml_1 = require("yaml");
-const readProvision = async ({ provisioningRootDir }, use) => {
-    await use(async ({ filePath }) => {
-        const resolvedPath = path_1.default.resolve(path_1.default.join(provisioningRootDir, filePath));
+const fs_1 = require("fs");
+const DASHBOARDS_DIR = 'dashboards';
+const readProvisionedDashboard = async ({ provisioningRootDir }, use) => {
+    await use(async ({ fileName }) => {
+        const resolvedPath = path_1.default.resolve(path_1.default.join(provisioningRootDir, DASHBOARDS_DIR, fileName));
         const contents = await fs_1.promises.readFile(resolvedPath, 'utf8');
-        return (0, yaml_1.parse)(contents);
+        return JSON.parse(contents);
     });
 };
-exports.default = readProvision;
+exports.default = readProvisionedDashboard;

package/dist/fixtures/commands/readProvisionedDataSource.js

@@ -6,9 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const yaml_1 = require("yaml");
+const DATASOURCES_DIR = 'datasources';
 const readProvisionedDataSource = async ({ provisioningRootDir }, use) => {
     await use(async ({ fileName: filePath, name }) => {
-        const resolvedPath = path_1.default.resolve(path_1.default.join(provisioningRootDir, 'datasources', filePath));
+        const resolvedPath = path_1.default.resolve(path_1.default.join(provisioningRootDir, DATASOURCES_DIR, filePath));
         const contents = await fs_1.promises.readFile(resolvedPath, 'utf8');
         const yml = (0, yaml_1.parse)(contents);
         if (!name) {

package/dist/fixtures/index.d.ts

@@ -10,8 +10,8 @@ declare const fixtures: {
     annotationEditPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: import("..").AnnotationEditPage) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
     explorePage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: import("..").ExplorePage) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
     createDataSource: (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("..").CreateDataSourceArgs) => Promise<import("..").DataSourceSettings<{}, {}>>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
-    readProvision: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: <T = any>(args: import("..").ReadProvisionArgs) => Promise<T>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
-    readProvisionedDataSource: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: <T_1 = any>(args: import("..").ReadProvisionedDataSourceArgs) => Promise<T_1>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
+    readProvisionedDataSource: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: <T = any>(args: import("..").ReadProvisionedDataSourceArgs) => Promise<T>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
+    readProvisionedDashboard: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: <T_1 = any>(args: import("..").ReadProvisionedDashboardArgs) => Promise<T_1>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
     isFeatureToggleEnabled: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: <T_2 = object>(featureToggle: keyof T_2) => Promise<boolean>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
     createUser: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: () => Promise<void>) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
 };

package/dist/fixtures/index.js

@@ -10,8 +10,8 @@ const login_1 = __importDefault(require("./commands/login"));
 const createDataSourceConfigPage_1 = __importDefault(require("./commands/createDataSourceConfigPage"));
 const panelEditPage_1 = __importDefault(require("./panelEditPage"));
 const createDataSource_1 = __importDefault(require("./commands/createDataSource"));
-const readProvision_1 = __importDefault(require("./commands/readProvision"));
 const readProvisionedDataSource_1 = __importDefault(require("./commands/readProvisionedDataSource"));
+const readProvisionedDashboard_1 = __importDefault(require("./commands/readProvisionedDashboard"));
 const newDashboardPage_1 = __importDefault(require("./newDashboardPage"));
 const variableEditPage_1 = __importDefault(require("./variableEditPage"));
 const explorePage_1 = __importDefault(require("./explorePage"));
@@ -30,8 +30,8 @@ const fixtures = {
     annotationEditPage: annotationEditPage_1.default,
     explorePage: explorePage_1.default,
     createDataSource: createDataSource_1.default,
-    readProvision: readProvision_1.default,
     readProvisionedDataSource: readProvisionedDataSource_1.default,
+    readProvisionedDashboard: readProvisionedDashboard_1.default,
     isFeatureToggleEnabled: isFeatureToggleEnabled_1.default,
     createUser: createUser_1.default,
 };

package/dist/types.d.ts

@@ -132,11 +132,11 @@ export type DashboardEditViewArgs<T> = {
     dashboard?: DashboardPageArgs;
     id: T;
 };
-export type ReadProvisionArgs = {
+export type ReadProvisionedDashboardArgs = {
     /**
      * The path, relative to the provisioning folder, to the dashboard json file
      */
-    filePath: string;
+    fileName: string;
 };
 export type ReadProvisionedDataSourceArgs = {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -45,5 +45,5 @@
     "semver": "^7.5.4",
     "uuid": "^9.0.1"
   },
-  "gitHead": "959073a920b21a7a650449446bdac9693cc68a65"
+  "gitHead": "8841e5d604d588ccf42d771fff63007c8bde4d25"
 }

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

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