From 324413e01d0742e8fc81e36bcd93a1183f0bca3d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 7 Feb 2025 16:20:52 +0000 Subject: [PATCH] chore(deps): update dependency phpstan/phpstan to v2 --- composer.lock | 12 ++-- phpstan.neon | 2 +- .../Business/Model/DeployTasksExecutor.php | 32 +++++++-- .../Business/Model/DeployTasksFileReader.php | 2 +- .../Business/Model/DeployTasksLogger.php | 2 +- .../Business/Model/DeployTasksProcessor.php | 9 ++- .../Business/Model/DeployTasksValidator.php | 10 +-- .../Model/DeployTasksVersionJournal.php | 2 +- .../Business/DeployTasksExecutorTest.php | 4 +- .../Business/DeployTasksFileReaderTest.php | 2 - .../Business/DeployTasksValidatorTest.php | 72 +++++++++---------- .../_support/Helper/PropelInstallHelper.php | 2 +- 12 files changed, 85 insertions(+), 66 deletions(-) diff --git a/composer.lock b/composer.lock index be527c3..f7fe4e4 100644 --- a/composer.lock +++ b/composer.lock @@ -11204,20 +11204,20 @@ }, { "name": "phpstan/phpstan", - "version": "1.12.17", + "version": "2.1.3", "source": { "type": "git", "url": "https://github.com/phpstan/phpstan.git", - "reference": "7027b3b0270bf392de0cfba12825979768d728bf" + "reference": "64ae44e48214f3deebdaeebf2694297a10a2bea9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpstan/phpstan/zipball/7027b3b0270bf392de0cfba12825979768d728bf", - "reference": "7027b3b0270bf392de0cfba12825979768d728bf", + "url": "https://api.github.com/repos/phpstan/phpstan/zipball/64ae44e48214f3deebdaeebf2694297a10a2bea9", + "reference": "64ae44e48214f3deebdaeebf2694297a10a2bea9", "shasum": "" }, "require": { - "php": "^7.2|^8.0" + "php": "^7.4|^8.0" }, "conflict": { "phpstan/phpstan-shim": "*" @@ -11258,7 +11258,7 @@ "type": "github" } ], - "time": "2025-02-07T15:01:57+00:00" + "time": "2025-02-07T15:05:24+00:00" }, { "name": "phpunit/php-code-coverage", diff --git a/phpstan.neon b/phpstan.neon index 991a4ae..76410f6 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -20,7 +20,7 @@ parameters: - '%rootDir%/../../../tests/TurbineKreuzbergTest/Zed/DeployTasks/_output/*' - '%rootDir%/../../../tests/TurbineKreuzbergTest/Zed/DeployTasks/_support/_generated/*' - checkMissingIterableValueType: false + treatPhpDocTypesAsCertain: false reportUnmatchedIgnoredErrors: false diff --git a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksExecutor.php b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksExecutor.php index 1f2d3d1..27ba3a0 100644 --- a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksExecutor.php +++ b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksExecutor.php @@ -45,7 +45,9 @@ public function execute(array $task): bool return true; } - /** @var string $command */ + /** + * @var string $command + */ $command = $task[DeployTasksConstants::YAML_KEY_COMMAND]; $this->tasksLogger->writeOutput(sprintf('Execute: %s', $command)); @@ -87,23 +89,31 @@ public function execute(array $task): bool } /** - * @param array $task + * @param array> $task * * @return bool */ private function isExecutionSkippedForCurrentStore(array $task): bool { - $storeToExecuteFor = $task[DeployTasksConstants::YAML_KEY_EXECUTE_FOR_STORE]; + /** + * @var array $storesToExecuteFor + */ + $storesToExecuteFor = $task[DeployTasksConstants::YAML_KEY_EXECUTE_FOR_STORE]; $currentStore = getenv('APPLICATION_STORE'); - if (in_array($currentStore, $storeToExecuteFor, true)) { + if (in_array($currentStore, $storesToExecuteFor, true)) { return false; } + /** + * @var string $command + */ + $command = $task[DeployTasksConstants::YAML_KEY_COMMAND]; + $this->tasksLogger->writeOutput( sprintf( "Command '%s' will be skipped for store '%s'", - $task[DeployTasksConstants::YAML_KEY_COMMAND], + $command, $currentStore, ), ); @@ -112,12 +122,15 @@ private function isExecutionSkippedForCurrentStore(array $task): bool } /** - * @param array $task + * @param array> $task * * @return bool */ private function isExecutionSkippedInCurrentEnvironment(array $task): bool { + /** + * @var array $environmentsToExecuteOn + */ $environmentsToExecuteOn = $task[DeployTasksConstants::YAML_KEY_EXECUTE_ON]; $currentEnvironment = getenv('SHOP_ENV'); @@ -125,10 +138,15 @@ private function isExecutionSkippedInCurrentEnvironment(array $task): bool return false; } + /** + * @var string $command + */ + $command = $task[DeployTasksConstants::YAML_KEY_COMMAND]; + $this->tasksLogger->writeOutput( sprintf( "Command '%s' will be skipped in env '%s'", - $task[DeployTasksConstants::YAML_KEY_COMMAND], + $command, $currentEnvironment, ), ); diff --git a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksFileReader.php b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksFileReader.php index 67191f9..1b5a4c5 100644 --- a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksFileReader.php +++ b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksFileReader.php @@ -44,7 +44,7 @@ public function getFilesToExecute(): array /** * @param string $filePath * - * @return array>> + * @return array>>> */ public function readTasksFromFile(string $filePath): array { diff --git a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksLogger.php b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksLogger.php index 19820f3..e677c09 100644 --- a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksLogger.php +++ b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksLogger.php @@ -15,7 +15,7 @@ public function __construct() } /** - * @SuppressWarnings(PHPMD.BooleanArgumentFlag) + * @SuppressWarnings("PHPMD.BooleanArgumentFlag") * * @param string $message * @param bool $addDateTime diff --git a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksProcessor.php b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksProcessor.php index 6f304b9..56a6f4b 100644 --- a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksProcessor.php +++ b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksProcessor.php @@ -74,9 +74,12 @@ public function execute(): void $this->tasksLogger->printSeparatorLine(); $tasks = $this->tasksFileReader->readTasksFromFile($taskFile); - $validatedTasks = $this->tasksValidator->validate($tasks); + $validatedTasksArray = $this->tasksValidator->validate($tasks); - if ($this->executeTasks($validatedTasks[DeployTasksConstants::YAML_KEY_TASKS])) { + /** @var array>> $validatedTasks */ + $validatedTasks = $validatedTasksArray[DeployTasksConstants::YAML_KEY_TASKS]; + + if ($this->executeTasks($validatedTasks)) { $this->tasksVersionJournal->saveExecutedVersion((int)$timestamp); } } @@ -85,7 +88,7 @@ public function execute(): void } /** - * @param array $tasks + * @param array>> $tasks * * @return bool */ diff --git a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksValidator.php b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksValidator.php index cc5d4f2..73476eb 100644 --- a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksValidator.php +++ b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksValidator.php @@ -13,9 +13,9 @@ class DeployTasksValidator { /** - * @param array $tasks + * @param array>>> $tasks * - * @return array + * @return array>>> */ public function validate(array $tasks): array { @@ -26,7 +26,7 @@ public function validate(array $tasks): array } /** - * @param array $tasks + * @param array>>> $tasks * * @throws \TurbineKreuzberg\Zed\DeployTasks\Business\Exception\NoTasksKeyException * @throws \TurbineKreuzberg\Zed\DeployTasks\Business\Exception\NoTasksArrayException @@ -45,7 +45,7 @@ private function validateStructure(array $tasks): void } /** - * @param array $tasks + * @param array>> $tasks * * @throws \TurbineKreuzberg\Zed\DeployTasks\Business\Exception\TaskCommandNotAStringException * @throws \TurbineKreuzberg\Zed\DeployTasks\Business\Exception\TaskExecuteOnNotAnArrayException @@ -91,7 +91,7 @@ private function validateTasks(array $tasks): void } /** - * @param array $task + * @param array> $task * @param int $taskNumber * * @throws \TurbineKreuzberg\Zed\DeployTasks\Business\Exception\TaskMandatoryKeyMissingException diff --git a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksVersionJournal.php b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksVersionJournal.php index 99c0990..ab5aae7 100644 --- a/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksVersionJournal.php +++ b/src/TurbineKreuzberg/Zed/DeployTasks/Business/Model/DeployTasksVersionJournal.php @@ -22,7 +22,7 @@ public function __construct(TxbDeployTasksQuery $tasksQuery) } /** - * @return array + * @return array */ public function getExecutedVersions(): array { diff --git a/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksExecutorTest.php b/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksExecutorTest.php index 7f0bb9d..8382302 100644 --- a/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksExecutorTest.php +++ b/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksExecutorTest.php @@ -29,7 +29,7 @@ class DeployTasksExecutorTest extends Unit /** * @dataProvider tasksToExecuteDataProvider * - * @param array $task + * @param array> $task * @param bool $expectedResult * @param string|null $expectedOutput * @@ -64,7 +64,7 @@ private function createDeployTasksExecutor(): DeployTasksExecutor } /** - * @return array + * @return array> */ public function tasksToExecuteDataProvider(): array { diff --git a/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksFileReaderTest.php b/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksFileReaderTest.php index 204981c..575df0f 100644 --- a/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksFileReaderTest.php +++ b/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksFileReaderTest.php @@ -52,7 +52,6 @@ public function testFileReaderReturnsCorrectArrayOfFilesToBeExecuted(): void codecept_debug(compact('filesToExecute')); $countAllFiles = 4; - self::assertIsArray($filesToExecute); self::assertCount($countAllFiles, $filesToExecute); $firstVersionExecuted = 123456789; @@ -92,7 +91,6 @@ public function testFileReaderReturnsArrayWithCorrectOrderOfVersionKeys(): void $previousVersion = null; foreach ($versions as $version) { - self::assertIsInt($version); self::assertGreaterThan(0, $version); // @phpstan-ignore-next-line diff --git a/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksValidatorTest.php b/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksValidatorTest.php index 22f58b5..4a9c2a3 100644 --- a/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksValidatorTest.php +++ b/tests/TurbineKreuzbergTest/Zed/DeployTasks/Business/DeployTasksValidatorTest.php @@ -53,46 +53,46 @@ public function testTasksFilesAreCorrectlyValidated(string $file, ?string $expec } /** - * @return array + * @return array> */ public function invalidTasksDataProvider(): array { return [ - 'valid-tasks' => [ - 'file' => 'tasks.valid.yml', - ], - 'missing-tasks-key' => [ - 'file' => 'tasks.invalid.missing-tasks.yml', - 'expectedException' => NoTasksKeyException::class, - ], - 'tasks-not-an-array' => [ - 'file' => 'tasks.invalid.tasks-not-an-array.yml', - 'expectedException' => NoTasksArrayException::class, - ], - 'task-not-an-array' => [ - 'file' => 'tasks.invalid.task-not-an-array.yml', - 'expectedException' => InvalidTaskFormatException::class, - ], - 'task-key-command-missing' => [ - 'file' => 'tasks.invalid.key-command-missing.yml', - 'expectedException' => TaskMandatoryKeyMissingException::class, - ], - 'task-key-execute_on-missing' => [ - 'file' => 'tasks.invalid.key-execute_on-missing.yml', - 'expectedException' => TaskMandatoryKeyMissingException::class, - ], - 'task-key-execute_for_store-missing' => [ - 'file' => 'tasks.invalid.key-execute_for_store-missing.yml', - 'expectedException' => TaskMandatoryKeyMissingException::class, - ], - 'task-command-is-not-a-string' => [ - 'file' => 'tasks.invalid.task-command-not-string.yml', - 'expectedException' => TaskCommandNotAStringException::class, - ], - 'task-execute_on-not-an-array' => [ - 'file' => 'tasks.invalid.execute_on-not-an-array.yml', - 'expectedException' => TaskExecuteOnNotAnArrayException::class, - ], + 'valid-tasks' => [ + 'file' => 'tasks.valid.yml', + ], + 'missing-tasks-key' => [ + 'file' => 'tasks.invalid.missing-tasks.yml', + 'expectedException' => NoTasksKeyException::class, + ], + 'tasks-not-an-array' => [ + 'file' => 'tasks.invalid.tasks-not-an-array.yml', + 'expectedException' => NoTasksArrayException::class, + ], + 'task-not-an-array' => [ + 'file' => 'tasks.invalid.task-not-an-array.yml', + 'expectedException' => InvalidTaskFormatException::class, + ], + 'task-key-command-missing' => [ + 'file' => 'tasks.invalid.key-command-missing.yml', + 'expectedException' => TaskMandatoryKeyMissingException::class, + ], + 'task-key-execute_on-missing' => [ + 'file' => 'tasks.invalid.key-execute_on-missing.yml', + 'expectedException' => TaskMandatoryKeyMissingException::class, + ], + 'task-key-execute_for_store-missing' => [ + 'file' => 'tasks.invalid.key-execute_for_store-missing.yml', + 'expectedException' => TaskMandatoryKeyMissingException::class, + ], + 'task-command-is-not-a-string' => [ + 'file' => 'tasks.invalid.task-command-not-string.yml', + 'expectedException' => TaskCommandNotAStringException::class, + ], + 'task-execute_on-not-an-array' => [ + 'file' => 'tasks.invalid.execute_on-not-an-array.yml', + 'expectedException' => TaskExecuteOnNotAnArrayException::class, + ], ]; } } diff --git a/tests/TurbineKreuzbergTest/Zed/DeployTasks/_support/Helper/PropelInstallHelper.php b/tests/TurbineKreuzbergTest/Zed/DeployTasks/_support/Helper/PropelInstallHelper.php index 99acc54..aae60c1 100644 --- a/tests/TurbineKreuzbergTest/Zed/DeployTasks/_support/Helper/PropelInstallHelper.php +++ b/tests/TurbineKreuzbergTest/Zed/DeployTasks/_support/Helper/PropelInstallHelper.php @@ -50,7 +50,7 @@ private function runCommands(): void } /** - * @return array + * @return array */ private function getCommands(): array {