Checks the Symfony different version compatibilies in the CI

.github/workflows/ci.yaml

@@ -32,7 +32,42 @@ jobs:
                 uses: "ramsey/composer-install@v2"
 
             -   name: "Run tests"
-                run: "make test"
+                run: "make phpunit"
+
+    symfony-version:
+        runs-on: "ubuntu-latest"
+        name: "Test ${{ matrix.php }} with Symfony ${{ matrix.symfony.version }}"
+        strategy:
+            fail-fast: false
+            matrix:
+                php:
+                    - "7.4"
+                    - "8.0"
+                    - "8.1"
+                symfony:
+                    - version: "4.4"
+                      conflict: ">=5.0"
+                    - version: "5.4"
+                      conflict: ">=6.0,<5.0"
+
+        steps:
+            -   name: "Check out repository code"
+                uses: "actions/checkout@v2"
+
+            -   name: "Setup PHP"
+                uses: "shivammathur/setup-php@v2"
+                with:
+                    php-version: "${{ matrix.php }}"
+                    tools: "composer"
+
+            -   name: "Fix the Symfony versions"
+                run: "bin/fix-symfony-versions \"${{ matrix.symfony.conflict }}\""
+
+            -   name: "Install Composer dependencies"
+                uses: "ramsey/composer-install@v2"
+
+            -   name: "Run tests"
+                run: "make phpunit"
 
     infection:
         runs-on: "ubuntu-latest"

.php-cs-fixer.php

@@ -123,6 +123,10 @@
     ->setFinder(
         Finder::create()
             ->in(__DIR__)
+            ->append([
+                '.github/fix-symfony-versions',
+                'set-composer-conflicts.php',
+            ])
             ->exclude([
                 'dist',
                 'tests/Integration/var',

bin/fix-symfony-versions

@@ -0,0 +1,56 @@
+#!/usr/bin/env php
+<?php
+
+/*
+ * This file is part of the Webmozarts Console Parallelization package.
+ *
+ * (c) Webmozarts GmbH <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Webmozarts\Console\Parallelization\CI;
+
+use function file_get_contents;
+use function file_put_contents;
+use function json_decode;
+use function json_encode;
+use function shell_exec;
+use const JSON_PRETTY_PRINT;
+use const JSON_UNESCAPED_SLASHES;
+
+require_once __DIR__.'/set-composer-conflicts.php';
+
+$composerJsonPath = __DIR__.'/../composer.json';
+
+$packagesToFix = [
+    'symfony/cache',
+    'symfony/config',
+    'symfony/console',
+    'symfony/dependency-injection',
+    'symfony/error-handler',
+    'symfony/event-dispatcher',
+    'symfony/filesystem',
+    'symfony/finder',
+    'symfony/framework-bundle',
+    'symfony/http-foundation',
+    'symfony/http-kernel',
+    'symfony/process',
+    'symfony/routing',
+    'symfony/string',
+    'symfony/var-dumper',
+    'symfony/var-exporter',
+];
+
+$decodedComposerJson = json_decode(file_get_contents($composerJsonPath));
+
+set_composer_conflicts(
+    $decodedComposerJson,
+    $packagesToFix,
+    $argv[1] ?? null,
+);
+
+file_put_contents($composerJsonPath, json_encode($decodedComposerJson, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));

bin/set-composer-conflicts.php

@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Webmozarts Console Parallelization package.
+ *
+ * (c) Webmozarts GmbH <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Webmozarts\Console\Parallelization\CI;
+
+use function count;
+use stdClass;
+
+/**
+ * @param list<non-empty-string> $packageNames
+ * @param non-empty-string|null  $conflict
+ */
+function set_composer_conflicts(
+    stdClass $decodedComposerJson,
+    array $packageNames,
+    ?string $conflict
+): void {
+    if (0 === count($packageNames)) {
+        return;
+    }
+
+    $decodedComposerJson->conflict = $decodedComposerJson->conflict ?? new stdClass();
+
+    if (null === $conflict) {
+        foreach ($packageNames as $packageName) {
+            unset($decodedComposerJson->conflict->$packageName);
+        }
+    } else {
+        foreach ($packageNames as $packageName) {
+            $decodedComposerJson->conflict->$packageName = $conflict;
+        }
+    }
+}

phpstan.neon.dist

@@ -1,6 +1,7 @@
 parameters:
     level: 5
     paths:
+        - bin/set-composer-conflicts.php
         - src
         - tests
     excludePaths:

tests/SetComposerConflictsTest.php

@@ -0,0 +1,122 @@
+<?php
+
+/*
+ * This file is part of the Webmozarts Console Parallelization package.
+ *
+ * (c) Webmozarts GmbH <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Webmozarts\Console\Parallelization;
+
+require_once __DIR__.'/../bin/set-composer-conflicts.php';
+
+use function is_array;
+use PHPUnit\Framework\TestCase;
+use stdClass;
+use function Webmozarts\Console\Parallelization\CI\set_composer_conflicts;
+
+/**
+ * @coversNothing
+ */
+final class SetComposerConflictsTest extends TestCase
+{
+    /**
+     * @dataProvider conflictProvider
+     *
+     * @param list<non-empty-string> $packageNames
+     * @param non-empty-string|null  $conflict
+     */
+    public function test_it_can_the_desired_packages_to_the_composer_conflict_section(
+        stdClass $decodedComposerJson,
+        array $packageNames,
+        ?string $conflict,
+        stdClass $expected
+    ): void {
+        set_composer_conflicts($decodedComposerJson, $packageNames, $conflict);
+
+        self::assertEquals($expected, $decodedComposerJson);
+    }
+
+    public static function conflictProvider(): iterable
+    {
+        yield 'nominal' => [
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+            ]),
+            ['symfony/cache', 'symfony/framework-bundle'],
+            '>=5.0',
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+                'conflict' => [
+                    'symfony/cache' => '>=5.0',
+                    'symfony/framework-bundle' => '>=5.0',
+                ],
+            ]),
+        ];
+
+        yield 'no packages' => [
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+            ]),
+            [],
+            '>=5.0',
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+            ]),
+        ];
+
+        yield 'already has a conflict section' => [
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+                'conflict' => [
+                    'symfony/service-contracts' => '<2.0',
+                ],
+            ]),
+            ['symfony/cache', 'symfony/framework-bundle'],
+            '>=5.0',
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+                'conflict' => [
+                    'symfony/service-contracts' => '<2.0',
+                    'symfony/cache' => '>=5.0',
+                    'symfony/framework-bundle' => '>=5.0',
+                ],
+            ]),
+        ];
+
+        yield 'removes conflicts if no conflict is provided' => [
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+                'conflict' => [
+                    'symfony/service-contracts' => '<2.0',
+                    'symfony/cache' => '>=5.0',
+                    'symfony/framework-bundle' => '>=5.0',
+                ],
+            ]),
+            ['symfony/cache', 'symfony/framework-bundle'],
+            null,
+            self::toStdClass([
+                'package' => 'webmozarts/console-parallelization',
+                'conflict' => [
+                    'symfony/service-contracts' => '<2.0',
+                ],
+            ]),
+        ];
+    }
+
+    private static function toStdClass(array $value): stdClass
+    {
+        foreach ($value as $key => $item) {
+            if (is_array($item)) {
+                $value[$key] = self::toStdClass($item);
+            }
+        }
+
+        return (object) $value;
+    }
+}