feat(test): add pw fixtures (podman-desktop#8745)

* feat(test): add pw fixtures
Signed-off-by: Vladimir Lazar <[email protected]>

Author: cbr7

playwright.config.ts

@@ -21,6 +21,7 @@ import { defineConfig, devices } from '@playwright/test';
 export default defineConfig({
   outputDir: 'tests/playwright/output/',
   workers: 1,
+  timeout: 60000,
 
   reporter: [
     ['list'],

tests/playwright/src/index.ts

@@ -22,6 +22,7 @@ export * from './runner/podman-desktop-runner';
 export * from './setupFiles/setup-registry';
 export type { RunnerTestContext } from './testContext/runner-test-context';
 export * from './utility/cleanup';
+export * from './utility/fixtures';
 export * from './utility/operations';
 export * from './utility/platform';
 export * from './utility/wait';

tests/playwright/src/runner/podman-desktop-runner.ts

@@ -43,7 +43,27 @@ export class PodmanDesktopRunner {
   private _autoUpdate: boolean;
   private _autoCheckUpdate: boolean;
 
-  constructor({
+  private static _instance: PodmanDesktopRunner | undefined;
+
+  static async getInstance({
+    profile = '',
+    customFolder = 'podman-desktop',
+    autoUpdate = true,
+    autoCheckUpdate = true,
+  }: {
+    profile?: string;
+    customFolder?: string;
+    autoUpdate?: boolean;
+    autoCheckUpdate?: boolean;
+  } = {}): Promise<PodmanDesktopRunner> {
+    if (!PodmanDesktopRunner._instance) {
+      PodmanDesktopRunner._instance = new PodmanDesktopRunner({ profile, customFolder, autoUpdate, autoCheckUpdate });
+      await PodmanDesktopRunner._instance.start();
+    }
+    return PodmanDesktopRunner._instance;
+  }
+
+  private constructor({
     profile = '',
     customFolder = 'podman-desktop',
     autoUpdate = true,
@@ -63,7 +83,8 @@ export class PodmanDesktopRunner {
 
   public async start(): Promise<Page> {
     if (this.isRunning()) {
-      throw Error('Podman Desktop is already running');
+      console.log('Podman Desktop is already running');
+      return this.getPage();
     }
 
     try {
@@ -215,6 +236,7 @@ export class PodmanDesktopRunner {
       }
     }
     this._running = false;
+    PodmanDesktopRunner._instance = undefined;
 
     if (this._videoAndTraceName) {
       const videoPath = join(this._testOutput, 'videos', `${this._videoAndTraceName}.webm`);

tests/playwright/src/specs/compose-onboarding-smoke.spec.ts

@@ -17,7 +17,6 @@
  ***********************************************************************/
 
 import type { Page } from '@playwright/test';
-import { expect as playExpect, test } from '@playwright/test';
 
 import { CLIToolsPage } from '../model/pages/cli-tools-page';
 import { ComposeLocalInstallPage } from '../model/pages/compose-onboarding/compose-local-install-page';
@@ -27,43 +26,34 @@ import { ComposeWideInstallPage } from '../model/pages/compose-onboarding/compos
 import { ResourceCliCardPage } from '../model/pages/resource-cli-card-page';
 import { ResourcesPage } from '../model/pages/resources-page';
 import { SettingsBar } from '../model/pages/settings-bar';
-import { WelcomePage } from '../model/pages/welcome-page';
-import { NavigationBar } from '../model/workbench/navigation';
-import { PodmanDesktopRunner } from '../runner/podman-desktop-runner';
+import type { NavigationBar } from '../model/workbench/navigation';
+import { expect as playExpect, test } from '../utility/fixtures';
 import { isCI, isLinux } from '../utility/platform';
 
 const RESOURCE_NAME: string = 'Compose';
 
-let pdRunner: PodmanDesktopRunner;
-let page: Page;
-let navBar: NavigationBar;
 let composeVersion: string;
 // property that will make sure that on linux we can run only partial tests, by default this is turned off
 const composePartialInstallation = process.env.COMPOSE_PARTIAL_INSTALL ? process.env.COMPOSE_PARTIAL_INSTALL : false;
 
 test.skip(!!isCI && isLinux, 'Tests suite should not run on Linux platform');
 
-test.beforeAll(async () => {
-  pdRunner = new PodmanDesktopRunner();
-  page = await pdRunner.start();
+test.beforeAll(async ({ pdRunner, welcomePage }) => {
   pdRunner.setVideoAndTraceName('compose-onboarding-e2e');
-
-  const welcomePage = new WelcomePage(page);
   await welcomePage.handleWelcomePage(true);
-  navBar = new NavigationBar(page);
 });
 
-test.afterAll(async () => {
+test.afterAll(async ({ pdRunner }) => {
   await pdRunner.close();
 });
 
 test.describe.serial('Compose onboarding workflow verification @smoke', () => {
-  test.afterEach(async () => {
-    await navBar.openDashboard();
+  test.afterEach(async ({ navigationBar }) => {
+    await navigationBar.openDashboard();
   });
 
-  test('Compose onboarding button Setup is available', async () => {
-    await navBar.openSettings();
+  test('Compose onboarding button Setup is available', async ({ page, navigationBar }) => {
+    await navigationBar.openSettings();
     const settingsBar = new SettingsBar(page);
     const resourcesPage = await settingsBar.openTabPage(ResourcesPage);
 
@@ -77,8 +67,8 @@ test.describe.serial('Compose onboarding workflow verification @smoke', () => {
     ).toBeVisible({ timeout: 10000 });
   });
 
-  test('Can enter Compose onboarding', async () => {
-    const onboardingPage = await openComposeOnboarding(page);
+  test('Can enter Compose onboarding', async ({ page, navigationBar }) => {
+    const onboardingPage = await openComposeOnboarding(page, navigationBar);
 
     await playExpect(onboardingPage.heading).toBeVisible();
 
@@ -89,8 +79,8 @@ test.describe.serial('Compose onboarding workflow verification @smoke', () => {
     composeVersion = await onboardingVersionPage.getVersion();
   });
 
-  test('Can install Compose locally', async () => {
-    const onboardingPage = await openComposeOnboarding(page);
+  test('Can install Compose locally', async ({ page, navigationBar }) => {
+    const onboardingPage = await openComposeOnboarding(page, navigationBar);
     await onboardingPage.nextStepButton.click();
 
     const onboardigLocalPage = new ComposeLocalInstallPage(page);
@@ -105,8 +95,8 @@ test.describe.serial('Compose onboarding workflow verification @smoke', () => {
     await skipOkButton.click();
   });
 
-  test('Can resume Compose onboarding and it can be canceled', async () => {
-    await openComposeOnboarding(page);
+  test('Can resume Compose onboarding and it can be canceled', async ({ page, navigationBar }) => {
+    await openComposeOnboarding(page, navigationBar);
     const onboardingLocalPage = new ComposeLocalInstallPage(page);
 
     await playExpect(onboardingLocalPage.onboardingStatusMessage).toHaveText('Compose successfully Downloaded');
@@ -119,10 +109,10 @@ test.describe.serial('Compose onboarding workflow verification @smoke', () => {
     await skipOkButton.click();
   });
 
-  test('Can install Compose system-wide', async () => {
+  test('Can install Compose system-wide', async ({ page, navigationBar }) => {
     test.skip(!!composePartialInstallation, 'Partial installation of Compose is enabled');
 
-    const onboardingPage = await openComposeOnboarding(page);
+    const onboardingPage = await openComposeOnboarding(page, navigationBar);
     await onboardingPage.nextStepButton.click();
 
     const onboardingWidePage = new ComposeWideInstallPage(page);
@@ -136,10 +126,10 @@ test.describe.serial('Compose onboarding workflow verification @smoke', () => {
     await playExpect(resourcesPage.heading).toBeVisible();
   });
 
-  test('Verify Compose was installed', async () => {
+  test('Verify Compose was installed', async ({ page, navigationBar }) => {
     test.skip(!!composePartialInstallation, 'Partial installation of Compose is enabled');
 
-    await navBar.openSettings();
+    await navigationBar.openSettings();
     const settingsBar = new SettingsBar(page);
     const resourcesPage = await settingsBar.openTabPage(ResourcesPage);
     await playExpect.poll(async () => await resourcesPage.resourceCardIsVisible(RESOURCE_NAME)).toBeTruthy();
@@ -154,8 +144,8 @@ test.describe.serial('Compose onboarding workflow verification @smoke', () => {
   });
 });
 
-async function openComposeOnboarding(page: Page): Promise<ComposeOnboardingPage> {
-  await navBar.openSettings();
+async function openComposeOnboarding(page: Page, navigationBar: NavigationBar): Promise<ComposeOnboardingPage> {
+  await navigationBar.openSettings();
   const settingsBar = new SettingsBar(page);
   const resourcesPage = await settingsBar.openTabPage(ResourcesPage);
   await playExpect(resourcesPage.heading).toBeVisible();

tests/playwright/src/specs/container-smoke.spec.ts

@@ -16,33 +16,24 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
-import type { Page } from '@playwright/test';
-import { expect as playExpect, test } from '@playwright/test';
-
 import { ContainerState } from '../model/core/states';
 import type { ContainerInteractiveParams } from '../model/core/types';
 import { ContainersPage } from '../model/pages/containers-page';
 import { ImageDetailsPage } from '../model/pages/image-details-page';
 import type { ImagesPage } from '../model/pages/images-page';
-import { WelcomePage } from '../model/pages/welcome-page';
 import { NavigationBar } from '../model/workbench/navigation';
-import { PodmanDesktopRunner } from '../runner/podman-desktop-runner';
+import { expect as playExpect, test } from '../utility/fixtures';
 import { deleteContainer, deleteImage } from '../utility/operations';
 import { waitForPodmanMachineStartup, waitWhile } from '../utility/wait';
 
-let pdRunner: PodmanDesktopRunner;
-let page: Page;
 const imageToPull = 'ghcr.io/linuxcontainers/alpine';
 const imageTag = 'latest';
 const containerToRun = 'alpine-container';
 const containerList = ['first', 'second', 'third'];
 const containerStartParams: ContainerInteractiveParams = { attachTerminal: false };
 
-test.beforeAll(async () => {
-  pdRunner = new PodmanDesktopRunner();
-  page = await pdRunner.start();
+test.beforeAll(async ({ pdRunner, welcomePage, page }) => {
   pdRunner.setVideoAndTraceName('containers-e2e');
-  const welcomePage = new WelcomePage(page);
   await welcomePage.handleWelcomePage(true);
   await waitForPodmanMachineStartup(page);
   // wait giving a time to podman desktop to load up
@@ -65,7 +56,7 @@ test.beforeAll(async () => {
   }
 });
 
-test.afterAll(async () => {
+test.afterAll(async ({ pdRunner, page }) => {
   test.setTimeout(90000);
 
   try {
@@ -83,29 +74,25 @@ test.afterAll(async () => {
 test.describe.serial('Verification of container creation workflow @smoke', () => {
   test.describe.configure({ retries: 2 });
 
-  test(`Pulling of '${imageToPull}:${imageTag}' image`, async () => {
+  test(`Pulling of '${imageToPull}:${imageTag}' image`, async ({ navigationBar }) => {
     test.setTimeout(90000);
 
-    const navigationBar = new NavigationBar(page);
     let images = await navigationBar.openImages();
     const pullImagePage = await images.openPullImage();
     images = await pullImagePage.pullImage(imageToPull, imageTag);
 
     await playExpect.poll(async () => await images.waitForImageExists(imageToPull)).toBeTruthy();
   });
 
-  test(`Start a container '${containerToRun}' from image`, async () => {
-    const navigationBar = new NavigationBar(page);
+  test(`Start a container '${containerToRun}' from image`, async ({ navigationBar }) => {
     let images = await navigationBar.openImages();
     const imageDetails = await images.openImageDetails(imageToPull);
     const runImage = await imageDetails.openRunImage();
-    await pdRunner.screenshot('containers-run-image.png');
     const containers = await runImage.startContainer(containerToRun, containerStartParams);
     await playExpect(containers.header).toBeVisible();
     await playExpect
       .poll(async () => await containers.containerExists(containerToRun), { timeout: 10000 })
       .toBeTruthy();
-    await pdRunner.screenshot('containers-container-exists.png');
     const containerDetails = await containers.openContainersDetails(containerToRun);
     await playExpect
       .poll(async () => await containerDetails.getState(), { timeout: 10000 })
@@ -115,8 +102,7 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
     playExpect(await images.getCurrentStatusOfImage(imageToPull)).toBe('USED');
   });
 
-  test('Test navigation between pages', async () => {
-    const navigationBar = new NavigationBar(page);
+  test('Test navigation between pages', async ({ navigationBar }) => {
     const containers = await navigationBar.openContainers();
 
     const containersDetails = await containers.openContainersDetails(containerToRun);
@@ -129,14 +115,12 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
     await containersDetails.closeButton.click();
     await playExpect(containers.heading).toBeVisible();
   });
-  test('Open a container details', async () => {
-    const navigationBar = new NavigationBar(page);
+  test('Open a container details', async ({ navigationBar }) => {
     const containers = await navigationBar.openContainers();
     const containersDetails = await containers.openContainersDetails(containerToRun);
     await playExpect(containersDetails.heading).toBeVisible();
     await playExpect(containersDetails.heading).toContainText(containerToRun);
     // test state of container in summary tab
-    await pdRunner.screenshot('containers-container-details.png');
     const containerState = await containersDetails.getState();
     playExpect(containerState).toContain(ContainerState.Running);
     // check Logs output
@@ -149,8 +133,7 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
     await containersDetails.activateTab('Terminal');
     // TODO: After updating of accessibility of various element in containers pages, we can extend test
   });
-  test('Redirecting to image details from a container details', async () => {
-    const navigationBar = new NavigationBar(page);
+  test('Redirecting to image details from a container details', async ({ page, navigationBar }) => {
     const containers = await navigationBar.openContainers();
     const containersDetails = await containers.openContainersDetails(containerToRun);
     await playExpect(containersDetails.heading).toBeVisible();
@@ -161,8 +144,7 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
     await playExpect(imageDetails.heading).toBeVisible();
     await playExpect(imageDetails.heading).toContainText(imageToPull);
   });
-  test('Stopping a container from Container details', async () => {
-    const navigationBar = new NavigationBar(page);
+  test('Stopping a container from Container details', async ({ navigationBar }) => {
     const containers = await navigationBar.openContainers();
     const containersDetails = await containers.openContainersDetails(containerToRun);
     await playExpect(containersDetails.heading).toBeVisible();
@@ -178,8 +160,7 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
     await playExpect(startButton).toBeVisible();
   });
 
-  test(`Start a container from the Containers page`, async () => {
-    const navigationBar = new NavigationBar(page);
+  test(`Start a container from the Containers page`, async ({ navigationBar }) => {
     const containers = await navigationBar.openContainers();
     const containersDetails = await containers.openContainersDetails(containerToRun);
     await playExpect(containersDetails.heading).toBeVisible();
@@ -196,8 +177,7 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
       .toContain(ContainerState.Running);
   });
 
-  test(`Stop a container from the Containers page`, async () => {
-    const navigationBar = new NavigationBar(page);
+  test(`Stop a container from the Containers page`, async ({ navigationBar }) => {
     const containers = await navigationBar.openContainers();
     const containersDetails = await containers.openContainersDetails(containerToRun);
     await playExpect(containersDetails.heading).toBeVisible();
@@ -214,8 +194,7 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
       .toContain(ContainerState.Exited);
   });
 
-  test('Deleting a container from Container details', async () => {
-    const navigationBar = new NavigationBar(page);
+  test('Deleting a container from Container details', async ({ navigationBar }) => {
     const containers = await navigationBar.openContainers();
     const containersDetails = await containers.openContainersDetails(containerToRun);
     await playExpect(containersDetails.heading).toContainText(containerToRun);
@@ -224,9 +203,8 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
     await playExpect.poll(async () => await containersPage.containerExists(containerToRun)).toBeFalsy();
   });
 
-  test(`Deleting a container from the Containers page`, async () => {
+  test(`Deleting a container from the Containers page`, async ({ navigationBar }) => {
     //re-start the container from an image
-    const navigationBar = new NavigationBar(page);
     let images = await navigationBar.openImages();
     const imageDetails = await images.openImageDetails(imageToPull);
     const runImage = await imageDetails.openRunImage();
@@ -235,7 +213,6 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
     await playExpect
       .poll(async () => await containers.containerExists(containerToRun), { timeout: 10000 })
       .toBeTruthy();
-    await pdRunner.screenshot('containers-container-exists.png');
     const containerDetails = await containers.openContainersDetails(containerToRun);
     await playExpect
       .poll(async () => await containerDetails.getState(), { timeout: 10000 })
@@ -253,10 +230,9 @@ test.describe.serial('Verification of container creation workflow @smoke', () =>
       .toBeFalsy();
   });
 
-  test('Prune containers', async () => {
+  test('Prune containers', async ({ page, navigationBar }) => {
     test.setTimeout(120000);
 
-    const navigationBar = new NavigationBar(page);
     //Start 3 containers
     for (const container of containerList) {
       const images = await navigationBar.openImages();