airmedia/phpunit-doctrine-extension

Provides the base TestCase for functional ORM/DB tests.

0.10.1 2021-07-02 14:37 UTC

Requires

• php: ^7.1 || ^8.0
• doctrine/common: ^2.13.0 || ^3.0
• doctrine/orm: ~2.6
• phpunit/phpunit: ^7.0 || ^8.0 || ^9.0

Requires (Dev)

• airmedia/coding-standard: ^0.8.0
• doctrine/data-fixtures: ^1.2

Suggests

• doctrine/data-fixtures: For use ORM fixtures

MIT

• database
• testing
• phpunit

README

Provides the base TestCase for functional ORM\DB tests.

Works with RDBMS:

• PostgreSQL > 9.4
• SQLite

Installation

$ composer require airmedia\phpunit-doctrine-extension --dev

Support PostgreSQL

For work with PostgreSQL you need to modify your configuration file (phpunit.xml) for PHPUnit. Add some variables to configure connection to PostgreSQL server. For example:

    <php>
        <var name="db_type" value="pdo_pgsql" />
        <var name="db_host" value="localhost" />
        <var name="db_username" value="postgres" />
        <var name="db_password" value="" />
        <var name="db_name" value="my_database_tests" />
        <var name="db_port" value="5432" />
    </php>

If these options are missing then will be used driver for SQLite as the fallback.

Usage

You must inherit from AirMedia\Test\OrmTestCase and implement createMappingDriver to provide configured mapping driver.

Also you may override the static field $customTypes to define the custom types for Doctrine.

Example:

<?php

use AirMedia\Test\ORMTestCase;
use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver;
use Doctrine\Common\Persistence\Mapping\Driver\MappingDriverChain;
use Doctrine\ORM\Configuration;
use Ramsey\Uuid\Doctrine\UuidType;

class RepositoryTestCase extends ORMTestCase
{
    static protected $customTypes = [
        UuidType::NAME => UuidType::class,
    ];
    
    public function testAnything()
    {
        $repository = $this->em->getRepository('Acme\Entity\User');
        
        // Action and asserts...
    }
    
    protected function createMappingDriver(Configuration $config): MappingDriver
    {
        $annotationDriver = $config->newDefaultAnnotationDriver([
            realpath(__DIR__ . '/../src/Entity'),
        ], false);
        
        $driver = new MappingDriverChain();
        $driver->addDriver($annotationDriver, 'Acme\Entity');

        return $driver;
    }
}

Doctrine Data Fixtures Extension

You may populate your database throught the data fixtures using trait AirMedia\Test\Helper\DataFixturesTrait.

<?php

use AirMedia\Test\ORMTestCase;
use AirMedia\Test\Helper\DataFixturesTrait;

class FooTestCase extends ORMTestCase
{
    use DataFixturesTrait;
    
    protected function setUp()
    {
        parent::setUp();
        
        $this->loadFixtures([
            new \Acme\DataFixtures\UserFixture(),
            'Acme\DataFixtures\GroupFixture', // or class name
        ]);
    }
}

License

This package is licensed using the MIT License.