haproxy/reg-tests
Tim Duesterhus 721d686bd1 BUG/MEDIUM: compression: Set Vary: Accept-Encoding for compressed responses
Make HAProxy set the `Vary: Accept-Encoding` response header if it compressed
the server response.

Technically the `Vary` header SHOULD also be set for responses that would
normally be compressed based off the current configuration, but are not due
to a missing or invalid `Accept-Encoding` request header or due to the
maximum compression rate being exceeded.

Not setting the header in these cases does no real harm, though: An
uncompressed response might be returned by a Cache, even if a compressed
one could be retrieved from HAProxy. This increases the traffic to the end
user if the cache is unable to compress itself, but it saves another
roundtrip to HAProxy.

see the discussion on the mailing list: https://www.mail-archive.com/haproxy@formilux.org/msg34221.html
Message-ID: 20190617121708.GA2964@1wt.eu

A small issue remains: The User-Agent is not added to the `Vary` header,
despite being relevant to the response. Adding the User-Agent header would
make responses effectively uncacheable and it's unlikely to see a Mozilla/4
in the wild in 2019.

Add a reg-test to ensure the behaviour as described in this commit message.

see issue #121
Should be backported to all branches with compression (i.e. 1.6+).
2019-06-17 18:51:43 +02:00
..
cache REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
checks REGTEST: extend the check duration on tls_health_checks and mark it slow 2019-05-17 17:16:20 +02:00
compression BUG/MEDIUM: compression: Set Vary: Accept-Encoding for compressed responses 2019-06-17 18:51:43 +02:00
connection REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
converter MINOR: sample: Add sha2([<bits>]) converter 2019-06-17 13:36:42 +02:00
http-capture REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
http-cookies REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
http-messaging REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
http-rules REGTEST: relax the IPv6 address format checks in converters_ipmask_concat_strcmp_field_word 2019-04-25 08:47:15 +02:00
log REGTEST: Wrong assumption in IP:port logging test. 2019-05-07 13:58:35 +02:00
lua REGTEST: adapt some reg tests after renaming. 2019-04-23 15:37:11 +02:00
mailers REGTEST: adapt some reg tests after renaming. 2019-04-23 15:37:11 +02:00
peers REGTEST: Reg tests file renaming. 2019-05-07 11:32:56 +02:00
seamless-reload REGTEST: exclude OSX and generic targets from abns_socket.vtc 2019-04-25 08:50:25 +02:00
server REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
spoe REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
ssl REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
stick-table REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
stickiness REGTEST: Add a basic server by name stickiness reg test. 2019-06-05 08:42:36 +02:00
webstats REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
README REGTEST: Adapt reg test doc files to vtest. 2019-01-14 14:24:29 +01:00

                 * Regression testing for HAProxy with VTest *


This little README file is about how to compile and run vtest test case files (VTC files)
to test HAProxy for any regression.

To do so, you will have to compile vtest program sources which depends on
Varnish cache application sources. vtest, formerly varnishtest, is a very useful
program which has been developed to test Varnish cache application. vtest has been
modified in collaboration with Varnish cache conceptor Poul-Henning Kamp to support
HAProxy in addition to Varnish cache.

See also: doc/regression-testing.txt

* vtest compilation *

    $ git clone https://github.com/vtest/VTest

    $ cd VTest

    $ make vtest

  Then vtest program may be found at the root directory of vtest sources directory.
  The Varnish cache manuals are located in 'man' directory of Varnish cache sources
  directory. You will have to have a look at varnishtest(7) and vtc(7) manuals to
  use vtest.

  Some information may also be found in doc/regression-testing.txt in HAProxy
  sources.

  Note that VTC files for Varnish cache may be found in bin/varnishtest/tests directory
  of Varnish cache sources directory which may be found here:
  https://github.com/varnishcache/varnish-cache


* vtest execution *

  You must set HAPROXY_PROGRAM environment variable to give the location
  of the HAProxy program to test to vtest:

    $ HAPROXY_PROGRAM=<my haproxy program> vtest [-Dno-htx=] ...

  The HAProxy VTC files found in HAProxy sources may be run with the reg-tests
  Makefile target. You must set the VTEST_PROGRAM environment variable to
  give the location of the vtest program which has been previously compiled.

    $ VTEST_PROGRAM=<my vtest program> make reg-tests

  "reg-tests" Makefile target run scripts/run-regtest.sh script.
  To get more information about this script run it with --help option.

  Note that vtest is run with -t10 and -l option. -l option is to keep
  keep vtest temporary directory in case of failed test cases. core files
  may be found in this directory (if enabled by ulimit).


* vtest patches for HAProxy VTC files *

  When producing a patch to add a VTC regression testing file to reg-tests directory,
  please follow these simple rules:

    - If your VTC file needs others files, if possible, use the same basename as that
      of the VTC file,
    - Put these files in a directory with the same name as the code area concerned
      by the bug ('peers', 'lua', 'acl' etc).