archived-maker-bundle/tests/Maker/TemplateLinterTest.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\MakeVoter;
use Symfony\Bundle\MakerBundle\Test\MakerTestCase;
use Symfony\Bundle\MakerBundle\Test\MakerTestRunner;

/**
 * This test is not testing a maker directly. But the files generated by a maker.
 *
 * @author Jesse Rushlow <jr@rushlow.dev>
 *
 * @internal
 */
final class TemplateLinterTest extends MakerTestCase
{
    protected function getMakerClass(): string
    {
        // We can use any maker here - MakeVoter is the simplest for now.
        return MakeVoter::class;
    }

    public static function getTestDetails(): \Generator
    {
        yield 'lints_templates_with_custom_php_cs_fixer_and_config' => [self::buildMakerTest()
            ->addExtraDependencies('php-cs-fixer/shim')
            ->run(static function (MakerTestRunner $runner) {
                $runner->copy('template-linter/php-cs-fixer.test.php', 'php-cs-fixer.test.php');

                $runner->replaceInFile(
                    '.env',
                    '###< symfony/framework-bundle ###',
                    <<< 'EOT'
                        MAKER_PHP_CS_FIXER_CONFIG_PATH=php-cs-fixer.test.php
                        MAKER_PHP_CS_FIXER_BINARY_PATH=bin/php-cs-fixer
                        EOT
                );

                // Voter class name
                $output = $runner->runMaker(['FooBar']);

                $generatedTemplate = file_get_contents($runner->getPath('src/Security/Voter/FooBarVoter.php'));

                self::assertStringContainsString('Linted by custom php-cs-config', $generatedTemplate);

                $expectedOutput = 'System PHP-CS-Fixer (bin/php-cs-fixer) & System PHP-CS-Fixer Configuration (php-cs-fixer.test.php)';
                self::assertStringContainsString($expectedOutput, $output);
            }),
        ];

        yield 'lints_templates_with_flex_generated_config_file' => [self::buildMakerTest()
            ->addExtraDependencies('php-cs-fixer/shim')
            ->run(static function (MakerTestRunner $runner) {
                $runner->replaceInFile(
                    '.php-cs-fixer.dist.php',
                    '\'@Symfony\' => true,',
                    <<< 'EOT'
                        '@Symfony' => true,
                        'header_comment' => [
                            'header' => 'Linted with stock php-cs-config',
                        ],
                        EOT
                );

                // Voter class name
                $output = $runner->runMaker(['FooBar']);

                $generatedTemplate = file_get_contents($runner->getPath('src/Security/Voter/FooBarVoter.php'));

                self::assertStringContainsString('Linted with stock php-cs-config', $generatedTemplate);

                $expectedOutput = 'Bundled PHP-CS-Fixer & System PHP-CS-Fixer Configuration (.php-cs-fixer.dist.php)';
                self::assertStringContainsString($expectedOutput, $output);
            }),
        ];

        yield 'lints_templates_with_bundled_php_cs_fixer' => [self::buildMakerTest()
            ->run(static function (MakerTestRunner $runner) {
                // Voter class name
                $output = $runner->runMaker(['FooBar']);

                $expectedOutput = 'Bundled PHP-CS-Fixer & Bundled PHP-CS-Fixer Configuration';
                self::assertStringContainsString($expectedOutput, $output);
            }),
        ];
    }
}