@bugzy-ai/bugzy 1.9.3 → 1.9.4

package/templates/playwright/BasePage.template.ts

@@ -1,190 +1,190 @@
-import { type Page, type Locator } from '@playwright/test';
-
-/**
- * Base Page Object Model
- * All page objects should extend this class
- *
- * Provides common functionality and patterns for page interactions
- */
-export class BasePage {
-  readonly page: Page;
-
-  constructor(page: Page) {
-    this.page = page;
-  }
-
-  /**
-   * Navigate to a specific path
-   * @param path - The path to navigate to (relative to baseURL)
-   */
-  async navigate(path: string): Promise<void> {
-    await this.page.goto(path);
-  }
-
-  /**
-   * Wait for the page to be fully loaded
-   */
-  async waitForPageLoad(): Promise<void> {
-    await this.page.waitForLoadState('networkidle');
-  }
-
-  /**
-   * Get the current URL
-   */
-  getCurrentURL(): string {
-    return this.page.url();
-  }
-
-  /**
-   * Get the page title
-   */
-  async getTitle(): Promise<string> {
-    return await this.page.title();
-  }
-
-  /**
-   * Wait for a locator to be visible
-   * @param locator - The locator to wait for
-   * @param timeout - Optional custom timeout
-   */
-  async waitForVisible(locator: Locator, timeout?: number): Promise<void> {
-    await locator.waitFor({ state: 'visible', timeout });
-  }
-
-  /**
-   * Wait for a locator to be hidden
-   * @param locator - The locator to wait for
-   * @param timeout - Optional custom timeout
-   */
-  async waitForHidden(locator: Locator, timeout?: number): Promise<void> {
-    await locator.waitFor({ state: 'hidden', timeout });
-  }
-
-  /**
-   * Click an element and wait for navigation
-   * @param locator - The element to click
-   */
-  async clickAndNavigate(locator: Locator): Promise<void> {
-    await Promise.all([
-      this.page.waitForNavigation(),
-      locator.click()
-    ]);
-  }
-
-  /**
-   * Fill a form field
-   * @param locator - The input field
-   * @param value - The value to fill
-   */
-  async fillField(locator: Locator, value: string): Promise<void> {
-    await locator.clear();
-    await locator.fill(value);
-  }
-
-  /**
-   * Select an option from a dropdown
-   * @param locator - The select element
-   * @param value - The value to select
-   */
-  async selectOption(locator: Locator, value: string): Promise<void> {
-    await locator.selectOption(value);
-  }
-
-  /**
-   * Check a checkbox
-   * @param locator - The checkbox element
-   */
-  async check(locator: Locator): Promise<void> {
-    if (!(await locator.isChecked())) {
-      await locator.check();
-    }
-  }
-
-  /**
-   * Uncheck a checkbox
-   * @param locator - The checkbox element
-   */
-  async uncheck(locator: Locator): Promise<void> {
-    if (await locator.isChecked()) {
-      await locator.uncheck();
-    }
-  }
-
-  /**
-   * Get text content from an element
-   * @param locator - The element to get text from
-   */
-  async getText(locator: Locator): Promise<string> {
-    return (await locator.textContent()) || '';
-  }
-
-  /**
-   * Check if element is visible
-   * @param locator - The element to check
-   */
-  async isVisible(locator: Locator): Promise<boolean> {
-    return await locator.isVisible();
-  }
-
-  /**
-   * Check if element is enabled
-   * @param locator - The element to check
-   */
-  async isEnabled(locator: Locator): Promise<boolean> {
-    return await locator.isEnabled();
-  }
-
-  /**
-   * Scroll element into view
-   * @param locator - The element to scroll to
-   */
-  async scrollIntoView(locator: Locator): Promise<void> {
-    await locator.scrollIntoViewIfNeeded();
-  }
-
-  /**
-   * Take a screenshot
-   * @param name - The screenshot file name
-   */
-  async takeScreenshot(name: string): Promise<void> {
-    await this.page.screenshot({ path: `screenshots/${name}.png`, fullPage: true });
-  }
-
-  /**
-   * Execute JavaScript in the browser context
-   * @param script - The script to execute
-   * @param args - Arguments to pass to the script
-   */
-  async executeScript<T>(script: string | Function, ...args: any[]): Promise<T> {
-    return await this.page.evaluate(script, ...args);
-  }
-
-  /**
-   * Wait for API response
-   * @param urlPattern - The URL pattern to wait for
-   */
-  async waitForResponse(urlPattern: string | RegExp): Promise<void> {
-    await this.page.waitForResponse(urlPattern);
-  }
-
-  /**
-   * Reload the current page
-   */
-  async reload(): Promise<void> {
-    await this.page.reload();
-  }
-
-  /**
-   * Go back in browser history
-   */
-  async goBack(): Promise<void> {
-    await this.page.goBack();
-  }
-
-  /**
-   * Go forward in browser history
-   */
-  async goForward(): Promise<void> {
-    await this.page.goForward();
-  }
-}
+import { type Page, type Locator } from '@playwright/test';
+
+/**
+ * Base Page Object Model
+ * All page objects should extend this class
+ *
+ * Provides common functionality and patterns for page interactions
+ */
+export class BasePage {
+  readonly page: Page;
+
+  constructor(page: Page) {
+    this.page = page;
+  }
+
+  /**
+   * Navigate to a specific path
+   * @param path - The path to navigate to (relative to baseURL)
+   */
+  async navigate(path: string): Promise<void> {
+    await this.page.goto(path);
+  }
+
+  /**
+   * Wait for the page to be fully loaded
+   */
+  async waitForPageLoad(): Promise<void> {
+    await this.page.waitForLoadState('networkidle');
+  }
+
+  /**
+   * Get the current URL
+   */
+  getCurrentURL(): string {
+    return this.page.url();
+  }
+
+  /**
+   * Get the page title
+   */
+  async getTitle(): Promise<string> {
+    return await this.page.title();
+  }
+
+  /**
+   * Wait for a locator to be visible
+   * @param locator - The locator to wait for
+   * @param timeout - Optional custom timeout
+   */
+  async waitForVisible(locator: Locator, timeout?: number): Promise<void> {
+    await locator.waitFor({ state: 'visible', timeout });
+  }
+
+  /**
+   * Wait for a locator to be hidden
+   * @param locator - The locator to wait for
+   * @param timeout - Optional custom timeout
+   */
+  async waitForHidden(locator: Locator, timeout?: number): Promise<void> {
+    await locator.waitFor({ state: 'hidden', timeout });
+  }
+
+  /**
+   * Click an element and wait for navigation
+   * @param locator - The element to click
+   */
+  async clickAndNavigate(locator: Locator): Promise<void> {
+    await Promise.all([
+      this.page.waitForNavigation(),
+      locator.click()
+    ]);
+  }
+
+  /**
+   * Fill a form field
+   * @param locator - The input field
+   * @param value - The value to fill
+   */
+  async fillField(locator: Locator, value: string): Promise<void> {
+    await locator.clear();
+    await locator.fill(value);
+  }
+
+  /**
+   * Select an option from a dropdown
+   * @param locator - The select element
+   * @param value - The value to select
+   */
+  async selectOption(locator: Locator, value: string): Promise<void> {
+    await locator.selectOption(value);
+  }
+
+  /**
+   * Check a checkbox
+   * @param locator - The checkbox element
+   */
+  async check(locator: Locator): Promise<void> {
+    if (!(await locator.isChecked())) {
+      await locator.check();
+    }
+  }
+
+  /**
+   * Uncheck a checkbox
+   * @param locator - The checkbox element
+   */
+  async uncheck(locator: Locator): Promise<void> {
+    if (await locator.isChecked()) {
+      await locator.uncheck();
+    }
+  }
+
+  /**
+   * Get text content from an element
+   * @param locator - The element to get text from
+   */
+  async getText(locator: Locator): Promise<string> {
+    return (await locator.textContent()) || '';
+  }
+
+  /**
+   * Check if element is visible
+   * @param locator - The element to check
+   */
+  async isVisible(locator: Locator): Promise<boolean> {
+    return await locator.isVisible();
+  }
+
+  /**
+   * Check if element is enabled
+   * @param locator - The element to check
+   */
+  async isEnabled(locator: Locator): Promise<boolean> {
+    return await locator.isEnabled();
+  }
+
+  /**
+   * Scroll element into view
+   * @param locator - The element to scroll to
+   */
+  async scrollIntoView(locator: Locator): Promise<void> {
+    await locator.scrollIntoViewIfNeeded();
+  }
+
+  /**
+   * Take a screenshot
+   * @param name - The screenshot file name
+   */
+  async takeScreenshot(name: string): Promise<void> {
+    await this.page.screenshot({ path: `screenshots/${name}.png`, fullPage: true });
+  }
+
+  /**
+   * Execute JavaScript in the browser context
+   * @param script - The script to execute
+   * @param args - Arguments to pass to the script
+   */
+  async executeScript<T>(script: string | Function, ...args: any[]): Promise<T> {
+    return await this.page.evaluate(script, ...args);
+  }
+
+  /**
+   * Wait for API response
+   * @param urlPattern - The URL pattern to wait for
+   */
+  async waitForResponse(urlPattern: string | RegExp): Promise<void> {
+    await this.page.waitForResponse(urlPattern);
+  }
+
+  /**
+   * Reload the current page
+   */
+  async reload(): Promise<void> {
+    await this.page.reload();
+  }
+
+  /**
+   * Go back in browser history
+   */
+  async goBack(): Promise<void> {
+    await this.page.goBack();
+  }
+
+  /**
+   * Go forward in browser history
+   */
+  async goForward(): Promise<void> {
+    await this.page.goForward();
+  }
+}

