README

Magic Test allows you to write browser tests by simply clicking around on the application being tested, all without the slowness of constantly restarting the testing environment.
It inverts the test-writing experience and avoids all the back and forth between tests, your terminal and your template files. See it in action here.
The easiest way to explain Magic Test is through a video. Check it out here.

Magic Test was originally created by Andrew Culver and Adam Pallozi for Ruby on Rails.
Laravel Magic Test was created by Mateus Guimarães.

Magic Test is still in early development, and that includes the documentation. Any questions you have that aren't already address in the documentation should be opened as issues so they can be appropriately addressed in the documentation.

⚠️ If you are using Windows/Laragon: This package won't work with Windows/Laragon, since this doesn't support TTY. This package DOES work with WSL.

Installation

You can install the package via composer:

composer require magic-test/magic-test-laravel --dev

Usage

On your Laravel Dusk tests, simply add magic() at the end of your method chain. For example:

    public function testBasicExample()
    {
        $this->browse(function (Browser $browser) {
            $browser->visit('/')
                    ->magic();
        });
    }

To run Magic Test, you must simply run the command php artisan magic. Behind the scenes, it is the same as running php artisan dusk, but it will maintain the browser window open.

This will leave you with two or three windows:

The browser
An interactive Shell
Your text editor if you had it open

For the Magic Experience™️, we suggest you organize the three windows to fit your screen. That way, you can see tests being generated in real-time.

Recording Actions

Once the browser is open, Magic Test will already be capturing all of your actions. You can click around, fill inputs, checkboxes, selects and radios just like you would do manually testing an application.

Generating Assertions

Additionally, you can generate text assertions by selecting a given text and then pressing ControlShift + A. You'll see a dialog box confirming the assertion has been recorded.

Saving the new actions to the test file

To save the actions that were recorded, simply go to the Shell and type ok. You are free to close it and come back to your Magic Sessiona any time, or just keep recording more actions.
If you're satisfied with your test, you can type finish on the Shell and it'll remove the magic() call from your test, leaving you with a clean, working test.

See how it works on this video

Magic Test is still in it's early days, so you might find that the output is not exactly what you wanted. In that case, feel free to submit an issue and we'll try to improve it ASAP.

Known issues

Magic Test does not work well with Inertia.js assertions. If you're using Inertia in an integration test, please disable Magic Test by add the following code to your setUp method:

<?php

use MagicTest\MagicTest\MagicTest;

class MyTest extends TestCase
{
    protected function setUp(): void
    {
        parent::setUp();
        
        MagicTest::disable();
    }
}

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

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

Credits

License

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

magic-test / magic-test-laravel

Maintainers

Details