bug: mockery not setup correctly (#1785)

JimTools · web-flow · commit add2c0580eb3 · 2024-09-22T11:06:33.000-04:00
* bug: mockery not setup correctly Fixed a subtle bug in the way Mockery is setup in the project, versions of Mockery before version 1.0.0 would automatically register a listener with PHPUnit meaning that assertions in mockery would automatically count towards PHPUnit's assertion count. This results in devs adding hacks to make the unit tests pass i.e adding the `DoesNotPerformAssertions` attribute. https://docs.mockery.io/en/latest/reference/phpunit_integration.html * chore: apply cs fixes
diff --git a/tests/Unit/AccessTokenControllerTest.php b/tests/Unit/AccessTokenControllerTest.php
@@ -6,6 +6,7 @@
 use Laravel\Passport\Http\Controllers\AccessTokenController;
 use League\OAuth2\Server\AuthorizationServer;
 use League\OAuth2\Server\Exception\OAuthServerException as LeagueException;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use Nyholm\Psr7\Response;
 use PHPUnit\Framework\TestCase;
@@ -14,10 +15,7 @@
 
 class AccessTokenControllerTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_a_token_can_be_issued()
     {
diff --git a/tests/Unit/AccessTokenTest.php b/tests/Unit/AccessTokenTest.php
@@ -11,8 +11,6 @@ class AccessTokenTest extends TestCase
 {
     protected function tearDown(): void
     {
-        parent::tearDown();
-
         Passport::$withInheritedScopes = false;
     }
 
diff --git a/tests/Unit/ApiTokenCookieFactoryTest.php b/tests/Unit/ApiTokenCookieFactoryTest.php
@@ -7,16 +7,14 @@
 use Illuminate\Encryption\Encrypter;
 use Laravel\Passport\ApiTokenCookieFactory;
 use Laravel\Passport\Passport;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Cookie;
 
 class ApiTokenCookieFactoryTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_cookie_can_be_successfully_created()
     {
diff --git a/tests/Unit/ApproveAuthorizationControllerTest.php b/tests/Unit/ApproveAuthorizationControllerTest.php
@@ -6,17 +6,15 @@
 use Laravel\Passport\Http\Controllers\ApproveAuthorizationController;
 use League\OAuth2\Server\AuthorizationServer;
 use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use Nyholm\Psr7\Response;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ResponseInterface;
 
 class ApproveAuthorizationControllerTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_complete_authorization_request()
     {
diff --git a/tests/Unit/AuthorizationControllerTest.php b/tests/Unit/AuthorizationControllerTest.php
@@ -17,6 +17,7 @@
 use League\OAuth2\Server\Exception\OAuthServerException as LeagueException;
 use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
 use League\OAuth2\Server\RequestTypes\AuthorizationRequestInterface;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use Nyholm\Psr7\Response;
 use PHPUnit\Framework\TestCase;
@@ -25,10 +26,7 @@
 
 class AuthorizationControllerTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_authorization_view_is_presented()
     {
diff --git a/tests/Unit/AuthorizedAccessTokenControllerTest.php b/tests/Unit/AuthorizedAccessTokenControllerTest.php
@@ -8,12 +8,14 @@
 use Laravel\Passport\RefreshTokenRepository;
 use Laravel\Passport\Token;
 use Laravel\Passport\TokenRepository;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Response;
 
 class AuthorizedAccessTokenControllerTest extends TestCase
 {
+    use MockeryPHPUnitIntegration;
     /**
      * @var \Mockery\Mock|\Laravel\Passport\TokenRepository
      */
diff --git a/tests/Unit/BridgeAccessTokenRepositoryTest.php b/tests/Unit/BridgeAccessTokenRepositoryTest.php
@@ -10,15 +10,13 @@
 use Laravel\Passport\Bridge\Client;
 use Laravel\Passport\Bridge\Scope;
 use Laravel\Passport\TokenRepository;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
 class BridgeAccessTokenRepositoryTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_access_tokens_can_be_persisted()
     {
@@ -59,8 +57,6 @@ public function test_access_tokens_can_be_revoked()
 
         $repository = new AccessTokenRepository($tokenRepository, $events);
         $repository->revokeAccessToken('token-id');
-
-        $this->expectNotToPerformAssertions();
     }
 
     public function test_access_token_revoke_event_is_not_dispatched_when_nothing_happened()
@@ -73,8 +69,6 @@ public function test_access_token_revoke_event_is_not_dispatched_when_nothing_ha
 
         $repository = new AccessTokenRepository($tokenRepository, $events);
         $repository->revokeAccessToken('token-id');
-
-        $this->expectNotToPerformAssertions();
     }
 
     public function test_can_get_new_access_token()
diff --git a/tests/Unit/BridgeClientRepositoryTest.php b/tests/Unit/BridgeClientRepositoryTest.php
@@ -6,11 +6,14 @@
 use Laravel\Passport\Bridge\Client;
 use Laravel\Passport\Bridge\ClientRepository as BridgeClientRepository;
 use Laravel\Passport\ClientRepository;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
 class BridgeClientRepositoryTest extends TestCase
 {
+    use MockeryPHPUnitIntegration;
+
     /**
      * @var \Laravel\Passport\ClientRepository
      */
diff --git a/tests/Unit/BridgeRefreshTokenRepositoryTest.php b/tests/Unit/BridgeRefreshTokenRepositoryTest.php
@@ -9,15 +9,13 @@
 use Laravel\Passport\Bridge\RefreshToken;
 use Laravel\Passport\Bridge\RefreshTokenRepository as BridgeRefreshTokenRepository;
 use Laravel\Passport\RefreshTokenRepository;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
 class BridgeRefreshTokenRepositoryTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_access_tokens_can_be_persisted()
     {
diff --git a/tests/Unit/BridgeScopeRepositoryTest.php b/tests/Unit/BridgeScopeRepositoryTest.php
@@ -8,11 +8,14 @@
 use Laravel\Passport\Client as ClientModel;
 use Laravel\Passport\ClientRepository;
 use Laravel\Passport\Passport;
-use Mockery;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
+use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
 class BridgeScopeRepositoryTest extends TestCase
 {
+    use MockeryPHPUnitIntegration;
+
     protected function tearDown(): void
     {
         Passport::$withInheritedScopes = false;
@@ -24,9 +27,9 @@ public function test_invalid_scopes_are_removed()
             'scope-1' => 'description',
         ]);
 
-        $client = Mockery::mock(ClientModel::class)->makePartial();
+        $client = m::mock(ClientModel::class)->makePartial();
 
-        $clients = Mockery::mock(ClientRepository::class);
+        $clients = m::mock(ClientRepository::class);
         $clients->shouldReceive('findActive')->withAnyArgs()->andReturn($client);
 
         $repository = new ScopeRepository($clients);
@@ -44,10 +47,10 @@ public function test_invalid_scopes_are_removed_without_a_client_repository()
             'scope-1' => 'description',
         ]);
 
-        $clients = Mockery::mock(ClientRepository::class);
+        $clients = m::mock(ClientRepository::class);
         $clients->shouldReceive('findActive')
             ->with('id')
-            ->andReturn(Mockery::mock(ClientModel::class)->makePartial());
+            ->andReturn(m::mock(ClientModel::class)->makePartial());
 
         $repository = new ScopeRepository($clients);
 
@@ -65,10 +68,10 @@ public function test_clients_do_not_restrict_scopes_by_default()
             'scope-2' => 'description',
         ]);
 
-        $client = Mockery::mock(ClientModel::class)->makePartial();
+        $client = m::mock(ClientModel::class)->makePartial();
         $client->scopes = null;
 
-        $clients = Mockery::mock(ClientRepository::class);
+        $clients = m::mock(ClientRepository::class);
         $clients->shouldReceive('findActive')->withAnyArgs()->andReturn($client);
 
         $repository = new ScopeRepository($clients);
@@ -87,10 +90,10 @@ public function test_scopes_disallowed_for_client_are_removed()
             'scope-2' => 'description',
         ]);
 
-        $client = Mockery::mock(ClientModel::class)->makePartial();
+        $client = m::mock(ClientModel::class)->makePartial();
         $client->scopes = ['scope-1'];
 
-        $clients = Mockery::mock(ClientRepository::class);
+        $clients = m::mock(ClientRepository::class);
         $clients->shouldReceive('findActive')->withAnyArgs()->andReturn($client);
 
         $repository = new ScopeRepository($clients);
@@ -112,10 +115,10 @@ public function test_scopes_disallowed_for_client_are_removed_but_inherited_scop
             'scope-2' => 'description',
         ]);
 
