Merge pull request dingo#1716 from loonpwn/feat/phpunit-8

[3.x] PHPUnit 8.5

Author: specialtactics

composer.json

@@ -32,7 +32,7 @@
         "illuminate/pagination": "^5.5 || ^6.0 || ^7.0",
         "laravel/lumen-framework": "^5.5 || ^6.0 || ^7.0",
         "mockery/mockery": "~1.0",
-        "phpunit/phpunit": "^4.8.35 || ^5.4.3 || ^6.5",
+        "phpunit/phpunit": "^4.8.35 || ^5.4.3 || ^6.5 || ^8.5",
         "squizlabs/php_codesniffer": "~2.0",
         "tymon/jwt-auth": "1.0.*"
     },

phpunit.xml.dist

@@ -13,7 +13,6 @@
          processIsolation="false"
          stopOnError="false"
          stopOnFailure="false"
-         syntaxCheck="true"
          verbose="true"
     >
     <testsuites>

tests/Auth/AuthTest.php

@@ -2,36 +2,45 @@
 
 namespace Dingo\Api\Tests\Auth;
 
-use Mockery as m;
 use Dingo\Api\Auth\Auth;
+use Dingo\Api\Contract\Auth\Provider;
 use Dingo\Api\Http\Request;
 use Dingo\Api\Routing\Route;
 use Dingo\Api\Routing\Router;
-use PHPUnit\Framework\TestCase;
+use Dingo\Api\Tests\BaseTestCase;
 use Illuminate\Container\Container;
-use Dingo\Api\Contract\Auth\Provider;
+use Mockery as m;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
 
