如何在Symfony 4中用Codeception执行测试前运行Doctrine迁移？

刚好我之前也遇到过类似的需求，给你几个不用额外引入Codeception DB模块的方案，完全基于你已经在用的Symfony模块来实现：

方案1：利用Codeception全局钩子（推荐，更可靠） #

通过自定义Helper类的_beforeSuite方法，直接通过Symfony容器调用Doctrine迁移命令，不需要依赖外部命令行：

1. 配置Symfony模块：确保你的测试套件配置（比如tests/api.suite.yml）里Symfony模块已经正确配置，能访问容器：

modules:
    enabled:
        - Symfony:
            app_path: 'src'
            environment: 'test'

2. 创建全局Helper类：在tests/_support/Helper/ApiHelper.php中添加如下代码：

<?php

namespace Helper;

use Codeception\Module;
use Doctrine\Migrations\Tools\Console\Command\MigrateCommand;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\NullOutput;

class ApiHelper extends Module
{
    public function _beforeSuite($settings = [])
    {
        // 获取Symfony模块实例及容器
        $symfonyModule = $this->getModule('Symfony');
        $container = $symfonyModule->container;

        // 执行迁移命令
        $migrateCommand = $container->get(MigrateCommand::class);
        $input = new ArrayInput([
            '--no-interaction' => true,
            '--env' => 'test',
        ]);
        $output = new NullOutput(); // 静默输出，避免干扰测试日志
        $migrateCommand->run($input, $output);
    }
}

3. 启用Helper类：在测试套件配置里添加这个Helper：

modules:
    enabled:
        - Symfony:
            app_path: 'src'
            environment: 'test'
        - Helper\ApiHelper

方案2：使用启动脚本（最简单） #

直接在测试套件配置里指定一个启动脚本，执行Doctrine迁移的控制台命令：

1. 配置bootstrap脚本：修改tests/api.suite.yml：

bootstrap: _bootstrap.php
modules:
    enabled:
        - Symfony:
            app_path: 'src'
            environment: 'test'

2. 创建bootstrap脚本：在tests/_bootstrap.php中添加：

<?php

// 执行迁移命令，添加错误判断避免测试在迁移失败时继续执行
$exitCode = 0;
$output = [];
exec('php bin/console doctrine:migrations:migrate --no-interaction --env=test', $output, $exitCode);

if ($exitCode !== 0) {
    die(sprintf('Database migration failed with code %d: %s', $exitCode, implode("\n", $output)));
}

方案3：自定义轻量模块（适合多套件复用） #

如果多个测试套件都需要执行迁移，可以封装成一个自定义Codeception模块：

1. 创建自定义模块：在tests/_support/Module/DoctrineMigrationModule.php中添加：

<?php

namespace Module;

use Codeception\Module;
use Doctrine\Migrations\Tools\Console\Command\MigrateCommand;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\NullOutput;

class DoctrineMigrationModule extends Module
{
    public function _beforeSuite($settings = [])
    {
        // 确保Symfony模块已启用
        if (!$this->hasModule('Symfony')) {
            throw new \RuntimeException('DoctrineMigrationModule requires the Symfony module to be enabled.');
        }

        $symfonyModule = $this->getModule('Symfony');
        $container = $symfonyModule->container;
        $env = $symfonyModule->_getConfig('environment');

        // 执行迁移
        $migrateCommand = $container->get(MigrateCommand::class);
        $input = new ArrayInput([
            '--no-interaction' => true,
            '--env' => $env,
        ]);
        $output = new NullOutput();
        $migrateCommand->run($input, $output);
    }
}

2. 启用自定义模块：在测试套件配置里添加：

modules:
    enabled:
        - Symfony:
            app_path: 'src'
            environment: 'test'
        - Module\DoctrineMigrationModule

额外注意事项 #

• 确保测试环境的数据库配置和Symfony模块使用的是同一个，完全复用现有配置，避免重复配置的问题
• 如果需要在测试后清理数据库，可以在_afterSuite方法中添加doctrine:migrations:rollback或者doctrine:schema:drop --force的逻辑
• 方案1和3直接通过Symfony容器调用命令，比exec更可靠，不会受命令行环境变量的影响

内容的提问来源于stack exchange，提问作者Chris Brown