Merge pull request #45 from cabello/patch-2

Create JsonResponse and add response status code assertions

Author: robocoder

Test/Functional/WebTestCase.php

@@ -6,8 +6,8 @@
 namespace IC\Bundle\Base\TestBundle\Test\Functional;
 
 use Doctrine\Common\DataFixtures\Purger\ORMPurger;
-use Symfony\Bundle\FrameworkBundle\Test\WebTestCase as BaseWebTestCase;
 use IC\Bundle\Base\TestBundle\Test\Loader;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase as BaseWebTestCase;
 
 /**
  * Abstract class for Web test cases
@@ -181,4 +181,84 @@ protected static function getFixtureList()
     {
         return array();
     }
+
+    /**
+     * Assert HTTP response status code is 200 OK.
+     *
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @param string                                     $message
+     */
+    protected function assertResponseStatusOk($response, $message = '')
+    {
+        $this->assertResponseStatusCode(200, $response, $message);
+    }
+
+    /**
+     * Assert HTTP response status code is Redirection 3xx.
+     *
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @param string                                     $message
+     */
+    protected function assertResponseStatusRedirection($response, $message = '')
+    {
+        $this->assertGreaterThanOrEqual(300, $response->getStatusCode(), $message);
+        $this->assertLessThanOrEqual(399, $response->getStatusCode(), $message);
+    }
+
+    /**
+     * Assert HTTP response status code is 301 Moved.
+     *
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @param string                                     $message
+     */
+    protected function assertResponseStatusMoved($response, $message = '')
+    {
+        $this->assertResponseStatusCode(301, $response, $message);
+    }
+
+    /**
+     * Assert HTTP response status code is 302 Found.
+     *
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @param string                                     $message
+     */
+    protected function assertResponseStatusFound($response, $message = '')
+    {
+        $this->assertResponseStatusCode(302, $response, $message);
+    }
+
+    /**
+     * Assert HTTP response status code is 404 Not Found.
+     *
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @param string                                     $message
+     */
+    protected function assertResponseStatusNotFound($response, $message = '')
+    {
+        $this->assertResponseStatusCode(404, $response, $message);
+    }
+
+    /**
+     * Assert HTTP response status code matches the expected.
+     *
+     * @param integer                                    $expectedStatusCode
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @param string                                     $message
+     */
+    protected function assertResponseStatusCode($expectedStatusCode, $response, $message = '')
+    {
+        $this->assertEquals($expectedStatusCode, $response->getStatusCode(), $message);
+    }
+
+    /**
+     * Assert HTTP response header location matches the expected.
+     *
+     * @param string|null                                $expectedLocation
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     * @param  string $message
+     */
+    protected function assertResponseRedirectionLocation($expectedLocation, $response, $message = '')
+    {
+        $this->assertEquals($expectedLocation, $response->headers->get('location'), $message);
+    }
 }

Test/Helper/SessionHelper.php

@@ -89,7 +89,7 @@ public function authenticate(UserInterface $user, $firewall)
 
         $this->session->set('_security_' . $firewall, serialize($token));
         $this->session->save();
-        
+
         $this->client->getCookieJar()->set(new Cookie($this->session->getName(), $this->session->getId()));
     }
 

Test/Model/JsonResponse.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * @copyright 2013 Instaclick Inc.
+ */
+
+namespace IC\Bundle\Base\TestBundle\Test\Model;
+
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\PropertyAccess\PropertyAccess;
+
+/**
+ * Provides accessor to properties of a JSON encoded response.
+ *
+ * @author Danilo Cabello <danilo.cabello@gmail.com>
+ */
+class JsonResponse
+{
+    /**
+     * Original response.
+     *
+     * @var \Symfony\Component\HttpFoundation\Response
+     */
+    private $response;
+
+    /**
+     * Decoded JSON response into StdClass object.
+     *
+     * @var StdClass|null
+     */
+    private $responseObject = null;
+
+    /**
+     * Constructor needs the original response and creates a property accessor.
+     *
+     * @param \Symfony\Component\HttpFoundation\Response $response
+     */
+    public function __construct(Response $response)
+    {
+        $this->response       = $response;
+        $this->responseObject = json_decode($this->response->getContent());
+        $this->accessor       = PropertyAccess::getPropertyAccessor();
+    }
+
+    /**
+     * If method is not implemented here, try calling method from original response.
+     *
+     * @param string $methodName
+     * @param array  $argumentList
+     *
+     * @return mixed Return type will be the same from original method.
+     */
+    public function __call($methodName, $argumentList)
+    {
+        return call_user_func_array(array($this->response, $methodName), $argumentList);
+    }
+
+    /**
+     * Retrieve decoded JSON response into StdClass object.
+     *
+     * @return StdClass
+     */
+    public function getResponseObject()
+    {
+        return $this->responseObject;
+    }
+
+    /**
+     * Retrieve property from decoded object.
+     *
+     * @param string $propertyPath
+     *
+     * @return mixed
+     */
+    public function getProperty($propertyPath)
+    {
+        return $this->accessor->getValue($this->getResponseObject(), $propertyPath);
+    }
+}

Test/WebTestCase.php

@@ -80,13 +80,12 @@ public function getHelper($name)
 
     /**
      * Add helper to helper list.
-     * 
+     *
      * @param string $name
      * @param string $namespace
      */
     public function addHelper($name, $namespace)
     {
         $this->helperList->set($name, $namespace);
     }
-
 }