Merge pull request #322 from FriendsOfSymfony/varnish5

Add Varnish 5 compatibility

Author: dbu

.travis.yml

@@ -1,3 +1,5 @@
+dist: trusty
+group: edge
 language: php
 
 php:
@@ -7,12 +9,14 @@ php:
   - 7
 
 env:
-  - VARNISH_VERSION=4.0
+  - VARNISH_VERSION=5.0.0
 
 matrix:
   include:
     - php: 5.5
       env: SYMFONY_VERSION=2.7.* VARNISH_VERSION=3.0 COMPOSER_FLAGS="--prefer-lowest"
+    - php: 7.0
+      env: VARNISH_VERSION=4.1
 
 branches:
   only:
@@ -25,10 +29,19 @@ install:
 
 before_script:
   # Install Varnish
-  - curl http://repo.varnish-cache.org/debian/GPG-key.txt | sudo apt-key add -
-  - echo "deb http://repo.varnish-cache.org/ubuntu/ precise varnish-${VARNISH_VERSION}" | sudo tee -a /etc/apt/sources.list
-  - sudo apt-get update -qq
-  - sudo apt-get install -qq varnish python-sphinx enchant
+  - |
+    if [ "$VARNISH_VERSION" = "5.0.0" ]; then
+      wget https://repo.varnish-cache.org/pkg/${VARNISH_VERSION}/varnish_${VARNISH_VERSION}-1_amd64.deb
+      sudo dpkg -i varnish_${VARNISH_VERSION}-1_amd64.deb
+      sudo apt-get update -qq
+      sudo apt-get -f install
+    else
+      curl http://repo.varnish-cache.org/debian/GPG-key.txt | sudo apt-key add -
+      echo "deb http://repo.varnish-cache.org/ubuntu/ precise varnish-${VARNISH_VERSION}" | sudo tee -a /etc/apt/sources.list
+      sudo apt-get update -qq
+      sudo apt-get install -qq varnish
+    fi
+  - sudo apt-get install -qq python-sphinx enchant
   - sudo pip install -r doc/requirements.txt
   # Install NGINX
   - sh ./tests/install-nginx.sh

CHANGELOG.md

