Merge pull request #13 from veewee/tools

Upgrade tools
veewee · Oct 21, 2024 · 7c833bb · 7c833bb
2 parents 24b9244 + 2c0c455
commit 7c833bb
Show file tree

Hide file tree

Showing 19 changed files with 86,810 additions and 74,764 deletions.
diff --git a/.github/workflows/analyzers.yaml b/.github/workflows/analyzers.yaml
@@ -7,7 +7,7 @@ jobs:
         strategy:
             matrix:
                 operating-system: [ubuntu-latest]
-                php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+                php-versions: ['8.1', '8.2', '8.3', '8.4']
             fail-fast: false
         name: PHP ${{ matrix.php-versions }} @ ${{ matrix.operating-system }}
         steps:
@@ -23,3 +23,4 @@ jobs:
               run: composer update --prefer-dist --no-progress --no-suggest ${{ matrix.composer-options }}
             - name: Run the tests
               run: composer run psalm
+              continue-on-error: ${{ matrix.php-versions == '8.4'}}
diff --git a/.github/workflows/code-style.yaml b/.github/workflows/code-style.yaml
@@ -7,7 +7,7 @@ jobs:
         strategy:
             matrix:
                 operating-system: [ubuntu-latest]
-                php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+                php-versions: ['8.1', '8.2', '8.3', '8.4']
             fail-fast: false
         name: PHP ${{ matrix.php-versions }} @ ${{ matrix.operating-system }}
         steps:

diff --git a/.github/workflows/functional.yaml b/.github/workflows/functional.yaml
@@ -7,7 +7,7 @@ jobs:
         strategy:
             matrix:
                 operating-system: [ubuntu-latest, windows-latest, macos-latest]
-                php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+                php-versions: ['8.1', '8.2', '8.3', '8.4']
             fail-fast: false
         name: PHP ${{ matrix.php-versions }} @ ${{ matrix.operating-system }}
         steps:

diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -7,7 +7,7 @@ jobs:
         strategy:
             matrix:
                 operating-system: [ubuntu-latest]
-                php-versions: ['7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+                php-versions: ['8.1', '8.2', '8.3', '8.4']
             fail-fast: false
         name: PHP ${{ matrix.php-versions }} @ ${{ matrix.operating-system }}
         steps:
@@ -24,4 +24,4 @@ jobs:
             - name: Run the tests
               run: composer run tests
             - name: Check tests quality
-              run: composer parallel coverage infection || true
+              run: composer parallel coverage infection
diff --git a/.phive/phars.xml b/.phive/phars.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpunit" version="^9.5.26" installed="9.5.26" location="./tools/phpunit.phar" copy="true"/>
-  <phar name="psalm" version="^4.29.0" installed="4.29.0" location="./tools/psalm.phar" copy="true"/>
-  <phar name="infection" version="^0.26" installed="0.26.1" location="./tools/infection.phar" copy="true"/>
-  <phar name="php-cs-fixer" version="^3.13.0" installed="3.13.0" location="./tools/php-cs-fixer.phar" copy="true"/>
+  <phar name="phpunit" version="^9.5.26" installed="9.6.21" location="./tools/phpunit.phar" copy="true"/>
+  <phar name="psalm" version="^5.26.1" installed="5.26.1" location="./tools/psalm.phar" copy="true"/>
+  <phar name="infection" version="^0.26" installed="0.26.21" location="./tools/infection.phar" copy="true"/>
+  <phar name="php-cs-fixer" version="^3.13.0" installed="3.64.0" location="./tools/php-cs-fixer.phar" copy="true"/>
 </phive>
diff --git a/composer.json b/composer.json
@@ -11,7 +11,7 @@
         }
     ],
     "require": {
-        "php": "^7.4 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0",
+        "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0",
         "composer-plugin-api": "~2.0"
     },
     "require-dev": {

diff --git a/infection.json.dist b/infection.json.dist
@@ -13,6 +13,11 @@
         "text": "infection.log"
     },
     "mutators": {
-        "@default": true
+        "@default": true,
+        "CastInt": {
+            "ignore": [
+                "ComposerRunParallel\\Scripts\\ParallelScript::__invoke"
+            ]
+        }
     }
 }
diff --git a/src/Executor/AsyncTaskExecutor.php b/src/Executor/AsyncTaskExecutor.php
@@ -41,6 +41,8 @@ public function __invoke(string $task, array $args): PromiseInterface
      * @param list<string> $args
      *
      * @throws ParallelException
