1VARNISHTEST(1) VARNISHTEST(1)
2
6 varnishtest - Test program for Varnish
7
9 varnishtest [-hikLlqv] [-b size] [-D name=val] [-j jobs] [-n iter] [-t
10 duration] file [file ...]
11
13 The varnishtest program is a script driven program used to test the
14 Varnish Cache.
15 The varnishtest program, when started and given one or more script
17 files, can create a number of threads representing backends, some
18 threads representing clients, and a varnishd process. This is then used
19 to simulate a transaction to provoke a specific behavior.
20 The following options are available:
22 -b size
24 Set internal buffer size (default: 1M)
25 -D name=val Define macro for use in scripts
27 -h Show help
29 -i Set PATH and vmod_path to find varnish binaries in build tree
31 -j jobs
33 Run this many tests in parallel
34 -k Continue on test failure
36 -L Always leave temporary vtc.*
38 -l Leave temporary vtc.* if test fails
40 -n iterations
42 Run tests this many times
43 -p name=val Pass parameters to all varnishd command lines
45 -q Quiet mode: report only failures
47 -t duration
49 Time tests out after this long (default: 60s)
50 -v Verbose mode: always report test log
52 file File to use as a script
54 If TMPDIR is set in the environment, varnishtest creates temporary
56 vtc.* directories for each test in $TMPDIR, otherwise in /tmp.
57
59 The vtc syntax is documented at length in vtc(7). Should you want more
60 examples than the one below, you can have a look at the Varnish source
61 code repository, under bin/varnishtest/tests/, where all the regression
62 tests for Varnish are kept.
63 An example:
65 varnishtest "#1029"
67 server s1 {
69 rxreq
70 expect req.url == "/bar"
71 txresp -gzipbody {[bar]}
72 rxreq
74 expect req.url == "/foo"
75 txresp -body {<h1>FOO<esi:include src="/bar"/>BARF</h1>}
76 } -start
78 varnish v1 -vcl+backend {
80 sub vcl_backend_response {
81 set beresp.do_esi = true;
82 if (bereq.url == "/foo") {
83 set beresp.ttl = 0s;
84 } else {
85 set beresp.ttl = 10m;
86 }
87 }
88 } -start
89 client c1 {
91 txreq -url "/bar" -hdr "Accept-Encoding: gzip"
92 rxresp
93 gunzip
94 expect resp.bodylen == 5
95 txreq -url "/foo" -hdr "Accept-Encoding: gzip"
97 rxresp
98 expect resp.bodylen == 21
99 } -run
100 When run, the above script will simulate a server (s1) that expects two
102 different requests. It will start a Varnish server (v1) and add the
103 backend definition to the VCL specified (-vcl+backend). Finally it
104 starts the c1-client, which is a single client sending two requests.
105
107 Whether you are building a VMOD or trying to use one that you freshly
108 built, you can tell varnishtest to pass a vmod_path to varnishd
109 instances started using the varnish -start command in your test case:
110 varnishtest -p vmod_path=... /path/to/*.vtc
112 This way you can use the same test cases on both installed and built
114 VMODs:
115 server s1 {...} -start
117 varnish v1 -vcl+backend {
119 import wossname;
120 ...
122 } -start
123 ...
125 You are not limited to the vmod_path and can pass any parameter, allow‐
127 ing you to run a build matrix without changing the test suite. You can
128 achieve the same with macros, but then they need to be defined on each
129 run.
130 You can see the actual varnishd command lines in test outputs, they
132 look roughly like this:
133 exec varnishd [varnishtest -p params] [testing params] [vtc -arg params]
135 Parameters you define with varnishtest -p may be overriden by parame‐
137 ters needed by varnishtest to run properly, and they may in turn be
138 overriden by parameters set in test scripts.
139 There's also a special mode in which varnishtest builds itself a PATH
141 and a vmod_path in order to find Varnish binaries (programs and VMODs)
142 in the build tree surrounding the varnishtest binary. This is meant for
143 testing of Varnish under development and will disregard your vmod_path
144 if you set one.
145 If you need to test your VMOD against a Varnish build tree, you must
147 install it first, in a temp directory for instance. With information
148 provided by the installation's pkg-config(1) you can build a proper
149 PATH in order to access Varnish programs, and a vmod_path to access
150 both your VMOD and the built-in VMODs:
151 export PKG_CONFIG_PATH=/path/to/install/lib/pkgconfig
153 BINDIR="$(pkg-config --variable=bindir varnishapi)"
155 SBINDIR="$(pkg-config --variable=sbindir varnishapi)"
156 PATH="SBINDIR:BINDIR:$PATH"
157 VMODDIR="$(pkg-config --variable=vmoddir varnishapi)"
159 VMOD_PATH="/path/to/your/vmod/build/dir:$VMODDIR"
160 varnishtest -p vmod_path="$VMOD_PATH" ...
162
164 · varnishtest source code repository with tests
165 · varnishhist(1)
167 · varnishlog(1)
169 · varnishncsa(1)
171 · varnishstat(1)
173 · varnishtop(1)
175 · vcl(7)
177 · vtc(7)
179 · vmod_vtc(3)
181
183 The varnishtest program was developed by Poul-Henning Kamp <‐
184 phk@phk.freebsd.dk> in cooperation with Varnish Software AS. This man‐
185 ual page was originally written by Stig Sandbeck Mathisen <‐
186 ssm@linpro.no> and updated by Kristian Lyngstøl <‐
187 kristian@varnish-cache.org>.
188
190 This document is licensed under the same licence as Varnish itself. See
191 LICENCE for details.
192 · Copyright (c) 2007-2016 Varnish Software AS
194 VARNISHTEST(1)