@@ -29,7 +29,9 @@ See also the [GitHub releases page](https://github.com/FriendsOfSymfony/FOSHttpC
 
 * Varnish configuration are now files that you can directly include from your
   .vcl and call custom functions to avoid copy-pasting VCL code.
-* Changed default Varnish version to 4.
+* Moved Varnish 4 and 5 configuration files from `resources/config/varnish-4/` 
+  to `resources/config/varnish/`.
+* Changed default Varnish version to 5.
 
 ### NGINX
 

README.md

@@ -27,7 +27,7 @@ Features
   with minimal impact on performance.
 * Cache tagging abstraction, uses BAN with Varnish and allows tagging support for other caching proxies in the future.
 * Use the built-in support for [Varnish](http://foshttpcache.readthedocs.org/en/stable/varnish-configuration.html)
-  3 and 4, [NGINX](http://foshttpcache.readthedocs.org/en/stable/nginx-configuration.html), the
+  3, 4 and 5, [NGINX](http://foshttpcache.readthedocs.org/en/stable/nginx-configuration.html), the
   [Symfony reverse proxy from the http-kernel component](http://foshttpcache.readthedocs.org/en/stable/symfony-cache-configuration.html)
   or easily implement your own caching proxy client.
 * [Test your application](http://foshttpcache.readthedocs.org/en/stable/testing-your-application.html)

doc/conf.py

@@ -52,7 +52,7 @@
 
 # General information about the project.
 project = 'FOSHttpCache'
-copyright = '2014, FriendsOfSymfony'
+copyright = u'2014–2016, FriendsOfSymfony'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -263,5 +263,5 @@ def setup(app):
 
 config_block = {
     'varnish3': 'Varnish 3',
-    'varnish4': 'Varnish 4'
+    'varnish4': 'Varnish 4 & 5'
 }

doc/installation.rst

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

doc/varnish-configuration.rst

@@ -4,8 +4,8 @@ Varnish Configuration
 ---------------------
 
 Below you will find detailed Varnish configuration recommendations for the
-features provided by this library. The configuration is provided for Varnish 3
-and 4.
+features provided by this library. The configuration is provided for Varnish 3,
+4 and 5.
 
 Basic Varnish Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -14,7 +14,7 @@ To invalidate cached objects in Varnish, begin by adding an `ACL`_ (for Varnish
 3 see `ACL for Varnish 3`_) to your Varnish configuration. This ACL determines
 which IPs are allowed to issue invalidation requests. To use the provided
 configuration fragments, this ACL has to be named ``invalidators``. The most
-simple ACL, valid for both Varnish 4 and Varnish 3, looks as follows:
+simple ACL, valid for all Varnish versions from 3 onwards, looks as follows:
 
 .. code-block:: varnish4
 
@@ -61,7 +61,7 @@ To enable support add the following to ``your_varnish.vcl``:
 
     .. code-block:: varnish4
 
-        include "path-to-config/varnish-4/fos_purge.vcl";
+        include "path-to-config/varnish/fos_purge.vcl";
 
         sub vcl_recv {
             call fos_purge_recv;
@@ -102,7 +102,7 @@ To enable support, add the following to ``your_varnish.vcl``:
 
     .. code-block:: varnish4
 
-        include "path-to-config/varnish-4/fos_refresh.vcl";
+        include "path-to-config/varnish/fos_refresh.vcl";
 
         sub vcl_recv {
             call fos_refresh_recv;
@@ -131,7 +131,7 @@ To enable support add the following to ``your_varnish.vcl``:
 
     .. code-block:: varnish4
 
-        include "path-to-config/varnish-4/fos_ban.vcl";
+        include "path-to-config/varnish/fos_ban.vcl";
 
         sub vcl_recv {
             call fos_ban_recv;
@@ -185,7 +185,7 @@ VCL will look like this:
 
 .. configuration-block::
 
-    .. literalinclude:: ../resources/config/varnish-4/fos_ban.vcl
+    .. literalinclude:: ../resources/config/varnish/fos_ban.vcl
         :language: varnish4
         :emphasize-lines: 17-22,49-50
         :linenos:
@@ -212,8 +212,8 @@ To enable support add the following to ``your_varnish.vcl``:
 
     .. code-block:: varnish4
 
-        include "path-to-config/varnish-4/fos_user_context.vcl";
-        include "path-to-config/varnish-4/fos_user_context_url.vcl";
+        include "path-to-config/varnish/fos_user_context.vcl";
+        include "path-to-config/varnish/fos_user_context_url.vcl";
 
         sub vcl_recv {
             call fos_user_context_recv;
@@ -230,7 +230,7 @@ To enable support add the following to ``your_varnish.vcl``:
     .. code-block:: varnish3
 
         include "path-to-config/varnish-3/fos_user_context.vcl";
-        include "path-to-config/varnish-4/fos_user_context_url.vcl";
+        include "path-to-config/varnish/fos_user_context_url.vcl";
 
         sub vcl_recv {
             call fos_user_context_recv;
@@ -291,7 +291,7 @@ values are different for each request. Because of this, the hash request would
 not be cached, but multiple hashes would be generated for one and the same user.
 
 To make the hash request cacheable, you must extract a stable user session id
-*before calling ``fos_user_context_recv``*. You can do this as
+*before* calling ``fos_user_context_recv``. You can do this as
 `explained in the Varnish documentation`_:
 
 .. code-block:: varnish4
@@ -331,7 +331,7 @@ inline C enabled: ``-p vcc_allow_inline_c=on``. Then add the following to
 
     .. code-block:: varnish4
 
-        include "path-to-config/varnish-4/fos_custom_ttl.vcl";
+        include "path-to-config/varnish/fos_custom_ttl.vcl";
 
         sub vcl_backend_response {
             call fos_custom_ttl_backend_response;
@@ -364,7 +364,7 @@ To enable support add the following to ``your_varnish.vcl``:
 
     .. code-block:: varnish4
 
-        include "path-to-config/varnish-4/fos_debug.vcl";
+        include "path-to-config/varnish/fos_debug.vcl";
 
         sub vcl_deliver {
             call fos_debug_deliver;

resources/config/varnish-4/fos_ban.vcl renamed to resources/config/varnish/fos_ban.vcl

@@ -1,7 +1,7 @@
 vcl 4.0;
 
-include "../../../../resources/config/varnish-4/fos_debug.vcl";
-include "../../../../resources/config/varnish-4/fos_custom_ttl.vcl";
+include "../../../../resources/config/varnish/fos_debug.vcl";
+include "../../../../resources/config/varnish/fos_custom_ttl.vcl";
 
 backend default {
     .host = "127.0.0.1";

resources/config/varnish-4/fos_custom_ttl.vcl renamed to resources/config/varnish/fos_custom_ttl.vcl

@@ -1,19 +1,19 @@
 vcl 4.0;
 
-include "../../../../resources/config/varnish-4/fos_debug.vcl";
-include "../../../../resources/config/varnish-4/fos_refresh.vcl";
-include "../../../../resources/config/varnish-4/fos_purge.vcl";
-include "../../../../resources/config/varnish-4/fos_ban.vcl";
+acl invalidators {
+    "127.0.0.1";
+}
+
+include "../../../../resources/config/varnish/fos_debug.vcl";
+include "../../../../resources/config/varnish/fos_refresh.vcl";
+include "../../../../resources/config/varnish/fos_purge.vcl";
+include "../../../../resources/config/varnish/fos_ban.vcl";
 
 backend default {
     .host = "127.0.0.1";
     .port = "8080";
 }
 
-acl invalidators {
-    "127.0.0.1";
-}
-
 sub vcl_recv {
     call fos_ban_recv;
     call fos_purge_recv;

resources/config/varnish-4/fos_debug.vcl renamed to resources/config/varnish/fos_debug.vcl

@@ -1,5 +1,5 @@
-include "../../../../resources/config/varnish-4/fos_user_context.vcl";
-include "../../../../resources/config/varnish-4/fos_debug.vcl";
+include "../../../../resources/config/varnish/fos_user_context.vcl";
+include "../../../../resources/config/varnish/fos_debug.vcl";
 
 sub vcl_recv {
     call fos_user_context_recv;
@@ -12,4 +12,4 @@ sub vcl_backend_response {
 sub vcl_deliver {
     call fos_debug_deliver;
     call fos_user_context_deliver;
-}
+}

resources/config/varnish-4/fos_purge.vcl renamed to resources/config/varnish/fos_purge.vcl

@@ -30,10 +30,10 @@ public function setUp()
     protected function getConfigFile()
     {
         switch ((int) $this->getVarnishVersion()) {
-            case 4:
-                return './tests/Functional/Fixtures/varnish-4/custom_ttl.vcl';
-            default:
+            case 3:
                 return './tests/Functional/Fixtures/varnish-3/custom_ttl.vcl';
+            default:
+                return './tests/Functional/Fixtures/varnish/custom_ttl.vcl';
         }
     }
 

resources/config/varnish-4/fos_refresh.vcl renamed to resources/config/varnish/fos_refresh.vcl

@@ -23,7 +23,7 @@ protected function getConfigFile()
             case 3:
                 return './tests/Functional/Fixtures/varnish-3/user_context_cache.vcl';
             default:
-                return './tests/Functional/Fixtures/varnish-4/user_context_cache.vcl';
+                return './tests/Functional/Fixtures/varnish/user_context_cache.vcl';
         }
     }
 

resources/config/varnish-4/fos_user_context.vcl renamed to resources/config/varnish/fos_user_context.vcl

@@ -99,7 +99,7 @@ protected function getConfigFile()
             case 3:
                 return sprintf('./tests/Functional/Fixtures/varnish-3/user_context_%s.vcl', $this->mode);
             default:
-                return sprintf('./tests/Functional/Fixtures/varnish-4/user_context_%s.vcl', $this->mode);
+                return sprintf('./tests/Functional/Fixtures/varnish/user_context_%s.vcl', $this->mode);
         }
     }
 }

resources/config/varnish-4/fos_user_context_url.vcl renamed to resources/config/varnish/fos_user_context_url.vcl

@@ -23,7 +23,7 @@ protected function getConfigFile()
             case 3:
                 return './tests/Functional/Fixtures/varnish-3/user_context_nocache.vcl';
             default:
-                return './tests/Functional/Fixtures/varnish-4/user_context_nocache.vcl';
+                return './tests/Functional/Fixtures/varnish/user_context_nocache.vcl';
         }
     }
 

tests/Functional/Fixtures/varnish-4/custom_ttl.vcl renamed to tests/Functional/Fixtures/varnish/custom_ttl.vcl

@@ -20,7 +20,7 @@
     ) {
         define('VARNISH_FILE', './tests/Functional/Fixtures/varnish-3/fos.vcl');
     } else {
-        define('VARNISH_FILE', './tests/Functional/Fixtures/varnish-4/fos.vcl');
+        define('VARNISH_FILE', './tests/Functional/Fixtures/varnish/fos.vcl');
     }
 }