Analyze tests using PHPStan

Author: mspirkov

phpstan.neon

@@ -7,6 +7,7 @@ parameters:
         - tests/benchmark/Assets/*
     paths:
         - src
+        - tests
     ignoreErrors:
         -
             message: "#^Parameter \\#1 \\$constExprParser of class PHPStan\\\\PhpDocParser\\\\Parser\\\\TypeParser constructor expects PHPStan\\\\PhpDocParser\\\\Parser\\\\ConstExprParser\\|null, PHPStan\\\\PhpDocParser\\\\ParserConfig given\\.$#"
@@ -24,3 +25,20 @@ parameters:
             message: "#^Parameter \\#2 \\$quoteAwareConstExprString of class PHPStan\\\\PhpDocParser\\\\Parser\\\\TypeParser constructor expects bool, PHPStan\\\\PhpDocParser\\\\Parser\\\\ConstExprParser given\\.$#"
             count: 1
             path: src/TypeResolver.php
+
+        # We are intentionally adding invalid parameters here
+        -
+            message: "#^Parameter \\#2 \\$typeClassName of method phpDocumentor\\\\Reflection\\\\TypeResolver\\:\\:addKeyword\\(\\) expects class\\-string\\<phpDocumentor\\\\Reflection\\\\Type\\>\\, string given\\.$#"
+            count: 2
+            path: tests/unit/TypeResolverTest.php
+
+        # We are intentionally adding invalid parameters here
+        -
+            message: "#^Parameter \\#1 \\$types of class phpDocumentor\\\\Reflection\\\\Types\\\\Compound constructor expects array\\<phpDocumentor\\\\Reflection\\\\Type\\>\\, array\\<int\\, string\\> given\\.$#"
+            count: 1
+            path: tests/unit/Types/CompoundTest.php
+
+        -
+            message: "#^Parameter \\#1 \\$argument of class ReflectionClass constructor expects class\\-string\\<Foo\\\\Bar\\>\\|Foo\\\\Bar\\, string given\\.$#"
+            count: 1
+            path: tests/unit/Types/ContextFactoryTest.php

tests/benchmark/ContextFactoryBench.php

@@ -14,15 +14,15 @@ final class ContextFactoryBench
 {
     private string $source;
 
-    public function setup()
+    public function setup(): void
     {
-        $this->source = file_get_contents(__DIR__ . '/Assets/mpdf.php');
+        $this->source = (string) file_get_contents(__DIR__ . '/Assets/mpdf.php');
     }
 
     /**
      * @Warmup(1)
      */
-    public function benchCreateContextForNamespace()
+    public function benchCreateContextForNamespace(): void
     {
         $factory = new ContextFactory();
         $factory->createForNamespace(

tests/benchmark/TypeResolverBench.php

@@ -15,7 +15,7 @@ class TypeResolverBench
 {
     private TypeResolver $typeResolver;
 
-    public function setup()
+    public function setup(): void
     {
         $this->typeResolver = new TypeResolver();
     }

tests/benchmark/TypeResolverWithContextBench.php

@@ -24,10 +24,10 @@ final class TypeResolverWithContextBench
      */
     private $typeResolver;
 
-    public function setup()
+    public function setup(): void
     {
         $factory = new ContextFactory();
-        $this->context = $factory->createForNamespace('mpdf', file_get_contents(__DIR__ . '/Assets/mpdf.php'));
+        $this->context = $factory->createForNamespace('mpdf', (string) file_get_contents(__DIR__ . '/Assets/mpdf.php'));
         $this->typeResolver = new TypeResolver();
     }
 

tests/unit/NumericResolverTest.php

@@ -15,6 +15,7 @@
 
 use phpDocumentor\Reflection\PseudoTypes\Numeric_;
 use phpDocumentor\Reflection\PseudoTypes\NumericString;
+use phpDocumentor\Reflection\Types\Compound;
 use phpDocumentor\Reflection\Types\Context;
 use phpDocumentor\Reflection\Types\String_;
 use PHPUnit\Framework\TestCase;
@@ -40,7 +41,10 @@ public function testResolvingIntRange(): void
 
         $this->assertInstanceOf(Numeric_::class, $resolvedType);
         $this->assertSame('numeric', (string) $resolvedType);
-        $this->assertSame(false, $resolvedType->underlyingType()->contains(new String_()));
-        $this->assertSame(true, $resolvedType->underlyingType()->contains(new NumericString()));
+
+        $underlyingType = $resolvedType->underlyingType();
+        $this->assertInstanceOf(Compound::class, $underlyingType);
+        $this->assertFalse($underlyingType->contains(new String_()));
+        $this->assertTrue($underlyingType->contains(new NumericString()));
     }
 }

tests/unit/TypeResolverTest.php

@@ -101,6 +101,8 @@ class TypeResolverTest extends TestCase
      * @covers ::<private>
      *
      * @dataProvider provideKeywords
+     *
+     * @param class-string $expectedClass
      */
     public function testResolvingKeywords(string $keyword, string $expectedClass): void
     {
@@ -291,9 +293,8 @@ public function testResolvingNestedTypedArrays(): void
 
         $resolvedType = $fixture->resolve('string[][]', new Context(''));
 
-        $childValueType = $resolvedType->getValueType();
-
         $this->assertInstanceOf(Array_::class, $resolvedType);
+        $childValueType = $resolvedType->getValueType();
 
         $this->assertSame('string[][]', (string) $resolvedType);
         $this->assertInstanceOf(Compound::class, $resolvedType->getKeyType());
@@ -414,11 +415,12 @@ public function testResolvingMixedCompoundTypes(): void
 
         $resolvedType = $firstType->getValueType();
 
+        $this->assertInstanceOf(Intersection::class, $resolvedType);
         $firstSubType = $resolvedType->get(0);
         $secondSubType =  $resolvedType->get(1);
 
         $this->assertInstanceOf(Object_::class, $firstSubType);
-        $this->assertInstanceOf(Fqsen::class, $secondSubType->getFqsen());
+        $this->assertInstanceOf(Fqsen::class, $firstSubType->getFqsen());
         $this->assertInstanceOf(Object_::class, $secondSubType);
         $this->assertInstanceOf(Fqsen::class, $secondSubType->getFqsen());
     }

tests/unit/Types/ContextFactoryTest.php

@@ -61,7 +61,7 @@ public function testReadsAliasesFromClassReflection() : void
         public function testReadsNamespaceFromProvidedNamespaceAndContent() : void
         {
             $fixture = new ContextFactory();
-            $context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
+            $context = $fixture->createForNamespace(__NAMESPACE__, (string) file_get_contents(__FILE__));
 
             $this->assertSame(__NAMESPACE__, $context->getNamespace());
         }
@@ -73,7 +73,7 @@ public function testReadsNamespaceFromProvidedNamespaceAndContent() : void
         public function testReadsAliasesFromProvidedNamespaceAndContent() : void
         {
             $fixture = new ContextFactory();
-            $context = $fixture->createForNamespace(__NAMESPACE__, file_get_contents(__FILE__));
+            $context = $fixture->createForNamespace(__NAMESPACE__, (string) file_get_contents(__FILE__));
 
             $this->assertNamespaceAliasesFrom($context);
         }
@@ -198,7 +198,7 @@ class Bar
             $this->assertSame([], $context->getNamespaceAliases());
         }
 
-        public function assertNamespaceAliasesFrom(Context $context)
+        public function assertNamespaceAliasesFrom(Context $context): void
         {
             $expected = [
                 'm' => m::class,