lzakrzewski/doctrine-database-backup

Doctrine Database Backup

1.2.3 2016-10-24 16:24 UTC

Requires

• php: >=5.4
• doctrine/orm: ~2.3
• symfony/process: ~2.3|~3.0

Requires (Dev)

• mikey179/vfsstream: ~1
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0

MIT

• lzakrzewski

README

DoctrineDatabaseBackup is simple library for speed up tests in your app. It could be used for PHPUnit tests or Behat tests running from command line. My target was to avoid wasting time for dropping/creating or purging database for each test, so I optimized it.

This library puts contents of database to memory and share it between every tests.

Notice: I don't recommend to use this library with large fixtures because it can cause huge memory usage. I prefer to run tests with minimal database setup because it is more readable for me and it have better performance.

Requirements

  "require": {
    "php": ">=5.4",
    "doctrine/orm": "~2.3",
    "symfony/process": "~2.3"
  },

Features

• It supports SqlitePlatform and MySqlPlatform,
• It can create database backup per PHP process,
• It can purge database in fast way,
• It can restore database from backup before every test,
• It can restore clear database before every test.

Installation

Require the library with composer:

composer require lzakrzewski/doctrine-database-backup "~1.2"

Basic usage (PHPUnit example)

/** {@inheritdoc} */
protected function setUp()
{
    parent::setUp();

    $this->entityManager = $this->createEntityManager();

    $backup = new DoctrineDatabaseBackup($this->entityManager);
    $backup->restore();
}

This database setup prepares clear database before every test. Full working example.

Advanced usage (PHPUnit example)

/** {@inheritdoc} */
protected function setUp()
{
    parent::setUp();

    $this->entityManager = $this->createEntityManager();
    $backup = new DoctrineDatabaseBackup($this->entityManager);
    
    $backup->restore(function (EntityManager $entityManager) {
        //your fixtures
        $entityManager->persist(new TestProduct('Iron', 99));
        $entityManager->flush();
    });
}

This database setup database with your fixtures before every test. Full working example.

Notice: that before first test of PHP process database should be created.

Behat example

/** @BeforeScenario*/
public function restoreDatabase()
{
    // "getEntityManager" is your own getter for EntityManager
    $backup = new DoctrineDatabaseBackup($this->getEntityManager());
    $backup->restore();
}