pmgdev/database-replicator

This package is abandoned and no longer maintained. No replacement package was suggested.

Clone database for each test.

v0.1.2 2019-09-06 07:40 UTC

Requires

• php: >=7.1
• nette/utils: ^2.4 || ^3.0

Requires (Dev)

• nette/tester: ^2.0
• phpstan/phpstan: ^0.11.1
• tracy/tracy: ^2.0

Suggests

• ext-pgsql: Install extension, if you want test on PostgreSQL.

MIT

• Svatopluk Hastík
• Dominik Klapuch
• Milan Matějček
• Jakub Trmota

README

This is simple library whose prepare database for each test.

Support databases

• for this moment only postgres
• here is interface Command for implement other databases
• for add new database let's create pull request

Extensions

• Nette framework

Install by composer

composer require --dev pmgdev/database-replicator

How use our database layout

Everybody can have different database layout. Here is prepared interface DatabaseConnection. What we use in our tests. Or we can extend prepared abstract class Database. Where method create your instance of our database layout like (PDO, Doctrine, our implementation etc.).

We need one connection with the permission for create and to drop database. And secondary connection for standard to use.

1. we implement DatabaseConnection or we can use prepared abstract class Database.

   • this new class we used in tests
   • we need create dependency on Database\Replicator
   • method create() must create your database connection, let's save Config for import files
   • method drop() disconnect connection and drop database

2. here is prepared Builder, we can extend it and implement method createDatabase, where return our implementation from point 1)

Example

ConnectionFactory

<?php

use PmgDev\DatabaseReplicator;
use PmgDev\DatabaseReplicator\Config;

class MyConnectionDatabase extends DatabaseReplicator\Database
{

	public function createConnection(Config $config): object
	{
		return new MyConnection($config);
	}

	public function disconnectConnection($connection): void
	{
		$connection->diconnect();
	}

}

Builder

<?php

use PmgDev\DatabaseReplicator\Source;

class MyBuilder extends PmgDev\DatabaseReplicator\Builder 
{

	protected function createDatabase(): PmgDev\DatabaseReplicator\DatabaseConnection 
	{
		// these instances of Files are optional
		
		// if you have additional files for complete source of database
		$files = $this->createSourceFiles();
		$files->addFile('data.sql');
		$files->addDirectory('/sql/path');
		
		// import dynamic data, like a current_timestamp, to every copy of original database
		$dynamicFiles = new Source\Files;
		$dynamicFiles->addFile('dynamic.data.sql');
		
		return MyConnectionDatabase($this->createDatabaseReplicator($files, $dynamicFiles));
	}

}

Start using

<?php

use PmgDev\DatabaseReplicator\Config;
use PmgDev\DatabaseReplicator\Database;
use PmgDev\DatabaseReplicator\Database\Postgres;

$adminConfig = new Config('posgres', 'posgres', '***', 'localhost', 5432); // permission for create and drop databases
$command = (new Postgres\CommandFactory())->create($adminConfig); // prepared Command for postgres, this we can replace by other Command

$sourceFile = '/path/to/your/structure.sql'; // here is sql how look like database
$config = new Config('test', 'joe', '***', 'localhost', 5432); // standard config

/** @var Database $database */
$database = (new MyBuilder($sourceFile, $config, $command))->createDatabase();

$connection = $database->create(); // startup

var_dump($connection); // our connection instance of MyConnection
// make test

$database->drop(); // remove database