archived-maker-bundle/tests/Maker/MakeMigrationTest.php

<?php

/*
 * This file is part of the Symfony MakerBundle package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Bundle\MakerBundle\Tests\Maker;

use Symfony\Bundle\MakerBundle\Maker\MakeMigration;
use Symfony\Bundle\MakerBundle\Test\MakerTestCase;
use Symfony\Bundle\MakerBundle\Test\MakerTestDetails;
use Symfony\Bundle\MakerBundle\Test\MakerTestRunner;
use Symfony\Bundle\MakerBundle\Util\CliOutputHelper;
use Symfony\Component\Finder\Finder;

class MakeMigrationTest extends MakerTestCase
{
    protected function getMakerClass(): string
    {
        return MakeMigration::class;
    }

    private static function createMakeMigrationTest(): MakerTestDetails
    {
        return self::buildMakerTest()
            // doctrine-migrations-bundle only requires doctrine-bundle, which
            // only requires doctrine/dbal. But we're testing with the ORM,
            // so let's install it
            ->addExtraDependencies('doctrine/orm')
            ->preRun(static function (MakerTestRunner $runner) {
                $runner->copy(
                    'make-migration/SpicyFood.php',
                    'src/Entity/SpicyFood.php'
                );

                $runner->configureDatabase(false);
            })
        ;
    }

    public static function getTestDetails(): \Generator
    {
        yield 'it_generates_migration_with_changes' => [self::createMakeMigrationTest()
            ->run(static function (MakerTestRunner $runner) {
                $output = $runner->runMaker([/* no input */]);

                self::assertStringContainsString('Success', $output);

                // support for Migrations 3 (/migrations) and earlier
                $migrationsDirectoryPath = file_exists($runner->getPath('/migrations')) ? 'migrations' : 'src/Migrations';

                $finder = new Finder();
                $finder->in($runner->getPath($migrationsDirectoryPath))
                    ->name('*.php');
                self::assertCount(1, $finder);

                // see that the exact filename is in the output
                $iterator = $finder->getIterator();
                $iterator->rewind();
                self::assertStringContainsString(\sprintf('%s/%s', $migrationsDirectoryPath, $iterator->current()->getFilename()), $output);
            }),
        ];

        yield 'it_detects_symfony_cli_usage' => [self::createMakeMigrationTest()
            ->run(static function (MakerTestRunner $runner) {
                $output = $runner->runMaker(
                    inputs: [],
                    envVars: [CliOutputHelper::ENV_VERSION => '0.0.0', CliOutputHelper::ENV_BIN_NAME => 'symfony']
                );

                self::assertStringContainsString('symfony console doctrine:migrations:migrate', $output);
            }),
        ];

        yield 'it_detects_symfony_cli_is_not_used' => [self::createMakeMigrationTest()
            ->run(static function (MakerTestRunner $runner) {
                $output = $runner->runMaker(
                    inputs: [],
                    envVars: []
                );

                self::assertStringContainsString('php bin/console doctrine:migrations:migrate', $output);
            }),
        ];

        yield 'it_generates_migration_with_no_changes' => [self::createMakeMigrationTest()
            ->run(static function (MakerTestRunner $runner) {
                // sync so there are no changes
                $runner->updateSchema();
                $output = $runner->runMaker([/* no input */]);

                self::assertStringNotContainsString('Success', $output);

                self::assertStringContainsString('No database changes were detected', $output);
            }),
        ];

        yield 'it_asks_previous_migration_question' => [self::createMakeMigrationTest()
            ->addRequiredPackageVersion('doctrine/doctrine-migrations-bundle', '>=3')
            ->run(static function (MakerTestRunner $runner) {
                // generate a migration first
                $runner->runConsole('make:migration', []);

                $output = $runner->runMaker([
                    // confirm migration
                    'y',
                ]);

                self::assertStringContainsString('[WARNING] You have 1 available migrations to execute', $output);
                self::assertStringContainsString('Are you sure you wish to continue?', $output);
                self::assertStringContainsString('Success', $output);
            }),
        ];

        yield 'it_asks_previous_migration_question_and_decline' => [self::createMakeMigrationTest()
            ->addRequiredPackageVersion('doctrine/doctrine-migrations-bundle', '>=3')
            ->run(static function (MakerTestRunner $runner) {
                // generate a migration first
                $runner->runConsole('make:migration', []);

                $output = $runner->runMaker([
                    // no to confirm
                    'n',
                ]);

                self::assertStringNotContainsString('Success', $output);
            }),
        ];

        yield 'it_generates_a_formatted_migration' => [self::createMakeMigrationTest()
            ->addRequiredPackageVersion('doctrine/doctrine-migrations-bundle', '>=3')
            ->run(static function (MakerTestRunner $runner) {
                $runner->runConsole('make:migration', [], '--formatted');

                $output = $runner->runMaker([/* no input */]);

                self::assertStringContainsString('Success', $output);
            }),
        ];

        yield 'it_generates_a_nowdoc_migration' => [self::createMakeMigrationTest()
            ->addRequiredPackageVersion('doctrine/doctrine-migrations-bundle', '>=3')
            ->run(static function (MakerTestRunner $runner) {
                $runner->runConsole('make:migration', [], '--nowdoc');

                $output = $runner->runMaker([/* no input */]);

                self::assertStringContainsString('Success', $output);
            }),
        ];
    }
}