@grafana/plugin-e2e 0.0.0 → 0.0.1

package/dist/models/VariableEditPage.js

@@ -0,0 +1,109 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VariableEditPage = void 0;
+var gte = require('semver/functions/gte');
+var DataSourcePicker_1 = require("./DataSourcePicker");
+var GrafanaPage_1 = require("./GrafanaPage");
+var VariableEditPage = (function (_super) {
+    __extends(VariableEditPage, _super);
+    function VariableEditPage(ctx) {
+        var _this = _super.call(this, ctx) || this;
+        _this.datasource = new DataSourcePicker_1.DataSourcePicker(ctx);
+        return _this;
+    }
+    VariableEditPage.prototype.setVariableType = function (type) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.Dashboard.Settings.Variables.Edit.General.generalTypeSelectV2)
+                            .locator('input')
+                            .fill(type)];
+                    case 1:
+                        _a.sent();
+                        return [4, this.ctx.page.keyboard.press('ArrowDown')];
+                    case 2:
+                        _a.sent();
+                        return [4, this.ctx.page.keyboard.press('Enter')];
+                    case 3:
+                        _a.sent();
+                        return [4, this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.Dashboard.Settings.Variables.Edit.General.generalTypeSelectV2).scrollIntoViewIfNeeded()];
+                    case 4:
+                        _a.sent();
+                        return [2];
+                }
+            });
+        });
+    };
+    VariableEditPage.prototype.runQuery = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!gte(this.ctx.grafanaVersion, '9.2.0')) return [3, 2];
+                        return [4, this.getByTestIdOrAriaLabel(this.ctx.selectors.pages.Dashboard.Settings.Variables.Edit.General.submitButton).click()];
+                    case 1:
+                        _a.sent();
+                        return [3, 4];
+                    case 2: return [4, this.ctx.page.keyboard.press('Tab')];
+                    case 3:
+                        _a.sent();
+                        _a.label = 4;
+                    case 4: return [2];
+                }
+            });
+        });
+    };
+    return VariableEditPage;
+}(GrafanaPage_1.GrafanaPage));
+exports.VariableEditPage = VariableEditPage;

package/dist/models/VariablePage.d.ts

@@ -0,0 +1,8 @@
+import { PluginTestCtx } from '../types';
+import { GrafanaPage } from './GrafanaPage';
+import { VariableEditPage } from './VariableEditPage';
+export declare class VariablePage extends GrafanaPage {
+    constructor(ctx: PluginTestCtx);
+    goto(): Promise<void>;
+    clickAddNew(): Promise<VariableEditPage>;
+}

package/dist/models/VariablePage.js

@@ -0,0 +1,107 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VariablePage = void 0;
+var GrafanaPage_1 = require("./GrafanaPage");
+var VariableEditPage_1 = require("./VariableEditPage");
+var VariablePage = (function (_super) {
+    __extends(VariablePage, _super);
+    function VariablePage(ctx) {
+        return _super.call(this, ctx) || this;
+    }
+    VariablePage.prototype.goto = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.ctx.page.goto(this.ctx.selectors.pages.AddDashboard.Settings.Variables.url, {
+                            waitUntil: 'networkidle',
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2];
+                }
+            });
+        });
+    };
+    VariablePage.prototype.clickAddNew = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, addVariableCTAV2, addVariableCTAV2Item, newButton, ctaSelector, error_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        _a = this.ctx.selectors.pages.Dashboard.Settings.Variables.List, addVariableCTAV2 = _a.addVariableCTAV2, addVariableCTAV2Item = _a.addVariableCTAV2Item, newButton = _a.newButton;
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 4, , 6]);
+                        ctaSelector = this.getByTestIdOrAriaLabel(addVariableCTAV2(addVariableCTAV2Item));
+                        return [4, ctaSelector.waitFor()];
+                    case 2:
+                        _b.sent();
+                        return [4, ctaSelector.click()];
+                    case 3:
+                        _b.sent();
+                        return [3, 6];
+                    case 4:
+                        error_1 = _b.sent();
+                        return [4, this.getByTestIdOrAriaLabel(newButton).click()];
+                    case 5:
+                        _b.sent();
+                        return [3, 6];
+                    case 6: return [2, new VariableEditPage_1.VariableEditPage(this.ctx)];
+                }
+            });
+        });
+    };
+    return VariablePage;
+}(GrafanaPage_1.GrafanaPage));
+exports.VariablePage = VariablePage;

package/dist/models/index.d.ts

@@ -0,0 +1,8 @@
+export { AnnotationEditPage } from './AnnotationEditPage';
+export { AnnotationPage } from './AnnotationPage';
+export { DashboardPage } from './DashboardPage';
+export { DataSourceConfigPage } from './DataSourceConfigPage';
+export { GrafanaPage } from './GrafanaPage';
+export { PanelEditPage } from './PanelEditPage';
+export { VariableEditPage } from './VariableEditPage';
+export { VariablePage } from './VariablePage';

