@grafana/plugin-e2e 0.0.0 → 0.0.1

package/README.md

@@ -0,0 +1 @@
+# Grafana / Plugin E2E

package/dist/api.d.ts

@@ -0,0 +1,41 @@
+import { E2ESelectors } from './e2e-selectors/types';
+import { CreateDataSourceArgs, CreateDataSourcePageArgs, DataSource, ReadProvisionArgs } from './types';
+import { PanelEditPage, DataSourceConfigPage, DashboardPage, VariableEditPage, AnnotationEditPage } from './models';
+import { ExplorePage } from './models/ExplorePage';
+export type PluginOptions = {
+    selectorRegistration: void;
+};
+export type PluginFixture = {
+    grafanaVersion: string;
+    selectors: E2ESelectors;
+    newDashboardPage: DashboardPage;
+    panelEditPage: PanelEditPage;
+    variableEditPage: VariableEditPage;
+    annotationEditPage: AnnotationEditPage;
+    explorePage: ExplorePage;
+    createDataSourceConfigPage: (args: CreateDataSourcePageArgs) => Promise<DataSourceConfigPage>;
+    createDataSource: (args: CreateDataSourceArgs) => Promise<DataSource>;
+    login: () => Promise<void>;
+    readProvision<T = any>(args: ReadProvisionArgs): Promise<T>;
+};
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & PluginFixture & PluginOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export declare const expect: import("@playwright/test").Expect<{
+    toBeOK: (request: Promise<import("playwright-core").Response>) => Promise<{
+        message: () => string;
+        pass: boolean;
+        actual: number;
+    }>;
+    toHavePanelError: (panelError: import("./types").PanelError, options?: {
+        timeout?: number;
+    }) => Promise<{
+        message: () => any;
+        pass: boolean;
+        actual: number;
+    }>;
+    toDisplayPreviews: (variableEditPage: VariableEditPage, previewTexts: (string | RegExp)[]) => Promise<{
+        pass: boolean;
+        actual: boolean;
+        message: () => string;
+    }>;
+}>;
+export { selectors } from '@playwright/test';

package/dist/api.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.selectors = exports.expect = exports.test = void 0;
+var test_1 = require("@playwright/test");
+var fixtures_1 = __importDefault(require("./fixtures"));
+var matchers_1 = __importDefault(require("./matchers"));
+var selectorEngine_1 = require("./selectorEngine");
+exports.test = test_1.test.extend(fixtures_1.default);
+exports.expect = test_1.expect.extend(matchers_1.default);
+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/e2e-selectors/index.d.ts

@@ -0,0 +1,2 @@
+export { resolveSelectors } from './resolver';
+export * from './types';

package/dist/e2e-selectors/index.js

@@ -0,0 +1,20 @@
+"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 __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.resolveSelectors = void 0;
+var resolver_1 = require("./resolver");
+Object.defineProperty(exports, "resolveSelectors", { enumerable: true, get: function () { return resolver_1.resolveSelectors; } });
+__exportStar(require("./types"), exports);

package/dist/e2e-selectors/resolver.d.ts

@@ -0,0 +1,3 @@
+import { E2ESelectors } from './types';
+import { VersionedSelectors } from './versioned/types';
+export declare const resolveSelectors: (versionedSelectors: VersionedSelectors, grafanaVersion: string) => E2ESelectors;

package/dist/e2e-selectors/resolver.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveSelectors = void 0;
+var semver = require('semver');
+var processSelectors = function (selectors, versionedSelectors, grafanaVersion) {
+    var keys = Object.keys(versionedSelectors);
+    for (var index = 0; index < keys.length; index++) {
+        var key = keys[index];
+        var value = versionedSelectors[key];
+        if (typeof value === 'object' && Object.keys(value).length > 0 && !semver.valid(Object.keys(value)[0])) {
+            selectors[key] = processSelectors({}, value, grafanaVersion);
+        }
+        else {
+            if (typeof value === 'object' && Object.keys(value).length > 0 && semver.valid(Object.keys(value)[0])) {
+                var sorted = Object.keys(value).sort(semver.rcompare);
+                var validVersion = sorted[0];
+                for (var index_1 = 0; index_1 < sorted.length; index_1++) {
+                    var version = sorted[index_1];
+                    if (semver.gte(grafanaVersion, version)) {
+                        validVersion = version;
+                        break;
+                    }
+                }
+                selectors[key] = value[validVersion];
+            }
+            else {
+                selectors[key] = value;
+            }
+        }
+        continue;
+    }
+    return selectors;
+};
+var resolveSelectors = function (versionedSelectors, grafanaVersion) {
+    var selectors = {};
+    return processSelectors(selectors, versionedSelectors, grafanaVersion.replace(/\-.*/, ''));
+};
+exports.resolveSelectors = resolveSelectors;

package/dist/e2e-selectors/resolver.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/e2e-selectors/resolver.test.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var resolver_1 = require("./resolver");
+var versioned_1 = require("./versioned");
+var apis_1 = require("./versioned/apis");
+var constants_1 = require("./versioned/constants");
+var GRAFANA_VERSION = '10.2.0';
+var versionedSelectors = {
+    components: versioned_1.versionedComponents,
+    pages: versioned_1.versionedPages,
+    apis: apis_1.versionedAPIs,
+};
+var originalVersionedSelectors = versionedSelectors;
+describe('resolveSelectors', function () {
+    afterEach(function () {
+        versionedSelectors = originalVersionedSelectors;
+    });
+    test('handles selector without version', function () {
+        versionedSelectors.components.PanelEditor.General.content = 'Panel editor content';
+        var selectors = (0, resolver_1.resolveSelectors)(versionedSelectors, GRAFANA_VERSION);
+        expect(selectors.components.PanelEditor.General.content).toBe('Panel editor content');
+    });
+    test('returns the right selector value when it has multiple versions', function () {
+        var _a;
+        versionedSelectors.components.CodeEditor.container = (_a = {
+                '10.3.0': 'data-testid Code editor container'
+            },
+            _a[constants_1.MIN_GRAFANA_VERSION] = 'Code editor container',
+            _a);
+        var selectors = (0, resolver_1.resolveSelectors)(versionedSelectors, '10.4.0');
+        expect(selectors.components.CodeEditor.container).toBe('data-testid Code editor container');
+        selectors = (0, resolver_1.resolveSelectors)(versionedSelectors, '10.3.0');
+        expect(selectors.components.CodeEditor.container).toBe('data-testid Code editor container');
+        selectors = (0, resolver_1.resolveSelectors)(versionedSelectors, '10.3.0-pre');
+        expect(selectors.components.CodeEditor.container).toBe('data-testid Code editor container');
+        selectors = (0, resolver_1.resolveSelectors)(versionedSelectors, '9.2.0');
+        expect(selectors.components.CodeEditor.container).toBe('Code editor container');
+    });
+});