test linter works in project

Author: jrushlow

tests/Maker/TemplateLinterTest.php

@@ -0,0 +1,56 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * 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 <[email protected]>
+ */
+class TemplateLinterTest extends MakerTestCase
+{
+    protected function getMakerClass(): string
+    {
+        // We can use any maker here - MakeVoter is the simplest for now.
+        return MakeVoter::class;
+    }
+
+    public function getTestDetails(): \Generator
+    {
+        yield 'lints_templates_with_custom_php_cs_fixer_and_config' => [$this->createMakerTest()
+            ->addExtraDependencies('friendsofphp/php-cs-fixer')
+            ->run(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
+                $runner->runMaker(['FooBar']);
+
+                $generatedTemplate = file_get_contents($runner->getPath('src/Security/Voter/FooBarVoter.php'));
+
+                self::assertStringContainsString('Linted by custom php-cs-config', $generatedTemplate);
+            }),
+        ];
+    }
+}

tests/Util/TemplateLinterTest.php

@@ -1,5 +1,14 @@
 <?php
 
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace Symfony\Bundle\MakerBundle\Tests\Util;
 
 use PHPUnit\Framework\TestCase;
@@ -32,16 +41,16 @@ public function testLinterThrowsExceptionIfBinaryOrArgumentDoNotExist(string $bi
 
     public function pathProvider(): \Generator
     {
-        yield 'Binary Path Wrong' => ['/bad/path', dirname(__DIR__, 2).'/src/Resources/config/php-cs-fixer.config.php'];
-        yield 'Config Path Wrong' => [dirname(__DIR__, 2).'/src/Bin/php-cs-fixer-v3.13.0.phar', '/bad/path'];
+        yield 'Binary Path Wrong' => ['/bad/path', \dirname(__DIR__, 2).'/src/Resources/config/php-cs-fixer.config.php'];
+        yield 'Config Path Wrong' => [\dirname(__DIR__, 2).'/src/Bin/php-cs-fixer-v3.13.0.phar', '/bad/path'];
         yield 'Both Paths Wrong' => ['/bad/path', '/bad/path'];
     }
 
     private function copySourceToTemp(string $sourceFileName): string
     {
         $file = new Filesystem();
         $sourcePath = __DIR__.'/fixtures/source/';
-        $tmpLocation = dirname(__DIR__).'/tmp/cache/linter-test/';
+        $tmpLocation = \dirname(__DIR__).'/tmp/cache/linter-test/';
 
         $file->copy($sourcePath.$sourceFileName, $tmpLocation.$sourceFileName);
 

tests/fixtures/template-linter/.env

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        'header_comment' => [
+            'header' => 'Linted by custom php-cs-config',
+        ],
+    ])
+    ->setRiskyAllowed(true)
+;