@grafana/plugin-e2e 0.13.2 → 0.14.0-canary.740.aade71f.0

package/dist/api.d.ts

@@ -1,5 +1,5 @@
 import { E2ESelectors } from './e2e-selectors/types';
-import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSource, ReadProvisionArgs } from './types';
+import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSourceSettings, ReadProvisionedDataSourceArgs } from './types';
 import { PanelEditPage, GrafanaPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage } from './models';
 import { ExplorePage } from './models/ExplorePage';
 export type PluginOptions = {
@@ -114,7 +114,7 @@ export type PluginFixture = {
      * 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>;
+    createDataSource: (args: CreateDataSourceArgs) => Promise<DataSourceSettings>;
     /**
      * Fixture command that login to Grafana using the Grafana API.
      * If the same credentials should be used in every test,
@@ -141,10 +141,13 @@ export type PluginFixture = {
      */
     login: () => Promise<void>;
     /**
-     * Fixture command that reads a the yaml file for a provisioned dashboard
-     * or data source and returns it as json.
+     * Fixture command that reads a yaml file in the provisioning/datasources directory.
+     *
+     * The file name should be the name of the file with the .yaml|.yml extension.
+     * If a data source name is provided, the first data source that matches the name will be returned.
+     * If no name is provided, the first data source in the list of data sources will be returned.
      */
-    readProvision<T = any>(args: ReadProvisionArgs): Promise<T>;
+    readProvisionedDataSource<T = {}, S = {}>(args: ReadProvisionedDataSourceArgs): Promise<DataSourceSettings<T, S>>;
     /**
      * Function that checks if a feature toggle is enabled. Only works for frontend feature toggles.
      */
@@ -172,7 +175,28 @@ export declare const expect: import("@playwright/test").Expect<{
     }>;
     toHaveAlert: (grafanaPage: GrafanaPage, severity: import("./matchers/toHaveAlert").AlertVariant, options?: import("./types").AlertPageOptions | undefined) => Promise<{
         message: () => any;
-        pass: boolean;
+        pass: boolean; /**
+         * 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,
+            },
+         * });
+         */
     }>;
 }>;
 export { selectors } from '@playwright/test';

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

@@ -1,8 +1,8 @@
 import { APIRequestContext, TestFixture } from '@playwright/test';
 import { PluginFixture, PluginOptions } from '../../api';
-import { CreateDataSourceArgs, DataSource } from '../../types';
+import { CreateDataSourceArgs, DataSourceSettings } from '../../types';
 import { PlaywrightCombinedArgs } from '../types';
-type CreateDataSourceViaAPIFixture = TestFixture<(args: CreateDataSourceArgs) => Promise<DataSource>, PluginFixture & PluginOptions & PlaywrightCombinedArgs>;
-export declare const createDataSourceViaAPI: (request: APIRequestContext, datasource: CreateDataSourceArgs) => Promise<DataSource>;
+type CreateDataSourceViaAPIFixture = TestFixture<(args: CreateDataSourceArgs) => Promise<DataSourceSettings>, PluginFixture & PluginOptions & PlaywrightCombinedArgs>;
+export declare const createDataSourceViaAPI: (request: APIRequestContext, datasource: CreateDataSourceArgs) => Promise<DataSourceSettings>;
 declare const createDataSource: CreateDataSourceViaAPIFixture;
 export default createDataSource;

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

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

package/dist/fixtures/commands/readProvisionedDataSource.js

@@ -0,0 +1,20 @@
+"use strict";
+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 readProvisionedDataSource = async ({ provisioningRootDir }, use) => {
+    await use(async ({ fileName: filePath, name }) => {
+        const resolvedPath = path_1.default.resolve(path_1.default.join(provisioningRootDir, 'datasources', filePath));
+        const contents = await fs_1.promises.readFile(resolvedPath, 'utf8');
+        const yml = (0, yaml_1.parse)(contents);
+        if (!name) {
+            return yml.datasources[0];
+        }
+        return yml.datasources.find((ds) => ds.name === name);
+    });
+};
+exports.default = readProvisionedDataSource;

package/dist/fixtures/index.d.ts

@@ -9,8 +9,9 @@ declare const fixtures: {
     variableEditPage: (args: import("..").PluginFixture & import("..").PluginOptions & import("playwright/test").PlaywrightTestArgs & import("playwright/test").PlaywrightTestOptions & import("playwright/test").PlaywrightWorkerArgs & import("playwright/test").PlaywrightWorkerOptions, use: (r: import("..").VariableEditPage) => Promise<void>, testInfo: import("playwright/test").TestInfo) => any;
     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("../models/ExplorePage").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("../types").CreateDataSourceArgs) => Promise<import("../types").DataSource<any>>) => 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("../types").CreateDataSourceArgs) => Promise<import("../types").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("../types").ReadProvisionArgs) => Promise<T>) => 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_1 = object>(featureToggle: keyof T_1) => Promise<boolean>) => 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("../types").ReadProvisionedDataSourceArgs) => 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;
 };
 export default fixtures;

