chore(NEXT-35679): Code clean up

shopware · May 29, 2024 · 700211c · 700211c
1 parent 1111a8f
commit 700211c
Show file tree

Hide file tree

Showing 50 changed files with 378 additions and 249 deletions.
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [8.2, 8.3]
+        php: [ 8.2, 8.3 ]
     steps:
       - uses: actions/checkout@v4
 
@@ -24,7 +24,7 @@ jobs:
         run: composer install
 
       - name: Run tests
-        run: vendor/bin/phpunit --coverage-cobertura coverage.xml
+        run: composer test-coverage-cobertura
 
       - name: Upload coverage
         uses: codecov/codecov-action@v4
@@ -46,7 +46,7 @@ jobs:
         run: composer install
 
       - name: Run PHPStan
-        run: vendor/bin/phpstan analyse
+        run: composer phpstan
 
   cs:
     runs-on: ubuntu-latest
@@ -62,4 +62,4 @@ jobs:
         run: composer install
 
       - name: Run PHP CS Fixer
-        run: vendor/bin/php-cs-fixer fix --dry-run --diff
+        run: composer cs-dry
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@
 /composer.lock
 /.php-cs-fixer.cache
 /.phpunit.cache
+/var/cache
+/build/coverage
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -2,29 +2,24 @@
 
 use PhpCsFixer\Config;
 use PhpCsFixer\Finder;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
 
 return (new Config())
     ->setRiskyAllowed(true)
+    ->setParallelConfig(ParallelConfigFactory::detect())
     ->setRules([
-        '@PER-CS2.0' => true,
-        '@PER-CS2.0:risky' => true,
-        // Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line.
-        'blank_line_after_opening_tag' => false,
-        // Ensure there is no code on the same line as the PHP open tag.
-        'linebreak_after_opening_tag' => false,
-        // We use the attribute CoversClass which is not recognized by php-cs-fixer
-        'php_unit_test_class_requires_covers' => false,
-        'yoda_style' => [
-            'equal' => false,
-            'identical' => false,
-            'less_and_greater' => false,
-        ],
-        'no_unused_imports' => true,
-        'declare_strict_types' => true,
+        '@PER-CS' => true,
+        '@PER-CS:risky' => true,
+        '@PHP84Migration' => true,
+        '@PHP80Migration:risky' => true,
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
+        'concat_space' => ['spacing' => 'one'],
     ])
     ->setFinder(
         Finder::create()
-            ->exclude('vendor')
+            ->name('shopware-deployment-helper')
             ->in(__DIR__),
     )
 ;
diff --git a/bin/shopware-deployment-helper b/bin/shopware-deployment-helper
@@ -1,6 +1,8 @@
 #!/usr/bin/env php
 <?php
 
+declare(strict_types=1);
+
 use Shopware\Deployment\Application;
 
 error_reporting(-1);
