chore(test): simplifying and extracting test logic, refactor (#3078)

ScrewTSW · web-flow · commit e916fe89b920 · 2025-05-26T20:44:59.000+02:00
Signed-off-by: Tibor Dancs &lt;tdancs@redhat.com&gt;
diff --git a/tests/playwright/playwright.config.ts b/tests/playwright/playwright.config.ts
@@ -21,6 +21,7 @@ import { defineConfig, devices } from '@playwright/test';
 export default defineConfig({
   outputDir: './output/',
   workers: 1,
+  timeout: 60_000,
 
   reporter: [
     ['list'],
diff --git a/tests/playwright/src/ai-lab-extension.spec.ts b/tests/playwright/src/ai-lab-extension.spec.ts
@@ -16,7 +16,7 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
-import type { Locator, Page } from '@playwright/test';
+import type { Locator } from '@playwright/test';
 import type { NavigationBar, ExtensionsPage } from '@podman-desktop/tests-playwright';
 import {
   expect as playExpect,
@@ -26,24 +26,26 @@ import {
   waitForPodmanMachineStartup,
   isLinux,
 } from '@podman-desktop/tests-playwright';
-import { AILabPage } from './model/ai-lab-page';
+import type { AILabDashboardPage } from './model/ai-lab-dashboard-page';
 import type { AILabRecipesCatalogPage } from './model/ai-lab-recipes-catalog-page';
-import { AILabExtensionDetailsPage } from './model/podman-extension-ai-lab-details-page';
 import type { AILabCatalogPage } from './model/ai-lab-catalog-page';
-import { handleWebview } from './utils/webviewHandler';
 import type { AILabServiceDetailsPage } from './model/ai-lab-service-details-page';
 import type { AILabPlaygroundsPage } from './model/ai-lab-playgrounds-page';
 import type { AILabPlaygroundDetailsPage } from './model/ai-lab-playground-details-page';
+import {
+  getExtensionCard,
+  getExtensionVersion,
+  openAILabExtensionDetails,
+  reopenAILabDashboard,
+  waitForExtensionToInitialize,
+} from './utils/aiLabHandler';
 
 const AI_LAB_EXTENSION_OCI_IMAGE =
   process.env.EXTENSION_OCI_IMAGE ?? 'ghcr.io/containers/podman-desktop-extension-ai-lab:nightly';
 const AI_LAB_EXTENSION_PREINSTALLED: boolean = process.env.EXTENSION_PREINSTALLED === 'true';
-const AI_LAB_CATALOG_EXTENSION_LABEL: string = 'redhat.ai-lab';
-const AI_LAB_CATALOG_EXTENSION_NAME: string = 'Podman AI Lab extension';
 const AI_LAB_CATALOG_STATUS_ACTIVE: string = 'ACTIVE';
 
-let webview: Page;
-let aiLabPage: AILabPage;
+let aiLabPage: AILabDashboardPage;
 const runnerOptions = {
   customFolder: 'ai-lab-tests-pd',
   aiLabModelUploadDisabled: isWindows ? true : false,
@@ -86,36 +88,20 @@ test.describe.serial(`AI Lab extension installation and verification`, () => {
     });
 
     test('Extension (card) is installed, present and active', async ({ navigationBar }) => {
-      const extensions = await navigationBar.openExtensions();
-      await playExpect
-        .poll(async () => await extensions.extensionIsInstalled(AI_LAB_CATALOG_EXTENSION_LABEL), { timeout: 30000 })
-        .toBeTruthy();
-      const extensionCard = await extensions.getInstalledExtension(
-        AI_LAB_CATALOG_EXTENSION_NAME,
-        AI_LAB_CATALOG_EXTENSION_LABEL,
-      );
+      await waitForExtensionToInitialize(navigationBar);
+      const extensionCard = await getExtensionCard(navigationBar);
       await playExpect(extensionCard.status).toHaveText(AI_LAB_CATALOG_STATUS_ACTIVE);
     });
 
-    test(`Extension's details show correct status, no error`, async ({ page, navigationBar }) => {
-      const extensions = await navigationBar.openExtensions();
-      const extensionCard = await extensions.getInstalledExtension('ai-lab', AI_LAB_CATALOG_EXTENSION_LABEL);
-      await extensionCard.openExtensionDetails(AI_LAB_CATALOG_EXTENSION_NAME);
-      const details = new AILabExtensionDetailsPage(page);
-      await playExpect(details.heading).toBeVisible();
-      await playExpect(details.status).toHaveText(AI_LAB_CATALOG_STATUS_ACTIVE);
-      const errorTab = details.tabs.getByRole('button', { name: 'Error' });
-      // we would like to propagate the error's stack trace into test failure message
-      let stackTrace = '';
-      if ((await errorTab.count()) > 0) {
-        await details.activateTab('Error');
-        stackTrace = await details.errorStackTrace.innerText();
-      }
-      await playExpect(errorTab, `Error Tab was present with stackTrace: ${stackTrace}`).not.toBeVisible();
+    test(`Extension's details show correct status, no error`, async ({ navigationBar }) => {
+      const aiLabExtensionDetailsPage = await openAILabExtensionDetails(navigationBar);
+      await aiLabExtensionDetailsPage.waitForLoad();
+      await aiLabExtensionDetailsPage.checkIsActive(AI_LAB_CATALOG_STATUS_ACTIVE);
+      await aiLabExtensionDetailsPage.checkForErrors();
     });
-    test(`Verify AI Lab extension is installed`, async ({ runner, page, navigationBar }) => {
-      [page, webview] = await handleWebview(runner, page, navigationBar);
-      aiLabPage = new AILabPage(page, webview);
+
+    test(`Verify AI Lab is accessible`, async ({ runner, page, navigationBar }) => {
+      aiLabPage = await reopenAILabDashboard(runner, page, navigationBar);
       await aiLabPage.navigationBar.waitForLoad();
     });
   });
@@ -127,11 +113,8 @@ test.describe.serial(`AI Lab extension installation and verification`, () => {
     test.beforeAll(
       'Get AI Lab extension version and open AI Lab navigation bar',
       async ({ page, runner, navigationBar }) => {
-        const extensions = await navigationBar.openExtensions();
-        extensionVersion = await extensions.getInstalledExtensionVersion('ai-lab', AI_LAB_CATALOG_EXTENSION_LABEL);
-
-        [page, webview] = await handleWebview(runner, page, navigationBar);
-        aiLabPage = new AILabPage(page, webview);
+        extensionVersion = await getExtensionVersion(navigationBar);
+        aiLabPage = await reopenAILabDashboard(runner, page, navigationBar);
         await aiLabPage.navigationBar.waitForLoad();
       },
     );
@@ -227,8 +210,7 @@ test.describe.serial(`AI Lab extension installation and verification`, () => {
       let catalogPage: AILabCatalogPage;
 
       test.beforeEach(`Open AI Lab Catalog`, async ({ runner, page, navigationBar }) => {
-        [page, webview] = await handleWebview(runner, page, navigationBar);
-        aiLabPage = new AILabPage(page, webview);
+        aiLabPage = await reopenAILabDashboard(runner, page, navigationBar);
         await aiLabPage.navigationBar.waitForLoad();
 
         catalogPage = await aiLabPage.navigationBar.openCatalog();
@@ -270,8 +252,7 @@ test.describe.serial(`AI Lab extension installation and verification`, () => {
       );
 
       test.beforeAll(`Open AI Lab Catalog`, async ({ runner, page, navigationBar }) => {
-        [page, webview] = await handleWebview(runner, page, navigationBar);
-        aiLabPage = new AILabPage(page, webview);
+        aiLabPage = await reopenAILabDashboard(runner, page, navigationBar);
         await aiLabPage.navigationBar.waitForLoad();
 
         catalogPage = await aiLabPage.navigationBar.openCatalog();
@@ -362,8 +343,7 @@ test.describe.serial(`AI Lab extension installation and verification`, () => {
       const systemPrompt = 'Always respond with: "Hello, I am Chat Bot"';
 
       test.beforeAll(`Open AI Lab Catalog`, async ({ runner, page, navigationBar }) => {
-        [page, webview] = await handleWebview(runner, page, navigationBar);
-        aiLabPage = new AILabPage(page, webview);
+        aiLabPage = await reopenAILabDashboard(runner, page, navigationBar);
         await aiLabPage.navigationBar.waitForLoad();
 
         catalogPage = await aiLabPage.navigationBar.openCatalog();
@@ -447,8 +427,7 @@ test.describe.serial(`AI Lab extension installation and verification`, () => {
       let recipesCatalogPage: AILabRecipesCatalogPage;
 
       test.beforeEach(`Open Recipes Catalog`, async ({ runner, page, navigationBar }) => {
-        [page, webview] = await handleWebview(runner, page, navigationBar);
-        aiLabPage = new AILabPage(page, webview);
+        aiLabPage = await reopenAILabDashboard(runner, page, navigationBar);
         await aiLabPage.navigationBar.waitForLoad();
 
         recipesCatalogPage = await aiLabPage.navigationBar.openRecipesCatalog();
diff --git a/tests/playwright/src/model/ai-lab-catalog-page.ts b/tests/playwright/src/model/ai-lab-catalog-page.ts
@@ -19,7 +19,7 @@
 import type { Locator, Page } from '@playwright/test';
 import { expect as playExpect } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
-import { handleConfirmationDialog } from '@podman-desktop/tests-playwright';
+import { handleConfirmationDialog, podmanAILabExtension } from '@podman-desktop/tests-playwright';
 import { AILabCreatingModelServicePage } from './ai-lab-creating-model-service-page';
 
 export class AILabCatalogPage extends AILabBasePage {
@@ -84,7 +84,7 @@ export class AILabCatalogPage extends AILabBasePage {
     await deleteButton.focus();
     await deleteButton.click();
     await this.page.waitForTimeout(1_000);
-    await handleConfirmationDialog(this.page, 'Podman AI Lab', true, 'Confirm');
+    await handleConfirmationDialog(this.page, podmanAILabExtension.extensionName, true, 'Confirm');
   }
 
   async isModelDownloaded(modelName: string): Promise<boolean> {
diff --git a/tests/playwright/src/model/ai-lab-dashboard-page.ts b/tests/playwright/src/model/ai-lab-dashboard-page.ts
@@ -21,7 +21,7 @@ import { expect as playExpect } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
 import { AILabNavigationBar } from './ai-lab-navigation-bar';
 
-export class AILabPage extends AILabBasePage {
+export class AILabDashboardPage extends AILabBasePage {
   readonly navigationBar: AILabNavigationBar;
 
   constructor(page: Page, webview: Page) {
diff --git a/tests/playwright/src/model/ai-lab-model-service-page.ts b/tests/playwright/src/model/ai-lab-model-service-page.ts
@@ -19,7 +19,7 @@
 import { expect as playExpect } from '@playwright/test';
 import type { Locator, Page } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
-import { handleConfirmationDialog } from '@podman-desktop/tests-playwright';
+import { handleConfirmationDialog, podmanAILabExtension } from '@podman-desktop/tests-playwright';
 import { AILabCreatingModelServicePage } from './ai-lab-creating-model-service-page';
 
 export class AiModelServicePage extends AILabBasePage {
@@ -59,7 +59,7 @@ export class AiModelServicePage extends AILabBasePage {
     await playExpect(this.deleteSelectedItems).toBeEnabled();
     await this.deleteSelectedItems.click();
 
-    await handleConfirmationDialog(this.page, 'Podman AI Lab', true, 'Confirm');
+    await handleConfirmationDialog(this.page, podmanAILabExtension.extensionName, true, 'Confirm');
   }
 
   async getCurrentModelCount(): Promise<number> {
diff --git a/tests/playwright/src/model/ai-lab-navigation-bar.ts b/tests/playwright/src/model/ai-lab-navigation-bar.ts
@@ -25,9 +25,11 @@ import { AiModelServicePage } from './ai-lab-model-service-page';
 import { AILabCatalogPage } from './ai-lab-catalog-page';
 import { AILabPlaygroundsPage } from './ai-lab-playgrounds-page';
 import { AILabLocalServerPage } from './ai-lab-local-server-page';
+import { AILabDashboardPage } from './ai-lab-dashboard-page';
 
 export class AILabNavigationBar extends AILabBasePage {
   readonly navigationBar: Locator;
+  readonly dashboardButton: Locator;
   readonly recipesCatalogButton: Locator;
   readonly runningAppsButton: Locator;
   readonly catalogButton: Locator;
@@ -39,6 +41,7 @@ export class AILabNavigationBar extends AILabBasePage {
   constructor(page: Page, webview: Page) {
     super(page, webview, undefined);
     this.navigationBar = this.webview.getByRole('navigation', { name: 'PreferencesNavigation' });
+    this.dashboardButton = this.navigationBar.getByRole('link', { name: 'Dashboard', exact: true });
     this.recipesCatalogButton = this.navigationBar.getByRole('link', { name: 'Recipe Catalog', exact: true });
     this.runningAppsButton = this.navigationBar.getByRole('link', { name: 'Running' });
     this.catalogButton = this.navigationBar.getByRole('link', { name: 'Catalog', exact: true });
@@ -52,6 +55,12 @@ export class AILabNavigationBar extends AILabBasePage {
     await playExpect(this.navigationBar).toBeVisible();
   }
 
+  async openDashboard(): Promise<AILabDashboardPage> {
+    await playExpect(this.dashboardButton).toBeEnabled();
+    await this.dashboardButton.click();
+    return new AILabDashboardPage(this.page, this.webview);
+  }
+
   async openRecipesCatalog(): Promise<AILabRecipesCatalogPage> {
     await playExpect(this.recipesCatalogButton).toBeEnabled();
     await this.recipesCatalogButton.click();
diff --git a/tests/playwright/src/model/ai-lab-playground-details-page.ts b/tests/playwright/src/model/ai-lab-playground-details-page.ts
@@ -20,7 +20,7 @@ import { expect as playExpect } from '@playwright/test';
 import type { Locator, Page } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
 import { AILabPlaygroundsPage } from './ai-lab-playgrounds-page';
-import { handleConfirmationDialog } from '@podman-desktop/tests-playwright';
+import { handleConfirmationDialog, podmanAILabExtension } from '@podman-desktop/tests-playwright';
 
 export class AILabPlaygroundDetailsPage extends AILabBasePage {
   readonly name: string;
@@ -73,7 +73,7 @@ export class AILabPlaygroundDetailsPage extends AILabBasePage {
   async deletePlayground(): Promise<AILabPlaygroundsPage> {
     await playExpect(this.deletePlaygroundButton).toBeEnabled();
     await this.deletePlaygroundButton.click();
-    await handleConfirmationDialog(this.page, 'Podman AI Lab', true, 'Confirm');
+    await handleConfirmationDialog(this.page, podmanAILabExtension.extensionName, true, 'Confirm');
     return new AILabPlaygroundsPage(this.page, this.webview);
   }
 
diff --git a/tests/playwright/src/model/ai-lab-playgrounds-page.ts b/tests/playwright/src/model/ai-lab-playgrounds-page.ts
@@ -19,7 +19,7 @@
 import type { Locator, Page } from '@playwright/test';
 import { expect as playExpect } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
-import { handleConfirmationDialog } from '@podman-desktop/tests-playwright';
+import { handleConfirmationDialog, podmanAILabExtension } from '@podman-desktop/tests-playwright';
 import { AILabPlaygroundDetailsPage } from './ai-lab-playground-details-page';
 
 export class AILabPlaygroundsPage extends AILabBasePage {
@@ -60,7 +60,7 @@ export class AILabPlaygroundsPage extends AILabBasePage {
     const deleteButton = playgroundRow.getByRole('button', { name: 'Delete conversation', exact: true });
     await playExpect(deleteButton).toBeEnabled();
     await deleteButton.click();
-    await handleConfirmationDialog(this.page, 'Podman AI Lab', true, 'Confirm');
+    await handleConfirmationDialog(this.page, podmanAILabExtension.extensionName, true, 'Confirm');
     return this;
   }
 
diff --git a/tests/playwright/src/model/ai-lab-running-apps-page.ts b/tests/playwright/src/model/ai-lab-running-apps-page.ts
@@ -19,7 +19,7 @@
 import { expect as playExpect } from '@playwright/test';
 import type { Locator, Page } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
-import { handleConfirmationDialog } from '@podman-desktop/tests-playwright';
+import { handleConfirmationDialog, podmanAILabExtension } from '@podman-desktop/tests-playwright';
 
 export class AiRunningAppsPage extends AILabBasePage {
   constructor(page: Page, webview: Page) {
@@ -66,7 +66,7 @@ export class AiRunningAppsPage extends AILabBasePage {
     await playExpect(deleteButton).toBeVisible();
     await deleteButton.click();
 
-    await handleConfirmationDialog(this.page, 'Podman AI Lab', true, 'Confirm');
+    await handleConfirmationDialog(this.page, podmanAILabExtension.extensionName, true, 'Confirm');
   }
 
   async appExists(appName: string): Promise<boolean> {
diff --git a/tests/playwright/src/model/ai-lab-service-details-page.ts b/tests/playwright/src/model/ai-lab-service-details-page.ts
@@ -20,7 +20,7 @@ import { expect as playExpect } from '@playwright/test';
 import type { Locator, Page } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
 import { AiModelServicePage } from './ai-lab-model-service-page';
-import { handleConfirmationDialog } from '@podman-desktop/tests-playwright';
+import { handleConfirmationDialog, podmanAILabExtension } from '@podman-desktop/tests-playwright';
 
 export class AILabServiceDetailsPage extends AILabBasePage {
   readonly endpointURL: Locator;
@@ -47,7 +47,7 @@ export class AILabServiceDetailsPage extends AILabBasePage {
   async deleteService(): Promise<AiModelServicePage> {
     await playExpect(this.deleteServiceButton).toBeEnabled();
     await this.deleteServiceButton.click();
-    await handleConfirmationDialog(this.page, 'Podman AI Lab', true, 'Confirm');
+    await handleConfirmationDialog(this.page, podmanAILabExtension.extensionName, true, 'Confirm');
     return new AiModelServicePage(this.page, this.webview);
   }
 
diff --git a/tests/playwright/src/model/ai-lab-start-recipe-page.ts b/tests/playwright/src/model/ai-lab-start-recipe-page.ts
@@ -19,7 +19,7 @@
 import { expect as playExpect } from '@playwright/test';
 import type { Locator, Page } from '@playwright/test';
 import { AILabBasePage } from './ai-lab-base-page';
-import { StatusBar, handleConfirmationDialog, waitUntil } from '@podman-desktop/tests-playwright';
+import { StatusBar, handleConfirmationDialog, podmanAILabExtension, waitUntil } from '@podman-desktop/tests-playwright';
 import { AILabNavigationBar } from './ai-lab-navigation-bar';
 
 export class AILabStartRecipePage extends AILabBasePage {
@@ -46,7 +46,7 @@ export class AILabStartRecipePage extends AILabBasePage {
     await playExpect(this.startRecipeButton).toBeEnabled();
     await this.startRecipeButton.click();
     try {
-      await handleConfirmationDialog(this.page, 'Podman AI Lab', true, 'Reset');
+      await handleConfirmationDialog(this.page, podmanAILabExtension.extensionName, true, 'Reset');
     } catch (error) {
       console.warn(`Warning: Could not reset the app, repository probably clean.\n\t${error}`);
     }
diff --git a/tests/playwright/src/model/podman-extension-ai-lab-details-page.ts b/tests/playwright/src/model/podman-extension-ai-lab-details-page.ts
@@ -16,11 +16,32 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
-import type { Page } from '@playwright/test';
-import { ExtensionDetailsPage } from '@podman-desktop/tests-playwright';
+import type { Locator, Page } from '@playwright/test';
+import { expect as playExpect, ExtensionDetailsPage } from '@podman-desktop/tests-playwright';
 
 export class AILabExtensionDetailsPage extends ExtensionDetailsPage {
+  readonly errorTab: Locator;
+
   constructor(page: Page) {
     super(page, 'Podman AI Lab extension');
+    this.errorTab = this.tabs.getByRole('button', { name: 'Error' });
+  }
+
+  async waitForLoad(): Promise<void> {
+    await playExpect(this.heading).toBeVisible();
+  }
+
+  async checkIsActive(statusTest: string): Promise<void> {
+    await playExpect(this.status).toHaveText(statusTest);
+  }
+
+  async checkForErrors(): Promise<void> {
+    // we would like to propagate the error's stack trace into test failure message
+    let stackTrace = '';
+    if ((await this.errorTab.count()) > 0) {
+      await this.activateTab('Error');
+      stackTrace = await this.errorStackTrace.innerText();
+    }
+    await playExpect(this.errorTab, `Error Tab was present with stackTrace: ${stackTrace}`).not.toBeVisible();
   }
 }
diff --git a/tests/playwright/src/model/preferences-extension-ai-lab-page.ts b/tests/playwright/src/model/preferences-extension-ai-lab-page.ts
diff --git a/tests/playwright/src/utils/aiLabHandler.ts b/tests/playwright/src/utils/aiLabHandler.ts
diff --git a/tests/playwright/src/utils/webviewHandler.ts b/tests/playwright/src/utils/webviewHandler.ts
