hjerichen/dbunit

An alternative to phpunit/dbunit.

0.4.0 2025-02-18 12:19 UTC

Requires

• php: ^8.2
• ext-pdo: *
• sebastian/comparator: ^4.0 | ^5.0 | ^6.0
• symfony/yaml: ^6.0 | ^7.0

Requires (Dev)

• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^11.5
• psalm/plugin-phpunit: ^0.19.2
• vimeo/psalm: ^6.0

MIT

• Heiko Jerichen

README

DBUnit

An alternative to phpunit/dbunit.
Supports PDO Drivers but currently only tested with MySQL.

Installation

Use Composer:

composer require --dev hjerichen/dbunit

Usage

Use the trait MySQLTestCaseTrait in PHPUnit Test Cases to test with MySQL, or build an abstract DatabaseTestCase class for your Test classes.

<?php

use HJerichen\DBUnit\Dataset\Attribute\DatasetForExpected
use HJerichen\DBUnit\Dataset\Attribute\DatasetForSetup
use HJerichen\DBUnit\Dataset\Dataset;
use HJerichen\DBUnit\Dataset\DatasetArray;
use HJerichen\DBUnit\MySQLTestCaseTrait;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit\Framework\TestCase;
use SebastianBergmann\Comparator\ComparisonFailure;

class MySQLTest extends TestCase
{
    use MySQLTestCaseTrait;

    private PDO $database;

    protected function getDatabase(): PDO
    {
        if (!isset($this->database)) {
            $this->database = new PDO(MYSQL_DSN, MYSQL_USER, MYSQL_PASS);
        }
        return $this->database;
    }

    protected function getDatasetForSetup(): Dataset
    {
        return $this->getDatasetForSetupFromAttribute() ?? new DatasetArray([
            'product' => [
                ['id' => 1, 'ean' => '123', 'stock' => 0],
                ['id' => 2, 'ean' => '456', 'stock' => 10],
            ]
        ]);
    }

    /* TESTS */

    public function testImportAndCompare(): void
    {
        $expected = new DatasetArray([
            'product' => [
                ['id' => 1, 'ean' => '123', 'stock' => 0],
                ['id' => 2, 'ean' => '456', 'stock' => 10],
            ]
        ]);
        $this->assertDatasetEqualsCurrentOne($expected);
    }

    #[DatasetForSetup([
        'product' => [
            ['id' => 1, 'ean' => '123', 'stock' => 0],
        ],
    ])]
    #[DatasetForExpected([
        'product' => [
            ['id' => 1, 'ean' => '123', 'stock' => 0],
        ],
    ])]
    public function testImportAndCompare2(): void
    {
        $expected = $this->getDatasetForExpectedFromAttribute();
        $this->assertDatasetEqualsCurrentOne($expected);
    }
    
    private function assertDatasetEqualsCurrentOne(DatasetArray $expected):void{
        try {
            $this->assertDatasetEqualsCurrent($expected);
        } catch (ComparisonFailure $failure) {
            throw new ExpectationFailedException($failure->getMessage(), $failure);
        }
    }
}

Datasets

Supported Datasets are:
DatasetArray (also via test method attribute)
DatasetYaml

License and authors

This project is free and under the MIT Licence. Responsible for this project is Heiko Jerichen ([e-mail]).