integration test

.github/workflows/ci.yml

@@ -38,3 +38,28 @@ jobs:
               composer update --prefer-dist --no-interaction --no-progress ${{ matrix.flags }}
       - name: Execute tests
         run: ./vendor/bin/phpunit
+
+  integration:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    name: integration
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.3'
+          coverage: xdebug
+      - name: Install dependencies
+        uses: nick-fields/retry@v3
+        with:
+          timeout_minutes: 5
+          max_attempts: 5
+          command: |
+              composer -V
+              composer update --prefer-dist --no-interaction --no-progress ${{ matrix.flags }}
+      - name: Execute tests
+        run: ./vendor/bin/phpunit -c phpunit.integration.xml

.php-cs-fixer.dist.php

@@ -9,7 +9,8 @@
 
 $finder = Finder::base()
     ->in(__DIR__)
-    ->append(['.php-cs-fixer.dist.php', 'bin/relax']);
+    ->append(['.php-cs-fixer.dist.php', 'bin/relax'])
+    ->notName('*_actual.php');
 
 return Config::create('relax')
     ->setRules($localRules)

.vscode/tasks.json

@@ -9,6 +9,12 @@
             "command": "./vendor/bin/phpunit",
             "problemMatcher": []
         },
+        {
+            "label": "[Tests] PHPUnit (integration)",
+            "type": "shell",
+            "command": "./vendor/bin/phpunit -c phpunit.integration.xml",
+            "problemMatcher": []
+        },
         {
             "label": "[Tests] PHPUnit (coverage-html)",
             "type": "shell",

phpunit.integration.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
+    bootstrap="vendor/autoload.php"
+    cacheResultFile=".tmp/PHPUnit/.phpunit.result.cache"
+    colors="true"
+>
+    <testsuites>
+        <testsuite name="Unit">
+            <directory suffix="Test.php">./tests/Codestyle</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

tests/Codestyle/CodestyleTestCase.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Realodix\Relax\Tests\Codestyle;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Input\StringInput;
+
+abstract class CodestyleTestCase extends TestCase
+{
+    protected function setUp(): void
+    {
+        $this->clearTempDirectory();
+    }
+
+    protected function tearDown(): void
+    {
+        $this->clearTempDirectory();
+    }
+
+    /**
+     * @throws \Exception
+     */
+    protected function testFixture(string $name, ?string $suffix = null): void
+    {
+        $fileName = $name;
+
+        if (! is_null($suffix)) {
+            $fileName = $fileName.'-'.$suffix;
+        }
+
+        copy(__DIR__."/../Fixtures/Ruleset/{$fileName}_actual.php", __DIR__."/tmp/{$fileName}.php");
+
+        $this->assertTrue(
+            file_exists(__DIR__."/tmp/{$fileName}.php"),
+            "Fixture fixtures/{$fileName} does not exist.",
+        );
+
+        $this->assertTrue(
+            is_writable(__DIR__."/tmp/{$fileName}.php"),
+            "Fixture fixtures/{$fileName} is not writable.",
+        );
+
+        $this->assertFalse(
+            $this->runFixer($name),
+            "Fixture fixtures/{$fileName} returned invalid true result.",
+        );
+
+        $this->assertTrue(
+            $this->runFixer($name, true),
+            "Fixture fixtures/{$fileName} was not proceeded properly.",
+        );
+
+        $this->assertFileEquals(
+            __DIR__."/../Fixtures/Ruleset/{$fileName}_expected.php",
+            __DIR__."/tmp/{$fileName}.php",
+            "Result of proceeded fixture fixtures/{$fileName} is not equal to expected.",
+        );
+    }
+
+    /**
+     * @throws \Exception
+     */
+    protected function runFixer(string $name, bool $fix = false): bool
+    {
+        $dryRun = $fix ? '' : '--dry-run';
+
+        $application = new \PhpCsFixer\Console\Application;
+        $application->setAutoExit(false);
+
+        $output = new \Symfony\Component\Console\Output\BufferedOutput;
+        $config = "tests/Codestyle/Config/config_{$name}.php";
+        $result = $application->run(new StringInput("fix {$dryRun} --diff --config={$config} --quiet"), $output);
+
+        return $result === 0;
+    }
+
+    protected function clearTempDirectory(): void
+    {
+        $files = glob(__DIR__.'/tmp/*.php');
+
+        foreach ($files as $file) {
+            unlink($file);
+        }
+    }
+
+    protected function getConfigPath(): string
+    {
+        return 'tests/codestyle/config/config_relax.php';
+    }
+}

tests/Codestyle/Config/config_relax.php

@@ -0,0 +1,10 @@
+<?php
+
+use PhpCsFixer\Finder;
+use Realodix\Relax\Config;
+
+$finder = (new Finder)->in('./tests/Codestyle/tmp');
+
+return Config::create('relax')
+    ->setFinder($finder)
+    ->setUsingCache(false);

tests/Codestyle/RelaxRulesetTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Realodix\Relax\Tests\Codestyle;
+
+class RelaxRulesetTest extends CodestyleTestCase
+{
+    public function testRelaxRuleset(): void
+    {
+        $this->testFixture('relax');
+    }
+
+    public function testRelaxCustom(): void
+    {
+        $this->testFixture('relax', 'custom');
+    }
+
+    public function testRelaxCleanup(): void
+    {
+        $this->testFixture('relax', 'deprecated');
+    }
+}

tests/Codestyle/tmp/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

tests/Fixtures/Ruleset/relax-custom_actual.php

@@ -0,0 +1,50 @@
+<?php
+namespace Realodix\Relax;
+
+use DateTime;
+
+/**
+ * FooRepository
+ *
+ * This class was generated by the Doctrine ORM. Add your own custom
+ * repository methods below.
+ */
+class RelaxCustom
+{
+    /**
+     * @var RelaxCustom PhpdocSelfAccessorFixer
+     */
+    private $instance;
+
+    /**
+     * @var array<int,string>
+     */
+    private $phpdocTypesCommaSpacesFixer;
+
+    /** Hello
+     * World!
+     */
+    public function multilineCommentOpeningClosingAloneFixer() {}
+
+    public function noImportFromGlobalNamespaceFixer(DateTime $dateTime) {}
+
+    /**
+     * Created by PhpStorm.
+     * User: root * Date: 01.01.70
+     * Time: 12:00
+     */
+    public function noPhpStormGeneratedCommentFixer() {}
+
+    /**
+     * @param bool   $b
+     * @param int    $i
+     * @param string $s this is string
+     * @param string $s duplicated
+     */
+    public function phpdocNoSuperfluousParamFixer() {}
+
+    /**
+     * @param null | string $x
+     */
+    public function phpdocTypesTrimFixer($x) {}
+}

tests/Fixtures/Ruleset/relax-custom_expected.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Realodix\Relax;
+
+class RelaxCustom
+{
+    /**
+     * @var self PhpdocSelfAccessorFixer
+     */
+    private $instance;
+
+    /**
+     * @var array<int, string>
+     */
+    private $phpdocTypesCommaSpacesFixer;
+
+    /**
+     * Hello
+     * World!
+     */
+    public function multilineCommentOpeningClosingAloneFixer() {}
+
+    public function noImportFromGlobalNamespaceFixer(\DateTime $dateTime) {}
+
+    public function noPhpStormGeneratedCommentFixer() {}
+
+    public function phpdocNoSuperfluousParamFixer() {}
+
+    /**
+     * @param null|string $x
+     */
+    public function phpdocTypesTrimFixer($x) {}
+}

tests/Fixtures/Ruleset/relax-deprecated_actual.php

@@ -0,0 +1,23 @@
+<?php
+namespace Realodix\Relax;
+
+class RelaxDeprecatedSets extends Config
+{
+    public function cast_notation()
+    {
+        $b =  2;
+
+        // no_unset_cast
+        $a = (unset) $b;
+    }
+
+    public function string_notation__simple_to_complex_string_variable()
+    {
+        $name = 'World';
+
+        echo "Hello ${name}!";
+        echo <<<TEST
+        -Hello ${name}!
+        TEST;
+    }
+}

tests/Fixtures/Ruleset/relax-deprecated_expected.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Realodix\Relax;
+
+class RelaxDeprecatedSets extends Config
+{
+    public function cast_notation()
+    {
+        $b = 2;
+
+        // no_unset_cast
+        $a = null;
+    }
+
+    public function string_notation__simple_to_complex_string_variable()
+    {
+        $name = 'World';
+
+        echo "Hello {$name}!";
+        echo <<<TEST
+        -Hello {$name}!
+        TEST;
+    }
+}