-        $client = Mockery::mock(ClientModel::class)->makePartial();
+        $client = m::mock(ClientModel::class)->makePartial();
         $client->scopes = ['scope-1'];
 
-        $clients = Mockery::mock(ClientRepository::class);
+        $clients = m::mock(ClientRepository::class);
         $clients->shouldReceive('findActive')->withAnyArgs()->andReturn($client);
 
         $repository = new ScopeRepository($clients);
@@ -133,9 +136,9 @@ public function test_superuser_scope_cant_be_applied_if_wrong_grant()
             'scope-1' => 'description',
         ]);
 
-        $client = Mockery::mock(ClientModel::class)->makePartial();
+        $client = m::mock(ClientModel::class)->makePartial();
 
-        $clients = Mockery::mock(ClientRepository::class);
+        $clients = m::mock(ClientRepository::class);
         $clients->shouldReceive('findActive')->withAnyArgs()->andReturn($client);
 
         $repository = new ScopeRepository($clients);
@@ -153,10 +156,10 @@ public function test_superuser_scope_cant_be_applied_if_wrong_grant_without_a_cl
             'scope-1' => 'description',
         ]);
 
-        $clients = Mockery::mock(ClientRepository::class);
+        $clients = m::mock(ClientRepository::class);
         $clients->shouldReceive('findActive')
             ->with('id')
