restructure the API test suite

Author: xabbuh

tests/Api/ActivityProfileApiClientTest.php

@@ -80,10 +80,17 @@ public function testDeleteDocument()
     {
         $activityProfile = $this->createActivityProfile();
 
-        $this->validateDeleteDocumentCall('activities/profile', array(
-            'activityId' => 'activity-id',
-            'profileId' => 'profile-id',
-        ));
+        $this->validateRequest(
+            'delete',
+            'activities/profile',
+            array(
+                'activityId' => 'activity-id',
+                'profileId' => 'profile-id',
+            ),
+            '',
+            $this->createResponseMock(204, '')
+        );
+        $this->validateSerializer(array());
 
         $this->client->deleteDocument($activityProfile);
     }

tests/Api/AgentProfileApiClientTest.php

@@ -87,14 +87,17 @@ public function testDeleteDocument()
     {
         $profile = $this->createAgentProfile();
 
-        $this->validateDeleteDocumentCall(
+        $this->validateRequest(
+            'delete',
             'agents/profile',
             array(
                 'agent' => 'agent-as-json',
                 'profileId' => 'profile-id',
             ),
-            array(array('data' => $profile->getAgent(), 'result' => 'agent-as-json'))
+            '',
+            $this->createResponseMock(204, '')
         );
+        $this->validateSerializer(array(array('data' => $profile->getAgent(), 'result' => 'agent-as-json')));
 
         $this->client->deleteDocument(
             $profile

tests/Api/ApiClientTest.php

@@ -42,16 +42,11 @@ abstract class ApiClientTest extends \PHPUnit_Framework_TestCase
 
     protected function setUp()
     {
-        $this->requestHandler = $this->createRequestHandlerMock();
-        $this->serializer = $this->createSerializerMock();
+        $this->requestHandler = $this->getMockBuilder('\Xabbuh\XApi\Client\Request\HandlerInterface')->getMock();
+        $this->serializer = $this->getMockBuilder('\Symfony\Component\Serializer\SerializerInterface')->getMock();
         $this->serializerRegistry = $this->createSerializerRegistry();
     }
 
-    protected function createRequestHandlerMock()
-    {
-        return $this->getMock('\Xabbuh\XApi\Client\Request\HandlerInterface');
-    }
-
     protected function createSerializerRegistry()
     {
         $registry = new SerializerRegistry();
@@ -63,76 +58,54 @@ protected function createSerializerRegistry()
         return $registry;
     }
 
-    protected function createSerializerMock()
-    {
-        return $this->getMock('\Symfony\Component\Serializer\SerializerInterface');
-    }
-
-    protected function validateDeserializer($data, $type, $returnValue)
-    {
-        $this->serializer
-            ->expects($this->once())
-            ->method('deserialize')
-            ->with($data, 'Xabbuh\XApi\Model\\'.$type, 'json')
-            ->will($this->returnValue($returnValue));
-    }
-
     protected function validateSerializer(array $serializerMap)
     {
         $this
             ->serializer
             ->expects($this->any())
             ->method('serialize')
-            ->will($this->returnCallback(function ($data) use ($serializerMap) {
+            ->willReturnCallback(function ($data) use ($serializerMap) {
                 foreach ($serializerMap as $entry) {
                     if ($data == $entry['data']) {
                         return $entry['result'];
                     }
                 }
 
                 return '';
-            }));
-    }
-
-    protected function createRequestMock($response = null)
-    {
-        $request = $this->getMock('\Guzzle\Http\Message\RequestInterface');
-
-        if (null !== $response) {
-            $request->expects($this->any())
-                ->method('send')
-                ->will($this->returnValue($response));
-        }
-
-        return $request;
+            });
     }
 
     protected function createResponseMock($statusCode, $body)
     {
-        $response = $this->getMock(
-            '\Guzzle\Http\Message\Response',
-            array(),
-            array($statusCode)
-        );
+        $response = $this->getMockBuilder('\Guzzle\Http\Message\Response')
+            ->disableOriginalConstructor()
+            ->getMock();
         $response->expects($this->any())
             ->method('getStatusCode')
-            ->will($this->returnValue($statusCode));
+            ->willReturn($statusCode);
         $response->expects($this->any())
             ->method('getBody')
-            ->will($this->returnValue($body));
+            ->willReturn($body);
 
         return $response;
     }
 
     protected function validateRequest($method, $uri, array $urlParameters, $body = null, $response = null)
     {
-        $request = $this->createRequestMock($response);
+        $request = $this->getMockBuilder('\Guzzle\Http\Message\RequestInterface')->getMock();
+
+        if (null !== $response) {
+            $request->expects($this->any())
+                ->method('send')
+                ->willReturn($response);
+        }
+
         $this
             ->requestHandler
             ->expects($this->once())
             ->method('createRequest')
             ->with($method, $uri, $urlParameters, $body)
-            ->will($this->returnValue($request));
+            ->willReturn($request);
 
         return $request;
     }
@@ -149,20 +122,24 @@ protected function validateRetrieveApiCall($method, $uri, array $urlParameters,
                 ->expects($this->once())
                 ->method('executeRequest')
                 ->with($request)
-                ->will($this->throwException(new NotFoundException('Not found')));
+                ->willThrowException(new NotFoundException('Not found'));
         } else {
             $this
                 ->requestHandler
                 ->expects($this->once())
                 ->method('executeRequest')
                 ->with($request)
-                ->will($this->returnValue($response));
+                ->willReturn($response);
         }
 
         $this->validateSerializer($serializerMap);
 
         if ($statusCode < 400) {
-            $this->validateDeserializer($rawResponse, $type, $transformedResult);
+            $this->serializer
+                ->expects($this->once())
+                ->method('deserialize')
+                ->with($rawResponse, 'Xabbuh\XApi\Model\\'.$type, 'json')
+                ->willReturn($transformedResult);
         }
     }
 
@@ -176,15 +153,8 @@ protected function validateStoreApiCall($method, $uri, array $urlParameters, $st
             ->expects($this->once())
             ->method('executeRequest')
             ->with($request, array($statusCode))
-            ->will($this->returnValue($response));
+            ->willReturn($response);
         $serializerMap[] = array('data' => $object, 'result' => $rawRequest);
         $this->validateSerializer($serializerMap);
     }
-
-    protected function validateDeleteDocumentCall($uri, array $urlParameters, array $serializerMap = array())
-    {
-        $response = $this->createResponseMock(204, '');
-        $this->validateRequest('delete', $uri, $urlParameters, '', $response);
-        $this->validateSerializer($serializerMap);
-    }
 }

tests/Api/StateApiClientTest.php

@@ -88,15 +88,18 @@ public function testDeleteDocument()
     {
         $state = $this->createState();
 
-        $this->validateDeleteDocumentCall(
+        $this->validateRequest(
+            'delete',
             'activities/state',
             array(
                 'activityId' => 'activity-id',
                 'agent' => 'agent-as-json',
                 'stateId' => 'state-id',
             ),
-            array(array('data' => $state->getActor(), 'result' => 'agent-as-json'))
+            '',
+            $this->createResponseMock(204, '')
         );
+        $this->validateSerializer(array(array('data' => $state->getActor(), 'result' => 'agent-as-json')));
 
         $this->client->deleteDocument($state);
     }

tests/Api/StatementsApiClientTest.php

@@ -298,7 +298,7 @@ public function testGetStatementsWithAgentInStatementsFilter()
             ->expects($this->once())
             ->method('serialize')
             ->with($agent, 'json')
-            ->will($this->returnValue($agentJson));
+            ->willReturn($agentJson);
         $this->validateRetrieveApiCall(
             'get',
             'statements',

tests/XApiClientTest.php

@@ -103,25 +103,25 @@ private function createSerializerRegistryMock()
         $serializerRegistry
             ->expects($this->any())
             ->method('getStatementSerializer')
-            ->will($this->returnValue($statementSerializer));
+            ->willReturn($statementSerializer);
 
         $statementResultSerializer = $this->getMock('\Xabbuh\XApi\Serializer\StatementResultSerializerInterface');
         $serializerRegistry
             ->expects($this->any())
             ->method('getStatementResultSerializer')
-            ->will($this->returnValue($statementResultSerializer));
+            ->willReturn($statementResultSerializer);
 
         $actorSerializer = $this->getMock('\Xabbuh\XApi\Serializer\ActorSerializerInterface');
         $serializerRegistry
             ->expects($this->any())
             ->method('getActorSerializer')
-            ->will($this->returnValue($actorSerializer));
+            ->willReturn($actorSerializer);
 
         $documentDataSerializer = $this->getMock('\Xabbuh\XApi\Serializer\DocumentDataSerializerInterface');
         $serializerRegistry
             ->expects($this->any())
             ->method('getDocumentDataSerializer')
-            ->will($this->returnValue($documentDataSerializer));
+            ->willReturn($documentDataSerializer);
 
         return $serializerRegistry;
     }