+     *
+     * @psalm-suppress RiskyTruthyFalsyComparison
      */
     private function buildProcess(string $task, array $args): string
     {

diff --git a/src/Finder/PhpExecutableFinder.php b/src/Finder/PhpExecutableFinder.php
@@ -32,7 +32,7 @@ public static function default(): self
     public function __invoke(): string
     {
         $phpPath = $this->finder->find(false);
-        if (!$phpPath) {
+        if (false === $phpPath) {
             throw ParallelException::phpBinaryNotFound();
         }
 

diff --git a/src/Result/ResultMap.php b/src/Result/ResultMap.php
@@ -59,7 +59,7 @@ public function listFailedTasks(): array
     }
 
     /**
-     *     @throws ParallelException
+     * @throws ParallelException
      *
      * @return list<string>
      */
@@ -96,7 +96,7 @@ public function getResultCode(): int
      */
     public function conclude(
         callable $onSuccess,
-        callable $onFailure
+        callable $onFailure,
     ) {
         $resultCode = $this->getResultCode();
 

diff --git a/src/Scripts/ParallelScript.php b/src/Scripts/ParallelScript.php
@@ -61,7 +61,7 @@ public function __invoke(Event $event): int
                         static function (Process $process) use ($task, $io, $resultMap): void {
                             $resultMap->registerResult($task, (int) $process->getExitCode());
 
-                            $io->write('<info>Finished task '.$task.'</info>');
+                            $io->write(sprintf('<info>Finished task %s</info>', $task));
                             $io->writeError($process->getErrorOutput());
                             $io->write([$process->getOutput(), '']);
                         }

diff --git a/tests/Unit/Exception/ParallelExceptionTest.php b/tests/Unit/Exception/ParallelExceptionTest.php
@@ -16,6 +16,7 @@ final class ParallelExceptionTest extends TestCase
     public function it_can_throw_exception_on_invalid_amount_of_tasks(): void
     {
         $this->expectException(ParallelException::class);
+        $this->expectExceptionMessage('Expected at least 1 task to run in parallel!');
 
         throw ParallelException::atLeastOneTask();
     }
@@ -24,7 +25,7 @@ public function it_can_throw_exception_on_invalid_amount_of_tasks(): void
     public function it_can_throw_exception_on_unkown_task(): void
     {
         $this->expectException(ParallelException::class);
-        $this->expectExceptionMessage('taskName');
+        $this->expectExceptionMessage('Script "taskName" is not defined in this package');
 
         throw ParallelException::invalidTask('taskName');
     }
@@ -33,7 +34,7 @@ public function it_can_throw_exception_on_unkown_task(): void
     public function it_can_throw_exception_on_no_result_yet_for_task(): void
     {
         $this->expectException(ParallelException::class);
-        $this->expectExceptionMessage('taskName');
+        $this->expectExceptionMessage('Received no result for task taskName yet.');
 
         throw ParallelException::noResultForTaskYet('taskName');
     }
@@ -42,6 +43,9 @@ public function it_can_throw_exception_on_no_result_yet_for_task(): void
     public function it_can_throw_exception_if_composer_does_not_contain_executor(): void
     {
         $this->expectException(ParallelException::class);
+        $this->expectExceptionMessage(
+            'The composer Loop does not contain a ProcessExecutor. Please log an issue with detailed information on how to reproduce!'
+        );
 
         throw ParallelException::noProcessExecutorDetected();
     }
@@ -50,6 +54,7 @@ public function it_can_throw_exception_if_composer_does_not_contain_executor():
     public function it_can_throw_exception_if_php_binary_cannot_be_found(): void
     {
         $this->expectException(ParallelException::class);
+        $this->expectExceptionMessage('Failed to locate PHP binary to execute.');
 
         throw ParallelException::phpBinaryNotFound();
     }

diff --git a/tests/Unit/Finder/PhpExecutableFinderTest.php b/tests/Unit/Finder/PhpExecutableFinderTest.php
@@ -4,6 +4,7 @@
 
 namespace ComposerRunParallel\Test\Unit\Executor;
 
+use Composer\Util\ProcessExecutor;
 use ComposerRunParallel\Exception\ParallelException;
 use ComposerRunParallel\Finder\PhpExecutableFinder;
 use PHPUnit\Framework\TestCase;
@@ -27,6 +28,27 @@ public function it_throws_exception_on_php_executable_not_found(): void
         $phpExecutableFinder();
     }
 
+    /** @test */
+    public function it_can_find_executable(): void
+    {
+        $finder = $this->createMock(SymfonyPhpExecutableFinder::class);
+        $finder->method('find')->with(false)->willReturn('php');
+
+        $phpExecutableFinder = new PhpExecutableFinder($finder);
+        $actual = $phpExecutableFinder();
+
+        $allowUrlFOpenFlag = '-d allow_url_fopen='.ProcessExecutor::escape(ini_get('allow_url_fopen'));
+        $disableFunctionsFlag = '-d disable_functions='.ProcessExecutor::escape(ini_get('disable_functions'));
+        $memoryLimitFlag = '-d memory_limit='.ProcessExecutor::escape(ini_get('memory_limit'));
+
+        self::assertSame(
+            <<<EOCLI
+            'php' {$allowUrlFOpenFlag} {$disableFunctionsFlag} {$memoryLimitFlag}
+            EOCLI,
+            $actual
+        );
+    }
+
     /** @test */
     public function it_can_create_a_default_finder(): void
     {

diff --git a/tests/Unit/Scripts/ParallelScriptTest.php b/tests/Unit/Scripts/ParallelScriptTest.php
@@ -41,13 +41,19 @@ protected function setUp(): void
         $finder->method('find')->willReturn('php');
         $finder->method('findArguments')->willReturn([]);
 
+        // Composer comes with symfony console 2.8, which has deprecated methods:
+        // Deprecated: Return type of Symfony\Component\Console\Helper\HelperSet::getIterator() should either be compatible with IteratorAggregate::getIterator(): Traversable,
+        // Since it's a composer dependency, we can't change it, so we need to suppress the deprecation notice
+        // Let's mute it for now.
+        $previousErrorLevel = error_reporting(0);
         $this->io = new BufferIO();
+        error_reporting($previousErrorLevel);
 
         $dispatcher = $this->createMock(EventDispatcher::class);
         $dispatcher
             ->method('hasEventListeners')
             ->will($this->returnCallback(
-                static fn (Event $event) => in_array($event->getName(), ['task1', 'task2'], true)
+                static fn (Event $event) => in_array($event->getName(), ['task1', 'task2', 'task3', 'task4'], true)
             ));
 
         $this->composer = new Composer();
@@ -81,36 +87,48 @@ public function it_fails_if_a_task_is_not_known(): void
     public function it_can_successfully_run_scripts_in_parallel(): void
     {
         $this->processExecutor->method('executeAsync')->willReturn(
+            $this->createProcessResult(true),
             $this->createProcessResult(true)
         );
 
-        $result = ($this->script)($this->createEvent(['task1']));
+        $result = ($this->script)($this->createEvent(['task1', 'task2']));
 
         self::assertEquals(0, $result);
 
         $output = $this->io->getOutput();
-        self::assertStringContainsString('Finished running: '.PHP_EOL.'task1', $output);
+        self::assertStringContainsString('Running tasks in parallel:'.PHP_EOL.'task1'.PHP_EOL.'task2'.PHP_EOL, $output);
+        self::assertStringContainsString('Finished task task1'.PHP_EOL.'stderr'.PHP_EOL.'stdout'.PHP_EOL, $output);
+        self::assertStringContainsString('Finished task task2'.PHP_EOL.'stderr'.PHP_EOL.'stdout'.PHP_EOL, $output);
+        self::assertStringContainsString('Finished running: '.PHP_EOL.'task1'.PHP_EOL.'task2', $output);
     }
 
     /** @test */
     public function it_can_insuccessfully_run_scripts_in_parallel(): void
     {
         $this->processExecutor->method('executeAsync')->willReturn(
+            $this->createProcessResult(false),
+            $this->createProcessResult(true),
             $this->createProcessResult(false),
             $this->createProcessResult(true)
         );
         $exception = null;
 
         try {
-            ($this->script)($this->createEvent(['task1', 'task2']));
+            ($this->script)($this->createEvent(['task1', 'task2', 'task3', 'task4']));
         } catch (ScriptExecutionException $exception) {
         }
 
         self::assertInstanceOf(ScriptExecutionException::class, $exception);
+        self::assertSame(1, $exception->getCode());
 
         $output = $this->io->getOutput();
-        self::assertStringContainsString('Succesfully ran: '.PHP_EOL.'task2', $output);
-        self::assertStringContainsString('Failed running: '.PHP_EOL.'task1', $output);
+        self::assertStringContainsString('Running tasks in parallel:'.PHP_EOL.'task1'.PHP_EOL.'task2'.PHP_EOL.'task3'.PHP_EOL.'task4'.PHP_EOL, $output);
+        self::assertStringContainsString('Finished task task1'.PHP_EOL.'stderr'.PHP_EOL.'stdout'.PHP_EOL, $output);
+        self::assertStringContainsString('Finished task task2'.PHP_EOL.'stderr'.PHP_EOL.'stdout'.PHP_EOL, $output);
+        self::assertStringContainsString('Finished task task3'.PHP_EOL.'stderr'.PHP_EOL.'stdout'.PHP_EOL, $output);
+        self::assertStringContainsString('Finished task task4'.PHP_EOL.'stderr'.PHP_EOL.'stdout'.PHP_EOL, $output);
+        self::assertStringContainsString('Succesfully ran: '.PHP_EOL.'task2'.PHP_EOL.'task4', $output);
+        self::assertStringContainsString('Failed running: '.PHP_EOL.'task1'.PHP_EOL.'task3', $output);
         self::assertStringContainsString('Not all tasks could be executed successfully!', $output);
     }
 

diff --git a/tools/full-coverage-check.php b/tools/full-coverage-check.php
@@ -11,7 +11,7 @@
     $checkedElements = (int) current($xml->xpath('/coverage/project/metrics/@coveredelements'));
     $coverage = round(($checkedElements / $totalElements) * 100, 2);
 
-    if ($coverage !== 100) {
+    if ($coverage !== 100.0) {
         echo('Expected coverage of 100%, only got '.$coverage.'%.'.PHP_EOL);
         exit(1);
     }

diff --git a/tools/infection.phar b/tools/infection.phar
diff --git a/tools/php-cs-fixer.phar b/tools/php-cs-fixer.phar