haproxy/reg-tests
Willy Tarreau ec9ac54982 REGTEST: add sample_fetches/hashes.vtc to validate hashes
This regtest validates all hashes that we support, on all input bytes from
0x00 to 0xFF. Those supporting avalanche are tested as well. It also tests
len(), hex() and base64(). It purposely does not enable sha2() because this
one relies on OpenSSL and there's no point in validating that OpenSSL knows
how to hash, what matters is that we can test our hashing functions in all
cases. However since the tests were written, they're still present and
commented out in case that helps.

It may be backported to supported versions, possibly dropping a few algos
that were not supported (e.g. crc32c requires 1.9 minimum).

Note that this test will fail on crc32/djb2/sdbm/wt6 unless patches
"BUG/MINOR: stream: init variables when the list is empty" and
"BUG/MAJOR: hashes: fix the signedness of the hash inputs" are included.
2020-01-16 08:45:27 +01:00
..
cache REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
checks REGTESTS: server/cli_set_fqdn requires version 1.8 minimum 2019-10-22 13:06:59 +02:00
compression BUG/MEDIUM: compression: Set Vary: Accept-Encoding for compressed responses 2019-06-17 18:51:43 +02:00
connection REGTESTS: Adapt proxy_protocol_random_fail.vtc to match normalized URI too 2019-10-14 22:28:50 +02:00
converter MINOR: sample: Validate the number of bits for the sha2 converter 2019-12-17 13:28:00 +01: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: Add an HTX reg-test to check an edge case 2019-12-11 16:46:16 +01: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
mcli REGTEST: mcli/mcli_start_progs: start 2 programs 2020-01-14 15:42:38 +01:00
peers REGTESTS: Send valid URIs in peers reg-tests and fix HA config to avoid warnings 2019-10-14 22:28:50 +02:00
sample_fetches REGTEST: add sample_fetches/hashes.vtc to validate hashes 2020-01-16 08:45:27 +01:00
seamless-reload REGTEST: vtest can now enable mcli with its own flag 2019-10-30 19:10:04 +01:00
server REGTESTS: server/cli_set_fqdn requires version 1.8 minimum 2019-10-22 13:06:59 +02:00
spoe REGTEST: rename the reg test files. 2019-04-23 15:37:03 +02:00
ssl REGTEST: set_ssl_cert.vtc: replace "echo" with "printf" 2020-01-09 05:56:04 +01: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

README

                 * 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).