mirror of
http://git.haproxy.org/git/haproxy.git/
synced 2024-12-31 09:02:07 +00:00
44c5ff69ac
A long-standing issue was reported in issue #1215. In short, var() was initially internally declared as returning a string because it was not possible by then to return "any type". As such, users regularly get trapped thinking that when they're storing an integer there, then the integer matching method automatically applies. Except that this is not possible since this is related to the config parser and is decided at boot time where the variable's type is not known yet. As such, what is done is that the output being declared as type string, the string match will automatically apply, and any value will first be converted to a string. This results in several issues like: http-request set-var(txn.foo) int(-1) http-request deny if { var(txn.foo) lt 0 } not working. This is because the string match on the second line will in fact compare the string representation of the variable against strings "lt" and "0", none of which matches. The doc says that the matching method is mandatory, though that's not the case in the code due to that default string type being permissive. There's not even a warning when no explicit match is placed, because this happens very deep in the expression evaluator and making a special case just for "var" can reveal very complicated. The set-var() converter already mandates a matching method, as the following will be rejected: ... if { int(12),set-var(txn.truc) 12 } while this one will work: ... if { int(12),set-var(txn.truc) -m int 12 } As such, this patch this modifies var() to match the doc, returning the type "any", and mandating the matching method, implying that this bogus config which does not work: http-request set-var(txn.foo) int(-1) http-request deny if { var(txn.foo) lt 0 } will need to be written like this: http-request set-var(txn.foo) int(-1) http-request deny if { var(txn.foo) -m int lt 0 } This *will* break some configs (and even 3 of our regtests relied on this), but except those which already match string exclusively, all other ones are already broken and silently fail (and one of the 3 regtests, the one on FIX, was bogus regarding this). In order to fix existing configs, one can simply append "-m str" after a "var()" in an ACL or "if" expression: http-request deny unless { var(txn.jwt_alg) "ES" } must become: http-request deny unless { var(txn.jwt_alg) -m str "ES" } Most commonly, patterns such as "le", "lt", "ge", "gt", "eq", "ne" in front of a number indicate that the intent was to match an integer, and in this case "-m int" would be desired: tcp-response content reject if ! { var(res.size) gt 3800 } ought to become: tcp-response content reject if ! { var(res.size) -m int gt 3800 } This must not be backported, but if a solution is found to at least detect this exact condition in the generic expression parser and emit a warning, this could probably help spot configuration bugs. Link: https://www.mail-archive.com/haproxy@formilux.org/msg41341.html Cc: Christopher Faulet <cfaulet@haproxy.com> Cc: Tim Düsterhus <tim@bastelstu.be> |
||
|---|---|---|
| .. | ||
| balance | ||
| cache | ||
| checks | ||
| compression | ||
| connection | ||
| contrib | ||
| converter | ||
| filters | ||
| http-capture | ||
| http-cookies | ||
| http-errorfiles | ||
| http-messaging | ||
| http-rules | ||
| http-set-timeout | ||
| jwt | ||
| log | ||
| lua | ||
| mailers | ||
| mcli | ||
| peers | ||
| sample_fetches | ||
| seamless-reload | ||
| server | ||
| spoe | ||
| ssl | ||
| startup | ||
| stick-table | ||
| stickiness | ||
| stream | ||
| tcp-rules | ||
| webstats | ||
| 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 ...
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).