package/dist/fixtures/index.js

@@ -11,6 +11,7 @@ const createDataSourceConfigPage_1 = __importDefault(require("./commands/createD
 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 newDashboardPage_1 = __importDefault(require("./newDashboardPage"));
 const variableEditPage_1 = __importDefault(require("./variableEditPage"));
 const explorePage_1 = __importDefault(require("./explorePage"));
@@ -29,6 +30,7 @@ const fixtures = {
     explorePage: explorePage_1.default,
     createDataSource: createDataSource_1.default,
     readProvision: readProvision_1.default,
+    readProvisionedDataSource: readProvisionedDataSource_1.default,
     isFeatureToggleEnabled: isFeatureToggleEnabled_1.default,
 };
 exports.default = fixtures;

package/dist/models/DataSourceConfigPage.d.ts

@@ -1,9 +1,9 @@
 import { Response } from '@playwright/test';
-import { DataSource, NavigateOptions, PluginTestCtx, TriggerQueryOptions } from '../types';
+import { DataSourceSettings, NavigateOptions, PluginTestCtx, TriggerQueryOptions } from '../types';
 import { GrafanaPage } from './GrafanaPage';
 export declare class DataSourceConfigPage extends GrafanaPage {
     private datasource;
-    constructor(ctx: PluginTestCtx, datasource: DataSource);
+    constructor(ctx: PluginTestCtx, datasource: DataSourceSettings);
     deleteDataSource(): Promise<void>;
     /**
      * Navigates to the datasource edit page for an existing datasource

package/dist/types.d.ts

@@ -8,21 +8,21 @@ export type PluginTestCtx = {
     selectors: E2ESelectors;
 } & Pick<PlaywrightTestArgs, 'page' | 'request'>;
 /**
- * The data source object
+ * The data source settings
  */
-export interface DataSource<T = any> {
+export interface DataSourceSettings<T = {}, S = {}> {
     id: number;
     editable?: boolean;
     uid: string;
     orgId?: number;
-    name?: string;
+    name: string;
     type: string;
     access?: string;
     url?: string;
     database?: string;
     isDefault?: boolean;
-    jsonData?: T;
-    secureJsonData?: T;
+    jsonData: T;
+    secureJsonData?: S;
 }
 /**
  * The dashboard object
@@ -31,12 +31,6 @@ export interface Dashboard {
     uid: string;
     title?: string;
 }
-/**
- * The YAML provision file parsed to a javascript object
- */
-export type ProvisionFile<T = DataSource> = {
-    datasources: Array<DataSource<T>>;
-};
 export type CreateDataSourceArgs<T = any> = {
     /**
      * The data source to create
@@ -129,6 +123,16 @@ export type ReadProvisionArgs = {
      */
     filePath: string;
 };
+export type ReadProvisionedDataSourceArgs = {
+    /**
+     * The path, relative to the provisioning folder, to the dashboard json file
+     */
+    fileName: string;
+    /**
+     * The name of the data source in the datasources list
+     */
+    name?: string;
+};
 export type NavigateOptions = {
     /**
      * Referer header value.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.13.2",
+  "version": "0.14.0-canary.740.aade71f.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -45,5 +45,5 @@
     "semver": "^7.5.4",
     "uuid": "^9.0.1"
   },
-  "gitHead": "e33d8bcf282d0642b0207c07eee75c68a0611f02"
+  "gitHead": "aade71f7c634349d24ff8ae8ac4885d480034ad6"
 }