README.md

Playwright Basic Demo

A basic demo of Playwright Framework and Microsoft Playwright Testing.

Setup/Prerequisites - Playwright Framework

Install dependencies for Playwright Framework on your local machine:

npm install -D @playwright/test
npx playwright install
npx playwright install-deps

First time setup of a new project (not needed for this project as it has already been setup):

mkdir playwright-basic-demo
cd playwright-basic-demo
npm init playwright@latest

cp basic-demo/tests-examples/demo-todo-app.spec.ts tests

After cloning this project from GitHub, install the npm packages:

npm install

Setup/Prerequisites - Playwright Testing Service

• Setup a Playwright Testing workspace

  • See: Quickstart: Run end-to-end tests at scale with Microsoft Playwright Testing Preview

• Create a .env file in the root of the project

  • See: Set up your environment

• Create a playwright.config.ts file in the root of the project

  • See: Add a service configuration file

Demo Script

Quick walkthrough of the Playwright Framework docs

• Playwright Docs - Getting Started / Installation

Running tests locally

Examine the playwright config file: basic-demo\playwright.config.ts

Examine a basic test file: basic-demo\tests\example.spec.ts

Run tests:

# Run specific test file with 3 workers, using all profiles (chromium, firefox, webkit)
npx playwright test example.spec.ts --workers=3

npx playwright show-report

Examine a more detailed test file: demo-todo-app.spec.ts

Run tests:

# Run specific test file with 5 workers, using the chromium profile
npx playwright test demo-todo-app.spec.ts --workers=5 --project=chromium

# Run specific test file with 1 worker, using the chromium profile and headed mode
npx playwright test demo-todo-app.spec.ts:72 --workers=1 --project=chromium --headed

npx playwright show-report

Run API tests:

$env:GITHUB_USER="your_githubuser"
# Create a PAT token with repo and issues read/write permissions
$env:API_TOKEN="github_pat_xxxxxxxxxxxxxxxxxxxxxxxxxx"

# Uncomment the setup ad/or teardown functions as required (e.g. to create thr github repo and delete it after the tests are run)
npx playwright test github-api.spec.ts --workers=1

Interactive Mode

npx playwright test demo-todo-app.spec.ts --project=webkit --ui

• Run the tests
• Examine the timeline
• Examine the test the test cases and individual steps
• Use the Locator to find selectors
• Use watch mode on a single test
• Create a failing test and debug it

Run tests using the Playwright Testing service

Navigate to Playwright Testing in the Azure Portal:

• Open the Playwright Testing workspace - https://playwright.microsoft.com/
• Quick walkthrough of the workspace and configuring the access token and playwright.config.ts

Run parallel tests across multiple remote browsers:

# Run specific test file with 50 workers, all profiles,
# using the Playwright service configuration
npx playwright test demo-todo-app.spec.ts --workers=50 --config=playwright.service.config.ts

# ==> Running 72 tests using 50 workers

Interactive Mode (using Playwright Inspector)

npx playwright test demo-todo-app.spec.ts --project=chromium --ui

• Run the tests
• Examine the timeline
• Examine the test cases and individual steps
• Use the Locator to find selectors
• Use watch mode on a single test
• Create a failing test and debug/fix it

VSCode Integration / GitHub Copilot

Test Explorer:

• Show Test Explorer (click "Testing" icon in the Activity Bar or select "View" / "Testing" from the menu)
• Click "Show Browser"
• Run the "demo-todo-app.spec.ts" test file from Test Explorer
• Show Trace Viewer (from WSL2, change browser URL address from 0.0.0.0 to localhost)
  • Make a test fail, suggest using Counter or Item Marked Completed
  • Show in the tracer viewer: Action / Before / After
• Pick Locator

Record a new test and use Copilot to help write the test:

• Browse to https://demo.playwright.dev/todomvc/#/
• Click "What needs to be done?"
• Type "Buy milk" and press Enter
• Click "Assert text" from the testing toolbar
• Select the item count label
• Enter "1 item" and click the check mark to accept
• Click "What needs to be done?"
• Type "Buy bread" and press Enter
• Click "Assert text" from the testing toolbar
• Select the item count label
• Enter "2 items" and click the check mark to accept
• End the test recording by clicking the record circle

You should get code similar to the following:

import { test, expect } from '@playwright/test';

test('test', async ({ page }) => {
  await page.goto('https://demo.playwright.dev/todomvc/#/');
  await page.getByPlaceholder('What needs to be done?').click();
  await page.getByPlaceholder('What needs to be done?').fill('Buy milk');
  await page.getByPlaceholder('What needs to be done?').press('Enter');
  await expect(page.locator('body')).toContainText('1 item');
  await page.getByPlaceholder('What needs to be done?').click();
  await page.getByPlaceholder('What needs to be done?').fill('Buy bread');
  await page.getByPlaceholder('What needs to be done?').press('Enter');
  await expect(page.locator('body')).toContainText('2 items');
});

Select the code and choose Copilot / Start Inline Chat:

"refactor to reduce repetition"

import { test, expect } from '@playwright/test';

test('test', async ({ page }) => {
  const inputField = page.getByPlaceholder('What needs to be done?');

  await page.goto('https://demo.playwright.dev/todomvc/#/');

  await inputField.click();
  await inputField.fill('Buy milk');
  await inputField.press('Enter');
  await expect(page.getByTestId('todo-count')).toContainText('1 item');
  await inputField.click();
  await inputField.fill('Buy bread');
  await inputField.press('Enter');
  await expect(page.getByTestId('todo-count')).toContainText('2 items');
});

Select the inner test the code, start a Copilot inline chat:

"Add a Page Object Model to represent this page."

import { test, expect, Page } from '@playwright/test';

class TodoPage {
  private page: Page;

  constructor(page: Page) {
    this.page = page;
  }

  async addTodoItem(item: string) {
    const inputField = await this.page.getByPlaceholder('What needs to be done?');
    await inputField.click();
    await inputField.fill(item);
    await inputField.press('Enter');
  }

  async getTodoItemCount() {
    const todoCount = await this.page.getByTestId('todo-count');
    return await todoCount.textContent();
  }

  async navigateTo() {
    await this.page.goto('https://demo.playwright.dev/todomvc/#/');
  }
}

test('test', async ({ page }) => {
  const todoPage = new TodoPage(page);

  await todoPage.navigateTo();

  await todoPage.addTodoItem('Buy milk');
  await expect(await todoPage.getTodoItemCount()).toContain('1 item');

  await todoPage.addTodoItem('Buy bread');
  await expect(await todoPage.getTodoItemCount()).toContain('2 items');
});

Select all the code in the file:

"Refactor getTodoCount to take an integer which is the todo count. Assert the todo count matches the passed in value."

import { test, expect } from '@playwright/test';

class TodoPage {
  private page: any;

  constructor(page: any) {
    this.page = page;
  }

  async navigateTo() {
    await this.page.goto('https://demo.playwright.dev/todomvc/#/');
  }

  async addTodoItem(item: string) {
    const inputField = await this.page.getByPlaceholder('What needs to be done?');
    await inputField.click();
    await inputField.fill(item);
    await inputField.press('Enter');
  }

  async markAllAsComplete() {
    await this.page.getByText('Mark all as complete').click();
  }

  async assertTodoItemCount(count: number) {
    const bodyLocator = await this.page.getByTestId('todo-count');
    const bodyText = await bodyLocator.textContent();
    const itemCount = parseInt(bodyText.split(' ')[0]);
    expect(itemCount).toBe(count);
  }
}

test('test', async ({ page }) => {
  const todoPage = new TodoPage(page);
  await todoPage.navigateTo();

  await todoPage.addTodoItem('Buy Milk');
  await todoPage.assertTodoItemCount(1);

  await todoPage.addTodoItem('Buy Bread');
  await todoPage.assertTodoItemCount(2);

  await todoPage.markAllAsComplete();
  await todoPage.assertTodoItemCount(0);
});

Visual Comparisons

When running locally, visual comparisons are ignored (as set in the playwright.config.ts file):

npx playwright test demo-todo-app.spec.ts:259 --workers=1 --project=firefox --update-snapshots
npx playwright test demo-todo-app.spec.ts:259 --workers=1 --project=chromium

When running on the Playwright Testing service, visual comparisons are enabled (as set in the playwright.service.config.ts file)::

# Edit `playwright.config.ts` to enable visual comparisons (ignoreSnapshots: false)
npx playwright test demo-todo-app.spec.ts:259 --config=playwright.service.config.ts --project=firefox --update-snapshots

# This should fail as it's a different browser and it has a different rendering engine (can also use Windows instead of Linux)
npx playwright test demo-todo-app.spec.ts:259 --config=playwright.service.config.ts --project=webskit

# Reset `playwright.config.ts` to disable visual comparisons (ignoreSnapshots: true)

Run tests on CI (GitHub Actions)

Setup: one-off setup for the workflow

• Generate an access token in the Playwright Testing workspace
• Store the access token in a GitHub repository secret with the name PLAYWRIGHT_SERVICE_ACCESS_TOKEN
• Fetch the Playwright Service URL for your workspace
• Store the Playwright Service URL in a GitHub repository secret with the name PLAYWRIGHT_SERVICE_URL
• Check that playwright.service.config.ts is committed to the repository, check the sample one in the docs or download it from your Playwright Testing workspace under the section "Add Playwright Service Configuration"
• Update the GitHub Actions workflow file to run the tests on CI based on this sample

Enable workflow: one-off setup for the workflow

• Ensure the workflow Playwright Tests is enabled in the GitHub Actions tab of the repository
• Make any necessary changes to the workflow file (.github/workflows/playwright.yml) and commit them to the repository

View the playwright report and traces

• Navigate to the Playwright Tests workflow run
• Select the most recent workflow run click the acceptance-tests job to see the logs
• Go back to the Summary
• In the Artifacts section, download the report and traces contained in the playwright-report aritfact ZIP file
• Unzip the directory playwright-report
• From the command-line, run the playwright report viewer:

cd ~/Downloads/
rm -rf ./playwright-report ./playwright-report.zip
unzip playwright-report.zip -d playwright-report

npx playwright show-report playwright-report
# Serving HTML report at http://localhost:9323. Press Ctrl+C to quit.

Navigate to the URL http://localhost:9323 in your browser to view the report.

Commit a failing tests and view report with traces

• Open the file demo-todo-app.spec.ts, change these tests to fail:

Line 64: await expect(todoCount).toHaveText(/2/); Line 145: await expect(firstTodo).toHaveClass('complete'); Line 146: await expect(secondTodo).toHaveClass('complete');

• Also, change the PLAYWRIGHT_SERVICE_OS in GitHub Actions to windows and save before committing and pushing the changes to the repository
• Commit and push the changes to the repository - the tests should fail
• Download the playright-report artifact from the workflow run
• View only failing tests and traces in the report

Fix the failing test and view report

• Revert the changes made above.
• The tests should pass.
• Show the caches for all workflows as well and explain that this can save time on subsequent runs.

Resources

• Playwright Docs - Getting Started / Installation
• Visual Comparisons