-class AuthTest extends TestCase
+class AuthTest extends BaseTestCase
 {
-    public function setUp()
+    /**
+     * @var Container
+     */
+    protected $container;
+    /**
+     * @var Router|m\LegacyMockInterface|m\MockInterface
+     */
+    protected $router;
+    /**
+     * @var Auth
+     */
+    protected $auth;
+
+    public function setUp(): void
     {
+        parent::setUp();
+
         $this->container = new Container;
         $this->router = m::mock(Router::class);
         $this->auth = new Auth($this->router, $this->container, []);
     }
 
-    public function tearDown()
-    {
-        m::close();
-    }
-
-    /**
-     * @expectedException \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
-     */
     public function testExceptionThrownWhenAuthorizationHeaderNotSet()
     {
+        $this->expectException(UnauthorizedHttpException::class);
+
         $this->router->shouldReceive('getCurrentRoute')->once()->andReturn($route = m::mock(Route::class));
         $this->router->shouldReceive('getCurrentRequest')->once()->andReturn($request = Request::create('foo', 'GET'));
 
@@ -43,11 +52,10 @@ public function testExceptionThrownWhenAuthorizationHeaderNotSet()
         $this->auth->authenticate();
     }
 
-    /**
-     * @expectedException \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
-     */
     public function testExceptionThrownWhenProviderFailsToAuthenticate()
     {
+        $this->expectException(UnauthorizedHttpException::class);
+
         $this->router->shouldReceive('getCurrentRoute')->once()->andReturn($route = m::mock(Route::class));
         $this->router->shouldReceive('getCurrentRequest')->once()->andReturn($request = Request::create('foo', 'GET'));
 

tests/Auth/Provider/AuthorizationTest.php

@@ -2,24 +2,19 @@
 
 namespace Dingo\Api\Tests\Auth\Provider;
 
-use Mockery as m;
 use Dingo\Api\Routing\Route;
-use Illuminate\Http\Request;
-use PHPUnit\Framework\TestCase;
+use Dingo\Api\Tests\BaseTestCase;
 use Dingo\Api\Tests\Stubs\AuthorizationProviderStub;
+use Illuminate\Http\Request;
+use Mockery as m;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
-class AuthorizationTest extends TestCase
+class AuthorizationTest extends BaseTestCase
 {
-    public function tearDown()
-    {
-        m::close();
-    }
-
-    /**
-     * @expectedException \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
-     */
     public function testExceptionThrownWhenAuthorizationHeaderIsInvalid()
     {
+        $this->expectException(BadRequestHttpException::class);
+
         $request = Request::create('GET', '/');
 
         (new AuthorizationProviderStub)->authenticate($request, m::mock(Route::class));

tests/Auth/Provider/BasicTest.php

@@ -2,38 +2,36 @@
 
 namespace Dingo\Api\Tests\Auth\Provider;
 
-use Mockery as m;
+use Dingo\Api\Auth\Provider\Basic;
+use Dingo\Api\Routing\Route;
+use Dingo\Api\Tests\BaseTestCase;
 use Illuminate\Http\Request;
 use Illuminate\Http\Response;
-use PHPUnit\Framework\TestCase;
-use Dingo\Api\Auth\Provider\Basic;
+use Mockery as m;
+use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
 
-class BasicTest extends TestCase
+class BasicTest extends BaseTestCase
 {
     protected $auth;
     protected $provider;
 
-    public function setUp()
+    public function setUp(): void
     {
+        parent::setUp();
+
         $this->auth = m::mock('Illuminate\Auth\AuthManager');
         $this->provider = new Basic($this->auth);
     }
 
-    public function tearDown()
-    {
-        m::close();
-    }
-
-    /**
-     * @expectedException \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
-     */
     public function testInvalidBasicCredentialsThrowsException()
     {
+        $this->expectException(UnauthorizedHttpException::class);
+
         $request = Request::create('GET', '/', [], [], [], ['HTTP_AUTHORIZATION' => 'Basic 12345']);
 
         $this->auth->shouldReceive('onceBasic')->once()->with('email')->andReturn(new Response('', 401));
 
-        $this->provider->authenticate($request, m::mock(\Dingo\Api\Routing\Route::class));
+        $this->provider->authenticate($request, m::mock(Route::class));
     }
 
     public function testValidCredentialsReturnsUser()
@@ -43,6 +41,6 @@ public function testValidCredentialsReturnsUser()
         $this->auth->shouldReceive('onceBasic')->once()->with('email')->andReturn(null);
         $this->auth->shouldReceive('user')->once()->andReturn('foo');
 
-        $this->assertSame('foo', $this->provider->authenticate($request, m::mock(\Dingo\Api\Routing\Route::class)));
+        $this->assertSame('foo', $this->provider->authenticate($request, m::mock(Route::class)));
     }
 }

tests/Auth/Provider/JWTTest.php

@@ -2,49 +2,47 @@
 
 namespace Dingo\Api\Tests\Auth\Provider;
 
-use Mockery as m;
-use Illuminate\Http\Request;
-use PHPUnit\Framework\TestCase;
 use Dingo\Api\Auth\Provider\JWT;
+use Dingo\Api\Routing\Route;
+use Dingo\Api\Tests\BaseTestCase;
+use Illuminate\Http\Request;
+use Mockery as m;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;
 use Tymon\JWTAuth\Exceptions\JWTException;
 
-class JWTTest extends TestCase
+class JWTTest extends BaseTestCase
 {
     protected $auth;
     protected $provider;
 
-    public function setUp()
+    public function setUp(): void
     {
+        parent::setUp();
+
         $this->auth = m::mock('Tymon\JWTAuth\JWTAuth');
         $this->provider = new JWT($this->auth);
     }
 
-    public function tearDown()
-    {
-        m::close();
-    }
-
-    /**
-     * @expectedException \Symfony\Component\HttpKernel\Exception\BadRequestHttpException
-     */
     public function testValidatingAuthorizationHeaderFailsAndThrowsException()
     {
+        $this->expectException(BadRequestHttpException::class);
+
         $request = Request::create('foo', 'GET');
-        $this->provider->authenticate($request, m::mock(\Dingo\Api\Routing\Route::class));
+        $this->provider->authenticate($request, m::mock(Route::class));
     }
 
-    /**
-     * @expectedException \Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException
-     */
     public function testAuthenticatingFailsAndThrowsException()
     {
+        $this->expectException(UnauthorizedHttpException::class);
+
         $request = Request::create('foo', 'GET');
         $request->headers->set('authorization', 'Bearer foo');
 
         $this->auth->shouldReceive('setToken')->with('foo')->andReturn(m::self());
         $this->auth->shouldReceive('authenticate')->once()->andThrow(new JWTException('foo'));
 
-        $this->provider->authenticate($request, m::mock(\Dingo\Api\Routing\Route::class));
+        $this->provider->authenticate($request, m::mock(Route::class));
     }
 
     public function testAuthenticatingSucceedsAndReturnsUserObject()
@@ -55,7 +53,7 @@ public function testAuthenticatingSucceedsAndReturnsUserObject()
         $this->auth->shouldReceive('setToken')->with('foo')->andReturn(m::self());
         $this->auth->shouldReceive('authenticate')->once()->andReturn((object) ['id' => 1]);
 
-        $this->assertSame(1, $this->provider->authenticate($request, m::mock(\Dingo\Api\Routing\Route::class))->id);
+        $this->assertSame(1, $this->provider->authenticate($request, m::mock(Route::class))->id);
     }
 
     public function testAuthenticatingWithQueryStringSucceedsAndReturnsUserObject()
@@ -65,6 +63,6 @@ public function testAuthenticatingWithQueryStringSucceedsAndReturnsUserObject()
         $this->auth->shouldReceive('setToken')->with('foo')->andReturn(m::self());
         $this->auth->shouldReceive('authenticate')->once()->andReturn((object) ['id' => 1]);
 
-        $this->assertSame(1, $this->provider->authenticate($request, m::mock(\Dingo\Api\Routing\Route::class))->id);
+        $this->assertSame(1, $this->provider->authenticate($request, m::mock(Route::class))->id);
     }
 }

tests/BaseTestCase.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Dingo\Api\Tests;
+
+use Dingo\Api\Http\Response;
+use Mockery;
+use PHPUnit\Framework\TestCase;
+
+class BaseTestCase extends TestCase
+{
+    public function tearDown(): void
+    {
+        parent::tearDown();
+        // make sure mocker is cleaned up
+        Mockery::close();
+        // reset response formatters on tear down
+        Response::setFormatters([]);
+        Response::setFormatsOptions([]);
+    }
+
+    public function setUp(): void
+    {
+        parent::setUp();
+    }
+}