Merge pull request #142 from magento-commerce/MCLOUD-10319

MCLOUD-10319: Stabilize static tests

Author: tomreece

composer.json

@@ -45,7 +45,7 @@
     "consolidation/robo": "^1.2 || ^3.0",
     "php-mock/php-mock-phpunit": "^2.0",
     "phpmd/phpmd": "@stable",
-    "phpstan/phpstan": "^0.12",
+    "phpstan/phpstan": "^1.10",
     "phpunit/php-code-coverage": "^7.0 || ^9.2",
     "phpunit/phpunit": "^8.5 || ^9.5",
     "squizlabs/php_codesniffer": "^3.0",

src/Filesystem/DirectoryList.php

@@ -80,9 +80,9 @@ public function getPath(string $code, bool $relativePath = false): string
             throw  new \RuntimeException("Code {$code} is not registered");
         }
 
-        if (!array_key_exists(static::PATH, $directories[$code])) {
+        if (!array_key_exists(self::PATH, $directories[$code])) {
             throw new \RuntimeException(
-                sprintf('Config var "%s" does not exists', static::PATH)
+                sprintf('Config var "%s" does not exists', self::PATH)
             );
         }
 
@@ -113,7 +113,7 @@ public function getMagentoRoot(): string
      */
     public function getInit(): string
     {
-        return $this->getPath(static::DIR_INIT);
+        return $this->getPath(self::DIR_INIT);
     }
 
     /**
@@ -122,7 +122,7 @@ public function getInit(): string
      */
     public function getVar(): string
     {
-        return $this->getPath(static::DIR_VAR);
+        return $this->getPath(self::DIR_VAR);
     }
 
     /**
@@ -131,7 +131,7 @@ public function getVar(): string
      */
     public function getLog(): string
     {
-        return $this->getPath(static::DIR_LOG);
+        return $this->getPath(self::DIR_LOG);
     }
 
     /**
@@ -140,7 +140,7 @@ public function getLog(): string
      */
     public function getGeneratedCode(): string
     {
-        return $this->getPath(static::DIR_GENERATED_CODE);
+        return $this->getPath(self::DIR_GENERATED_CODE);
     }
 
     /**
@@ -149,7 +149,7 @@ public function getGeneratedCode(): string
      */
     public function getGeneratedMetadata(): string
     {
-        return $this->getPath(static::DIR_GENERATED_METADATA);
+        return $this->getPath(self::DIR_GENERATED_METADATA);
     }
 
     /**
@@ -161,15 +161,15 @@ public function getGeneratedMetadata(): string
     public function getWritableDirectories(): array
     {
         $writableDirs = [
-            static::DIR_ETC,
-            static::DIR_MEDIA,
-            static::DIR_LOG,
-            static::DIR_VIEW_PREPROCESSED,
+            self::DIR_ETC,
+            self::DIR_MEDIA,
+            self::DIR_LOG,
+            self::DIR_VIEW_PREPROCESSED,
         ];
 
         if ($this->magentoVersion->satisfies('2.1.*')) {
-            $writableDirs[] = static::DIR_GENERATED_METADATA;
-            $writableDirs[] = static::DIR_GENERATED_CODE;
+            $writableDirs[] = self::DIR_GENERATED_METADATA;
+            $writableDirs[] = self::DIR_GENERATED_CODE;
         }
 
         return array_map(function ($path) {
@@ -186,10 +186,10 @@ public function getWritableDirectories(): array
     public function getMountPoints(): array
     {
         $mountPoints = [
-            static::DIR_ETC,
-            static::DIR_VAR,
-            static::DIR_MEDIA,
-            static::DIR_STATIC
+            self::DIR_ETC,
+            self::DIR_VAR,
+            self::DIR_MEDIA,
+            self::DIR_STATIC
         ];
 
         return array_map(function ($path) {
@@ -203,13 +203,13 @@ public function getMountPoints(): array
     private function getDefaultDirectories(): array
     {
         $config = [
-            static::DIR_INIT => [static::PATH => 'init'],
-            static::DIR_VAR => [static::PATH => 'var'],
-            static::DIR_LOG => [static::PATH => 'var/log'],
-            static::DIR_ETC => [static::PATH => 'app/etc'],
-            static::DIR_MEDIA => [static::PATH => 'pub/media'],
-            static::DIR_STATIC => [static::PATH => 'pub/static'],
-            static::DIR_VIEW_PREPROCESSED => [static::PATH => 'var/view_preprocessed'],
+            self::DIR_INIT => [self::PATH => 'init'],
+            self::DIR_VAR => [self::PATH => 'var'],
+            self::DIR_LOG => [self::PATH => 'var/log'],
+            self::DIR_ETC => [self::PATH => 'app/etc'],
+            self::DIR_MEDIA => [self::PATH => 'pub/media'],
+            self::DIR_STATIC => [self::PATH => 'pub/static'],
+            self::DIR_VIEW_PREPROCESSED => [self::PATH => 'var/view_preprocessed'],
         ];
 
         return $config;
@@ -224,11 +224,11 @@ private function getDefaultVariadicDirectories(): array
         $config = [];
 
         if ($this->magentoVersion->satisfies('2.1.*')) {
-            $config[static::DIR_GENERATED_CODE] = [static::PATH => 'var/generation'];
-            $config[static::DIR_GENERATED_METADATA] = [static::PATH => 'var/di'];
+            $config[self::DIR_GENERATED_CODE] = [self::PATH => 'var/generation'];
+            $config[self::DIR_GENERATED_METADATA] = [self::PATH => 'var/di'];
         } else {
-            $config[static::DIR_GENERATED_CODE] = [static::PATH => 'generated/code'];
-            $config[static::DIR_GENERATED_METADATA] = [static::PATH => 'generated/metadata'];
+            $config[self::DIR_GENERATED_CODE] = [self::PATH => 'generated/code'];
+            $config[self::DIR_GENERATED_METADATA] = [self::PATH => 'generated/metadata'];
         }
 
         return $config;

src/Test/Unit/Config/AdminDataTest.php

@@ -9,8 +9,8 @@
 
 use Magento\MagentoCloud\Config\AdminData;
 use Magento\MagentoCloud\Config\EnvironmentDataInterface;
-use PHPStan\Testing\TestCase;
 use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
 
 /**
  * @inheritDoc

src/Test/Unit/Config/EnvironmentDataTest.php

@@ -17,8 +17,8 @@
 use Magento\MagentoCloud\Filesystem\Driver\File;
 use Magento\MagentoCloud\Filesystem\FileSystemException;
 use phpmock\phpunit\PHPMock;
-use PHPStan\Testing\TestCase;
 use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
 
 /**
  * @inheritDoc

src/Util/StaticContentCompressor.php

@@ -153,7 +153,7 @@ private function getCompressionCommand(
     ): string {
         $compressionLevel = $compressionLevel > 0 && $compressionLevel <= 9
             ? $compressionLevel
-            : static::DEFAULT_COMPRESSION_LEVEL;
+            : self::DEFAULT_COMPRESSION_LEVEL;
 
         return sprintf(
             '%s -k 30 %s %s -c %s',

tests/static/phpstan.neon

@@ -2,13 +2,38 @@ parameters:
     level: 5
     paths:
         - ../../src
-    excludes_analyse:
+    excludePaths:
         - ../../src/Test/*
     reportUnmatchedIgnoredErrors: false
+    treatPhpDocTypesAsCertain: false
     ignoreErrors:
         - message: "#.*ComponentRegistrar.*#"
           path: ../../src/StaticContent/ThemeResolver.php
         - message: "#Strict comparison using === between bool and null will always evaluate to false.#"
           path: ../../src/Filesystem/Driver/File.php
         - message: "#should return int but returns null#"
           path: ../../src/Command/DbDump.php
+        - message: '#Call to an undefined method Symfony\\Component\\Console\\Helper\\HelperInterface\:\:ask\(\)\.#'
+          paths:
+            - ../../src/Command/BackupRestore.php
+            - ../../src/Command/DbDump.php
+        - message: '#Access to private constant#'
+          path: ../../src/App/Logger/Gelf/TransportFactory.php
+        - message: '#Property Magento\\MagentoCloud\\App\\Logger\\LineFormatterFactory\:\:\$container is never read, only written\.#'
+          path: ../../src/App/Logger/LineFormatterFactory.php
+        - message: '#Property Magento\\MagentoCloud\\Command\\ConfigShow\:\:\$logger is never read, only written\.#'
+          path: ../../src/Command/ConfigShow.php
+        - message: '#Property Magento\\MagentoCloud\\Command\\ConfigShow\\Renderer\:\:\$logger is never read, only written\.#'
+          path: ../../src/Command/ConfigShow/Renderer.php
+        - message: '#Property Magento\\MagentoCloud\\Command\\CronUnlock\:\:\$magentoVersion is never read, only written\.#'
+          path: ../../src/Command/CronUnlock.php
+        - message: '#Property Magento\\MagentoCloud\\Filesystem\\RecoverableDirectoryList\:\:\$environment is never read, only written\.#'
+          path: ../../src/Filesystem/RecoverableDirectoryList.php
+        - message: '#Property Magento\\MagentoCloud\\Step\\Deploy\\InstallUpdate\\ConfigUpdate\\CronConsumersRunner\:\:\$environment is never read, only written\.#'
+          path: ../../src/Step/Deploy/InstallUpdate/ConfigUpdate/CronConsumersRunner.php
+        - message: '#Property Magento\\MagentoCloud\\Step\\Deploy\\InstallUpdate\\ConfigUpdate\\Urls\\Database\:\:\$environment is never read, only written\.#'
+          path: ../../src/Step/Deploy/InstallUpdate/ConfigUpdate/Urls/Database.php
+        - message: '#on null in isset\(\) does not exist#'
+          path: ../../src/Service/Validator.php
+        - message: '#Expression on left side of \?\? is not nullable#'
+          path: ../../src/Util/UrlManager.php