Updated helper functions and config

Author: Andrewgdewar

.github/workflows/stageTestAction.yml

@@ -41,8 +41,8 @@ jobs:
 
       - name: Create .env file
         run: |
-          echo "USER1USERNAME=$USER1USERNAME" >> .env
-          echo "USER1PASSWORD=$USER1PASSWORD" >> .env
+          echo "ADMIN_USERNAME=$ADMIN_USERNAME" >> .env
+          echo "ADMIN_PASSWORD=$ADMIN_PASSWORD" >> .env
           echo "BASE_URL=$BASE_URL" >> .env
           echo "PROXY=$PROXY" >> .env
           echo "TOKEN=apple" >> .env

example.env

@@ -1,8 +1,11 @@
 #skus for qe user contentPlaywrightUserAdmin: 
 # MCT4022,MCT3718,MCT3695,ES0113909
 
-USER1USERNAME="contentPlaywrightUserAdmin" # Required
-USER1PASSWORD="" # Required (Ask Andrew if needed)
+ADMIN_USERNAME="contentPlaywrightUserAdmin"
+ADMIN_PASSWORD=SOMETHINGSECRET
+
+READONLY_USERNAME="contentPlaywrightReader"
+READONLY_PASSWORD=SOMETHINGSECRET
 ORG_ID_1="1234" #org id to register for registration tests
 ACTIVATION_KEY_1="MyKey" #activation Key used for testing
 

playwright.config.ts

@@ -52,45 +52,29 @@ export default defineConfig({
       : {}),
   },
   projects: [
-    { name: "setup", testMatch: /.*\.setup\.ts/ },
+    { name: "setup", testMatch: /auth\.setup\.ts/ },
     {
-      name: "chromium", // 'Run admin user tests',
+      name: "AdminTests", // 'Run admin user tests',
       grepInvert: [/read-only/], // !!process.env.PROD ? [/preview-only/, /switch-to-preview/],  ] : [/switch-to-preview/],
       use: {
         ...devices["Desktop Chrome"],
-        storageState: `.auth/${process.env.USER1USERNAME}.json`,
+        storageState: `./.auth/${process.env.ADMIN_USERNAME}.json`, // Thise is setting the cookies
       },
       dependencies: ["setup"],
     },
-
     {
-      name: "chromium", // 'Run read-only user tests',
+      name: "SwitchToUser2",
+      testMatch: /.switchToUser2\.setup\.ts/,
+      dependencies: ["setup"],
+    },
+    {
+      name: "ReadOnlyTests", // 'Run read-only user tests',
       grep: [/read-only/],
       use: {
         ...devices["Desktop Chrome"],
-        storageState: `.auth/${process.env.RO_USER_USERNAME}.json`,
+        storageState: `.auth/${process.env.READONLY_USERNAME}.json`,
       },
-      dependencies: ["setup"],
+      dependencies: ["SwitchToUser2"],
     },
-    // ...!!process.env.PROD ?
-    //     [{
-    //         name: 'Switch to preview',
-    //         grep: [/switch-to-preview/],
-    //         use: {
-    //             ...devices['Desktop Chrome'],
-    //             storageState: `.auth/${process.env.USER1USERNAME}.json`,
-
-    //         },
-    //         dependencies: ['setup'],//'chromium',
-    //     },
-    //     {
-    //         name: 'Run preview only',
-    //         grep: [/preview-only/],
-    //         use: {
-    //             ...devices['Desktop Chrome'],
-    //             storageState: `.auth/${process.env.USER1USERNAME}.json`,
-    //         },
-    //         dependencies: ['Switch to preview'],
-    //     }] : [],
   ],
 });

readme.md

@@ -19,29 +19,30 @@ yarn get-tests
 ## Podman
 
 As your user, run podman to serve the api:
+
 ```
 podman system service -t 0 unix:///tmp/podman.sock
 ```
 
 Uncomment the DOCKER_SOCKET option in the .env file:
+
 ```
 DOCKER_SOCKET="/tmp/podman.sock"
 ```
 
 ## Docker
 
-* ensure the docker service is running
-* ensure your user is part of the 'docker' user group
-
+- ensure the docker service is running
+- ensure your user is part of the 'docker' user group
 
 # Option 1 Run local:
 
 For local testing, make sure your front-end/backend servers are running and accessible, then:
 
 - Ensure you do NOT specify a proxy in your .env file (put an empty value: "")
 - Make sure your .env's BASE_URL is pointed to the local front-end server "https://stage.foo.redhat.com:1337"
-- USER1USERNAME="<YOUR_STAGE_QE_USER>"
-- USER1PASSWORD="<YOUR_STAGE_QE_USER_PASSWORD>"
+- ADMIN_USERNAME="<YOUR_STAGE_QE_USER>"
+- ADMIN_PASSWORD="<YOUR_STAGE_QE_USER_PASSWORD>"
 
 Note: For Ethel, your user will require the following skus: MCT4022,MCT3718,MCT3695,ES0113909
 
