20

GitHub - drfraker/snipe-migrations: Blazing fast database migrations for Laravel...

 6 years ago
source link: https://github.com/drfraker/snipe-migrations
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

README.md

build status StyleCI

Snipe Migrations

Blazing fast database migrations for Laravel tests.

The package takes a snapshot of your mysql database and imports the schema to your test database rather than running all of your migrations when the test suite starts up.

If you have a project with many migration files, this process can provide you with a massive speed improvement when initializing your test suite. This package can be used as a replacement for the RefreshDatabase trait that is provided out of the box with Laravel.

As an example, we tested this on an application that takes about 4 seconds to run all migrations with RefreshDatabase. Using SnipeMigrations the tests start up in 200 ms.

Requirements

  1. Laravel >= 5.2
  2. PHP >= 7.1
  3. MySql or MariaDb, with separate database for testing.
    • For example if you have a development database for your application called amazingapp you would create a test database called amazingapp_test and add the details of the database in your phpunit.xml file. amazingapp_test is the database that Snipe will keep in sync for you.

Installation

Require the package using composer.

composer require --dev drfraker/snipe-migrations

Usage

After you've installed the package via composer

  1. Add the following code to your tests/TestCase file. Don't forget to import the classes at the top of the file.

  2. By default, SnipeMigrations will store the .snipe file and the snipe_snapshot.sql file in the root of tests/. If you would like to change the location of the files follow the directions below to publish the snipe config file.

    • To publish the snipe config file, run php artisan vendor:publish and select snipe-config from the list.

  3. To utilize SnipeMigrations, all you need to do is use DatabaseTransactions in your tests. When DatabaseTransactions is detected SnipeMigrations will create and use a snapshot of your database to keep your test database in sync.

  4. (optional) Add the files tests/.snipe and tests/snipe_snapshot.sql to your .gitignore.

// Add this code block to tests/TestCase, just below the use CreatesApplication; statement.
public function setUpTraits()
{
	$uses = parent::setUpTraits();

	if (isset($uses[DatabaseTransactions::class])) {
		(new Snipe())->importSnapshot();
	}
}

When you're done, you're tests/TestCase.php file should look like this.

<?php

namespace Tests;

use Drfraker\SnipeMigrations\Snipe;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;

    // Code you added in step 1.
    public function setUpTraits()
    {
        $uses = parent::setUpTraits();

        if (isset($uses[DatabaseTransactions::class])) {
            (new Snipe())->importSnapshot();
        }
    }
    // End of added code.
}

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK