The Project | About Us | Contribute | Donations | License
HOME My courses Completed
◄ Previous
◄

Using Fixtures and Hooks

Next ►
►

In this section, we will explore how to use fixtures and hooks in Playwright to enhance your test automation strategies. Fixtures and hooks are powerful tools that help manage test setup and teardown, ensuring your tests are efficient, maintainable, and reliable.

Key Concepts

  1. Fixtures:

    • Fixtures are reusable pieces of code that set up the environment for your tests. They can be used to initialize variables, set up databases, or configure the test environment.
    • Playwright provides built-in fixtures, but you can also create custom fixtures to suit your specific needs.

  2. Hooks:

    • Hooks are functions that run at specific points in the test lifecycle. They allow you to execute code before or after tests or test suites.
    • Common hooks include beforeAll, afterAll, beforeEach, and afterEach.

Using Fixtures

Built-in Fixtures

Playwright comes with several built-in fixtures that simplify common tasks. For example, the page fixture provides a new browser page for each test.

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

test('example test using page fixture', async ({ page }) => {
  await page.goto('https://example.com');
  const title = await page.title();
  expect(title).toBe('Example Domain');
});

Custom Fixtures

You can define custom fixtures to share setup code across tests. Here's how you can create a custom fixture:

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

type MyFixtures = {
  customData: string;
};

const test = base.extend<MyFixtures>({
  customData: async ({}, use) => {
    const data = 'Hello, Playwright!';
    await use(data);
  },
});

test('example test using custom fixture', async ({ customData }) => {
  console.log(customData); // Output: Hello, Playwright!
});

Using Hooks

Common Hooks

  • beforeAll: Runs once before all tests in a suite.
  • afterAll: Runs once after all tests in a suite.
  • beforeEach: Runs before each test in a suite.
  • afterEach: Runs after each test in a suite.

Example of Hooks

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

test.beforeAll(async () => {
  console.log('Setting up before all tests');
});

test.afterAll(async () => {
  console.log('Cleaning up after all tests');
});

test.beforeEach(async () => {
  console.log('Setting up before each test');
});

test.afterEach(async () => {
  console.log('Cleaning up after each test');
});

test('example test with hooks', async ({ page }) => {
  await page.goto('https://example.com');
  const title = await page.title();
  expect(title).toBe('Example Domain');
});

Practical Exercise

Exercise: Create a test suite using Playwright where you:

  • Use a custom fixture to provide a base URL for your tests.
  • Implement hooks to log messages before and after each test.

Solution:

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

type MyFixtures = {
  baseUrl: string;
};

const test = base.extend<MyFixtures>({
  baseUrl: async ({}, use) => {
    const url = 'https://example.com';
    await use(url);
  },
});

test.beforeEach(async () => {
  console.log('Starting a new test');
});

test.afterEach(async () => {
  console.log('Test completed');
});

test('test with custom fixture and hooks', async ({ page, baseUrl }) => {
  await page.goto(baseUrl);
  const title = await page.title();
  expect(title).toBe('Example Domain');
});

Common Mistakes and Tips

  • Mistake: Forgetting to call await use(data) in custom fixtures.

    • Tip: Always ensure you call await use(data) to pass the fixture data to the test.

  • Mistake: Overusing hooks, leading to complex and hard-to-maintain tests.

    • Tip: Use hooks judiciously to keep your tests simple and maintainable.

Conclusion

In this section, you learned how to use fixtures and hooks in Playwright to manage test setup and teardown efficiently. By leveraging these tools, you can create more organized and maintainable test suites. In the next section, we will explore parallel test execution to further optimize your testing strategy.

◄ Previous
◄
Next ►
►
The Project | About Us | Contribute | Donations | License
© Copyright 2024. All rights reserved