@@ -51,8 +52,8 @@ For local stage testing, make sure the following:
 
 - PROXY must be set correctly in your .env file.
 - Make sure your .env's BASE_URL is pointed to the targeted env, if targeting PROD, the proxy is not needed.
-- USER1USERNAME="<YOUR_STAGE_QE_USER>"
-- USER1PASSWORD="<YOUR_STAGE_QE_USER_PASSWORD>"
+- ADMIN_USERNAME="<YOUR_STAGE_QE_USER>"
+- ADMIN_PASSWORD="<YOUR_STAGE_QE_USER_PASSWORD>"
 
 Note: For Ethel, your user will require the following skus: MCT4022,MCT3718,MCT3695,ES0113909
 

repoName.txt

@@ -0,0 +1 @@
+Repo-RBAC-hms2

tests/Integration/switchToPreview.spec.ts

@@ -1,20 +1,18 @@
 import { expect, test } from "@playwright/test";
 import { navigateToRepositories } from "../UI/helpers/navHelpers";
+import { randomName, randomUrl } from "../UI/helpers/repoHelpers";
+import { closePopupsIfExist, getRowByNameOrUrl } from "../UI/helpers/helpers";
+import fs from "fs";
+import { deleteAllRepos } from "../UI/helpers/deleteRepositories";
 import { switchToUser } from "../helpers/loginHelpers";
-import { randomName, randomUrl } from '../UI/helpers/repoHelpers';
-import { closePopupsIfExist, getRowByNameOrUrl } from '../UI/helpers/helpers';
-import fs from 'fs';
-import { deleteAllRepos } from '../UI/helpers/deleteRepositories';
 
