PMM-7 added portal setup

percona · Aug 17, 2023 · 07fcb4b · 07fcb4b
1 parent a3fd444
commit 07fcb4b
Show file tree

Hide file tree

Showing 8 changed files with 88 additions and 22 deletions.
diff --git a/.github/workflows/portal-tests-matrix.yml b/.github/workflows/portal-tests-matrix.yml
@@ -11,7 +11,7 @@ jobs:
     uses: ./.github/workflows/pmm-version-getter.yml
     with:
       repository: ${{ inputs.repository || 'dev-latest'}}
-      matrix_range: 10
+      matrix_range: 5
 
   portal:
     name: 'Portal / Integration'

diff --git a/playwright-tests/api/helpers/portalApiHelper.ts b/playwright-tests/api/helpers/portalApiHelper.ts
@@ -10,15 +10,22 @@ export interface RequestParams {
   path: string;
   data?: any;
   accessToken?: string;
+  /**
+   * Request timeout in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout.
+   */
+  timeout?: number;
 }
 
 interface ContextOptions {
   baseURL: string;
   extraHTTPHeaders?: { [key: string]: string; };
+  timeout?: number;
 }
 
-const getRequestContext = async ({ accessToken }: { baseURL?: string; accessToken?: string; }): Promise<APIRequestContext> => {
-  const options: ContextOptions = { baseURL: Constants.portal.url };
+const getRequestContext = async (
+  { accessToken, timeout }: { accessToken?: string; timeout?: number; },
+): Promise<APIRequestContext> => {
+  const options: ContextOptions = { baseURL: Constants.portal.url, timeout };
   if (accessToken) {
     options.extraHTTPHeaders = {
       Authorization: `Bearer ${accessToken}`,

diff --git a/playwright-tests/api/portalApi.ts b/playwright-tests/api/portalApi.ts
@@ -17,6 +17,7 @@ export const portalAPI = {
     return await portalAPIHelper.post({
       path: '/v1/orgs',
       accessToken,
+      timeout: 60_000,
       data: {
         name: orgName,
       },

diff --git a/playwright-tests/helpers/portalHelper.ts b/playwright-tests/helpers/portalHelper.ts
@@ -2,12 +2,9 @@ import { PortalUserRoles } from '@helpers/enums/portalUserRoles';
 import { fileHelper } from '@helpers/fileHelper';
 import { PortalUser } from '@helpers/types/PortalUser';
 import { Constants } from '@helpers/Constants';
-import * as dotenv from 'dotenv';
 import { ServiceNowResponse } from '@helpers/types/serviceNowResponse.interface';
 import { api } from '@api/api';
 
-dotenv.config();
-
 /**
  * Collection of methods for Portal tests setup.
  */
@@ -22,8 +19,7 @@ export const portalHelper = {
     let technicalUser: PortalUser;
 
     if (fileHelper.fileExists(Constants.portal.credentialsFile)) {
-      console.log(`Using existing users from file: ${Constants.portal.credentialsFile}`);
-      [firstAdmin, secondAdmin, technicalUser] = JSON.parse(fileHelper.readFile(Constants.portal.credentialsFile));
+      [firstAdmin, secondAdmin, technicalUser] = portalHelper.loadUsersFromFile();
       if (!Object.hasOwn(firstAdmin, 'org')) {
         const adminToken = await api.portal.getUserAccessToken(firstAdmin.email, firstAdmin.password);
         const orgId = Object.hasOwn(firstAdmin, 'org') ? firstAdmin.org!.id
@@ -39,6 +35,14 @@ export const portalHelper = {
     return [firstAdmin, secondAdmin, technicalUser];
   },
 
+  /**
+   * Just a wrapper to hold constants
+   */
+  loadUsersFromFile: (): [PortalUser, PortalUser, PortalUser, PortalUser] => {
+    console.log(`Using existing users from file: ${Constants.portal.credentialsFile}`);
+    return JSON.parse(fileHelper.readFile(Constants.portal.credentialsFile)) as [PortalUser, PortalUser, PortalUser, PortalUser];
+  },
+
   /**
    * Encapsulates all actions required to create Portal user for tests.
    */
@@ -47,18 +51,20 @@ export const portalHelper = {
     const firstAdmin: PortalUser = await api.okta.createTestUser(credentials.contacts.admin1.email);
     const secondAdmin: PortalUser = await api.okta.createTestUser(credentials.contacts.admin2.email);
     const technicalUser: PortalUser = await api.okta.createTestUser(credentials.contacts.technical.email);
+    const freeUser: PortalUser = await api.okta.createTestUser();
 
     const adminToken = await api.portal.getUserAccessToken(firstAdmin.email, firstAdmin.password);
     const { org } = await api.portal.createOrg(adminToken);
 
     await api.portal.inviteUserToOrg(adminToken, org.id, secondAdmin.email, PortalUserRoles.admin);
     await api.portal.inviteUserToOrg(adminToken, org.id, technicalUser.email, PortalUserRoles.technical);
-
+    await api.portal.inviteUserToOrg(adminToken, org.id, freeUser.email, PortalUserRoles.admin);
     firstAdmin.org = { id: org.id, role: PortalUserRoles.admin };
     secondAdmin.org = { id: org.id, role: PortalUserRoles.admin };
     technicalUser.org = { id: org.id, role: PortalUserRoles.technical };
+    freeUser.org = { id: org.id, role: PortalUserRoles.admin };
 
-    return [firstAdmin, secondAdmin, technicalUser];
+    return [firstAdmin, secondAdmin, technicalUser, freeUser];
   },
 
   /**

diff --git a/playwright-tests/playwright.config.ts b/playwright-tests/playwright.config.ts
@@ -3,24 +3,27 @@ import { devices } from '@playwright/test';
 import * as dotenv from 'dotenv';
 import Duration from '@helpers/enums/Duration';
 
-dotenv.config({ path: '.env.local' });
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
 dotenv.config();
+dotenv.config({ path: '.env.local' });
 
 const config: PlaywrightTestConfig = {
   testDir: './tests',
   timeout: Duration.FiveMinutes,
   expect: {
     timeout: 10_000,
   },
-
   fullyParallel: false,
   forbidOnly: !!process.env.CI,
   retries: process.env.CI ? 1 : 0,
   workers: 1,
   reporter: [
     ['github'],
     ['list'],
-    ['html', { open: 'never', outputFolder: './playwright-report' }]
+    ['html', { open: 'never', outputFolder: './playwright-report' }],
   ],
 
   use: {
@@ -33,14 +36,37 @@ const config: PlaywrightTestConfig = {
   projects: [
     {
       name: 'chromium',
-      testDir: `./tests`,
+      testDir: './tests',
+      testIgnore: 'tests/portal/*.spec.ts',
+      use: {
+        contextOptions: {
+          ignoreHTTPSErrors: true,
+        },
+        screenshot: 'on',
+        ...devices['Desktop Chrome'],
+        viewport: {
+          width: 1920, height: 1080,
+        },
+      },
+    },
+    {
+      name: 'Portal Setup',
+      testMatch: 'tests/portal/testUsers.setup.ts',
+    },
+    {
+      name: 'Portal',
+      dependencies: ['Portal Setup'],
+      testMatch: 'tests/portal/*.spec.ts',
+      retries: 0,
       use: {
         contextOptions: {
           ignoreHTTPSErrors: true,
         },
         screenshot: 'on',
         ...devices['Desktop Chrome'],
-        viewport: { width: 1920, height: 1080 },
+        viewport: {
+          width: 1920, height: 1080,
+        },
       },
     },
   ],

diff --git a/playwright-tests/tests/portal/connectPMM.spec.ts b/playwright-tests/tests/portal/connectPMM.spec.ts
@@ -17,12 +17,9 @@ test.describe('Spec file for connecting PMM to the portal', async () => {
   let secondAdmin: PortalUser;
   let technicalUser: PortalUser;
 
-  test.beforeAll(async ({ baseURL }) => {
+  test.beforeAll(async () => {
     pmmVersion = (await api.pmm.serverV1.getPmmVersion()).minor;
-    await api.pmm.settingsV1.changeSettings({
-      pmm_public_address: baseURL!.replace(/(^\w+:|^)\/\//, ''),
-    });
-    [firstAdmin, secondAdmin, technicalUser] = await portalHelper.loadTestUsers();
+    [firstAdmin, secondAdmin, technicalUser] = portalHelper.loadUsersFromFile();
   });
 
   test.beforeEach(async ({ page }) => {

diff --git a/playwright-tests/tests/portal/postPmmConnect.spec.ts b/playwright-tests/tests/portal/postPmmConnect.spec.ts
@@ -27,8 +27,7 @@ test.describe('Spec file for PMM connected the portal', async () => {
     if (!pmmVersion) {
       pmmVersion = (await api.pmm.serverV1.getPmmVersion()).minor;
     }
-    [firstAdmin, secondAdmin, technicalUser] = await portalHelper.loadTestUsers();
-    freeUser = await portalHelper.addRandomUserToOrg(firstAdmin, PortalUserRoles.admin);
+    [firstAdmin, secondAdmin, technicalUser, freeUser] = portalHelper.loadUsersFromFile();
   });
 
   test.beforeEach(async ({ page }) => {

diff --git a/playwright-tests/tests/portal/testUsers.setup.ts b/playwright-tests/tests/portal/testUsers.setup.ts
@@ -0,0 +1,30 @@
+import { test as setup } from '@playwright/test';
+import { api } from '@api/api';
+import { portalHelper } from '@helpers/portalHelper';
+import { fileHelper } from '@helpers/fileHelper';
+import { Constants } from '@helpers/Constants';
+
+/**
+ * Extension point: before Portal tests.
+ * Note that there are only 2 ways to pass any artifacts to tests: environment variables and files
+ */
+setup('Setup Portal tests', async ({ baseURL }) => {
+  await setup.step('Add pmm-server settings', async () => {
+    await api.pmm.settingsV1.changeSettings({
+      pmm_public_address: baseURL!.replace(/(^\w+:|^)\/\//, ''),
+    });
+  });
+  await setup.step('Remove old credentials file if it\'s there', async () => {
+    if (fileHelper.fileExists(Constants.portal.credentialsFile)) {
+      console.log('Found file with Portal test users! Removing...');
+      await fileHelper.removeFile(Constants.portal.credentialsFile);
+    }
+  });
+  await setup.step('Generate new users and save to file', async () => {
+    const [firstAdmin, secondAdmin, technicalUser, freeUser] = await portalHelper.createNewUsers();
+    fileHelper.writeToFile(
+      Constants.portal.credentialsFile,
+      JSON.stringify([firstAdmin, secondAdmin, technicalUser, freeUser]),
+    );
+  });
+});