README

This package introduces the php artisan pest:record command which provides an interactive way to generate a base for your Pest Browsertests.

Running this command allows you to perform actions in the browser which will be translated into Pest tests. This process works by using the npx playwirght codegen command. You can use the Codegen toolbar to add assertions:

By default, a development server (php artisan serve) will be started, this can be disabled with the --server=false flag.

After closing the browser you'll be prompted with a question if you want to expand an existing test file or create a new one, and to give your new test a name:

Installation

You can install the package via composer:

composer require tranquil-tools/laravel-pest-recorder --dev

You can publish the config file with:

php artisan vendor:publish --tag="laravel-pest-recorder-config"

The content of the published config can be viewed here.

Usage

php artisan pest:record

or:

php artisan pest:record
    --env=testing
    --url=http://localhost:8001
    --visit=/login
    --acting-as=user
    --server=true
    --migrate-fresh=false
    --seed=false
    --viewport-size=fullscreen

Available flags / options

The environment variable, obliged when using --migrate-fresh=true

--env=testing

Provide a URL which will be opened in the browser as starting point for your tests. When omitted, your .env APP_URL setting will be used.

--url=http://localhost:8001

Open a specific URI path when the recording browser starts. The path is appended to the base URL. The initial navigation will automatically generate $page = visit('/...'); in the test.

--visit=/login

Record and store Playwright browser auth state under a named key (e.g. user). The state is saved to storage/app/tmp/auth/{name}.json (configurable via acting_as_storage_path in the config).

First run (no file yet): you will be prompted to record a login sequence. A browser opens at acting_as_login_path (default /login); log in and close it — the browser storage state is saved.
Subsequent runs (file exists): the saved state is loaded automatically, so the browser starts pre-authenticated, and you can skip straight to recording the feature you want to test.
Generated test: $this->actingAs(\App\Models\User::factory()->create()); is prepended to the it() block. Authentication during the actual test run is handled by Laravel's actingAs(), not by replaying browser login steps.

it('test name', function () {
    $this->actingAs(\App\Models\User::factory()->create());

    $page = visit('/dashboard');
    $page->assertSee('...');
});

--acting-as=user

Start a development server (php artisan serve) for the given environment, URL and port.

--server=true

Run php artisan migrate:fresh before starting the server? Specifying --env=... is mandatory.

--migrate-fresh=false

Seed the database after migrate:fresh? This option is only available when using --migrate-fresh=true.

--seed=false

Set the viewport dimensions, or use fullscreen (the default) to detect the primary screen resolution. Detected via system_profiler (macOS), xdpyinfo/xrandr (Linux), or PowerShell (Windows). Falls back to 1920,1080 if detection fails. Ignored when --device is set.

--viewport-size=fullscreen  (default)
--viewport-size=1280,720

Emulate a specific device, including its viewport, user agent and touch settings. Overrides --viewport-size. Run npx playwright codegen --help for the full list of supported device names.

--device="iPhone 15"
--device="Pixel 7"

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Pull requests are welcome!

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

ComfyCoders BV - https://comfycoders.nl

License

The MIT License (MIT). Please see License File for more information.

tranquil-tools / laravel-pest-recorder

Maintainers

Package info

Statistics

Security