package/dist/models/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VariablePage = exports.VariableEditPage = exports.PanelEditPage = exports.GrafanaPage = exports.DataSourceConfigPage = exports.DashboardPage = exports.AnnotationPage = exports.AnnotationEditPage = void 0;
+var AnnotationEditPage_1 = require("./AnnotationEditPage");
+Object.defineProperty(exports, "AnnotationEditPage", { enumerable: true, get: function () { return AnnotationEditPage_1.AnnotationEditPage; } });
+var AnnotationPage_1 = require("./AnnotationPage");
+Object.defineProperty(exports, "AnnotationPage", { enumerable: true, get: function () { return AnnotationPage_1.AnnotationPage; } });
+var DashboardPage_1 = require("./DashboardPage");
+Object.defineProperty(exports, "DashboardPage", { enumerable: true, get: function () { return DashboardPage_1.DashboardPage; } });
+var DataSourceConfigPage_1 = require("./DataSourceConfigPage");
+Object.defineProperty(exports, "DataSourceConfigPage", { enumerable: true, get: function () { return DataSourceConfigPage_1.DataSourceConfigPage; } });
+var GrafanaPage_1 = require("./GrafanaPage");
+Object.defineProperty(exports, "GrafanaPage", { enumerable: true, get: function () { return GrafanaPage_1.GrafanaPage; } });
+var PanelEditPage_1 = require("./PanelEditPage");
+Object.defineProperty(exports, "PanelEditPage", { enumerable: true, get: function () { return PanelEditPage_1.PanelEditPage; } });
+var VariableEditPage_1 = require("./VariableEditPage");
+Object.defineProperty(exports, "VariableEditPage", { enumerable: true, get: function () { return VariableEditPage_1.VariableEditPage; } });
+var VariablePage_1 = require("./VariablePage");
+Object.defineProperty(exports, "VariablePage", { enumerable: true, get: function () { return VariablePage_1.VariablePage; } });

package/dist/selectorEngine.d.ts

@@ -0,0 +1,4 @@
+export declare const grafanaE2ESelectorEngine: () => {
+    query(root: Element, selector: string): Element;
+    queryAll(root: Element, selector: string): NodeListOf<Element>;
+};

package/dist/selectorEngine.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.grafanaE2ESelectorEngine = void 0;
+var grafanaE2ESelectorEngine = function () { return ({
+    query: function (root, selector) {
+        if (selector.startsWith('data-testid')) {
+            return root.querySelector("[data-testid=\"".concat(selector, "\"]"));
+        }
+        return root.querySelector("[aria-label=\"".concat(selector, "\"]"));
+    },
+    queryAll: function (root, selector) {
+        if (selector.startsWith('data-testid')) {
+            return root.querySelectorAll("[data-testid=\"".concat(selector, "\"]"));
+        }
+        return root.querySelectorAll("[aria-label=\"".concat(selector, "\"]"));
+    },
+}); };
+exports.grafanaE2ESelectorEngine = grafanaE2ESelectorEngine;

package/dist/types.d.ts

@@ -0,0 +1,54 @@
+import { PlaywrightTestArgs } from '@playwright/test';
+import { E2ESelectors } from './e2e-selectors/types';
+export type PluginTestCtx = {
+    grafanaVersion: string;
+    selectors: E2ESelectors;
+} & Pick<PlaywrightTestArgs, 'page' | 'request'>;
+export interface DataSource<T = any> {
+    id?: number;
+    editable?: boolean;
+    uid?: string;
+    orgId?: number;
+    name?: string;
+    type: string;
+    access?: string;
+    url?: string;
+    database?: string;
+    isDefault?: boolean;
+    jsonData?: T;
+    secureJsonData?: T;
+}
+export type ProvisionFile<T = DataSource> = {
+    datasources: Array<DataSource<T>>;
+};
+export type CreateDataSourceArgs = {
+    datasource: DataSource;
+};
+export type CreateDataSourcePageArgs = {
+    type: string;
+    name?: string;
+    deleteDataSourceAfterTest?: boolean;
+};
+export type RequestOptions = {
+    timeout?: number;
+};
+export interface TimeRangeArgs {
+    from: string;
+    to: string;
+    zone?: string;
+}
+export type GotoDashboardArgs = {
+    uid?: string;
+    timeRange?: TimeRangeArgs;
+    queryParams?: URLSearchParams;
+};
+export type ReadProvisionArgs = {
+    filePath: string;
+};
+export type NavigateOptions = {
+    referer?: string;
+    timeout?: number;
+    waitUntil?: 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
+    queryParams?: URLSearchParams;
+};
+export type Visualization = 'Alert list' | 'Bar gauge' | 'Clock' | 'Dashboard list' | 'Gauge' | 'Graph' | 'Heatmap' | 'Logs' | 'News' | 'Pie Chart' | 'Plugin list' | 'Polystat' | 'Stat' | 'Table' | 'Text' | 'Time series' | 'Worldmap Panel';

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -38,11 +38,11 @@
   "devDependencies": {
     "@playwright/test": "^1.39.0",
     "@types/uuid": "^9.0.7",
-    "dotenv": "^16.3.1",
-    "typescript": "5.3.3"
+    "dotenv": "^16.3.1"
   },
   "dependencies": {
     "semver": "^7.5.4",
     "uuid": "^9.0.1"
-  }
+  },
+  "gitHead": "08a556e5a4d4a093a6a6dad65ffcf20abe78508d"
 }