package/templates/playwright/auth.setup.template.ts

@@ -1,89 +1,89 @@
-import { test as setup, expect } from '@playwright/test';
-import path from 'path';
-import { mkdir } from 'fs/promises';
-
-/**
- * Authentication Setup
- * Generated by Bugzy - https://github.com/bugzy-ai/bugzy
- *
- * This file runs before all tests to authenticate and save the state
- * Other tests can reuse this authenticated state for faster execution
- *
- * Benefits:
- * - Login once, reuse for all tests
- * - Faster test execution
- * - More stable tests (no repeated login operations)
- */
-
-const authFile = path.join(__dirname, '../.auth/user.json');
-
-setup('authenticate', async ({ page }) => {
-  // Skip if no authentication is needed
-  // Remove this if you need authentication
-  if (!process.env.TEST_USER_EMAIL || !process.env.TEST_USER_PASSWORD) {
-    console.log('Skipping authentication setup - no credentials provided');
-    return;
-  }
-
-  // Navigate to login page
-  // Adjust the URL based on your application
-  await page.goto('/login');
-
-  // Perform authentication steps
-  // Using role-based selectors for stability
-
-  // Fill in email
-  await page.getByLabel('Email').fill(process.env.TEST_USER_EMAIL);
-
-  // Fill in password
-  await page.getByLabel('Password').fill(process.env.TEST_USER_PASSWORD);
-
-  // Click the sign in button
-  // Adjust the button text based on your app
-  await page.getByRole('button', { name: /sign in|login/i }).click();
-
-  // Wait for redirect after successful login
-  // Adjust the URL pattern based on where users land after login
-  await page.waitForURL(/.*\/(dashboard|home)/);
-
-  // Verify authentication was successful
-  // Check for a user-specific element (e.g., user menu, profile icon)
-  // Adjust based on your application
-  // await expect(page.getByRole('button', { name: /profile|account/i })).toBeVisible();
-
-  // Create .auth directory if it doesn't exist
-  await mkdir(path.dirname(authFile), { recursive: true });
-
-  // Save authentication state to file
-  await page.context().storageState({ path: authFile });
-
-  console.log('✓ Authentication state saved successfully');
-});
-
-/**
- * Example: Multiple User Roles
- *
- * If you need to test with different user roles (admin, user, etc.),
- * create separate setup files:
- *
- * - auth.setup.admin.ts
- * - auth.setup.user.ts
- * - auth.setup.guest.ts
- *
- * Then configure them in playwright.config.ts:
- *
- * projects: [
- *   { name: 'setup-admin', testMatch: /.*\.setup\.admin\.ts/ },
- *   { name: 'setup-user', testMatch: /.*\.setup\.user\.ts/ },
- *   {
- *     name: 'admin-tests',
- *     use: { storageState: 'tests/.auth/admin.json' },
- *     dependencies: ['setup-admin'],
- *   },
- *   {
- *     name: 'user-tests',
- *     use: { storageState: 'tests/.auth/user.json' },
- *     dependencies: ['setup-user'],
- *   },
- * ]
- */
+import { test as setup, expect } from '@playwright/test';
+import path from 'path';
+import { mkdir } from 'fs/promises';
+
+/**
+ * Authentication Setup
+ * Generated by Bugzy - https://github.com/bugzy-ai/bugzy
+ *
+ * This file runs before all tests to authenticate and save the state
+ * Other tests can reuse this authenticated state for faster execution
+ *
+ * Benefits:
+ * - Login once, reuse for all tests
+ * - Faster test execution
+ * - More stable tests (no repeated login operations)
+ */
+
+const authFile = path.join(__dirname, '../.auth/user.json');
+
+setup('authenticate', async ({ page }) => {
+  // Skip if no authentication is needed
+  // Remove this if you need authentication
+  if (!process.env.TEST_USER_EMAIL || !process.env.TEST_USER_PASSWORD) {
+    console.log('Skipping authentication setup - no credentials provided');
+    return;
+  }
+
+  // Navigate to login page
+  // Adjust the URL based on your application
+  await page.goto('/login');
+
+  // Perform authentication steps
+  // Using role-based selectors for stability
+
+  // Fill in email
+  await page.getByLabel('Email').fill(process.env.TEST_USER_EMAIL);
+
+  // Fill in password
+  await page.getByLabel('Password').fill(process.env.TEST_USER_PASSWORD);
+
+  // Click the sign in button
+  // Adjust the button text based on your app
+  await page.getByRole('button', { name: /sign in|login/i }).click();
+
+  // Wait for redirect after successful login
+  // Adjust the URL pattern based on where users land after login
+  await page.waitForURL(/.*\/(dashboard|home)/);
+
+  // Verify authentication was successful
+  // Check for a user-specific element (e.g., user menu, profile icon)
+  // Adjust based on your application
+  // await expect(page.getByRole('button', { name: /profile|account/i })).toBeVisible();
+
+  // Create .auth directory if it doesn't exist
+  await mkdir(path.dirname(authFile), { recursive: true });
+
+  // Save authentication state to file
+  await page.context().storageState({ path: authFile });
+
+  console.log('✓ Authentication state saved successfully');
+});
+
+/**
+ * Example: Multiple User Roles
+ *
+ * If you need to test with different user roles (admin, user, etc.),
+ * create separate setup files:
+ *
+ * - auth.setup.admin.ts
+ * - auth.setup.user.ts
+ * - auth.setup.guest.ts
+ *
+ * Then configure them in playwright.config.ts:
+ *
+ * projects: [
+ *   { name: 'setup-admin', testMatch: /.*\.setup\.admin\.ts/ },
+ *   { name: 'setup-user', testMatch: /.*\.setup\.user\.ts/ },
+ *   {
+ *     name: 'admin-tests',
+ *     use: { storageState: 'tests/.auth/admin.json' },
+ *     dependencies: ['setup-admin'],
+ *   },
+ *   {
+ *     name: 'user-tests',
+ *     use: { storageState: 'tests/.auth/user.json' },
+ *     dependencies: ['setup-user'],
+ *   },
+ * ]
+ */