convert PHPUnit Mocks to Mockery

Author: LordSimal

.phive/phars.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="1.11.11" installed="1.11.11" location="./tools/phpstan" copy="false"/>
-  <phar name="psalm" version="5.25.0" installed="5.25.0" location="./tools/psalm" copy="false"/>
+    <phar name="phpstan" version="1.12.3" installed="1.12.3" location="./tools/phpstan" copy="false"/>
+    <phar name="psalm" version="5.26.1" installed="5.26.1" location="./tools/psalm" copy="false"/>
 </phive>

composer.json

@@ -9,6 +9,7 @@
     },
     "require-dev": {
         "cakephp/cakephp-codesniffer": "^5.0",
+        "mockery/mockery": "^1.6",
         "phpunit/phpunit": "^10.5.5 || ^11.1.3"
     },
     "license": "MIT",
@@ -17,6 +18,11 @@
             "CakeSentry\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "CakeSentry\\Test\\": "tests/"
+        }
+    },
     "scripts": {
         "test": "phpunit",
         "cs-check": "phpcs --colors -p",

tests/TestCase/CakeSentryInitTest.php

@@ -7,7 +7,7 @@
 use Cake\TestSuite\TestCase;
 use CakeSentry\CakeSentryInit;
 
-final class CakeSentryInitTest extends TestCase
+class CakeSentryInitTest extends TestCase
 {
     /**
      * @inheritDoc

tests/TestCase/Database/CakeSentryLogTest.php

@@ -10,7 +10,7 @@
 use PHPUnit\Framework\Attributes\DataProvider;
 use Psr\Log\LogLevel;
 
-final class CakeSentryLogTest extends TestCase
+class CakeSentryLogTest extends TestCase
 {
     protected CakeSentryLog $logger;
 

tests/TestCase/Error/SentryErrorLoggerTest.php

@@ -7,13 +7,15 @@
 use Cake\Error\PhpError;
 use CakeSentry\Error\SentryErrorLogger;
 use CakeSentry\Http\SentryClient;
+use Mockery;
 use PHPUnit\Framework\TestCase;
-use ReflectionProperty;
 use RuntimeException;
 
-final class SentryErrorLoggerTest extends TestCase
+class SentryErrorLoggerTest extends TestCase
 {
-    private SentryErrorLogger $subject;
+    protected SentryErrorLogger $logger;
+
+    protected SentryClient $client;
 
     /**
      * @inheritDoc
@@ -23,13 +25,9 @@ public function setUp(): void
         parent::setUp();
 
         Configure::write('Sentry.dsn', 'https://[email protected]/yourproject/1');
-        $subject = new SentryErrorLogger([]);
-
-        $clientMock = $this->createMock(SentryClient::class);
-        $this->subject = $subject;
-
-        $clientProp = $this->getClientProp();
-        $clientProp->setValue($this->subject, $clientMock);
+        $logger = new SentryErrorLogger([]);
+        $this->logger = $logger;
+        $this->client = Mockery::mock(SentryClient::class);
     }
 
     /**
@@ -38,13 +36,8 @@ public function setUp(): void
     public function testLogException()
     {
         $excpetion = new RuntimeException('some error');
-
-        $client = $this->getClientProp()->getValue($this->subject);
-        $client->expects($this->once())
-            ->method('captureException')
-            ->with($excpetion);
-
-        $this->subject->logException($excpetion);
+        $this->client->shouldReceive('captureException')->with($excpetion, null);
+        $this->assertNull($this->logger->logException($excpetion));
     }
 
     /**
@@ -53,25 +46,7 @@ public function testLogException()
     public function testLogError()
     {
         $phpError = new PhpError(E_USER_WARNING, 'some error');
-
-        $client = $this->getClientProp()->getValue($this->subject);
-        $client->expects($this->once())
-            ->method('captureError')
-            ->with($phpError);
-
-        $this->subject->logError($phpError);
-    }
-
-    /**
-     * Helper access subject::$client(reflection)
-     *
-     * @return ReflectionProperty Client reflection
-     */
-    private function getClientProp()
-    {
-        $clientProp = new ReflectionProperty($this->subject, 'client');
-        $clientProp->setAccessible(true);
-
-        return $clientProp;
+        $this->client->shouldReceive('captureError')->with($phpError, null);
+        $this->assertNull($this->logger->logError($phpError));
     }
 }

tests/TestCase/Http/ClientTest.php

@@ -11,6 +11,7 @@
 use CakeSentry\CakeSentryInit;
 use CakeSentry\Http\SentryClient;
 use Exception;
+use Mockery;
 use RuntimeException;
 use Sentry\ClientBuilder;
 use Sentry\ClientInterface;
@@ -20,7 +21,7 @@
 use Sentry\Options;
 use Sentry\State\Hub;
 
-final class ClientTest extends TestCase
+class ClientTest extends TestCase
 {
     /**
      * @inheritDoc
@@ -59,6 +60,7 @@ public function testSetupClientSetOptions(): void
     {
         Configure::write('Sentry.server_name', 'test-server');
 
+        CakeSentryInit::init();
         $subject = new SentryClient();
         $options = $subject->getHub()->getClient()->getOptions();
 
@@ -117,16 +119,13 @@ function () use (&$called) {
     public function testCaptureException(): void
     {
         $subject = new SentryClient();
-        $sentryClientP = $this->createConfiguredMock(ClientInterface::class, [
-            'captureException' => null,
-        ]);
-        $subject->getHub()->bindClient($sentryClientP);
+        $client = Mockery::mock(ClientInterface::class);
+        $client->shouldReceive('captureException')->once()->andReturn(null);
+        $subject->getHub()->bindClient($client);
 
         $exception = new RuntimeException('something wrong.');
         $subject->captureException($exception);
-
-        $result = $sentryClientP->captureException($exception);
-        $this->assertSame(null, $result);
+        $this->assertTrue(true);
     }
 
     /**
@@ -227,10 +226,9 @@ public function testCaptureErrorWithAdditionalData(): void
     public function testCaptureDispatchBeforeExceptionCapture(): void
     {
         $subject = new SentryClient();
-        $sentryClientP = $this->createConfiguredMock(ClientInterface::class, [
-            'captureException' => null,
-        ]);
-        $subject->getHub()->bindClient($sentryClientP);
+        $client = Mockery::mock(ClientInterface::class);
+        $client->shouldReceive('captureException')->andReturn(null);
+        $subject->getHub()->bindClient($client);
 
         $called = false;
         EventManager::instance()->on(

tests/TestCase/Middleware/CakeSentryMiddlewareTest.php

@@ -9,9 +9,10 @@
 use Cake\TestSuite\TestCase;
 use CakeSentry\Database\Log\CakeSentryLog;
 use CakeSentry\Middleware\CakeSentryQueryMiddleware;
+use Mockery;
 use Psr\Http\Server\RequestHandlerInterface;
 
-final class CakeSentryMiddlewareTest extends TestCase
+class CakeSentryMiddlewareTest extends TestCase
 {
     public function testQueryLoggingEnabled(): void
     {
@@ -25,10 +26,10 @@ public function testQueryLoggingEnabled(): void
             'body' => '<html><title>test</title><body><p>some text</p></body>',
         ]);
 
-        $handler = $this->handler();
-        $handler->expects($this->once())
-            ->method('handle')
-            ->willReturn($response);
+        $handler = Mockery::mock(RequestHandlerInterface::class);
+        $handler->shouldReceive('handle')
+            ->once()
+            ->andReturn($response);
 
         $middleware = new CakeSentryQueryMiddleware();
         $response = $middleware->process($request, $handler);
@@ -41,13 +42,4 @@ public function testQueryLoggingEnabled(): void
             $this->assertSame(CakeSentryLog::class, get_class($driver->getLogger()));
         }
     }
-
-    protected function handler()
-    {
-        $handler = $this->getMockBuilder(RequestHandlerInterface::class)
-            ->onlyMethods(['handle'])
-            ->getMock();
-
-        return $handler;
-    }
 }