Merge pull request #116 from FriendsOfSymfony/test-naming

Make test naming more consistent with bundle

Author: dbu

doc/testing-your-application.rst

@@ -19,7 +19,7 @@ By having your test classes extend ``VarnishTestCase``, you get:
 * ``$this->varnish`` referring to an instance of this library’s Varnish client
   that is configured to talk to your Varnish server
 * convenience methods for executing HTTP requests to your application:
-  ``$this->getClient()`` and ``$this->getResponse()``
+  ``$this->getHttpClient()`` and ``$this->getResponse()``
 * custom assertions ``assertHit`` and ``assertMiss`` for validating a cache hit/miss.
 
 Configuration

src/Test/NginxTestCase.php

@@ -32,7 +32,7 @@
  * NGINX_FILE         NGINX configuration file (required if not passed to setUp)
  * NGINX_CACHE_PATH   NGINX configuration file (required if not passed to setUp)
  */
-abstract class NginxTestCase extends AbstractProxyClientTestCase
+abstract class NginxTestCase extends ProxyTestCase
 {
     /**
      * @var NginxProxy

src/Test/AbstractProxyClientTestCase.php renamed to src/Test/ProxyTestCase.php

@@ -20,14 +20,14 @@
  * Abstract caching proxy test case
  *
  */
-abstract class AbstractProxyClientTestCase extends \PHPUnit_Framework_TestCase
+abstract class ProxyTestCase extends \PHPUnit_Framework_TestCase
 {
     /**
      * A Guzzle HTTP client.
      *
      * @var Client
      */
-    protected $client;
+    protected $httpClient;
 
     /**
      * Assert a cache miss
@@ -72,24 +72,24 @@ public static function isCacheMiss()
      */
     public function getResponse($url, array $headers = array(), $options = array())
     {
-        return $this->getClient()->get($url, $headers, $options)->send();
+        return $this->getHttpClient()->get($url, $headers, $options)->send();
     }
 
     /**
      * Get HTTP client for your application
      *
      * @return Client
      */
-    public function getClient()
+    public function getHttpClient()
     {
-        if (null === $this->client) {
-            $this->client = new Client(
+        if (null === $this->httpClient) {
+            $this->httpClient = new Client(
                 'http://' . $this->getHostName() . ':' . $this->getCachingProxyPort(),
                 array('curl.options' => array(CURLOPT_FORBID_REUSE => true))
             );
         }
 
-        return $this->client;
+        return $this->httpClient;
     }
 
     /**
@@ -125,12 +125,23 @@ protected function getHostName()
     }
 
     /**
+     * Get proxy server
+     *
      * @return \FOS\HttpCache\Test\Proxy\ProxyInterface
      */
     abstract protected function getProxy();
 
     /**
+     * Get proxy client
+     *
      * @return \FOS\HttpCache\ProxyClient\ProxyClientInterface
      */
     abstract protected function getProxyClient();
+
+    /**
+     * Get port that caching proxy listens on
+     *
+     * @return int
+     */
+    abstract protected function getCachingProxyPort();
 }

src/Test/VarnishTestCase.php

@@ -13,7 +13,6 @@
 
 use FOS\HttpCache\ProxyClient\Varnish;
 use FOS\HttpCache\Test\Proxy\VarnishProxy;
-use Symfony\Component\Process\Process;
 
 /**
  * A phpunit base class to write functional tests with varnish.
@@ -39,7 +38,7 @@
  *                      (default /tmp/foshttpcache-test)
  * WEB_SERVER_HOSTNAME  name of the webserver varnish has to talk to (required)
  */
-abstract class VarnishTestCase extends AbstractProxyClientTestCase
+abstract class VarnishTestCase extends ProxyTestCase
 {
     /**
      * @var Varnish

tests/Functional/Varnish/UserContextFailureTest.php

@@ -78,7 +78,9 @@ public function testUserContextNotUsed()
         $this->getResponse('/user_context.php', array(), array('cookies' => array('foo')));
 
         //Second request in head or post
-        $postResponse = $this->getClient()->post('/user_context.php', array(), null, array('cookies' => array('foo')))->send();
+        $postResponse = $this->getHttpClient()
+            ->post('/user_context.php', array(), null, array('cookies' => array('foo')))
+            ->send();
 
         $this->assertEquals('POST', $postResponse->getBody(true));
         $this->assertEquals('MISS', $postResponse->getHeader('X-HashCache'));

tests/Functional/Varnish/UserContextTestCase.php

@@ -47,13 +47,17 @@ public function testUserContextHash()
         $this->assertContextCache($cachedResponse2->getHeader('X-HashCache'));
         $this->assertHit($cachedResponse2);
 
-        $headResponse1 = $this->getClient()->head('/user_context.php', array(), array('cookies' => array('foo')))->send();
+        $headResponse1 = $this->getHttpClient()
+            ->head('/user_context.php', array(), array('cookies' => array('foo')))
+            ->send();
 
         $this->assertEquals('foo', $headResponse1->getHeader('X-HashTest'));
         $this->assertContextCache($headResponse1->getHeader('X-HashCache'));
         $this->assertHit($headResponse1);
 
-        $headResponse2 = $this->getClient()->head('/user_context.php', array(), array('cookies' => array('bar')))->send();
+        $headResponse2 = $this->getHttpClient()
+            ->head('/user_context.php', array(), array('cookies' => array('bar')))
+            ->send();
 
         $this->assertEquals('bar', $headResponse2->getHeader('X-HashTest'));
         $this->assertContextCache($headResponse2->getHeader('X-HashCache'));