Add psalm for static code analysis.

Heiko Jerichen · Heiko Jerichen · commit 35a235f3356c · 2025-02-03T20:02:33.000+01:00
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -55,6 +55,37 @@ jobs:
       - name: Run Tests
         run: vendor/bin/phpunit
 
+  psalm:
+    name: Psalm
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@2.9.0
+        with:
+          php-version: 8.2
+          coverage: none
+
+      - name: Get Composer Cache Directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-psalm-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-psalm-composer-
+
+      - name: Install Dependencies
+        run: composer update
+
+      - name: Run psalm
+        run: vendor/bin/psalm --output-format=github
+
   coverage:
     runs-on: ubuntu-latest
     name: Code Coverage
diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml
diff --git a/composer.json b/composer.json
@@ -23,6 +23,8 @@
     "require-dev": {
         "roave/security-advisories": "dev-latest",
         "phpunit/phpunit": "^9.6.21 | ^10.0 | ^11.0",
-        "phpspec/prophecy-phpunit": "^2.0"
+        "phpspec/prophecy-phpunit": "^2.0",
+        "vimeo/psalm": "^6.1",
+        "psalm/plugin-phpunit": "^0.19.2"
     }
 }
diff --git a/psalm.xml b/psalm.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<!--suppress XmlDefaultAttributeValue -->
+<psalm
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="https://getpsalm.org/schema/config"
+        xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+        errorLevel="1"
+        findUnusedBaselineEntry="true"
+        findUnusedCode="true"
+>
+    <projectFiles>
+        <directory name="src"/>
+        <directory name="tests"/>
+        <ignoreFiles>
+            <directory name="vendor/phpunit"/>
+        </ignoreFiles>
+    </projectFiles>
+    <issueHandlers>
+        <RedundantPropertyInitializationCheck errorLevel="suppress"/>
+        <PropertyNotSetInConstructor errorLevel="suppress"/>
+        <MissingConstructor errorLevel="suppress"/>
+        <InvalidDocblock errorLevel="suppress"/>
+    </issueHandlers>
+    <plugins>
+        <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
+    </plugins>
+</psalm>
diff --git a/src/FunctionDelegation.php b/src/FunctionDelegation.php
@@ -12,6 +12,7 @@ class FunctionDelegation
     /**
      * @return mixed
      * @noinspection PhpReturnDocTypeMismatchInspection
+     * @psalm-suppress InvalidReturnType, PossiblyUnusedParam
      */
     public function delegate(string $functionName, array $arguments)
     {
diff --git a/src/FunctionProphecy.php b/src/FunctionProphecy.php
@@ -35,7 +35,8 @@ public function getFunctionName(): string
 
     public function scoreArguments(array $arguments): int
     {
-        return $this->argumentEvaluator->scoreArguments($arguments) ?: 0;
+        $score = $this->argumentEvaluator->scoreArguments($arguments);
+        return $score === false ? 0 : $score;
     }
 
     public function makeCall(): mixed
diff --git a/src/FunctionProphecyStorage.php b/src/FunctionProphecyStorage.php
@@ -11,7 +11,7 @@ class FunctionProphecyStorage
 {
     private static self $instance;
 
-    /** @var FunctionProphecy[][][] */
+    /** @var array<string,array<string,array<string,FunctionProphecy>>> */
     private array $functionProphecies = [];
 
     public static function getInstance(): FunctionProphecyStorage
diff --git a/src/FunctionRevealer.php b/src/FunctionRevealer.php
@@ -15,6 +15,7 @@ public function __construct(
     ) {
     }
 
+    /** @psalm-suppress PossiblyUnusedParam */
     public function revealFunction(string $namespace, string $functionName): void
     {
         if ($this->isFunctionAlreadyRevealed($namespace, $functionName)) {
diff --git a/src/NamespaceProphecy.php b/src/NamespaceProphecy.php
@@ -8,6 +8,7 @@
 
 /**
  * @author Heiko Jerichen <heiko@jerichen.de>
+ * @template-implements ProphecyInterface<self>
  */
 readonly class NamespaceProphecy implements ProphecyInterface
 {
@@ -47,12 +48,13 @@ public function prepare(string ...$functionNames): void
     /**
      * Reveals prophecy object (double) .
      */
-    public function reveal(): void
+    public function reveal(): self
     {
         $functionNames = $this->functionProphecyStorage->getFunctionNamesOfSetProphecies($this->namespace);
         foreach ($functionNames as $functionName) {
             $this->functionRevealer->revealFunction($this->namespace, $functionName);
         }
+        return $this;
     }
 
     public function unReveal(): void
diff --git a/src/PHPBuiltInFunctions.php b/src/PHPBuiltInFunctions.php
@@ -400,6 +400,7 @@ public function getmypid(): MethodProphecy
      * </p>
      * @return MethodProphecy
      * @noinspection PhpUnusedParameterInspection
+     * @psalm-suppress PossiblyUnusedParam
      */
     public function exit($status = null): MethodProphecy
     {
@@ -422,6 +423,7 @@ public function exit($status = null): MethodProphecy
      * </p>
      * @return MethodProphecy
      * @noinspection PhpUnusedParameterInspection
+     * @psalm-suppress PossiblyUnusedParam
      */
     public function die($status = "") : MethodProphecy
     {
diff --git a/src/PHPProphetTrait.php b/src/PHPProphetTrait.php
@@ -25,6 +25,7 @@ private function prophesizePHP(string $namespace): NamespaceProphecy
 
     /**
      * @postCondition
+     * @psalm-suppress PossiblyUnusedMethod
      */
     #[PostCondition]
     protected function verifyPhpProphecyDoubles(): void
@@ -35,6 +36,7 @@ protected function verifyPhpProphecyDoubles(): void
         try {
             $this->phpProphet->checkPredictions();
         } catch (PredictionException $e) {
+            /** @psalm-suppress InternalClass, InternalMethod */
             throw new AssertionFailedError($e->getMessage());
         } finally {
             $this->countProphecyAssertions();
@@ -43,6 +45,7 @@ protected function verifyPhpProphecyDoubles(): void
 
     /**
      * @after
+     * @psalm-suppress PossiblyUnusedMethod
      */
     #[After]
     protected function tearDownPhpProphecy(): void
@@ -84,14 +87,13 @@ private function phpProphecyIsUsed(): bool
     private function countProphecyAssertions(): void
     {
         assert($this instanceof TestCase);
-        assert($this->phpProphet !== null);
+        assert(isset($this->phpProphet));
         $this->phpProphecyAssertionsCounted = true;
 
         foreach ($this->phpProphet->prophet->getProphecies() as $objectProphecy) {
             foreach ($objectProphecy->getMethodProphecies() as $methodProphecies) {
                 foreach ($methodProphecies as $methodProphecy) {
-                    assert($methodProphecy instanceof MethodProphecy);
-
+                    /** @psalm-suppress InternalMethod */
                     $this->addToAssertionCount(count($methodProphecy->getCheckedPredictions()));
                 }
             }
diff --git a/tests/Integration/IntegrationTest.php b/tests/Integration/IntegrationTest.php
@@ -75,7 +75,9 @@ public function testFunctionWillReturnSimpleWithParameter(): void
 
     public function testFunctionWillReturnSimpleWithProphecyArgument(): void
     {
-        $this->php->date(Argument::any())->willReturn('16.07.2019 21:43:00');
+        /** @var string $any */
+        $any = Argument::any();
+        $this->php->date($any)->willReturn('16.07.2019 21:43:00');
         $this->php->reveal();
 
         self::assertEquals('16.07.2019 21:43:00', date('d.m.Y H:i:s'));
@@ -88,6 +90,7 @@ public function testFunctionWillReturnSimpleWithWrongParameter(): void
 
         $this->expectException(FunctionProphecyNotFoundException::class);
 
+        /** @psalm-suppress UnusedFunctionCall */
         date('d.m.Y H:i');
     }
 
@@ -106,6 +109,7 @@ public function testFunctionWillReturnSimpleWithMoreThenOneParameterButWithOnyOn
 
         $this->expectException(FunctionProphecyNotFoundException::class);
 
+        /** @psalm-suppress UnusedFunctionCall */
         date('d.m.Y H:i:s');
     }
 
@@ -141,7 +145,9 @@ public function testOverwriteProphecy(): void
 
     public function testCalculateCorrectProphecy(): void
     {
-        $this->php->date(Argument::any())->willReturn('2020');
+        /** @var string $any */
+        $any = Argument::any();
+        $this->php->date($any)->willReturn('2020');
         $this->php->date('Y')->willReturn('2019');
         $this->php->reveal();
 
@@ -174,6 +180,7 @@ public function testDie(): void
 
     private function resetProphecy(): void
     {
+        /** @psalm-suppress UndefinedThisPropertyFetch */
         unset($this->prophet, $this->phpProphet);
     }
 }
diff --git a/tests/Unit/FunctionCallDetectorTest.php b/tests/Unit/FunctionCallDetectorTest.php
@@ -64,6 +64,7 @@ public function testFunctionCalled(): void
         $this->functionProphecy->makeCall()->willReturn(1234);
 
         $expected = 1234;
+        /** @var int $actual */
         $actual = $this->functionCallDetector->functionCalled($namespace, $functionName, $arguments);
         self::assertEquals($expected, $actual);
     }
@@ -102,6 +103,7 @@ public function testFunctionCalledWithFunctionNotMockedAtAll(): void
         $this->functionProphecyStorage->hasFunctionPropheciesForFunctionName($namespace, $functionName)->willReturn(false);
 
         $expected = time();
+        /** @var int $actual */
         $actual = $this->functionCallDetector->functionCalled($namespace, $functionName, $arguments);
         self::assertTrue($actual >= $expected);
     }
diff --git a/tests/Unit/FunctionProphecyTest.php b/tests/Unit/FunctionProphecyTest.php
@@ -87,6 +87,7 @@ public function testMakeCall(): void
         $this->functionDelegation->delegate($this->functionName, $this->arguments)->willReturn('something');
 
         $expected = 'something';
+        /** @var string $actual */
         $actual = $this->functionProphecy->makeCall();
         self::assertEquals($expected, $actual);
     }
diff --git a/tests/Unit/NamespaceProphecyTest.php b/tests/Unit/NamespaceProphecyTest.php
@@ -25,8 +25,11 @@ class NamespaceProphecyTest extends TestCase
     use ProphecyTrait;
 
     private NamespaceProphecy $namespaceProphecy;
+    /** @var ObjectProphecy<FunctionProphecyStorage> */
     private ObjectProphecy $functionProphecyStorage;
+    /** @var ObjectProphecy<FunctionDelegation> */
     private ObjectProphecy $functionDelegation;
+    /** @var ObjectProphecy<FunctionRevealer> */
     private ObjectProphecy $functionRevealer;
     private ObjectProphecy $methodProphecy;
     private MockObject $objectProphecy;
@@ -43,6 +46,7 @@ protected function setUp(): void
         $this->methodProphecy = $this->prophesize(MethodProphecy::class);
         $this->namespace = 'namespace';
 
+        /** @psalm-suppress MixedMethodCall */
         $this->objectProphecy->method('reveal')->willReturn($this->functionDelegation->reveal());
 
         $prophet = $this->createMock(Prophet::class);
diff --git a/tests/Unit/PHPBuiltInFunctionsTest.php b/tests/Unit/PHPBuiltInFunctionsTest.php
@@ -24,10 +24,16 @@ class PHPBuiltInFunctionsTest extends TestCase
     use ProphecyTrait;
 
     private NamespaceProphecy $namespaceProphecy;
+
+    /** @var ObjectProphecy<FunctionProphecyStorage>  */
     private ObjectProphecy $functionProphecyStorage;
+    /** @var ObjectProphecy<FunctionDelegation>  */
     private ObjectProphecy $functionDelegation;
+    /** @var ObjectProphecy<MethodProphecy>  */
     private ObjectProphecy $methodProphecy;
+
     private MockObject $objectProphecy;
+
     private string $namespace;
 
     protected function setUp(): void
@@ -36,6 +42,7 @@ protected function setUp(): void
 
         $this->functionDelegation = $this->prophesize(FunctionDelegation::class);
         $this->objectProphecy = $this->createMock(ObjectProphecy::class);
+        /** @psalm-suppress MixedMethodCall */
         $this->objectProphecy->method('reveal')->willReturn($this->functionDelegation->reveal());
         $this->methodProphecy = $this->prophesize(MethodProphecy::class);
 
@@ -202,11 +209,7 @@ public function testPcntlAsyncSignals(): void
 
     public function testPcntlSignal(): void
     {
-        $arguments = [
-            2,
-            static function () {
-            }
-        ];
+        $arguments = [2, static function (): void {}];
         $this->setUpCallTest('pcntl_signal', $arguments);
 
         $expected = $this->methodProphecy->reveal();
@@ -395,11 +398,14 @@ public function testGcEnable(): void
 
     public function testFWrite(): void
     {
-        $arguments = ['localhost', 'string'];
+        $resource = fopen('php://memory', 'rb+');
+        assert($resource !== false);
+
+        $arguments = [$resource, 'string'];
         $this->setUpCallTest('fwrite', $arguments);
 
         $expected = $this->methodProphecy->reveal();
-        $actual = $this->namespaceProphecy->fwrite(...$arguments);
+        $actual = $this->namespaceProphecy->fwrite($resource, 'string');
         self::assertEquals($expected, $actual);
     }
 
diff --git a/tests/Unit/PHPProphetTest.php b/tests/Unit/PHPProphetTest.php
@@ -19,7 +19,7 @@
 class PHPProphetTest extends TestCase
 {
     private PHPProphet $phpProphet;
-    private MockObject $prophet;
+    private MockObject&Prophet $prophet;
 
     protected function setUp(): void
     {

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`	`"require-dev": {`
`24`	`24`	`"roave/security-advisories": "dev-latest",`
`25`	`25`	`"phpunit/phpunit": "^9.6.21 \| ^10.0 \| ^11.0",`
`26`		`- "phpspec/prophecy-phpunit": "^2.0"`
	`26`	`+ "phpspec/prophecy-phpunit": "^2.0",`
	`27`	`+ "vimeo/psalm": "^6.1",`
	`28`	`+ "psalm/plugin-phpunit": "^0.19.2"`
`27`	`29`	`}`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ class FunctionDelegation`
`12`	`12`	`/**`
`13`	`13`	`* @return mixed`
`14`	`14`	`* @noinspection PhpReturnDocTypeMismatchInspection`
	`15`	`+ * @psalm-suppress InvalidReturnType, PossiblyUnusedParam`
`15`	`16`	`*/`
`16`	`17`	`public function delegate(string $functionName, array $arguments)`
`17`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,8 @@ public function getFunctionName(): string`
`35`	`35`
`36`	`36`	`public function scoreArguments(array $arguments): int`
`37`	`37`	`{`
`38`		`- return $this->argumentEvaluator->scoreArguments($arguments) ?: 0;`
	`38`	`+ $score = $this->argumentEvaluator->scoreArguments($arguments);`
	`39`	`+ return $score === false ? 0 : $score;`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`public function makeCall(): mixed`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class FunctionProphecyStorage`
`11`	`11`	`{`
`12`	`12`	`private static self $instance;`
`13`	`13`
`14`		`- /** @var FunctionProphecy[][][] */`
	`14`	`+ /** @var array<string,array<string,array<string,FunctionProphecy>>> */`
`15`	`15`	`private array $functionProphecies = [];`
`16`	`16`
`17`	`17`	`public static function getInstance(): FunctionProphecyStorage`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public function __construct(`
`15`	`15`	`) {`
`16`	`16`	`}`
`17`	`17`
	`18`	`+ /** @psalm-suppress PossiblyUnusedParam */`
`18`	`19`	`public function revealFunction(string $namespace, string $functionName): void`
`19`	`20`	`{`
`20`	`21`	`if ($this->isFunctionAlreadyRevealed($namespace, $functionName)) {`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* @author Heiko Jerichen <[email protected]>`
	`11`	`+ * @template-implements ProphecyInterface<self>`
`11`	`12`	`*/`
`12`	`13`	`readonly class NamespaceProphecy implements ProphecyInterface`
`13`	`14`	`{`
`@@ -47,12 +48,13 @@ public function prepare(string ...$functionNames): void`
`47`	`48`	`/**`
`48`	`49`	`* Reveals prophecy object (double) .`
`49`	`50`	`*/`
`50`		`- public function reveal(): void`
	`51`	`+ public function reveal(): self`
`51`	`52`	`{`
`52`	`53`	`$functionNames = $this->functionProphecyStorage->getFunctionNamesOfSetProphecies($this->namespace);`
`53`	`54`	`foreach ($functionNames as $functionName) {`
`54`	`55`	`$this->functionRevealer->revealFunction($this->namespace, $functionName);`
`55`	`56`	`}`
	`57`	`+ return $this;`
`56`	`58`	`}`
`57`	`59`
`58`	`60`	`public function unReveal(): void`