@@ -10,7 +12,7 @@ $includables = [
     __DIR__ . '/../../../autoload.php',
     __DIR__ . '/../../vendor/autoload.php',
     __DIR__ . '/../vendor/autoload.php',
-    __DIR__ . '/vendor/autoload.php'
+    __DIR__ . '/vendor/autoload.php',
 ];
 
 if (str_contains(__DIR__, 'custom/plugins')) {
@@ -19,7 +21,7 @@ if (str_contains(__DIR__, 'custom/plugins')) {
 
 foreach ($includables as $file) {
     if (file_exists($file)) {
-        include_once ($file);
+        include_once $file;
 
         break;
     }

diff --git a/composer.json b/composer.json
@@ -9,36 +9,56 @@
     ],
     "require": {
         "php": ">=8.2",
-        "ext-pdo": "*",
         "ext-dom": "*",
+        "ext-pdo": "*",
+        "digilist/dependency-graph": ">=0.4.1",
         "doctrine/dbal": "^3.0 || ^4.0",
-        "symfony/dotenv": "^7.0 || ^6.0",
-        "symfony/process": "^7.0 || ^6.0",
-        "symfony/event-dispatcher": "^7.0 || ^6.0",
-        "symfony/dependency-injection": "^7.0 || ^6.0",
         "symfony/config": "^7.0 || ^6.0",
         "symfony/console": "^7.0 || ^6.0",
-        "symfony/yaml": "^7.0 || ^6.0",
+        "symfony/dependency-injection": "^7.0 || ^6.0",
+        "symfony/dotenv": "^7.0 || ^6.0",
+        "symfony/event-dispatcher": "^7.0 || ^6.0",
+        "symfony/filesystem": "^7.0 || ^6.0",
         "symfony/finder": "^7.0 || ^6.0",
-        "digilist/dependency-graph": "*"
+        "symfony/process": "^7.0 || ^6.0",
+        "symfony/yaml": "^7.0 || ^6.0"
     },
     "require-dev": {
-        "symfony/var-dumper": "^7.0 || ^6.0",
-        "phpunit/phpunit": "^11.0",
-        "phpstan/phpstan": "^1.10",
-        "phpstan/phpstan-phpunit": "^1.0",
-        "phpstan/phpstan-symfony": "^1.3",
+        "friendsofphp/php-cs-fixer": "3.57.2",
         "phpstan/extension-installer": "1.3.1",
-        "friendsofphp/php-cs-fixer": "~3.53.0"
+        "phpstan/phpstan": "1.11.2",
+        "phpstan/phpstan-deprecation-rules": "1.2.0",
+        "phpstan/phpstan-phpunit": "1.4.0",
+        "phpstan/phpstan-strict-rules": "1.6.0",
+        "phpstan/phpstan-symfony": "1.4.1",
+        "phpunit/phpunit": "11.1.3",
+        "symfony/var-dumper": "^7.0 || ^6.0"
     },
     "autoload": {
         "psr-4": {
             "Shopware\\Deployment\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Shopware\\Deployment\\Tests\\": "tests/"
+        }
+    },
     "config": {
+        "sort-packages": true,
         "allow-plugins": {
             "phpstan/extension-installer": true
         }
+    },
+    "scripts": {
+        "cs-dry": "php-cs-fixer fix --dry-run --diff",
+        "cs-fix": "php-cs-fixer fix",
+        "phpstan": [
+            "DEV_MODE=true PROJECT_ROOT=. bin/shopware-deployment-helper -q",
+            "phpstan"
+        ],
+        "test": "phpunit",
+        "test-coverage-html": "phpunit --coverage-html=build/coverage",
+        "test-coverage-cobertura": "phpunit --coverage-cobertura coverage.xml"
     }
 }
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,4 +1,10 @@
+includes:
+	- phar://phpstan.phar/conf/bleedingEdge.neon
+
 parameters:
 	level: 8
+	treatPhpDocTypesAsCertain: false
 	paths:
 		- src
+	symfony:
+		containerXmlPath: var/cache/container.xml
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -5,7 +5,6 @@
          cacheDirectory=".phpunit.cache"
          executionOrder="depends,defects"
          requireCoverageMetadata="true"
-         beStrictAboutCoverageMetadata="false"
          beStrictAboutOutputDuringTests="true"
          failOnRisky="true"
          failOnWarning="true">
@@ -15,7 +14,9 @@
         </testsuite>
     </testsuites>
 
-    <source ignoreIndirectDeprecations="true" restrictNotices="true" restrictWarnings="true">
+    <source ignoreIndirectDeprecations="true"
+            restrictNotices="true"
+            restrictWarnings="true">
         <include>
             <directory>src</directory>
         </include>

diff --git a/src/Application.php b/src/Application.php
@@ -13,8 +13,10 @@
 use Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass;
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Dumper\XmlDumper;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
+use Symfony\Component\Filesystem\Filesystem;
 
 class Application extends SymfonyApplication
 {
@@ -24,9 +26,7 @@ public function __construct()
     {
         parent::__construct('Shopware Deployment Helper', '__VERSION__');
         $this->container = $this->createContainer();
-        // @phpstan-ignore-next-line
         $this->setDispatcher($this->container->get('event_dispatcher'));
-        // @phpstan-ignore-next-line
         $this->setCommandLoader($this->container->get('console.command_loader'));
     }
 
@@ -54,6 +54,10 @@ private function createContainer(): ContainerBuilder
         $loader->load('services.xml');
         $container->compile();
 
+        if (EnvironmentHelper::hasVariable('DEV_MODE')) {
+            (new Filesystem())->dumpFile(\dirname(__DIR__) . '/var/cache/container.xml', (new XmlDumper($container))->dump());
+        }
+
         return $container;
     }
 
@@ -62,7 +66,8 @@ private function createContainer(): ContainerBuilder
      */
     private function getProjectDir(): string
     {
-        if ($root = EnvironmentHelper::getVariable('PROJECT_ROOT')) {
+        $root = EnvironmentHelper::getVariable('PROJECT_ROOT');
+        if (\is_string($root) && $root !== '') {
             return $root;
         }
 

diff --git a/src/Command/OneTimeTaskListCommand.php b/src/Command/OneTimeTaskListCommand.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace Shopware\Deployment\Command;
 

diff --git a/src/Command/OneTimeTaskMarkCommand.php b/src/Command/OneTimeTaskMarkCommand.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace Shopware\Deployment\Command;
 
@@ -12,7 +14,7 @@
 
 #[AsCommand(
     name: 'one-time-task:mark',
-    description: 'Mark a one-time task as run without executing it',
+    description: 'Mark an one-time task as run without executing it',
 )]
 class OneTimeTaskMarkCommand extends Command
 {
@@ -31,7 +33,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io = new SymfonyStyle($input, $output);
 
         try {
-            $this->oneTimeTasks->markAsRun($input->getArgument('id'));
+            $this->oneTimeTasks->markAsRun((string) $input->getArgument('id'));
         } catch (\Throwable) {
             $io->error('Could not mark one-time task as run, as it has been marked as run before.');
 

diff --git a/src/Command/OneTimeTaskUnmarkCommand.php b/src/Command/OneTimeTaskUnmarkCommand.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace Shopware\Deployment\Command;
 
@@ -12,7 +14,7 @@
 
 #[AsCommand(
     name: 'one-time-task:unmark',
-    description: 'Unmark a one-time task as run without executing it',
+    description: 'Unmark an one-time task as run without executing it',
 )]
 class OneTimeTaskUnmarkCommand extends Command
 {
@@ -30,7 +32,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
-        $this->oneTimeTasks->remove($input->getArgument('id'));
+        $this->oneTimeTasks->remove((string) $input->getArgument('id'));
 
         $io->success('One-time task mark has been removed, this script will be executed on next deployment.');
 

diff --git a/src/Command/RunCommand.php b/src/Command/RunCommand.php
@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace Shopware\Deployment\Command;
 
@@ -27,33 +29,32 @@ public function __construct(
 
     protected function configure(): void
     {
-        $this->addOption('skip-theme-compile', null, InputOption::VALUE_OPTIONAL, 'Skip theme compile (should be used when the Theme has been compiled before in the CI/CD)', false);
-        $this->addOption('skip-asset-install', null, InputOption::VALUE_OPTIONAL, 'Skip asset install (should be used when the Assets has been copied before in the CI/CD)', false);
-        $this->addOption('timeout', null, InputOption::VALUE_OPTIONAL, 'Set script execution timeout (is seconds). Set to null to disable timeout', 300);
+        $this->addOption('skip-theme-compile', null, InputOption::VALUE_OPTIONAL, 'Skip theme compile (Should be used when the theme has been compiled before in the CI/CD)', false);
+        $this->addOption('skip-asset-install', null, InputOption::VALUE_OPTIONAL, 'Skip asset install (Should be used when the assets have been copied before in the CI/CD)', false);
+        $this->addOption('timeout', null, InputOption::VALUE_OPTIONAL, 'Set script execution timeout (in seconds). Set to null to disable timeout', 300);
     }
 
-
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $timeout = $input->getOption('timeout');
 
         $config = new RunConfiguration(
             skipThemeCompile: (bool) $input->getOption('skip-theme-compile'),
             skipAssetInstall: (bool) $input->getOption('skip-asset-install'),
-            timeout: $timeout ? (float) $timeout : null,
+            timeout: is_numeric($timeout) ? (float) $timeout : null,
         );
 
         $installed = $this->state->isInstalled();
 
-        $this->hookExecutor->execute(HookExecutor::PRE);
+        $this->hookExecutor->execute(HookExecutor::HOOK_PRE);
 
         if ($installed) {
             $this->upgradeManager->run($config, $output);
         } else {
             $this->installationManager->run($config, $output);
         }
 
-        $this->hookExecutor->execute(HookExecutor::POST);
+        $this->hookExecutor->execute(HookExecutor::HOOK_POST);
 
         return Command::SUCCESS;
     }