BDD 使用 Behat

Feature: Setup
    In order to run database migrations
    As a developer
    I need to be able to create the empty schema and migrations table.

Feature: Migrations
    In order to add changes to my database schema
    As a developer
    I need to be able to run the migrations script

$ ./vendor/bin/behat

<?php

use Behat\Behat\Context\Context;
use Behat\Behat\Context\SnippetAcceptingContext;
use Behat\Gherkin\Node\PyStringNode;

require_once __DIR__ . '/../../vendor/phpunit/phpunit/src/Framework/
Assert/Functions.php';

class FeatureContext implements Context, SnippetAcceptingContext
{
    private $db;
    private $config;
    private $output;

    public function __construct()
    {
        $configFileContent = file_get_contents(
            __DIR__ . '/../../config/app.json'
        );
        $this->config = json_decode($configFileContent, true);
    }

    private function getDb(): PDO
    {
        if ($this->db === null) {
            $this->db = new PDO(
                "mysql:host={$this->config['host']}; " . "dbname=bdd_db_test",
                $this->config['user'],
                $this->config['password']
            );
        }

        return $this->db;
    }

    /**
     * @Given I do not have the "bdd_db_test" schema
     */
    public function iDoNotHaveTheSchema()
    {
        $this->executeQuery('DROP SCHEMA IF EXISTS bdd_db_test');
    }

    /**
     * @Given I do not have migration files
     */
    public function iDoNotHaveMigrationFiles()
    {
        exec('rm db/migrations/*.sql > /dev/null 2>&1');
    }

    /**
     * @When I run the migrations script
     */
    public function iRunTheMigrationsScript()
    {
        exec('php migrate.php', $this->output);
    }

    /**
     * @Then I should have an empty migrations table
     */
    public function iShouldHaveAnEmptyMigrationsTable()
    {
        $migrations = $this->getDb()
            ->query('SELECT * FROM migrations')
            ->fetch();
        assertEmpty($migrations);
    }

    private function executeQuery(string $query)
    {
        $removeSchemaCommand = sprintf(
            'mysql -u %s %s -h %s -e "%s"',
            $this->config['user'],
            empty($this->config['password'])
                ? '' : "-p{$this->config['password']}",
            $this->config['host'],
            $query
        );

        exec($removeSchemaCommand);
    }
}

{
    "host": "127.0.0.1",
    "schema": "bdd_db_test",
    "user": "root",
    "password": ""
}

"autoload": {
    "psr-4": {
      "Migrations\\": "src/"
    }
}

<?php

namespace Migrations;

use Exception;
use PDO;

class Schema {
    const SETUP_FILE = __DIR__ . '/../db/setup.sql';
    const MIGRATIONS_DIR = __DIR__ . '/../db/migrations/';

    private $config;
    private $connection;

    public function __construct(array $config)
    {
        $this->config = $config;
    }

    private function getConnection(): PDO
    {
        if ($this->connection === null) {
            $this->connection = new PDO(
                "mysql:host={$this->config['host']};"
                . "dbname={$this->config['schema']}",
                $this->config['user'],
                $this->config['password']
            );
        }

        return $this->connection;
    }
}

