Merge pull request #315 from FriendsOfSymfony/test-cleanup

dbu · web-flow · commit a9714d8061ec · 2016-10-18T09:15:11.000+02:00
Test cleanup
diff --git a/.composer.lock.swp b/.composer.lock.swp
diff --git a/composer.json b/composer.json
@@ -32,7 +32,7 @@
         "php-http/discovery": "^1.0"
     },
     "require-dev": {
-        "mockery/mockery": "~0.9.1",
+        "mockery/mockery": "~0.9.5",
         "monolog/monolog": "^1.0",
         "php-http/guzzle6-adapter": "^1.0.0",
         "php-http/mock-client": "^0.3.2",
diff --git a/src/Exception/ExceptionCollection.php b/src/Exception/ExceptionCollection.php
@@ -35,7 +35,7 @@ public function __construct(array $exceptions = [])
      */
     public function add(\Exception $e)
     {
-        if (null == $this->message) {
+        if (!$this->message) {
             $this->message = $e->getMessage();
         }
 
diff --git a/src/ResponseTagger.php b/src/ResponseTagger.php
@@ -34,23 +34,26 @@ class ResponseTagger
     /**
      * @var TagsInterface
      */
-    private $client;
+    private $proxyClient;
 
     /**
      * @var array
      */
     private $tags = [];
 
     /**
-     * Constructor.
+     * Create the response tagger with a tag capable proxy client and options.
      *
-     * @param TagsInterface $client
-     * @param array         $options supported options:
-     *                               - strict (bool) Default: false. If set to true, throws exception when adding empty tags
+     * Supported options are:
+     *
+     * - strict (bool) Default: false. If set to true, throws exception when adding empty tags
+     *
+     * @param TagsInterface $proxyClient
+     * @param array         $options
      */
-    public function __construct(TagsInterface $client, array $options = array())
+    public function __construct(TagsInterface $proxyClient, array $options = array())
     {
-        $this->client = $client;
+        $this->proxyClient = $proxyClient;
 
         $resolver = new OptionsResolver();
         $resolver->setDefaults(array(
@@ -69,7 +72,7 @@ public function __construct(TagsInterface $client, array $options = array())
      */
     public function getTagsHeaderName()
     {
-        return $this->client->getTagsHeaderName();
+        return $this->proxyClient->getTagsHeaderName();
     }
 
     /**
@@ -81,7 +84,7 @@ public function getTagsHeaderName()
      */
     public function getTagsHeaderValue()
     {
-        return $this->client->getTagsHeaderValue($this->tags);
+        return $this->proxyClient->getTagsHeaderValue($this->tags);
     }
 
     /**
diff --git a/src/Test/HttpCaller.php b/src/Test/HttpCaller.php
@@ -23,7 +23,7 @@ trait HttpCaller
      *
      * @var HttpClient
      */
-    private $client;
+    private $httpClient;
 
     /**
      * Call a HTTP resource from your test.
@@ -36,11 +36,11 @@ trait HttpCaller
      */
     protected function getResponse($uri, array $headers = [], $method = 'GET')
     {
-        if (!$this->client) {
-            $this->client = new HttpClient($this->getHostName(), $this->getCachingProxyPort());
+        if (!$this->httpClient) {
+            $this->httpClient = new HttpClient($this->getHostName(), $this->getCachingProxyPort());
         }
 
-        return $this->client->getResponse($uri, $headers, $method);
+        return $this->httpClient->getResponse($uri, $headers, $method);
     }
 
     /**
diff --git a/src/Test/Proxy/AbstractProxy.php b/src/Test/Proxy/AbstractProxy.php
@@ -34,7 +34,7 @@ protected function waitFor($ip, $port, $timeout)
         if (!$this->wait(
             $timeout,
             function () use ($ip, $port) {
-                return true == @fsockopen($ip, $port);
+                return false !== @fsockopen($ip, $port);
             }
         )) {
             throw new \RuntimeException(
@@ -61,8 +61,7 @@ protected function waitUntil($ip, $port, $timeout)
         if (!$this->wait(
             $timeout,
             function () use ($ip, $port) {
-                // This doesn't seem to work
-                return false == @fsockopen($ip, $port);
+                return false === @fsockopen($ip, $port);
             }
         )) {
             throw new \RuntimeException(
diff --git a/tests/Functional/Fixtures/web/user_context.php b/tests/Functional/Fixtures/web/user_context.php
@@ -21,20 +21,20 @@
     exit;
 }
 
-if ('POST' == strtoupper($_SERVER['REQUEST_METHOD'])) {
+if ('POST' === strtoupper($_SERVER['REQUEST_METHOD'])) {
     echo 'POST';
     exit;
 }
 
-if (!isset($_COOKIE[0]) || ($_COOKIE[0] != 'foo' && $_COOKIE[0] != 'bar')) {
+if (!isset($_COOKIE[0]) || ('foo' !== $_COOKIE[0] && 'bar' !== $_COOKIE[0])) {
     header('HTTP/1.1 403');
     exit;
 }
 
 header('Cache-Control: max-age=3600');
 header('Vary: X-User-Context-Hash');
 
-if ($_COOKIE[0] == 'foo') {
+if ('foo' === $_COOKIE[0]) {
     header('X-HashTest: foo');
     echo 'foo';
 } else {
diff --git a/tests/Functional/Fixtures/web/user_context_anon.php b/tests/Functional/Fixtures/web/user_context_anon.php
@@ -17,7 +17,7 @@
 if (!isset($_COOKIE[0])) {
     header('X-HashTest: anonymous');
     echo 'anonymous';
-} elseif ($_COOKIE[0] == 'foo') {
+} elseif ('foo' === $_COOKIE[0]) {
     header('X-HashTest: foo');
     echo 'foo';
 } else {
diff --git a/tests/Functional/Fixtures/web/user_context_hash_cache.php b/tests/Functional/Fixtures/web/user_context_hash_cache.php
@@ -14,7 +14,7 @@
 // The application listens for hash request (by checking the accept header)
 // and creates an X-User-Context-Hash based on parameters in the request.
 // In this case it's based on Cookie.
-if ('application/vnd.fos.user-context-hash' == strtolower($_SERVER['HTTP_ACCEPT'])) {
+if ('application/vnd.fos.user-context-hash' === strtolower($_SERVER['HTTP_ACCEPT'])) {
     header(sprintf('X-User-Context-Hash: %s', $_COOKIE[0]));
     header('Content-Type: application/vnd.fos.user-context-hash');
     header('Cache-Control: max-age=3600');
diff --git a/tests/Functional/Fixtures/web/user_context_hash_failure.php b/tests/Functional/Fixtures/web/user_context_hash_failure.php
@@ -14,7 +14,7 @@
 // The application listens for hash request (by checking the accept header)
 // and creates an X-User-Context-Hash based on parameters in the request.
 // In this case it's based on Cookie.
-if ('application/vnd.fos.user-context-hash' == strtolower($_SERVER['HTTP_ACCEPT'])) {
+if ('application/vnd.fos.user-context-hash' === strtolower($_SERVER['HTTP_ACCEPT'])) {
     header(sprintf('X-User-Context-Hash: %s', 'failed'));
     header('Content-Type: application/vnd.fos.user-context-hash');
     header('Cache-Control: max-age=3600');
diff --git a/tests/Functional/Fixtures/web/user_context_hash_nocache.php b/tests/Functional/Fixtures/web/user_context_hash_nocache.php
@@ -14,7 +14,7 @@
 // The application listens for hash request (by checking the accept header)
 // and creates an X-User-Context-Hash based on parameters in the request.
 // In this case it's based on Cookie.
-if ('application/vnd.fos.user-context-hash' == strtolower($_SERVER['HTTP_ACCEPT'])) {
+if ('application/vnd.fos.user-context-hash' === strtolower($_SERVER['HTTP_ACCEPT'])) {
     header(sprintf('X-User-Context-Hash: %s', $_COOKIE[0]));
     header('Content-Type: application/vnd.fos.user-context-hash');
     header('Cache-Control: max-age=0, no-cache, private');
diff --git a/tests/Functional/Varnish/UserContextFailureTest.php b/tests/Functional/Varnish/UserContextFailureTest.php
@@ -21,11 +21,17 @@
  */
 class UserContextFailureTest extends VarnishTestCase
 {
-    private $mode;
+    /**
+     * Can be "cache" or "failure" and is used to determine the correct .vcl file.
+     *
+     * @var string
+     */
+    private $mode = 'cache';
 
     public function setUp()
     {
-        $this->mode = 'testHashRequestFailure' == $this->getName() ? 'failure' : 'cache';
+        // needs to be decided before doing the setup
+        $this->mode = 'testHashRequestFailure' === $this->getName() ? 'failure' : 'cache';
 
         parent::setUp();
     }
diff --git a/tests/Unit/ProxyClient/HttpDispatcherTest.php b/tests/Unit/ProxyClient/HttpDispatcherTest.php
@@ -31,11 +31,11 @@
 class HttpDispatcherTest extends \PHPUnit_Framework_TestCase
 {
     /**
-     * Mock client.
+     * Mock HTTP client.
      *
      * @var Client
      */
-    private $client;
+    private $httpClient;
 
     /**
      * @var MessageFactory
@@ -49,7 +49,7 @@ class HttpDispatcherTest extends \PHPUnit_Framework_TestCase
 
     protected function setUp()
     {
-        $this->client = new Client();
+        $this->httpClient = new Client();
         $this->messageFactory = MessageFactoryDiscovery::find();
         $this->uriFactory = UriFactoryDiscovery::find();
     }
@@ -60,7 +60,7 @@ protected function setUp()
      */
     public function testInstantiateWithNonUri()
     {
-        $httpDispatcher = new HttpDispatcher(
+        new HttpDispatcher(
             ['127.0.0.1:123'],
             $this
         );
@@ -75,11 +75,11 @@ public function testInstantiateWithNonUri()
      */
     public function testExceptions(\Exception $exception, $type, $message = null)
     {
-        $this->client->addException($exception);
+        $this->httpClient->addException($exception);
         $httpDispatcher = new HttpDispatcher(
             ['127.0.0.1:123'],
             'my_hostname.dev',
-            $this->client
+            $this->httpClient
         );
         $httpDispatcher->invalidate($this->messageFactory->createRequest('PURGE', '/path'));
 
@@ -150,7 +150,7 @@ public function testMissingHostExceptionIsThrown()
         $httpDispatcher = new HttpDispatcher(
             ['127.0.0.1:123'],
             '',
-            $this->client
+            $this->httpClient
         );
 
         $request = $this->messageFactory->createRequest('PURGE', '/path/without/hostname');
@@ -162,7 +162,7 @@ public function testSetBasePathWithHost()
         $httpDispatcher = new HttpDispatcher(
             ['127.0.0.1'],
             'fos.lo',
-            $this->client
+            $this->httpClient
         );
 
         $request = $this->messageFactory->createRequest('PURGE', '/path');
@@ -178,7 +178,7 @@ public function testSetBasePathWithPath()
         $httpDispatcher = new HttpDispatcher(
             ['127.0.0.1:8080'],
             'http://fos.lo/my/path',
-            $this->client
+            $this->httpClient
         );
         $request = $this->messageFactory->createRequest('PURGE', 'append');
         $httpDispatcher->invalidate($request);
@@ -191,7 +191,7 @@ public function testSetBasePathWithPath()
 
     public function testSetServersDefaultSchemeIsAdded()
     {
-        $httpDispatcher = new HttpDispatcher(['127.0.0.1'], 'fos.lo', $this->client);
+        $httpDispatcher = new HttpDispatcher(['127.0.0.1'], 'fos.lo', $this->httpClient);
         $request = $this->messageFactory->createRequest('PURGE', '/some/path');
         $httpDispatcher->invalidate($request);
         $httpDispatcher->flush();
@@ -202,7 +202,7 @@ public function testSetServersDefaultSchemeIsAdded()
 
     public function testSchemeIsAdded()
     {
-        $httpDispatcher = new HttpDispatcher(['127.0.0.1'], 'fos.lo', $this->client);
+        $httpDispatcher = new HttpDispatcher(['127.0.0.1'], 'fos.lo', $this->httpClient);
         $uri = $this->uriFactory->createUri('/some/path')->withHost('goo.bar');
         $request = $this->messageFactory->createRequest('PURGE', $uri);
         $httpDispatcher->invalidate($request);
@@ -214,7 +214,7 @@ public function testSchemeIsAdded()
 
     public function testPortIsAdded()
     {
-        $httpDispatcher = new HttpDispatcher(['127.0.0.1:8080'], 'fos.lo', $this->client);
+        $httpDispatcher = new HttpDispatcher(['127.0.0.1:8080'], 'fos.lo', $this->httpClient);
         $request = $this->messageFactory->createRequest('PURGE', '/some/path');
         $httpDispatcher->invalidate($request);
         $httpDispatcher->flush();
@@ -253,11 +253,11 @@ public function testSetServersThrowsInvalidServerException()
     public function testFlushEmpty()
     {
         $httpDispatcher = new HttpDispatcher(
-            ['127.0.0.1', '127.0.0.2'], 'fos.lo', $this->client
+            ['127.0.0.1', '127.0.0.2'], 'fos.lo', $this->httpClient
         );
         $this->assertEquals(0, $httpDispatcher->flush());
 
-        $this->assertCount(0, $this->client->getRequests());
+        $this->assertCount(0, $this->httpClient->getRequests());
     }
 
     public function testFlushCountSuccess()
@@ -345,6 +345,6 @@ function (RequestInterface $request) {
      */
     protected function getRequests()
     {
-        return $this->client->getRequests();
+        return $this->httpClient->getRequests();
     }
 }
diff --git a/tests/Unit/ProxyClient/HttpProxyClientTest.php b/tests/Unit/ProxyClient/HttpProxyClientTest.php
@@ -13,33 +13,23 @@
 
 use FOS\HttpCache\ProxyClient\HttpDispatcher;
 use FOS\HttpCache\ProxyClient\Varnish;
+use Mockery\MockInterface;
 
 /**
  * Testing the base methods of the proxy client, using the Varnish client as concrete class.
  */
 class HttpProxyClientTest extends \PHPUnit_Framework_TestCase
 {
-    /**
-     * @var HttpDispatcher|\PHPUnit_Framework_MockObject_MockObject
-     */
-    private $httpDispatcher;
-
-    protected function setUp()
-    {
-        $this->httpDispatcher = $this
-            ->getMockBuilder(HttpDispatcher::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-    }
-
     public function testFlush()
     {
-        $this->httpDispatcher
-            ->expects($this->once())
-            ->method('flush')
-            ->will($this->returnValue(42));
+        /** @var HttpDispatcher|MockInterface $httpDispatcher */
+        $httpDispatcher = \Mockery::mock(HttpDispatcher::class)
+            ->shouldReceive('flush')
+            ->once()
+            ->andReturn(42)
+            ->getMock();
 
-        $varnish = new Varnish($this->httpDispatcher);
+        $varnish = new Varnish($httpDispatcher);
 
         $this->assertEquals(42, $varnish->flush());
     }
diff --git a/tests/Unit/ProxyClient/MultiplexerClientTest.php b/tests/Unit/ProxyClient/MultiplexerClientTest.php
diff --git a/tests/Unit/SymfonyCache/CustomTtlListenerTest.php b/tests/Unit/SymfonyCache/CustomTtlListenerTest.php
diff --git a/tests/Unit/SymfonyCache/DebugListenerTest.php b/tests/Unit/SymfonyCache/DebugListenerTest.php
diff --git a/tests/Unit/SymfonyCache/PurgeSubscriberTest.php b/tests/Unit/SymfonyCache/PurgeSubscriberTest.php
diff --git a/tests/Unit/SymfonyCache/UserContextSubscriberTest.php b/tests/Unit/SymfonyCache/UserContextSubscriberTest.php

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct(array $exceptions = [])`
`35`	`35`	`*/`
`36`	`36`	`public function add(\Exception $e)`
`37`	`37`	`{`
`38`		`- if (null == $this->message) {`
	`38`	`+ if (!$this->message) {`
`39`	`39`	`$this->message = $e->getMessage();`
`40`	`40`	`}`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ trait HttpCaller`
`23`	`23`	`*`
`24`	`24`	`* @var HttpClient`
`25`	`25`	`*/`
`26`		`- private $client;`
	`26`	`+ private $httpClient;`
`27`	`27`
`28`	`28`	`/**`
`29`	`29`	`* Call a HTTP resource from your test.`
`@@ -36,11 +36,11 @@ trait HttpCaller`
`36`	`36`	`*/`
`37`	`37`	`protected function getResponse($uri, array $headers = [], $method = 'GET')`
`38`	`38`	`{`
`39`		`- if (!$this->client) {`
`40`		`- $this->client = new HttpClient($this->getHostName(), $this->getCachingProxyPort());`
	`39`	`+ if (!$this->httpClient) {`
	`40`	`+ $this->httpClient = new HttpClient($this->getHostName(), $this->getCachingProxyPort());`
`41`	`41`	`}`
`42`	`42`
`43`		`- return $this->client->getResponse($uri, $headers, $method);`
	`43`	`+ return $this->httpClient->getResponse($uri, $headers, $method);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`/**`