Codeception & Symfony - run Doctrine migrations before tests

I always create a bash script to do this, or a Makefile.

bash command

My ./runtests.sh scripts contains

#!/bin/bash
./bin/console command:for:migrations
./bin/phpunit

Makefile

Same with Makefile

.FOO: testsuite
testsuite:
    ./runtests.sh

or

.FOO: testsuite
testsuite:
    ./bin/console command:for:migrations
    ./bin/phpunit

why I prefer Makefile

Recently I added this script in my .bash_profile that allow me to autocomplete from bash all target made in makefile (very easy because you dont need anymore to remember all commands, but just make and tab).

complete -W "`grep -oE '^[a-zA-Z0-9_.-]+:([^=]|$)' Makefile | sed 's/[^a-zA-Z0-9_.-]*$//'`" make

Thus, .. you can create target like:

• runtests
• runtests_with_fixtures
• migrations
• runtests_with_migrations
• ...

and so on

My suggestion is to create your custom and easy way to run commands.

---

Here a way to run all or just one command usgin make

.FOO: dropforce
dropforce:
    bin/console doctrine:database:drop --force

.FOO: dbcreate
dbcreate:
    bin/console doctrine:database:create

.FOO: migrate
migrate:
    bin/console doctrine:migrations:migrate

.FOO: suite
suite: dropforce dbcreate migrate

I spent a while trying a couple of different ways to achieve this. I initially used RunProcess however this seemed to cause sporadic issues with the DB being deleted and not recreated, despite using the sleep configuration. I ended up just updating the existing extension to use the CLI module instead, and it works as desired (without having to create scripts or run multiple commands) and without having to use exec.

Final extension;

class DatabaseMigrationExtension extends Extension
{
    public static $events = [
        Events::SUITE_BEFORE => 'beforeSuite',
    ];

    public function beforeSuite()
    {
        try {
            /** @var \Codeception\Module\Cli $cli */
            $cli = $this->getModule('Cli');

            $this->writeln('Recreating the DB...');
            $cli->runShellCommand('bin/console doctrine:database:drop --if-exists --force');
            $cli->seeResultCodeIs(0);
            $cli->runShellCommand('bin/console doctrine:database:create');
            $cli->seeResultCodeIs(0);

            $this->writeln('Running Doctrine Migrations...');
            $cli->runShellCommand('bin/console doctrine:migrations:migrate --no-interaction');
            $cli->seeResultCodeIs(0);

            $this->writeln('Test database recreated');
        } catch (\Exception $e) {
            $this->writeln(
                sprintf(
                    'An error occurred whilst rebuilding the test database: %s',
                    $e->getMessage()
                )
            );
        }
    }
}

and registered;

// codeception.yml
extensions:
    enabled:
        - \DatabaseMigrationExtension

Output (-vv or higher also displays the output of the DB & Migration commands);