CREATE TABLE IF NOT EXISTS migrations(
    version INT UNSIGNED NOT NULL,
    `time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
    status ENUM('success', 'error'),
    PRIMARY KEY (version, status)
);

<?php

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

$configFileContent = file_get_contents(__DIR__ . '/config/app.json');
$config = json_decode($configFileContent, true);

$schema = new Migrations\Schema($config);

$schema->createSchema();

$version = $schema->getLatestMigration();
echo "Latest version applied is $version.\n";

Scenario: Schema does not exists and I have migrations
    Given I have migration file 1:
        """
        CREATE TABLE test1(id INT);
        """
    And I have migration file 2:
        """
        CREATE TABLE test2(id INT);
        """
    When I run the migrations script
    Then I should only have the following tables:
        | migrations |
        | test1      |
        | test2      |
    And I should have the following migrations:
        | 1 | success |
        | 2 | success |
    And I should get:
        """
        Latest version applied is 0.
        Applied migration 1 successfully.
        Applied migration 2 successfully.
        """

/**
 * @Given I have migration file :version:
 */
public function iHaveMigrationFile(
    string $version,
    PyStringNode $file
) {
    $filePath = __DIR__ . "/../../db/migrations/$version.sql";
    file_put_contents($filePath, $file->getRaw());
}

/**
 * @Then I should only have the following tables:
 */
public function iShouldOnlyHaveTheFollowingTables(TableNode $tables) {
    $tablesInDb = $this->getDb()
        ->query('SHOW TABLES')
        ->fetchAll(PDO::FETCH_NUM);

    assertEquals($tablesInDb, array_values($tables->getRows()));
}

/**
 * @Then I should have the following migrations:
 */
public function iShouldHaveTheFollowingMigrations(
    TableNode $migrations
) {
    $query = 'SELECT version, status FROM migrations';
    $migrationsInDb = $this->getDb()
        ->query($query)
        ->fetchAll(PDO::FETCH_NUM);

    assertEquals($migrations->getRows(), $migrationsInDb);
}

Feature: Migrations
In order to add changes to my database schema
As a developer
I need to be able to run the migrations script
Background:
Given I have the bdd_db_test
Scenario: Migrations are not consecutive
Given I have migration 3
And I have migration file 4:
"""
CREATE TABLE test4(id INT);
"""
And I have migration file 6:
"""
CREATE TABLE test6(id INT);
"""
When I run the migrations script
Then I should only have the following tables:
| migrations |
| test4 |
And I should have the following migrations:
| 3 | success |
| 4 | success |
And I should get:
"""
Latest version applied is 3.
Applied migration 4 successfully.
"""
Scenario: A migration throws an error
Given I have migration file 1:
"""
CREATE TABLE test1(id INT);
"""
And I have migration file 2:
"""
CREATE TABLE test1(id INT);
"""
And I have migration file 3:
"""
CREATE TABLE test3(id INT);
"""
When I run the migrations script
Then I should only have the following tables:
| migrations |
| test1 |
And I should have the following migrations:
| 1 | success |
| 2 | error |
And I should get:
"""
Latest version applied is 0.
Applied migration 1 successfully.
Error applying migration 2: Table 'test1' already exists.
"""

/**
 * @Given I have the bdd_db_test
 */
public function iHaveTheBddDbTest()
{
    $this->executeQuery('CREATE SCHEMA bdd_db_test');
}

/**
 * @Given I have migration :version
 */
public function iHaveMigration(string $version)
{
    $this->getDb()->exec(
        file_get_contents(__DIR__ . '/../../db/setup.sql')
    );

    $query = <<<SQL
INSERT INTO migrations (version, status)
VALUES(:version, 'success')
SQL;
    $this->getDb()
        ->prepare($query)
        ->execute(['version' => $version]);
}

public function applyMigrationsFrom(int $version): bool
{
    $filePath = self::MIGRATIONS_DIR . "$version.sql";

    if (!file_exists($filePath)) {
        return false;
    }

    $connection = $this->getConnection();
    if ($connection->exec(file_get_contents($filePath)) === false) {
        $error = $connection->errorInfo()[2];
        $this->registerMigration($version, 'error');
        throw new Exception($error);
    }

    $this->registerMigration($version, 'success');
    return true;
}

private function registerMigration(int $version, string $status)
{
    $query = <<<SQL
INSERT INTO migrations (version, status)
VALUES(:version, :status)
SQL;
    $params = ['version' => $version, 'status' => $status];

    $this->getConnection()->prepare($query)->execute($params);
}

do {
    $version++;

    try {
        $result = $schema->applyMigrationsFrom($version);
        if ($result) {
            echo "Applied migration $version successfully.\n";
        }
    } catch (Exception $e) {
        $error = $e->getMessage();
        echo "Error applying migration $version: $error.\n";
        exit(1);
    }
} while ($result);