Laravel项目中使用Liquibase实现单元测试的技术咨询

我之前在Laravel项目里用Liquibase做数据库版本管理时，也遇到过同样的单元测试困境，后来摸索出了一套可行的方案，分享给你参考：

核心思路 #

绕过Laravel原生迁移，直接让测试框架在执行测试前，调用Liquibase将测试数据库初始化到最新结构；测试过程中可以结合事务隔离保证数据干净，测试后按需清理。

1. 配置测试专用数据库 #

首先在项目根目录创建.env.testing，配置独立的测试数据库（避免污染开发/生产数据）：

APP_ENV=testing
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel_test_db
DB_USERNAME=root
DB_PASSWORD=

确保这个数据库预先创建好，且处于空状态。

2. 把Liquibase集成到测试流程 #

方法一：PHPUnit全局前置初始化（推荐） #

如果所有测试都依赖同一套数据库结构，最省心的方式是在PHPUnit启动时执行一次Liquibase更新：

1. 创建bootstrap-test.php文件放在项目根目录：

<?php

require __DIR__.'/vendor/autoload.php';

$app = require_once __DIR__.'/bootstrap/app.php';
$app->make(Illuminate\Contracts\Console\Kernel::class)->bootstrap();

if (env('APP_ENV') === 'testing') {
    $dbConfig = config('database.connections.mysql');
    $changeLogPath = base_path('database/changelog.xml'); // 你的Liquibase主变更文件路径
    $jdbcUrl = "jdbc:mysql://{$dbConfig['host']}:{$dbConfig['port']}/{$dbConfig['database']}?serverTimezone=UTC";

    // 拼接Liquibase命令
    $command = sprintf(
        'liquibase --changeLogFile=%s --url=%s --username=%s --password=%s update',
        escapeshellarg($changeLogPath),
        escapeshellarg($jdbcUrl),
        escapeshellarg($dbConfig['username']),
        escapeshellarg($dbConfig['password'] ?? '')
    );

    exec($command, $output, $returnCode);
    if ($returnCode !== 0) {
        die("Liquibase初始化测试数据库失败：\n" . implode("\n", $output));
    }
}

2. 修改phpunit.xml，指定这个bootstrap文件：

<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
         bootstrap="bootstrap-test.php"
         colors="true">
    <!-- 其他原有配置 -->
    <php>
        <server name="APP_ENV" value="testing"/>
        <server name="BCRYPT_ROUNDS" value="4"/>
        <server name="CACHE_DRIVER" value="array"/>
        <server name="DB_CONNECTION" value="mysql"/>
        <server name="MAIL_MAILER" value="array"/>
        <server name="QUEUE_CONNECTION" value="sync"/>
        <server name="SESSION_DRIVER" value="array"/>
        <server name="VIEW_COMPILED_PATH" value="storage/framework/views/testing"/>
    </php>
</phpunit>

方法二：TestCase中细粒度控制 #

如果需要针对不同测试类/方法执行不同的Liquibase操作（比如回滚到某个版本），可以在tests/TestCase.php中重写钩子方法：

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;

    protected function setUp(): void
    {
        parent::setUp();
        // 每个测试类执行前更新数据库
        $this->runLiquibaseUpdate();
    }

    protected function tearDown(): void
    {
        // 可选：测试后回滚到初始状态
        // $this->runLiquibaseRollback();
        parent::tearDown();
    }

    private function runLiquibaseUpdate(): void
    {
        $dbConfig = config('database.connections.mysql');
        $changeLogPath = base_path('database/changelog.xml');
        $jdbcUrl = "jdbc:mysql://{$dbConfig['host']}:{$dbConfig['port']}/{$dbConfig['database']}?serverTimezone=UTC";

        $command = sprintf(
            'liquibase --changeLogFile=%s --url=%s --username=%s --password=%s update',
            escapeshellarg($changeLogPath),
            escapeshellarg($jdbcUrl),
            escapeshellarg($dbConfig['username']),
            escapeshellarg($dbConfig['password'] ?? '')
        );

        exec($command, $output, $returnCode);
        if ($returnCode !== 0) {
            throw new \RuntimeException("Liquibase更新失败：\n" . implode("\n", $output));
        }
    }

    private function runLiquibaseRollback(): void
    {
        // 示例：回滚最近一次变更
        $dbConfig = config('database.connections.mysql');
        $changeLogPath = base_path('database/changelog.xml');
        $jdbcUrl = "jdbc:mysql://{$dbConfig['host']}:{$dbConfig['port']}/{$dbConfig['database']}?serverTimezone=UTC";

        $command = sprintf(
            'liquibase --changeLogFile=%s --url=%s --username=%s --password=%s rollback-count 1',
            escapeshellarg($changeLogPath),
            escapeshellarg($jdbcUrl),
            escapeshellarg($dbConfig['username']),
            escapeshellarg($dbConfig['password'] ?? '')
        );

        exec($command, $output, $returnCode);
    }
}

3. 优化测试速度 #

每次测试都跑Liquibase全量更新会很慢，推荐结合以下方式优化：

• 事务包裹测试：在测试类中使用Laravel的RefreshDatabase trait，它会在每个测试方法开启事务，测试结束后自动回滚。前提是已经通过Liquibase初始化了数据库结构，这样测试数据不会污染数据库，也不用重复执行Liquibase。
• 数据库快照复用：用mysqldump把Liquibase初始化后的测试数据库导出成快照，测试前直接导入快照，比重新执行所有变更快很多。

4. 额外小技巧 #

可以封装一个Artisan命令，方便在开发和测试环境快速执行Liquibase操作：

// app/Console/Commands/LiquibaseUpdate.php
namespace App\Console\Commands;

use Illuminate\Console\Command;

class LiquibaseUpdate extends Command
{
    protected $signature = 'liquibase:update';
    protected $description = '应用Liquibase数据库变更';

    public function handle()
    {
        $dbConfig = config('database.connections.' . config('database.default'));
        $changeLogPath = base_path('database/changelog.xml');
        $jdbcUrl = "jdbc:mysql://{$dbConfig['host']}:{$dbConfig['port']}/{$dbConfig['database']}?serverTimezone=UTC";

        $command = sprintf(
            'liquibase --changeLogFile=%s --url=%s --username=%s --password=%s update',
            escapeshellarg($changeLogPath),
            escapeshellarg($jdbcUrl),
            escapeshellarg($dbConfig['username']),
            escapeshellarg($dbConfig['password'] ?? '')
        );

        exec($command, $output, $returnCode);
        if ($returnCode === 0) {
            $this->info('Liquibase变更应用成功！');
        } else {
            $this->error('Liquibase变更应用失败：');
            $this->error(implode("\n", $output));
            return 1;
        }
    }
}

之后就可以用php artisan liquibase:update命令快速更新数据库了。

内容的提问来源于stack exchange，提问作者Manish Koju