-
-
-const repoNamePrefix = 'Repo-RBAC';
-const repoNameFile = 'repoName.txt';
+const repoNamePrefix = "Repo-RBAC";
+const repoNameFile = "repoName.txt";
 
 // Function to get or generate repo name using file persistence
 const getRepoName = (): string => {
   if (fs.existsSync(repoNameFile)) {
-    const repoName = fs.readFileSync(repoNameFile, 'utf8');
+    const repoName = fs.readFileSync(repoNameFile, "utf8");
     console.log(`Loaded repo name from file: ${repoName}`);
     return repoName;
   }
@@ -28,66 +26,89 @@ const getRepoName = (): string => {
 test.beforeAll(async () => {
   if (fs.existsSync(repoNameFile)) {
     fs.unlinkSync(repoNameFile);
-    console.log('Cleaned up repoName.txt');
+    console.log("Cleaned up repoName.txt");
   }
 });
 
 const url = randomUrl();
 
-test.describe.serial("Combined user tests", () => {
-  test("Login as user 1 (admin)", { tag: "@admin" }, async ({ page }) => {
-    await test.step('Navigate to the repository page', async () => {
-      await switchToUser(page, process.env.USER1USERNAME!);
-      console.log('\n   Try to delete old repos\n');
+test.describe("Combined user tests", () => {
+  test("Login as user 1 (admin)", async ({ page }) => {
+    await test.step("Navigate to the repository page", async () => {
+      console.log("\n   Try to delete old repos\n");
       await deleteAllRepos(page, `&search=${repoNamePrefix}`);
       await navigateToRepositories(page);
       await closePopupsIfExist(page);
     });
 
-    await test.step('Create a repository', async () => {
-      await page.getByRole('button', { name: 'Add repositories' }).first().click();
-      await expect(page.getByRole('dialog', { name: 'Add custom repositories' })).toBeVisible();
+    await test.step("Create a repository", async () => {
+      await page
+        .getByRole("button", { name: "Add repositories" })
+        .first()
+        .click();
+      await expect(
+        page.getByRole("dialog", { name: "Add custom repositories" })
+      ).toBeVisible();
 
       const repoName = getRepoName();
-      await page.getByLabel('Name').fill(repoName);
-      await page.getByLabel('Introspect only').click();
-      await page.getByLabel('URL').fill(url);
-      await page.getByRole('button', { name: 'Save', exact: true }).click();
+      await page.getByLabel("Name").fill(repoName);
+      await page.getByLabel("Introspect only").click();
+      await page.getByLabel("URL").fill(url);
+      await page.getByRole("button", { name: "Save", exact: true }).click();
     });
 
-    await test.step('Read the repo', async () => {
+    await test.step("Read the repo", async () => {
       const repoName = getRepoName();
       const row = await getRowByNameOrUrl(page, repoName);
-      await expect(row.getByText('Valid')).toBeVisible();
-      await row.getByLabel('Kebab toggle').click();
-      await row.getByRole('menuitem', { name: 'Edit' }).click();
-      await expect(page.getByRole('dialog', { name: 'Edit custom repository' })).toBeVisible();
-      await expect(page.getByPlaceholder('Enter name', { exact: true })).toHaveValue(repoName);
-      await expect(page.getByPlaceholder('https://', { exact: true })).toHaveValue(url);
+      await expect(row.getByText("Valid")).toBeVisible();
+      await row.getByLabel("Kebab toggle").click();
+      await row.getByRole("menuitem", { name: "Edit" }).click();
+      await expect(
+        page.getByRole("dialog", { name: "Edit custom repository" })
+      ).toBeVisible();
+      await expect(
+        page.getByPlaceholder("Enter name", { exact: true })
+      ).toHaveValue(repoName);
+      await expect(
+        page.getByPlaceholder("https://", { exact: true })
+      ).toHaveValue(url);
     });
 
-    await test.step('Update the repository', async () => {
+    await test.step("Update the repository", async () => {
       const repoName = getRepoName();
-      await page.getByPlaceholder('Enter name', { exact: true }).fill(`${repoName}-Edited`);
-      await page.getByRole('button', { name: 'Save changes', exact: true }).click();
+      await page
+        .getByPlaceholder("Enter name", { exact: true })
+        .fill(`${repoName}-Edited`);
+      await page
+        .getByRole("button", { name: "Save changes", exact: true })
+        .click();
     });
   });
 
-  test("Login as user 2 (read-only)", { tag: "@read-only" }, async ({ page }) => {
-    await test.step('Navigate to the repository page', async () => {
-      await switchToUser(page, process.env.RO_USER_USERNAME!);
-      await navigateToRepositories(page);
-      await closePopupsIfExist(page);
-    });
+  test(
+    "Login as user 2 (read-only)",
+    { tag: "@read-only" },
+    async ({ page }) => {
+      await test.step("Navigate to the repository page", async () => {
+        await navigateToRepositories(page);
+        await closePopupsIfExist(page);
+      });
 
-    await test.step('Read the repo', async () => {
-      const repoName = getRepoName();
-      const row = await getRowByNameOrUrl(page, `${repoName}-Edited`);
-      await expect(row.getByText('Valid')).toBeVisible({ timeout: 60000 });
-      await row.getByLabel('Kebab toggle').click();
-      await row.getByRole('menuitem', { name: 'Edit' }).click();
-      await expect(page.getByText('You do not have the required permissions to perform this action')).toBeVisible();
-      await expect(page.getByRole('dialog', { name: 'Edit custom repository' })).not.toBeVisible();
-    });
-  });
-});
+      await test.step("Read the repo", async () => {
+        const repoName = getRepoName();
+        const row = await getRowByNameOrUrl(page, `${repoName}-Edited`);
+        await expect(row.getByText("Valid")).toBeVisible({ timeout: 60000 });
+        await row.getByLabel("Kebab toggle").click();
+        await row.getByRole("menuitem", { name: "Edit" }).click();
+        await expect(
+          page.getByText(
+            "You do not have the required permissions to perform this action"
+          )
+        ).toBeVisible();
+        await expect(
+          page.getByRole("dialog", { name: "Edit custom repository" })
+        ).not.toBeVisible();
+      });
+    }
+  );
+});

tests/Integration/twouserRBACTest.spec.ts

@@ -4,57 +4,34 @@ import {
   closePopupsIfExist,
   switchToUser,
   logInWithUsernameAndPassword,
-  ensureNotInPreview,
   logout,
 } from "./helpers/loginHelpers";
 import { describe } from "node:test";
 
-const authFile = '.auth/contentPlaywrightUserAdmin.json';
-const authFileRO = '.auth/contentPlaywrightReader.json';
-
 describe("Setup", async () => {
   setup("Ensure needed ENV variables exist", async ({}) => {
     expect(() => throwIfMissingEnvVariables()).not.toThrow();
   });
 
   setup("Authenticate all the users", async ({ page }) => {
     await closePopupsIfExist(page);
-    await expect(page.locator('body')).toBeVisible();
-    console.log('Page URL before login:', page.url());
+
     await logInWithUsernameAndPassword(
       page,
-      process.env.USER1USERNAME,
-      process.env.USER1PASSWORD
+      process.env.READONLY_USERNAME,
+      process.env.READONLY_PASSWORD
     );
-    const cookies = await page.context().cookies();
-    console.log('Cookies after Admin login:', cookies);
-    // wait longer to see if cookie is available
-    await expect(
-      page.getByRole('heading', { name: 'Repositories', exact: false }),
-    ).toBeVisible();
-    await page.context().storageState({ path: authFile });
 
-    console.log('Cookies before Admin logout:', await page.context().cookies());
     await logout(page);
-    console.log('Cookies after Admin logout:', await page.context().cookies());
 
     await logInWithUsernameAndPassword(
       page,
-      process.env.RO_USER_USERNAME,
-      process.env.RO_USER_PASSWORD
+      process.env.ADMIN_USERNAME,
+      process.env.ADMIN_PASSWORD
     );
-    await page.context().storageState({ path: authFileRO });
-    await logout(page);
-    // Example of how to add another user
-    // await logout(page)
-    // await logInWithUsernameAndPassword(
-    //     page,
-    //     process.env.USER2USERNAME,
-    //     process.env.USER2PASSWORD
-    // );
-    // Example of how to switch to said user
-    // await switchToUser(page, process.env.USER1USERNAME!);
-    // await ensureNotInPreview(page);
-    // Other users for other tests can be added below after logging out
+
+    await switchToUser(page, process.env.ADMIN_USERNAME!);
+
+    // We do this as we run admin tests first.
   });
 });