MCLOUD-13147: Added PHP8.4 fixation with PHPUnit, PHPStan & PHPMD compatibility

prateek-karanpuria-adobe · prateek-karanpuria-adobe · commit 798b99c93d25 · 2025-01-11T01:32:06.000+05:30
diff --git a/composer.json b/composer.json
@@ -26,9 +26,10 @@
         "codeception/module-rest": "^1.2 || ^3.0",
         "consolidation/robo": "^2.0 || ^3.0",
         "phpmd/phpmd": "@stable",
-        "phpstan/phpstan": "^1.8",
-        "phpunit/phpunit": "^9.5",
-        "squizlabs/php_codesniffer": "^3.6"
+        "phpstan/phpstan": "^1.8 || ^2.0",
+        "phpunit/php-code-coverage": "^10.1",
+        "phpunit/phpunit": "^9.5 || ^10.5",
+        "squizlabs/php_codesniffer": "^3.7"
     },
     "bin": [
         "bin/ece-docker"
@@ -37,7 +38,8 @@
         "psr-4": {
             "Magento\\CloudDocker\\": "src/",
             "Magento\\CloudDocker\\Test\\Integration\\": "tests/integration",
-            "Magento\\CloudDocker\\Test\\Functional\\": "tests/functional/"
+            "Magento\\CloudDocker\\Test\\Functional\\": "tests/functional/",
+            "Magento\\CloudDocker\\Test\\Functional\\Support\\": "tests/functional/_support/"
         }
     },
     "scripts": {
@@ -55,7 +57,8 @@
         "test:integration": "phpunit --configuration tests/integration"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "optimize-autoloader": true
     },
     "prefer-stable": true,
     "extra": {
diff --git a/src/Application.php b/src/Application.php
@@ -13,7 +13,7 @@
 /**
  * @inheritdoc
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class Application extends \Symfony\Component\Console\Application
 {
diff --git a/src/Command/BuildCompose.php b/src/Command/BuildCompose.php
@@ -25,7 +25,7 @@
 /**
  * Builds Docker configuration for Magento project.
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class BuildCompose extends Command
 {
@@ -82,7 +82,7 @@ public function __construct(
     /**
      * {@inheritdoc}
      *
-     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+     * @SuppressWarnings("PHPMD.ExcessiveMethodLength")
      */
     protected function configure(): void
     {
diff --git a/src/Command/BuildCustomCompose.php b/src/Command/BuildCustomCompose.php
@@ -27,7 +27,7 @@
 /**
  * Build configuration from custom-provided source.
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class BuildCustomCompose extends Command
 {
diff --git a/src/Command/Image/GeneratePhp.php b/src/Command/Image/GeneratePhp.php
@@ -218,9 +218,9 @@ private function build(string $version, string $edition): void
      * @throws ConfigurationMismatchException
      * @throws FileNotFoundException
      *
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     * @SuppressWarnings(PHPMD.NPathComplexity)
-     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     * @SuppressWarnings("PHPMD.NPathComplexity")
+     * @SuppressWarnings("PHPMD.ExcessiveMethodLength")
      */
     private function buildDockerfile(string $dockerfile, string $phpVersion, string $edition): string
     {
diff --git a/src/Compose/DeveloperBuilder.php b/src/Compose/DeveloperBuilder.php
@@ -84,7 +84,7 @@ public function __construct(
     /**
      * {@inheritDoc}
      *
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     public function build(Config $config): Manager
     {
diff --git a/src/Compose/Php/ExtensionResolver.php b/src/Compose/Php/ExtensionResolver.php
@@ -158,7 +158,7 @@ public function get(Config $config): array
     /**
      * @return array
      *
-     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+     * @SuppressWarnings("PHPMD.ExcessiveMethodLength")
      */
     public static function getConfig(): array
     {
diff --git a/src/Compose/ProductionBuilder.php b/src/Compose/ProductionBuilder.php
@@ -83,9 +83,9 @@ public function __construct(
     /**
      * {@inheritdoc}
      *
-     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     * @SuppressWarnings(PHPMD.NPathComplexity)
+     * @SuppressWarnings("PHPMD.ExcessiveMethodLength")
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     * @SuppressWarnings("PHPMD.NPathComplexity")
      */
     public function build(Config $config): Manager
     {
diff --git a/src/Config/Source/CliSource.php b/src/Config/Source/CliSource.php
@@ -166,9 +166,9 @@ public function __construct(InputInterface $input)
     /**
      * {@inheritDoc}
      *
-     * @SuppressWarnings(PHPMD.NPathComplexity)
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
-     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+     * @SuppressWarnings("PHPMD.NPathComplexity")
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
+     * @SuppressWarnings("PHPMD.ExcessiveMethodLength")
      */
     public function read(): Repository
     {
diff --git a/src/Service/ServiceFactory.php b/src/Service/ServiceFactory.php
@@ -191,7 +191,7 @@ public function __construct(FileList $fileList)
      * @param string $name
      * @param string $version
      * @param array $config
-     * @param string $image
+     * @param string|null $image
      * @param string|null $customRegistry
      * @param string|null $imagePattern
      * @return array
@@ -201,9 +201,9 @@ public function create(
         string $name,
         string $version,
         array $config = [],
-        string $image = null,
-        string $customRegistry = null,
-        string $imagePattern = null
+        ?string $image = null,
+        ?string $customRegistry = null,
+        ?string $imagePattern = null
     ): array {
         if (!array_key_exists($name, self::$config)) {
             throw new ConfigurationMismatchException(sprintf(
diff --git a/src/Test/Unit/Config/Dist/GeneratorTest.php b/src/Test/Unit/Config/Dist/GeneratorTest.php
@@ -190,25 +190,36 @@ public function testGenerate(): void
                     'exported_application_value',
                 ]
             ]);
+
         $this->filesystemMock->expects($this->exactly(2))
             ->method('put')
-            ->withConsecutive(
-                [$rootDir . '/config.php.dist', $this->getConfigForUpdate()],
-                [
-                    $rootDir . '/config.env',
-                    'MAGENTO_CLOUD_RELATIONSHIPS=base64_relationship_value' . PHP_EOL
-                    . 'MAGENTO_CLOUD_ROUTES=base64_routes_value' . PHP_EOL
-                    . 'MAGENTO_CLOUD_VARIABLES=base64_variables_value' . PHP_EOL
-                    . 'MAGENTO_CLOUD_APPLICATION=base64_application_value' . PHP_EOL
+            ->willReturnCallback(function ($file, $content) use ($rootDir) {
+                static $expectedCalls = [
+                    [
+                        $rootDir . '/config.php.dist',
+                        $this->getConfigForUpdate(),
+                    ],
+                    [
+                        $rootDir . '/config.env',
+                        'MAGENTO_CLOUD_RELATIONSHIPS=base64_relationship_value' . PHP_EOL
+                        . 'MAGENTO_CLOUD_ROUTES=base64_routes_value' . PHP_EOL
+                        . 'MAGENTO_CLOUD_VARIABLES=base64_variables_value' . PHP_EOL
+                        . 'MAGENTO_CLOUD_APPLICATION=base64_application_value' . PHP_EOL,
+                    ],
+                ];
 
-                ]
-            );
+                $expectedCall = array_shift($expectedCalls);
+
+                $this->assertSame($expectedCall[0], $file);
+                $this->assertSame($expectedCall[1], $content);
+            });
 
         $this->distGenerator->generate($config);
     }
 
     /**
      * @return string
+     * @SuppressWarnings("PHPMD.UnusedPrivateMethod")
      */
     private function getConfigForUpdate(): string
     {
diff --git a/src/Test/Unit/Config/RelationshipTest.php b/src/Test/Unit/Config/RelationshipTest.php
@@ -104,35 +104,73 @@ public function testGet()
 
         $this->configMock->expects($this->exactly(8))
             ->method('hasServiceEnabled')
-            ->withConsecutive(
-                [ServiceInterface::SERVICE_DB],
-                [ServiceInterface::SERVICE_DB_QUOTE],
-                [ServiceInterface::SERVICE_DB_SALES],
-                ['redis'],
-                ['elasticsearch'],
-                ['opensearch'],
-                ['rabbitmq'],
-                ['zookeeper']
-            )
-            ->willReturnOnConsecutiveCalls(true, false, false, true, true, true, true, true);
+            ->willReturnCallback(function ($service) {
+                static $services = [
+                    ServiceInterface::SERVICE_DB,
+                    ServiceInterface::SERVICE_DB_QUOTE,
+                    ServiceInterface::SERVICE_DB_SALES,
+                    'redis',
+                    'elasticsearch',
+                    'opensearch',
+                    'rabbitmq',
+                    'zookeeper'
+                ];
+
+                static $responses = [
+                    true,
+                    false,
+                    false,
+                    true,
+                    true,
+                    true,
+                    true,
+                    true
+                ];
+
+                $expectedService = array_shift($services);
+                $expectedResponse = array_shift($responses);
+
+                $this->assertSame($expectedService, $service);
+
+                return $expectedResponse;
+            });
+
         $this->configMock->expects($this->exactly(6))
             ->method('getServiceVersion')
-            ->withConsecutive(
-                [ServiceInterface::SERVICE_DB],
-                ['redis'],
-                ['elasticsearch'],
-                ['opensearch'],
-                ['rabbitmq'],
-                ['zookeeper']
-            )
-            ->willReturnOnConsecutiveCalls(
+            ->willReturnCallback(function ($service) use (
                 $mysqlVersion,
                 $redisVersion,
                 $esVersion,
                 $osVersion,
                 $rmqVersion,
                 $zookeeperVersion
-            );
+            ) {
+                static $services = [
+                    ServiceInterface::SERVICE_DB,
+                    'redis',
+                    'elasticsearch',
+                    'opensearch',
+                    'rabbitmq',
+                    'zookeeper'
+                ];
+
+                static $versions = [
+                    $mysqlVersion,
+                    $redisVersion,
+                    $esVersion,
+                    $osVersion,
+                    $rmqVersion,
+                    $zookeeperVersion
+                ];
+
+                $expectedService = array_shift($services);
+                $expectedVersion = array_shift($versions);
+
+                // Assert that the service passed is the expected one
+                $this->assertSame($expectedService, $service);
+
+                return $expectedVersion;
+            });
 
         $this->assertEquals($configWithType, $this->relationship->get($this->configMock));
     }
diff --git a/tests/functional/_support/CliTester.php b/tests/functional/_support/CliTester.php
@@ -5,6 +5,8 @@
  */
 declare(strict_types=1);
 
+namespace Magento\CloudDocker\Test\Functional\Support;
+
 /**
  * @inheritdoc
  */
diff --git a/tests/functional/_support/FailedInfo.php b/tests/functional/_support/FailedInfo.php
@@ -5,7 +5,7 @@
  */
 declare(strict_types=1);
 
-namespace Codeception\Extension;
+namespace Magento\CloudDocker\Test\Functional\Support;
 
 use Codeception\Events;
 use Codeception\Extension;
diff --git a/tests/unit/phpunit.xml.dist b/tests/unit/phpunit.xml.dist
@@ -4,7 +4,7 @@
          xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.1/phpunit.xsd"
          colors="true"
          columns="max"
-         bootstrap="../../autoload.php"
+         bootstrap="../../bootstrap.php"
          beStrictAboutTestsThatDoNotTestAnything="false"
 >
     <testsuites>

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`/**`
`14`	`14`	`* @inheritdoc`
`15`	`15`	`*`
`16`		`- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`16`	`+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")`
`17`	`17`	`*/`
`18`	`18`	`class Application extends \Symfony\Component\Console\Application`
`19`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`/**`
`26`	`26`	`* Builds Docker configuration for Magento project.`
`27`	`27`	`*`
`28`		`- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`28`	`+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")`
`29`	`29`	`*/`
`30`	`30`	`class BuildCompose extends Command`
`31`	`31`	`{`
`@@ -82,7 +82,7 @@ public function __construct(`
`82`	`82`	`/**`
`83`	`83`	`* {@inheritdoc}`
`84`	`84`	`*`
`85`		`- * @SuppressWarnings(PHPMD.ExcessiveMethodLength)`
	`85`	`+ * @SuppressWarnings("PHPMD.ExcessiveMethodLength")`
`86`	`86`	`*/`
`87`	`87`	`protected function configure(): void`
`88`	`88`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`/**`
`28`	`28`	`* Build configuration from custom-provided source.`
`29`	`29`	`*`
`30`		`- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)`
	`30`	`+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")`
`31`	`31`	`*/`
`32`	`32`	`class BuildCustomCompose extends Command`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -218,9 +218,9 @@ private function build(string $version, string $edition): void`
`218`	`218`	`* @throws ConfigurationMismatchException`
`219`	`219`	`* @throws FileNotFoundException`
`220`	`220`	`*`
`221`		`- * @SuppressWarnings(PHPMD.CyclomaticComplexity)`
`222`		`- * @SuppressWarnings(PHPMD.NPathComplexity)`
`223`		`- * @SuppressWarnings(PHPMD.ExcessiveMethodLength)`
	`221`	`+ * @SuppressWarnings("PHPMD.CyclomaticComplexity")`
	`222`	`+ * @SuppressWarnings("PHPMD.NPathComplexity")`
	`223`	`+ * @SuppressWarnings("PHPMD.ExcessiveMethodLength")`
`224`	`224`	`*/`
`225`	`225`	`private function buildDockerfile(string $dockerfile, string $phpVersion, string $edition): string`
`226`	`226`	`{`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ public function __construct(`
`84`	`84`	`/**`
`85`	`85`	`* {@inheritDoc}`
`86`	`86`	`*`
`87`		`- * @SuppressWarnings(PHPMD.CyclomaticComplexity)`
	`87`	`+ * @SuppressWarnings("PHPMD.CyclomaticComplexity")`
`88`	`88`	`*/`
`89`	`89`	`public function build(Config $config): Manager`
`90`	`90`	`{`
Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,7 @@ public function get(Config $config): array`
`158`	`158`	`/**`
`159`	`159`	`* @return array`
`160`	`160`	`*`
`161`		`- * @SuppressWarnings(PHPMD.ExcessiveMethodLength)`
	`161`	`+ * @SuppressWarnings("PHPMD.ExcessiveMethodLength")`
`162`	`162`	`*/`
`163`	`163`	`public static function getConfig(): array`
`164`	`164`	`{`
Original file line number	Diff line number	Diff line change
`@@ -83,9 +83,9 @@ public function __construct(`
`83`	`83`	`/**`
`84`	`84`	`* {@inheritdoc}`
`85`	`85`	`*`
`86`		`- * @SuppressWarnings(PHPMD.ExcessiveMethodLength)`
`87`		`- * @SuppressWarnings(PHPMD.CyclomaticComplexity)`
`88`		`- * @SuppressWarnings(PHPMD.NPathComplexity)`
	`86`	`+ * @SuppressWarnings("PHPMD.ExcessiveMethodLength")`
	`87`	`+ * @SuppressWarnings("PHPMD.CyclomaticComplexity")`
	`88`	`+ * @SuppressWarnings("PHPMD.NPathComplexity")`
`89`	`89`	`*/`
`90`	`90`	`public function build(Config $config): Manager`
`91`	`91`	`{`
Original file line number	Diff line number	Diff line change
`@@ -166,9 +166,9 @@ public function __construct(InputInterface $input)`
`166`	`166`	`/**`
`167`	`167`	`* {@inheritDoc}`
`168`	`168`	`*`
`169`		`- * @SuppressWarnings(PHPMD.NPathComplexity)`
`170`		`- * @SuppressWarnings(PHPMD.CyclomaticComplexity)`
`171`		`- * @SuppressWarnings(PHPMD.ExcessiveMethodLength)`
	`169`	`+ * @SuppressWarnings("PHPMD.NPathComplexity")`
	`170`	`+ * @SuppressWarnings("PHPMD.CyclomaticComplexity")`
	`171`	`+ * @SuppressWarnings("PHPMD.ExcessiveMethodLength")`
`172`	`172`	`*/`
`173`	`173`	`public function read(): Repository`
`174`	`174`	`{`