playwright-cleanup

This plugin for Playwright helps simplify test cleanup. It does so by providing a systematic way to mark entities for deletion immediately after creation. This is particularly useful when tests involve creating complex structures, such as a bank account with an investment plan and a deposit. Without proper cleanup, attempting to delete the account may result in errors, such as a refusal due to the account not being empty. However, with playwright-cleanup, entities are deleted in the correct order, ensuring that tests clean up after themselves and do not interfere with each other. Read more here.

Installation

The easiest way to install this module as a (dev-)dependency is by using the following command:

npm install playwright-cleanup --save-dev

Major Update: Version 2.x.x

❗❗❗Breaking Changes❗❗❗

This release includes significant changes that may affect your existing implementations. Please read the following instructions carefully to ensure a smooth transition.

Import and Extending Playwright Test

We have simplified the way you import and extend the Playwright test in this version. Make sure to follow these new instructions to properly set up your tests.

Usage

Import the runtime module in your test file as follows:

import extendPlaywrightCleanup from "playwright-cleanup";

For TypeScript, add the fixture and option types separately:

import type { PlaywrightCleanup, CleanupOptions } from "playwright-cleanup";

For JavaScript, you can skip the type import entirely.

Usage in test

To use playwright-cleanup, extend your Playwright test object with the cleanup fixture. This adds the cleanup helper to your tests with no extra setup.

// test.ts
import base from "@playwright/test";
import extendPlaywrightCleanup from "playwright-cleanup";
import type { PlaywrightCleanup, CleanupOptions } from "playwright-cleanup";

const test = base.extend<CleanupOptions & PlaywrightCleanup>(extendPlaywrightCleanup());

For JavaScript, the same setup works without the type import:

// test.js
import base from "@playwright/test";
import extendPlaywrightCleanup from "playwright-cleanup";

const test = base.extend(extendPlaywrightCleanup());

Example usage:

test("should keep things tidy", async ({ page, cleanup}) => {
            // ...

            const accountId = createAccount("John Blow");
            
            cleanup.addCleanup(async () => await deleteAccount(accountId)); // TODO: here we mark it for deletion * 

            addInvestmentPlan(accountId, "ModRisk");

            cleanup.addCleanup(async () => await removeInvestmentPlan(accountId));
            
            deposit(accountId, 1000000);

            cleanup.addCleanup(async () => await removeDeposit(accountId));

            //...
        });

        // * Please note that the actual execution of the cleanup code occurs after test completion.
        // * Execution order: removeDeposit(accountId) -> removeInvestmentPlan(accountId) -> deleteAccount(accountId).

That's all there is to it! The cleanup functionality will now be automatically included in your tests.

• The recommended approach is to place the extended test object in its own shared module (e.g., a dedicated setup or fixtures file), allowing all test files to import and use the same extended configuration.

Options

suppressLogging

By default, the plugin writes detailed logging to the terminal. To suppress these logs, set the suppressLogging option to true and pass the option object as a parameter to extendPlaywrightCleanup:

import type { CleanupOptions, PlaywrightCleanup } from "playwright-cleanup";

const options: CleanupOptions = {
  suppressLogging: true,
};

const test = base.extend<CleanupOptions & PlaywrightCleanup>(extendPlaywrightCleanup(options));

Typescript support

Typescript is supported for this plugin.

Support

For any questions or suggestions contact me at: [email protected]

📬 Maintained by Tzur Paldi — explore my GitHub profile for more tools.