-            ->andReturn(Mockery::mock(ClientModel::class)->makePartial());
+            ->andReturn(m::mock(ClientModel::class)->makePartial());
 
         $repository = new ScopeRepository($clients);
 
diff --git a/tests/Unit/CheckClientCredentialsForAnyScopeTest.php b/tests/Unit/CheckClientCredentialsForAnyScopeTest.php
@@ -7,16 +7,14 @@
 use Laravel\Passport\Http\Middleware\CheckClientCredentialsForAnyScope;
 use League\OAuth2\Server\Exception\OAuthServerException;
 use League\OAuth2\Server\ResourceServer;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
 
 class CheckClientCredentialsForAnyScopeTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_request_is_passed_along_if_token_is_valid()
     {
diff --git a/tests/Unit/CheckClientCredentialsTest.php b/tests/Unit/CheckClientCredentialsTest.php
@@ -7,16 +7,14 @@
 use Laravel\Passport\Http\Middleware\CheckClientCredentials;
 use League\OAuth2\Server\Exception\OAuthServerException;
 use League\OAuth2\Server\ResourceServer;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
 
 class CheckClientCredentialsTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_request_is_passed_along_if_token_is_valid()
     {
diff --git a/tests/Unit/CheckForAnyScopeTest.php b/tests/Unit/CheckForAnyScopeTest.php
@@ -4,15 +4,13 @@
 
 use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Http\Middleware\CheckForAnyScope as CheckScopes;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
 class CheckForAnyScopeTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_request_is_passed_along_if_scopes_are_present_on_token()
     {
diff --git a/tests/Unit/CheckScopesTest.php b/tests/Unit/CheckScopesTest.php
@@ -4,15 +4,13 @@
 
 use Laravel\Passport\Exceptions\AuthenticationException;
 use Laravel\Passport\Http\Middleware\CheckScopes;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 
 class CheckScopesTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_request_is_passed_along_if_scopes_are_present_on_token()
     {
diff --git a/tests/Unit/ClientControllerTest.php b/tests/Unit/ClientControllerTest.php
@@ -8,16 +8,14 @@
 use Laravel\Passport\ClientRepository;
 use Laravel\Passport\Http\Controllers\ClientController;
 use Laravel\Passport\Http\Rules\RedirectRule;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Response;
 
 class ClientControllerTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function test_all_the_clients_for_the_current_user_can_be_retrieved()
     {
diff --git a/tests/Unit/CreateFreshApiTokenTest.php b/tests/Unit/CreateFreshApiTokenTest.php
@@ -7,16 +7,14 @@
 use Laravel\Passport\ApiTokenCookieFactory;
 use Laravel\Passport\Http\Middleware\CreateFreshApiToken;
 use Laravel\Passport\Passport;
+use Mockery\Adapter\Phpunit\MockeryPHPUnitIntegration;
 use Mockery as m;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Cookie;
 
 class CreateFreshApiTokenTest extends TestCase
 {
-    protected function tearDown(): void
-    {
-        m::close();
-    }
+    use MockeryPHPUnitIntegration;
 
     public function testShouldReceiveAFreshToken()
     {
diff --git a/tests/Unit/DenyAuthorizationControllerTest.php b/tests/Unit/DenyAuthorizationControllerTest.php
diff --git a/tests/Unit/HandlesOAuthErrorsTest.php b/tests/Unit/HandlesOAuthErrorsTest.php
diff --git a/tests/Unit/HasApiTokensTest.php b/tests/Unit/HasApiTokensTest.php
diff --git a/tests/Unit/PassportServiceProviderTest.php b/tests/Unit/PassportServiceProviderTest.php
diff --git a/tests/Unit/PersonalAccessTokenControllerTest.php b/tests/Unit/PersonalAccessTokenControllerTest.php
diff --git a/tests/Unit/RedirectRuleTest.php b/tests/Unit/RedirectRuleTest.php
diff --git a/tests/Unit/TokenGuardTest.php b/tests/Unit/TokenGuardTest.php
diff --git a/tests/Unit/TransientTokenControllerTest.php b/tests/Unit/TransientTokenControllerTest.php

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@ class AccessTokenTest extends TestCase`
`11`	`11`	`{`
`12`	`12`	`protected function tearDown(): void`
`13`	`13`	`{`
`14`		`- parent::tearDown();`
`15`		`-`
`16`	`14`	`Passport::$withInheritedScopes = false;`
`17`	`15`	`}`
`18`	`16`