PHP8系へのバージョンアップに伴うライブラリのリプレイス その2 〜PHPUnit/DbUnit編〜

<?php
use PHPUnit\DbUnit\DataSet;
use PHPUnit\DbUnit;

class BaseTestCase extends PHPUnit\DbUnit\TestCase
{
    static private $pdo = null;
    private $conn = null;

    protected function setUp()
    {
        $fixturePath = TEST_ROOT . '/datasets/' . get_class($this) . '/' . $this->getName() . '.yml';
        if (file_exists($fixturePath)) {
            $this->_dataSet = new PHPUnit\DbUnit\DataSet\YamlDataSet($fixturePath);
        } else {
            $this->_dataSet = new PHPUnit\DbUnit\DataSet\DefaultDataSet();
        }
        parent::setUp();
    }

    public function getConnection()
    {
        if ($this->conn === null) {
            if (self::$pdo == null) {
                $dbDsn = "mysql:dbname={$_ENV['DB_DBNAME']};host={$_ENV['DB_HOST']}";
                self::$pdo = new PDO($dbDsn, $_ENV['DB_USER'], $_ENV['DB_PASSWD']);
            }
            $this->conn = $this->createDefaultDBConnection(self::$pdo, $_ENV['DB_DBNAME']);
        }
        return $this->conn;
    }

    public function getDataSet()
    {
        return $this->_dataSet;
    }

    // テスト後にテーブルをTRUNCATEする
    public function getTearDownOperation()
    {
        return PHPUnit\DbUnit\Operation\Factory::TRUNCATE();
    }
}

protected function setUp()
{
    $fixturePath = TEST_ROOT . '/datasets/' . get_class($this) . '/' . $this->getName() . '.yml';
    if (file_exists($fixturePath)) {
        $this->_dataSet = new PHPUnit\DbUnit\DataSet\YamlDataSet($fixturePath);
    } else {
        $this->_dataSet = new PHPUnit\DbUnit\DataSet\DefaultDataSet();
    }
    parent::setUp();
}

実行しているテスト名でyamlファイルのfixtureが存在すれば、それをテスト用のデータとしてテスト用DBにinsertする

$this->_dataSet = new PHPUnit\DbUnit\DataSet\YamlDataSet($fixturePath);

/**
 * Creates a new YAML dataset
 *
 * @param string      $yamlFile
 * @param IYamlParser $parser
 */
public function __construct($yamlFile, $parser = null)
{
    if ($parser == null) {
        $parser = new SymfonyYamlParser();
    }
    $this->parser = $parser;
    $this->addYamlFile($yamlFile);
}

/**
 * Adds a new yaml file to the dataset.
 *
 * @param string $yamlFile
 */
public function addYamlFile($yamlFile): void
{
    $data = $this->parser->parseYaml($yamlFile);

    foreach ($data as $tableName => $rows) {
        if (!isset($rows)) {
            $rows = [];
        }

        if (!\is_array($rows)) {
            continue;
        }

        if (!\array_key_exists($tableName, $this->tables)) {
            $columns = $this->getColumns($rows);

            $tableMetaData = new DefaultTableMetadata(
                $tableName,
                $columns
            );

            $this->tables[$tableName] = new DefaultTable(
                $tableMetaData
            );
        }

        foreach ($rows as $row) {
            $this->tables[$tableName]->addRow($row);
        }
    }
}

<?php

use PHPUnit\Framework\TestCase;
use Symfony\Component\Yaml\Yaml;

class BaseTestCase extends TestCase
{
    private $db;
    private $fixturePath;

    protected function setUp(): void
    {
        $this->fixturePath = TEST_ROOT . '/datasets/' . str_replace("::", "/", $this->toString()) . '.yml';

        // fixtureのyamlファイルがなければDBへの接続処理は行わない
        if (!file_exists($this->fixturePath)) {
            return;
        }

        // テストデータベースをトランザクションでクリーンアップ
        $this->db = Dao_Table_Init::standby();
        $this->db->beginTransaction();

        // フィクスチャをロード
        $this->loadFixtures();
    }

    protected function getDb()
    {
        return $this->db;
    }

    public function loadFixtures()
    {
        $fixtures = Yaml::parse(file_get_contents($yamlFilePath));
        
        foreach ($this->fixtures as $table => $rows) {
            foreach ($rows as $row) {
                $this->db->insert($table, $row);
            }
        }
    }

    protected function tearDown(): void
    {
        // fixtureのyamlファイルがなければDBのロールバック処理は行わない
        if (!file_exists($this->fixturePath)) {
            return;
        }
        // ロールバックしてテストデータベースの状態をクリーンアップ
        $this->db->rollBack();
    }
}