Merge pull request #152 from hpatoio/issue_144

Mentioning NGINX and added info about groups for tests | Related to #144

Author: ddeboer

README.md

@@ -23,11 +23,11 @@ Features
 * Send [cache invalidation requests](http://foshttpcache.readthedocs.org/en/latest/cache-invalidator.html)
   with minimal impact on performance.
 * Use the built-in support for [Varnish](http://foshttpcache.readthedocs.org/en/latest/varnish-configuration.html)
-  3 and 4, [Nginx](http://foshttpcache.readthedocs.org/en/latest/nginx-configuration.html), the 
+  3 and 4, [NGINX](http://foshttpcache.readthedocs.org/en/latest/nginx-configuration.html), the 
   [Symfony reverse proxy from the http-kernel component](http://foshttpcache.readthedocs.org/en/latest/symfony-cache-configuration.html)
   or easily implement your own caching proxy client.
 * [Test your application](http://foshttpcache.readthedocs.org/en/latest/testing-your-application.html)
-  against your Varnish or Nginx setup.
+  against your Varnish or NGINX setup.
 * This library is fully compatible with [HHVM](http://www.hhvm.com).
 
 Documentation

doc/contributing.rst

@@ -27,8 +27,8 @@ To run the unit tests separately:
 Functional Tests
 ~~~~~~~~~~~~~~~~
 
-The library also includes functional tests against a Varnish instance. The
-functional test suite by default uses PHP’s built-in web server. If you have
+The library also includes functional tests against a Varnish and NGINX instance. 
+The functional test suite by default uses PHP’s built-in web server. If you have
 PHP 5.4 or newer, simply run with the default configuration.
 
 If you want to run the tests on PHP 5.3, you need to configure a web server
@@ -44,6 +44,15 @@ To run the functional tests:
 
     $ phpunit tests/Functional
 
+Tests are organized in groups: one for each reverse proxy supported. At the moment 
+groups are: `varnish` and  `nginx`. 
+
+To run only the `varnish` functional tests:
+
+.. code-block:: bash
+
+    $ phpunit --group=varnish
+
 For more information about testing, see :doc:`/testing-your-application`.
 
 Building the Documentation

doc/index.rst

@@ -4,7 +4,7 @@ FOSHttpCache
 This is the documentation for the `FOSHttpCache library <https://github.com/FriendsOfSymfony/FOSHttpCache>`_.
 
 This library integrates your PHP applications with HTTP caching proxies such as
-Varnish, Nginx or the Symfony HttpCache class. Use this library to send
+Varnish, NGINX or the Symfony HttpCache class. Use this library to send
 invalidation requests from your application to the caching proxy and to test
 your caching and invalidation setup.
 

doc/installation.rst

@@ -31,7 +31,7 @@ Overview
 
 This library mainly consists of:
 
-* low-level clients for communicating with caching proxies (Varnish and Nginx)
+* low-level clients for communicating with caching proxies (Varnish and NGINX)
 * a cache invalidator that acts as an abstraction layer for the caching proxy
   clients
 * test classes that you can use for integration testing your application

doc/invalidation-introduction.rst

@@ -22,7 +22,7 @@ HTTP Caching Terminology
 
     Caching proxy
         Also `reverse caching proxy <http://en.wikipedia.org/wiki/Reverse_proxy>`_.
-        Examples: Varnish, Nginx.
+        Examples: Varnish, NGINX.
 
     Time to live (TTL)
         Maximum lifetime of some content. Expressed in either an expiry date

doc/nginx-configuration.rst

@@ -1,41 +1,41 @@
 .. _nginx configuration:
 
-Nginx Configuration
+NGINX Configuration
 -------------------
 
-Below you will find detailed Nginx configuration recommendations for the
-features provided by this library. The examples are tested with Nginx version
+Below you will find detailed NGINX configuration recommendations for the
+features provided by this library. The examples are tested with NGINX version
 1.4.6.
 
-Nginx cache is a set of key/value pairs. The key is built with elements taken from the requests 
+NGINX cache is a set of key/value pairs. The key is built with elements taken from the requests 
 (URI, cookies, http headers etc) as specified by `proxy_cache_key` directive.
 
-When we interact with the cache to purge/refresh entries we must send to Nginx a request which has 
+When we interact with the cache to purge/refresh entries we must send to NGINX a request which has 
 the very same values, for the elements used for building the key, as the request that create the entry.
-In this way Nginx can build the correct key and apply the required operation to the entry.
+In this way NGINX can build the correct key and apply the required operation to the entry.
 
-By default Nginx key is built with `$scheme$proxy_host$request_uri`. For a full list of the elements
+By default NGINX key is built with `$scheme$proxy_host$request_uri`. For a full list of the elements
 you can use in the key see `this page from the official documentation <http://nginx.org/en/docs/http/ngx_http_core_module.html#variables>`_
 
 Purge
 ~~~~~
 
-Nginx does not support :term:`purge` functionality out of the box but you can easily add it with 
+NGINX does not support :term:`purge` functionality out of the box but you can easily add it with 
 `ngx_cache_purge <https://github.com/FRiCKLE/ngx_cache_purge>`_ module. You just need to compile 
-Nginx from sources adding `ngx_cache_purge` with `--add-module`
+NGINX from sources adding `ngx_cache_purge` with `--add-module`
 
 You can check the script :source:`install-nginx.sh <tests/install-nginx.sh>` to get an idea
 about the steps you need to perform.
 
-Then configure Nginx for purge requests:
+Then configure NGINX for purge requests:
 
 .. literalinclude:: ../tests/Functional/Fixtures/nginx/fos.conf
     :language: nginx
     :linenos:
     :emphasize-lines: 41, 47-53
 
 Please refer to the `ngx_cache_purge module documentation <https://github.com/FRiCKLE/ngx_cache_purge>`_
-for more on configuring Nginx to support purge requests.
+for more on configuring NGINX to support purge requests.
 
 Refresh
 ~~~~~~~

doc/proxy-clients.rst

@@ -1,7 +1,7 @@
 Caching Proxy Clients
 =====================
 
-This library ships with clients for the Varnish and Nginx caching proxy. You
+This library ships with clients for the Varnish and NGINX caching proxy. You
 can use the clients either wrapped by the :doc:`cache invalidator <cache-invalidator>`
 (recommended), or directly for low-level access to invalidation functionality.
 
@@ -37,12 +37,12 @@ include that port in the base URL::
 
     To use the client, you need to :doc:`configure Varnish <varnish-configuration>` accordingly.
 
-Nginx Client
+NGINX Client
 ~~~~~~~~~~~~
 
-At minimum, supply an array containing IPs or hostnames of the Nginx servers
+At minimum, supply an array containing IPs or hostnames of the NGINX servers
 that you want to send invalidation requests to. Make sure to include the port
-Nginx runs on if it is not port 80::
+NGINX runs on if it is not port 80::
 
     use FOS\HttpCache\Invalidation\Nginx;
 
@@ -55,14 +55,14 @@ is available as the second parameter::
 
     $nginx = new Nginx($servers, 'my-cool-app.com');
 
-If you have configured Nginx to support purge requests at a separate location,
+If you have configured NGINX to support purge requests at a separate location,
 supply that location to the class as the third parameter::
 
     $nginx = new Nginx($servers, 'my-cool-app.com', '/purge');
 
 .. note::
 
-    To use the client, you need to :doc:`configure Nginx <nginx-configuration>` accordingly.
+    To use the client, you need to :doc:`configure NGINX <nginx-configuration>` accordingly.
 
 Using the Clients
 -----------------
@@ -86,7 +86,7 @@ Supported invalidation methods
 Client        Purge   Refresh Ban
 ============= ======= ======= =======
 Varnish       ✓       ✓       ✓
-Nginx         ✓       ✓
+NGINX         ✓       ✓
 Symfony Cache ✓       ✓
 ============= ======= ======= =======
 

doc/symfony-cache-configuration.rst

@@ -3,7 +3,7 @@ Symfony HttpCache Configuration
 
 The ``symfony/http-kernel`` component provides a reverse proxy implemented
 completely in PHP, called `HttpCache`_. While it is certainly less efficient
-than using Varnish or Nginx, it can still provide considerable performance
+than using Varnish or NGINX, it can still provide considerable performance
 gains over an installation that is not cached at all. It can be useful for
 running an application on shared hosting for instance.
 

src/Test/NginxTestCase.php

@@ -49,15 +49,16 @@ abstract class NginxTestCase extends ProxyTestCase
      *
      * @throws \Exception
      *
-     * @return string the path to the nginx server configuration file to use with this test.
+     * @return string the path to the NGINX server configuration file to use with this test.
      */
     protected function getConfigFile()
     {
         if (!defined('NGINX_FILE')) {
-            throw new \Exception('Specify the nginx configuration file path in phpunit.xml or override getConfigFile()');
+            throw new \Exception('Specify the NGINX'
+                    . ' configuration file path in phpunit.xml or override getConfigFile()');
         }
 
-        // Nginx needs an absolute path
+        // NGINX needs an absolute path
         return realpath(NGINX_FILE);
     }
 
@@ -82,7 +83,7 @@ protected function getCachingProxyPort()
     }
 
     /**
-     * Get Nginx cache directory
+     * Get NGINX cache directory
      */
     protected function getCacheDir()
     {

src/Test/Proxy/NginxProxy.php

@@ -22,7 +22,7 @@ class NginxProxy extends Abstractproxy
     /**
      * Constructor
      *
-     * @param string $configFile Path to Nginx configuration file
+     * @param string $configFile Path to NGINX configuration file
      */
     public function __construct($configFile)
     {