@grafana/plugin-e2e 1.6.0-canary.970.deb7892.0 → 1.6.0

package/dist/auth/auth.setup.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const __1 = require("../");
-const options_1 = require("../options");
-(0, __1.test)('authenticate', async ({ login, createUser, user }) => {
-    if (user && (user.user !== options_1.DEFAULT_ADMIN_USER.user || user.password !== options_1.DEFAULT_ADMIN_USER.password)) {
+(0, __1.test)('authenticate', async ({ login, createUser, user, grafanaAPICredentials }) => {
+    if (user && (user.user !== grafanaAPICredentials.user || user.password !== grafanaAPICredentials.password)) {
         await createUser();
     }
     await login();

package/dist/fixtures/commands/createUser.js

@@ -1,51 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createUser = void 0;
-const test_1 = require("@playwright/test");
-const getHeaders = (user) => ({
-    Authorization: `Basic ${Buffer.from(`${user.user}:${user.password}`).toString('base64')}`,
-});
-const getUserIdByUsername = async (request, userName, grafanaAPIUser) => {
-    const getUserIdByUserNameReq = await request.get(`/api/users/lookup?loginOrEmail=${userName}`, {
-        headers: getHeaders(grafanaAPIUser),
-    });
-    (0, test_1.expect)(getUserIdByUserNameReq.ok()).toBeTruthy();
-    const json = await getUserIdByUserNameReq.json();
-    return json.id;
-};
-const createUser = async ({ request, user, grafanaAPICredentials }, use) => {
+const createUser = async ({ grafanaAPIClient, user }, use) => {
     await use(async () => {
         if (!user) {
             throw new Error('Playwright option `User` was not provided');
         }
-        const createUserReq = await request.post(`/api/admin/users`, {
-            data: {
-                name: user?.user,
-                login: user?.user,
-                password: user?.password,
-            },
-            headers: getHeaders(grafanaAPICredentials),
-        });
-        let userId;
-        if (createUserReq.ok()) {
-            const respJson = await createUserReq.json();
-            userId = respJson.id;
-        }
-        else if (createUserReq.status() === 412) {
-            // user already exists
-            userId = await getUserIdByUsername(request, user?.user, grafanaAPICredentials);
-        }
-        else {
-            throw new Error(`Could not create user '${user?.user}': ${await createUserReq.text()}`);
-        }
-        if (user.role) {
-            const updateRoleReq = await request.patch(`/api/org/users/${userId}`, {
-                data: { role: user.role },
-                headers: getHeaders(grafanaAPICredentials),
-            });
-            const updateRoleReqText = await updateRoleReq.text();
-            (0, test_1.expect)(updateRoleReq.ok(), `Could not assign role '${user.role}' to user '${user.user}': ${updateRoleReqText}`).toBeTruthy();
-        }
+        await grafanaAPIClient.createUser(user);
     });
 };
 exports.createUser = createUser;

package/dist/fixtures/commands/gotoDataSourceConfigPage.js

@@ -2,17 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.gotoDataSourceConfigPage = void 0;
 const DataSourceConfigPage_1 = require("../../models/pages/DataSourceConfigPage");
-const gotoDataSourceConfigPage = async ({ request, page, selectors, grafanaVersion, grafanaAPICredentials }, use, testInfo) => {
+const gotoDataSourceConfigPage = async ({ request, page, selectors, grafanaVersion, grafanaAPIClient }, use, testInfo) => {
     await use(async (uid) => {
-        const response = await request.get(`/api/datasources/uid/${uid}`, {
-            headers: {
-                Authorization: `Basic ${Buffer.from(`${grafanaAPICredentials.user}:${grafanaAPICredentials.password}`).toString('base64')}`,
-            },
-        });
-        if (!response.ok()) {
-            throw new Error(`Failed to get datasource by uid: ${response.statusText()}. If you're using a provisioned data source, make sure it has a UID`);
-        }
-        const settings = await response.json();
+        const settings = await grafanaAPIClient.getDataSourceSettingsByUID(uid);
         const dataSourceConfigPage = new DataSourceConfigPage_1.DataSourceConfigPage({ page, selectors, grafanaVersion, request, testInfo }, settings);
         await dataSourceConfigPage.goto();
         return dataSourceConfigPage;

package/dist/fixtures/commands/login.js

@@ -5,12 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.login = void 0;
 const path_1 = __importDefault(require("path"));
-const test_1 = require("@playwright/test");
 const login = async ({ request, user }, use) => {
     await use(async () => {
         const loginReq = await request.post('/login', { data: user });
         const text = await loginReq.text();
-        test_1.expect.soft(loginReq.ok(), `Could not log in to Grafana: ${text}`).toBeTruthy();
+        if (!loginReq.ok()) {
+            throw new Error(`Could not login to Grafana using user '${user?.user}': ${text}`);
+        }
         await request.storageState({ path: path_1.default.join(process.cwd(), `playwright/.auth/${user?.user}.json`) });
     });
 };

package/dist/fixtures/grafanaAPIClient.d.ts

@@ -0,0 +1,7 @@
+import { TestFixture, APIRequestContext } from '@playwright/test';
+import { PlaywrightArgs, User } from '../types';
+import { GrafanaAPIClient } from '../models/GrafanaAPIClient';
+type GrafanaAPIClientFixture = TestFixture<GrafanaAPIClient, PlaywrightArgs>;
+export declare const createAdminClientStorageState: (request: APIRequestContext, grafanaAPICredentials: User) => Promise<void>;
+export declare const grafanaAPIClient: GrafanaAPIClientFixture;
+export {};

package/dist/fixtures/grafanaAPIClient.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.grafanaAPIClient = exports.createAdminClientStorageState = void 0;
+const path_1 = __importDefault(require("path"));
+const test_1 = require("@playwright/test");
+const GrafanaAPIClient_1 = require("../models/GrafanaAPIClient");
+const adminClientStorageState = path_1.default.join(process.cwd(), `playwright/.auth/grafanaAPICredentials.json`);
+const createAdminClientStorageState = async (request, grafanaAPICredentials) => {
+    const loginReq = await request.post('/login', { data: grafanaAPICredentials });
+    const text = await loginReq.text();
+    await test_1.expect.soft(loginReq.ok(), `Could not log in to Grafana: ${text}`).toBeTruthy();
+    await request.storageState({ path: adminClientStorageState });
+};
+exports.createAdminClientStorageState = createAdminClientStorageState;
+const grafanaAPIClient = async ({ browser, grafanaAPICredentials }, use) => {
+    const context = await browser.newContext({ storageState: undefined });
+    const loginReq = await context.request.post('/login', { data: grafanaAPICredentials });
+    if (!loginReq.ok()) {
+        console.log(`Could not login to grafana using credentials '${grafanaAPICredentials?.user}'. Find information on how user can be managed in the plugin-e2e docs: https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/use-authentication#managing-users  : ${await loginReq.text()}`);
+    }
+    await context.request.storageState({ path: adminClientStorageState });
+    await use(new GrafanaAPIClient_1.GrafanaAPIClient(context.request));
+};
+exports.grafanaAPIClient = grafanaAPIClient;

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.selectors = exports.expect = exports.test = exports.resolveSelectors = exports.AppPage = exports.PluginConfigPage = exports.AppConfigPage = exports.VariablePage = exports.VariableEditPage = exports.PanelEditPage = exports.GrafanaPage = exports.ExplorePage = exports.DataSourceConfigPage = exports.DashboardPage = exports.AnnotationPage = exports.AnnotationEditPage = exports.TimeRange = exports.Panel = exports.DataSourcePicker = void 0;
 const test_1 = require("@playwright/test");
 const annotationEditPage_1 = require("./fixtures/annotationEditPage");
+const grafanaAPIClient_1 = require("./fixtures/grafanaAPIClient");
 const createDataSource_1 = require("./fixtures/commands/createDataSource");
 const createDataSourceConfigPage_1 = require("./fixtures/commands/createDataSourceConfigPage");
 const createUser_1 = require("./fixtures/commands/createUser");
@@ -86,6 +87,7 @@ exports.test = test_1.test.extend({
     selectors: selectors_1.selectors,
     grafanaVersion: grafanaVersion_1.grafanaVersion,
     login: login_1.login,
+    grafanaAPIClient: grafanaAPIClient_1.grafanaAPIClient,
     createDataSourceConfigPage: createDataSourceConfigPage_1.createDataSourceConfigPage,
     page: page_1.page,
     dashboardPage: dashboardPage_1.dashboardPage,

package/dist/models/GrafanaAPIClient.d.ts

@@ -0,0 +1,9 @@
+import { APIRequestContext } from '@playwright/test';
+import { DataSourceSettings, User } from '../types';
+export declare class GrafanaAPIClient {
+    private request;
+    constructor(request: APIRequestContext);
+    getUserIdByUsername(userName: string): Promise<any>;
+    createUser(user: User): Promise<void>;
+    getDataSourceSettingsByUID(uid: string): Promise<DataSourceSettings<{}, {}>>;
+}

package/dist/models/GrafanaAPIClient.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GrafanaAPIClient = void 0;
+class GrafanaAPIClient {
+    request;
+    constructor(request) {
+        this.request = request;
+    }
+    async getUserIdByUsername(userName) {
+        const getUserIdByUserNameReq = await this.request.get(`/api/users/lookup?loginOrEmail=${userName}`);
+        const json = await getUserIdByUserNameReq.json();
+        return json.id;
+    }
+    async createUser(user) {
+        const createUserReq = await this.request.post(`/api/admin/users`, {
+            data: {
+                name: user?.user,
+                login: user?.user,
+                password: user?.password,
+            },
+        });
+        let userId;
+        if (createUserReq.ok()) {
+            const respJson = await createUserReq.json();
+            userId = respJson.id;
+        }
+        else if (createUserReq.status() === 412) {
+            // user already exists
+            userId = await this.getUserIdByUsername(user?.user);
+        }
+        else {
+            throw new Error(`Could not create user '${user?.user}'. Find information on how user can be managed in the plugin-e2e docs: https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/use-authentication#managing-users  : ${await createUserReq.text()}`);
+        }
+        if (user.role) {
+            const updateRoleReq = await this.request.patch(`/api/org/users/${userId}`, {
+                data: { role: user.role },
+            });
+            if (!updateRoleReq.ok()) {
+                throw new Error(`Could not assign role '${user.role}' to user '${user.user}': ${await updateRoleReq.text()}`);
+            }
+        }
+    }
+    async getDataSourceSettingsByUID(uid) {
+        const response = await this.request.get(`/api/datasources/uid/${uid}`);
+        if (!response.ok()) {
+            throw new Error(`Failed to get datasource by uid: ${response.statusText()}. If you're using a provisioned data source, make sure it has a UID`);
+        }
+        const settings = await response.json();
+        return settings;
+    }
+}
+exports.GrafanaAPIClient = GrafanaAPIClient;

package/dist/types.d.ts

@@ -10,6 +10,7 @@ import { PanelEditPage } from './models/pages/PanelEditPage';
 import { VariableEditPage } from './models/pages/VariableEditPage';
 import { VariablePage } from './models/pages/VariablePage';
 import { AlertRuleEditPage } from './models/pages/AlertRuleEditPage';
+import { GrafanaAPIClient } from './models/GrafanaAPIClient';
 export type PluginOptions = {
     /**
      * When using the readProvisioning fixture, files will be read from this directory. If no directory is provided,
@@ -171,6 +172,17 @@ export type PluginFixture = {
      * Function that checks if a feature toggle is enabled. Only works for frontend feature toggles.
      */
     isFeatureToggleEnabled<T = object>(featureToggle: keyof T): Promise<boolean>;
+    /**
+     * Client that allows you to use certain endpoints in the Grafana http API.
+     *
+     The GrafanaAPIClient doesn't call the Grafana HTTP API on behalf of the logged in user -
+     * it uses the {@link types.grafanaAPICredentials} credentials. grafanaAPICredentials defaults to admin:admin, but you may override this
+     * by specifying grafanaAPICredentials in the playwright config options.
+     *
+     * Note that storage state for the admin client is not persisted throughout the test suite. For every test where the grafanaAPICredentials fixtures is used,
+     * new storage state is created.
+     */
+    grafanaAPIClient: GrafanaAPIClient;
     /**
      * Isolated {@link DashboardPage} instance for each test.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/plugin-e2e",
-  "version": "1.6.0-canary.970.deb7892.0",
+  "version": "1.6.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -55,5 +55,5 @@
       "start": "cls || clear"
     }
   },
-  "gitHead": "deb7892f45e25b0722c8b19d591e5fb5fcd71e16"
+  "gitHead": "0d126394b9c16cdbd47e3749cb25f258a233ac1a"
 }