Enable PHPStan on tests (#659)

Author: theofidry

Makefile

@@ -48,7 +48,7 @@ cs-check: $(CODE_SNIFFER)
 PHPSTAN=vendor-bin/phpstan/vendor/bin/phpstan
 phpstan: ## Runs PHPStan
 phpstan: $(PHPSTAN)
-	$(PHPNOGC) $(PHPSTAN) analyze src --level max --memory-limit=-1
+	$(PHPNOGC) $(PHPSTAN) analyze src tests --level max --memory-limit=-1
 
 .PHONY: build
 build:	 ## Builds the PHAR

phpstan.neon.dist

@@ -2,8 +2,7 @@ parameters:
     checkMissingIterableValueType: false
     checkGenericClassInNonGenericObjectType: false
 
-    excludePaths:
-        - src/Console/Command/AddPrefixCommand.php
+    excludePaths: []
 
     ignoreErrors:
         - message: '#Cannot cast array\<string\>\|string to string\.#'
@@ -24,4 +23,17 @@ parameters:
           path: 'src/PhpParser/NodeVisitor/OriginalNameResolver.php'
         - message: '#NamespaceManipulator::getOriginalName\(\) should return#'
           path: 'src/PhpParser/NodeVisitor/NamespaceStmt/NamespaceManipulator.php'
-        # TODO: this one is really strange and may be worth investigating
+        - message: '#Dead catch#'
+          path: 'tests/Scoper/PhpScoperTest.php'
+        - message: '#Dead catch#'
+          path: 'tests/Scoper/PhpScoperSpecTest.php'
+        - message: '#Cannot assign offset#'
+          path: 'tests/Scoper/PhpScoperSpecTest.php'
+        - message: '#DummyScoperFactory extends @final#'
+          path: 'tests/Console/Command/DummyScoperFactory.php'
+        - message: '#Anonymous function should return string but returns array#'
+          path: 'tests/Console/Command/AddPrefixCommandIntegrationTest.php'
+        - message: '#AddPrefixCommandIntegrationTest\:\:getNormalizeDisplay\(\) should return string but returns array#'
+          path: 'tests/Console/Command/AddPrefixCommandIntegrationTest.php'
+        - message: '#ConfigurationKeysTest\:\:retrieveConfigurationKeys\(\) should return array#'
+          path: 'tests/Configuration/ConfigurationKeysTest.php'

src/Console/Command/AddPrefixCommand.php

@@ -26,6 +26,7 @@
 use Humbug\PhpScoper\Console\ConfigLoader;
 use Humbug\PhpScoper\Console\ConsoleScoper;
 use Humbug\PhpScoper\Scoper\ScoperFactory;
+use InvalidArgumentException;
 use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
@@ -158,6 +159,9 @@ public function execute(IO $io): int
         return ExitCode::SUCCESS;
     }
 
+    /**
+     * @return non-empty-string
+     */
     private function getOutputDir(IO $io, string $cwd): string
     {
         return $this->canonicalizePath(
@@ -260,11 +264,17 @@ private function getPathArguments(IO $io, string $cwd): array
      */
     private function canonicalizePath(string $path, string $cwd): string
     {
-        return Path::canonicalize(
+        $canonicalPath = Path::canonicalize(
             $this->fileSystem->isAbsolutePath($path)
                 ? $path
                 : $cwd.DIRECTORY_SEPARATOR.$path,
         );
+
+        if ('' === $canonicalPath) {
+            throw new InvalidArgumentException('Cannot canonicalize empty path and empty working directory');
+        }
+
+        return $canonicalPath;
     }
 
     private function getScoper(): ConsoleScoper

tests/Configuration/ConfigurationKeysTest.php

@@ -50,16 +50,18 @@ private static function retrieveKeywords(): array
     {
         $configKeysReflection = new ReflectionClass(ConfigurationKeys::class);
 
-        $constant = $configKeysReflection->getConstant('KEYWORDS');
+        $constants = $configKeysReflection->getConstant('KEYWORDS');
 
-        foreach ($constant as $index => $value) {
+        self::assertIsArray($constants);
+
+        foreach ($constants as $index => $value) {
             self::assertNonEmptyStringConstantValue(
                 $value,
                 (string) $index,
             );
         }
 
-        return $constant;
+        return $constants;
     }
 
     /**

tests/Configuration/ConfigurationSymbolsConfigurationFactoryTest.php

@@ -8,6 +8,7 @@
 use Humbug\PhpScoper\Symbol\SymbolRegistry;
 use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
+use Throwable;
 
 /**
  * @covers \Humbug\PhpScoper\Configuration\SymbolsConfigurationFactory
@@ -184,6 +185,8 @@ public static function configProvider(): iterable
 
     /**
      * @dataProvider invalidConfigProvider
+     *
+     * @param class-string<Throwable> $expectedExceptionClassName
      */
     public function test_it_cannot_create_a_whitelist_from_an_invalid_config(
         array $config,

tests/Configuration/ConfigurationTest.php

@@ -27,6 +27,8 @@ final class ConfigurationTest extends TestCase
 {
     /**
      * @dataProvider prefixProvider
+     *
+     * @param non-empty-string $prefix
      */
     public function test_it_validates_the_prefix(
         string $prefix,

tests/Console/Command/AddPrefixCommandIntegrationTest.php

@@ -30,6 +30,7 @@
 use function Safe\preg_replace;
 use function Safe\realpath;
 use function str_replace;
+use function Safe\sprintf;
 use const DIRECTORY_SEPARATOR;
 
 /**
@@ -329,9 +330,19 @@ private static function collectFiles(string $dir): array
         return array_reduce(
             iterator_to_array($files),
             static function (array $collectedFiles, SplFileInfo $file) use ($dir): array {
-                $path = str_replace($dir, '', $file->getRealPath());
+                $realPath = $file->getRealPath();
 
-                $collectedFiles[$path] = file_get_contents($file->getRealPath());
+                self::assertIsString(
+                    $realPath,
+                    sprintf(
+                        'Expected file "%s" to have a real path.',
+                        $file->getPathname()
+                    ),
+                );
+
+                $path = str_replace($dir, '', $realPath);
+
+                $collectedFiles[$path] = file_get_contents($realPath);
 
                 return $collectedFiles;
             },

tests/PhpParser/UseStmtNameTest.php

@@ -196,6 +196,8 @@ private static function parseUseStmtName(string $php): Name
 
         $statements = $parser->parse($php);
 
+        self::assertNotNull($statements);
+
         $traverser->traverse($statements);
 
         foreach ($useStatements as $useStmts) {

tests/PhpScoperAssertions.php

@@ -12,6 +12,7 @@ final class PhpScoperAssertions
 {
     /**
      * @parma list $expected
+     * @param mixed $actual
      */
     public static function assertListEqualsCanonicalizing(
         array $expected,

tests/Scoper/PhpScoperSpecTest.php

@@ -330,7 +330,7 @@ private static function parseSpecFile(string $file, array $meta, $fixtureTitle,
         $spec = sprintf(
             '[%s] %s',
             $meta['title'],
-            isset($fixtureSet['spec']) ? $fixtureSet['spec'] : $fixtureTitle
+            $fixtureSet['spec'] ?? $fixtureTitle
         );
 
         $payload = is_string($fixtureSet) ? $fixtureSet : $fixtureSet['payload'];