allow specifying a admin api specific user

Author: sunker

packages/plugin-e2e/playwright.config.ts

@@ -25,6 +25,10 @@ export default defineConfig<PluginOptions>({
 
     /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
     trace: 'on-first-retry',
+    grafanaAPIUser: {
+      user: 'admin',
+      password: 'admin',
+    },
     httpCredentials: {
       username: 'admin',
       password: 'admin',
@@ -41,6 +45,13 @@ export default defineConfig<PluginOptions>({
       name: 'authenticate',
       testDir: './src/auth',
       testMatch: [/.*auth\.setup\.ts/],
+      use: {
+        user: {
+          user: 'admin',
+          password: 'admin',
+          userExists: true,
+        },
+      },
     },
     // Login to Grafana with new user with viewer role and store the cookie on disk for use in other tests
     {

packages/plugin-e2e/src/auth/auth.setup.ts

@@ -1,7 +1,7 @@
 import { test as setup } from '../';
 
 setup('authenticate', async ({ login, createUser, user }) => {
-  if (user) {
+  if (user && !user.skipCreateUser) {
     await createUser();
   }
   await login();

packages/plugin-e2e/src/fixtures/commands/createUser.ts

@@ -1,22 +1,26 @@
 import { APIRequestContext, expect, TestFixture } from '@playwright/test';
-import { PlaywrightArgs } from '../../types';
+import { PlaywrightArgs, User } from '../../types';
 
 type CreateUserFixture = TestFixture<() => Promise<void>, PlaywrightArgs>;
 
-const headers = {
-  Authorization: `Basic ${Buffer.from(`admin:admin`).toString('base64')}`,
-};
+const getHeaders = (user: User) => ({
+  Authorization: `Basic ${Buffer.from(`${user.user}:${user.password}`).toString('base64')}`,
+});
 
-const getUserIdByUsername = async (request: APIRequestContext, userName: string): Promise<number> => {
+const getUserIdByUsername = async (
+  request: APIRequestContext,
+  userName: string,
+  grafanaAPIUser: User
+): Promise<number> => {
   const getUserIdByUserNameReq = await request.get(`/api/users/lookup?loginOrEmail=${userName}`, {
-    headers,
+    headers: getHeaders(grafanaAPIUser),
   });
   expect(getUserIdByUserNameReq.ok()).toBeTruthy();
   const json = await getUserIdByUserNameReq.json();
   return json.id;
 };
 
-export const createUser: CreateUserFixture = async ({ request, user }, use) => {
+export const createUser: CreateUserFixture = async ({ request, user, grafanaAPIUser }, use) => {
   await use(async () => {
     if (!user) {
       throw new Error('Playwright option `User` was not provided');
@@ -28,7 +32,7 @@ export const createUser: CreateUserFixture = async ({ request, user }, use) => {
         login: user?.user,
         password: user?.password,
       },
-      headers,
+      headers: getHeaders(grafanaAPIUser),
     });
 
     let userId: number | undefined;
@@ -37,15 +41,15 @@ export const createUser: CreateUserFixture = async ({ request, user }, use) => {
       userId = respJson.id;
     } else if (createUserReq.status() === 412) {
       // user already exists
-      userId = await getUserIdByUsername(request, user?.user);
+      userId = await getUserIdByUsername(request, user?.user, grafanaAPIUser);
     } 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,
+        headers: getHeaders(grafanaAPIUser),
       });
       const updateRoleReqText = await updateRoleReq.text();
       expect(

packages/plugin-e2e/src/fixtures/commands/gotoDataSourceConfigPage.ts

@@ -5,15 +5,15 @@ import { DataSourceConfigPage } from '../../models/pages/DataSourceConfigPage';
 type GotoDataSourceConfigPageFixture = TestFixture<(uid: string) => Promise<DataSourceConfigPage>, PlaywrightArgs>;
 
 export const gotoDataSourceConfigPage: GotoDataSourceConfigPageFixture = async (
-  { request, page, selectors, grafanaVersion },
+  { request, page, selectors, grafanaVersion, grafanaAPIUser },
   use,
   testInfo
 ) => {
   await use(async (uid) => {
     const response = await request.get(`/api/datasources/uid/${uid}`, {
       headers: {
         // here we call backend as admin user and not on behalf of the logged in user as it might not have required permissions
-        Authorization: `Basic ${Buffer.from(`admin:admin`).toString('base64')}`,
+        Authorization: `Basic ${Buffer.from(`${grafanaAPIUser.user}:${grafanaAPIUser.password}`).toString('base64')}`,
       },
     });
     if (!response.ok()) {

packages/plugin-e2e/src/fixtures/commands/login.ts

@@ -1,14 +1,14 @@
 import path from 'path';
 import { expect, TestFixture } from '@playwright/test';
-import { PlaywrightArgs } from '../../types';
+import { PlaywrightArgs, User } from '../../types';
 
 type LoginFixture = TestFixture<() => Promise<void>, PlaywrightArgs>;
 
-const ADMIN_USER = { user: 'admin', password: 'admin' };
+export const DEFAULT_ADMIN_USER: User = { user: 'admin', password: 'admin' };
 
 export const login: LoginFixture = async ({ request, user }, use) => {
   await use(async () => {
-    const data = user ?? ADMIN_USER;
+    const data = user ?? DEFAULT_ADMIN_USER;
     const loginReq = await request.post('/login', { data });
     const text = await loginReq.text();
     expect.soft(loginReq.ok(), `Could not log in to Grafana: ${text}`).toBeTruthy();

packages/plugin-e2e/src/options.ts

@@ -1,9 +1,11 @@
 import path = require('path');
 import { Fixtures } from '@playwright/test';
 import { PluginOptions } from './types';
+import { DEFAULT_ADMIN_USER } from './fixtures/commands/login';
 
 export const options: Fixtures<{}, PluginOptions> = {
   user: [undefined, { option: true, scope: 'worker' }],
   featureToggles: [{}, { option: true, scope: 'worker' }],
   provisioningRootDir: [path.join(process.cwd(), 'provisioning'), { option: true, scope: 'worker' }],
+  grafanaAPIUser: [DEFAULT_ADMIN_USER, { option: true, scope: 'worker' }],
 };

packages/plugin-e2e/src/types.ts

@@ -62,7 +62,13 @@ export type PluginOptions = {
    * You can use different users for different projects. See the fixture createUser for more information on how to create a user,
    * and the fixture login for more information on how to authenticate. Also see https://grafana.com/developers/plugin-tools/e2e-test-a-plugin/use-authentication
    */
-  user?: CreateUserArgs;
+  user?: UserArgs;
+
+  /**
+   * The user to use when making requests to the Grafana API. For example when creating users, fetching data sources etc.
+   * If no user is provided, the server default admin/admin user will be used.
+   */
+  grafanaAPIUser: User;
 };
 
 export type PluginFixture = {
@@ -301,7 +307,7 @@ export interface Dashboard {
   title?: string;
 }
 
-export type CreateUserArgs = {
+export type UserArgs = {
   /**
    * The username of the user to create. Needs to be unique
    */
@@ -314,6 +320,23 @@ export type CreateUserArgs = {
    * The role of the user to create
    */
   role?: OrgRole;
+
+  /**
+   * Set this to true if the user already exist in the database. If omitted or set to false, the user will be created.
+   */
+  skipCreateUser?: boolean;
+};
+
+export type User = {
+  /**
+   * The username of the user
+   */
+  user: string;
+
+  /**
+   * The passwords
+   */
+  password: string;
 };
 
 export type CreateDataSourceArgs<T = any> = {