tonysm/laravel-paratest

Run your Laravel feature tests in parallel without race conditions.

0.0.2 2020-12-23 03:40 UTC

This package is auto-updated.

Last update: 2021-11-23 05:35:41 UTC


README

Latest Version on Packagist Build Status Quality Score Total Downloads

This package ships with some helper Artisan commands and testing traits to allow you running your Feature Tests in parallel using Paratest against a MySQL or PostgreSQL database without conflicts.

The package will create 1 database for each testing process you have running to avoid race conditions when your Feature Test try to run a test creating some fixtures while another test in a another process runs the artisan migrate:fresh.

You also don't have to worry about creating the test databases. They will be created when you run your tests. There's is even a helper runner to clean up the test databases afterwards.

Installation

You can install the package via composer:

composer require tonysm/laravel-paratest --dev

Usage

Attention: You will need a user with rights to create databases.

Instead of using Laravel's RefreshDatabase trait, use the package one:

<?php

use Tonysm\LaravelParatest\Testing\RefreshDatabase;

class MyTest extends TestCase
{
    use RefreshDatabase;
}

Tip: to replace all existing usages of Laravel's RefreshDatabase trait with the package's, you can use the following command:

grep -rl 'Illuminate\\Foundation\\Testing\\RefreshDatabase' tests/ | xargs sed -i 's/Illuminate\\Foundation\\Testing\\RefreshDatabase/Tonysm\\LaravelParatest\\Testing\\RefreshDatabase/g'

You need to boot this setup trait in your base TestCase manually, because Laravel does not do it automatically:

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
use Tonysm\LaravelParatest\Testing\RefreshDatabase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;

    protected function setUpTraits()
    {
        $uses = parent::setUpTraits();

        if (isset($uses[RefreshDatabase::class])) {
            $this->refreshDatabase();
        }

        return $uses;
    }
}

You can keep running you tests with PHPUnit:

phpunit

Or you can use Paratest:

paratest

When using paratest, one database will be created for each process. If you want to clean up these databases at the end of the tests, use the runner provided. First, register the runner alias in your composer.json file, something like this:

{
    "autoload-dev": {
        "psr-4": {
            "Tests\\": "tests/"
        },
        "files": [
            "vendor/tonysm/laravel-paratest/src/ParatestLaravelRunner.php"
        ]
    }
}

Now, run composer dump -o, and then you can use the runner, like so:

paratest --runner ParatestLaravelRunner

This will clean up the test databases after your test finishes running.

This package also gives you the following Artisan commands:

  • php artisan db:create
  • php artisan db:drop
  • php artisan db:recreate

Use it wisely.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email tonyzrp@gmail.com instead of using the issue tracker.

Credits

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.