メインコンテンツにスキップ

ページオブジェクトモデル

はじめに​

大規模なテストスイートは、作成とメンテナンスの容易さを最適化するために構造化できます。ページオブジェクトモデルは、テストスイートを構造化するためのそのようなアプローチの1つです。

ページオブジェクトは、ウェブアプリケーションの一部を表します。Eコマースのウェブアプリケーションには、ホームページ、商品一覧ページ、チェックアウトページがあるかもしれません。それらのそれぞれは、ページオブジェクトモデルによって表すことができます。

ページオブジェクトは、アプリケーションに適した高レベルのAPIを作成することで、作成を簡素化し、要素セレクターを一箇所にまとめることで、反復を避けるための再利用可能なコードを作成することで、メンテナンスを簡素化します。

実装​

私たちは、playwright.dev ページでの共通操作をカプセル化するために、PlaywrightDevPage ヘルパークラスを作成します。内部的には、page オブジェクトを使用します。

playwright-dev-page.ts
import { expect, type Locator, type Page } from '@playwright/test';

export class PlaywrightDevPage {
  readonly page: Page;
  readonly getStartedLink: Locator;
  readonly gettingStartedHeader: Locator;
  readonly pomLink: Locator;
  readonly tocList: Locator;

  constructor(page: Page) {
    this.page = page;
    this.getStartedLink = page.locator('a', { hasText: 'Get started' });
    this.gettingStartedHeader = page.locator('h1', { hasText: 'Installation' });
    this.pomLink = page.locator('li', {
      hasText: 'Guides',
    }).locator('a', {
      hasText: 'Page Object Model',
    });
    this.tocList = page.locator('article div.markdown ul > li > a');
  }

  async goto() {
    await this.page.goto('https://playwright.dokyumento.jp');
  }

  async getStarted() {
    await this.getStartedLink.first().click();
    await expect(this.gettingStartedHeader).toBeVisible();
  }

  async pageObjectModel() {
    await this.getStarted();
    await this.pomLink.click();
  }
}

これで、テストでPlaywrightDevPageクラスを使用できます。

example.spec.ts
import { test, expect } from '@playwright/test';
import { PlaywrightDevPage } from './playwright-dev-page';

test('getting started should contain table of contents', async ({ page }) => {
  const playwrightDev = new PlaywrightDevPage(page);
  await playwrightDev.goto();
  await playwrightDev.getStarted();
  await expect(playwrightDev.tocList).toHaveText([
    `How to install Playwright`,
    `What's Installed`,
    `How to run the example test`,
    `How to open the HTML test report`,
    `Write tests using web first assertions, page fixtures and locators`,
    `Run single test, multiple tests, headed mode`,
    `Generate tests with Codegen`,
    `See a trace of your tests`
  ]);
});

test('should show Page Object Model article', async ({ page }) => {
  const playwrightDev = new PlaywrightDevPage(page);
  await playwrightDev.goto();
  await playwrightDev.pageObjectModel();
  await expect(page.locator('article')).toContainText('Page Object Model is a common pattern');
});