varnish-cache/bin/varnishtest/vtc.c
0
/*-
1
 * Copyright (c) 2008-2011 Varnish Software AS
2
 * All rights reserved.
3
 *
4
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
5
 *
6
 * SPDX-License-Identifier: BSD-2-Clause
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions
10
 * are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 * SUCH DAMAGE.
28
 */
29
30
#include "config.h"
31
32
#include <sys/wait.h>
33
34
#include <ctype.h>
35
#include <stdarg.h>
36
#include <stdio.h>
37
#include <stdlib.h>
38
#include <string.h>
39
#include <unistd.h>
40
41
#include "vtc.h"
42
#include "vtc_log.h"
43
44
#include "vav.h"
45
#include "vrnd.h"
46
47
#define         MAX_TOKENS              200
48
49
volatile sig_atomic_t   vtc_error;      /* Error encountered */
50
int                     vtc_stop;       /* Stops current test without error */
51
pthread_t               vtc_thread;
52
int                     ign_unknown_macro = 0;
53
static struct vtclog    *vltop;
54
55
static pthread_mutex_t  vtc_vrnd_mtx;
56
57
static void
58 12384
vtc_vrnd_lock(void)
59
{
60 12384
        PTOK(pthread_mutex_lock(&vtc_vrnd_mtx));
61 12384
}
62
63
static void
64 12384
vtc_vrnd_unlock(void)
65
{
66 12384
        PTOK(pthread_mutex_unlock(&vtc_vrnd_mtx));
67 12384
}
68
69
static const char *tfn;
70
71
/**********************************************************************
72
 * Macro facility
73
 */
74
75
struct macro {
76
        unsigned                magic;
77
#define MACRO_MAGIC             0x803423e3
78
        VTAILQ_ENTRY(macro)     list;
79
        char                    *name;
80
        char                    *val;
81
        macro_f                 *func;
82
};
83
84
static VTAILQ_HEAD(,macro) macro_list = VTAILQ_HEAD_INITIALIZER(macro_list);
85
86
static const struct cmds global_cmds[] = {
87
#define CMD_GLOBAL(n) { #n, cmd_##n },
88
#include "cmds.h"
89
        { NULL, NULL }
90
};
91
92
static const struct cmds top_cmds[] = {
93
#define CMD_TOP(n) { #n, cmd_##n },
94
#include "cmds.h"
95
        { NULL, NULL }
96
};
97
98
/**********************************************************************/
99
100
static struct macro *
101 74982
macro_def_int(const char *name, macro_f *func, const char *fmt, va_list ap)
102
{
103
        struct macro *m;
104
        char buf[2048];
105
106 1004634
        VTAILQ_FOREACH(m, &macro_list, list)
107 931227
                if (!strcmp(name, m->name))
108 1575
                        break;
109 74982
        if (m == NULL) {
110 73407
                ALLOC_OBJ(m, MACRO_MAGIC);
111 73407
                AN(m);
112 73407
                REPLACE(m->name, name);
113 73407
                AN(m->name);
114 73407
                VTAILQ_INSERT_TAIL(&macro_list, m, list);
115 73407
        }
116 74982
        AN(m);
117 74982
        if (func != NULL) {
118 5910
                AZ(fmt);
119 5910
                m->func = func;
120 5910
        } else {
121 69072
                AN(fmt);
122 69072
                vbprintf(buf, fmt, ap);
123 69072
                REPLACE(m->val, buf);
124 69072
                AN(m->val);
125
        }
126 74982
        return (m);
127
}
128
129
130
/**********************************************************************
131
 * This is for defining macros before we fork the child process which
132
 * runs the test-case.
133
 */
134
135
void
136 32301
extmacro_def(const char *name, macro_f *func, const char *fmt, ...)
137
{
138
        va_list ap;
139
140 32301
        va_start(ap, fmt);
141 32301
        (void)macro_def_int(name, func, fmt, ap);
142 32301
        va_end(ap);
143 32301
}
144
145
/**********************************************************************
146
 * Below this point is run inside the testing child-process.
147
 */
148
149
static pthread_mutex_t          macro_mtx;
150
151
static void
152 3021
init_macro(void)
153
{
154
        struct macro *m;
155
156
        /* Dump the extmacros for completeness */
157 36150
        VTAILQ_FOREACH(m, &macro_list, list) {
158 33129
                if (m->val != NULL)
159 54174
                        vtc_log(vltop, 4,
160 27087
                            "extmacro def %s=%s", m->name, m->val);
161
                else
162 6042
                        vtc_log(vltop, 4, "extmacro def %s(...)", m->name);
163 33129
        }
164
165 3021
        PTOK(pthread_mutex_init(&macro_mtx, NULL));
166 3021
}
167
168
void
169 42681
macro_def(struct vtclog *vl, const char *instance, const char *name,
170
    const char *fmt, ...)
171
{
172
        char buf1[256];
173
        struct macro *m;
174
        va_list ap;
175
176 42681
        AN(fmt);
177
178 42681
        if (instance != NULL) {
179 33618
                bprintf(buf1, "%s_%s", instance, name);
180 33618
                name = buf1;
181 33618
        }
182
183 42681
        PTOK(pthread_mutex_lock(&macro_mtx));
184 42681
        va_start(ap, fmt);
185 42681
        m = macro_def_int(name, NULL, fmt, ap);
186 42681
        va_end(ap);
187 42681
        vtc_log(vl, 4, "macro def %s=%s", name, m->val);
188 42681
        PTOK(pthread_mutex_unlock(&macro_mtx));
189 42681
}
190
191
void
192 10626
macro_undef(struct vtclog *vl, const char *instance, const char *name)
193
{
194
        char buf1[256];
195
        struct macro *m;
196
197 10626
        if (instance != NULL) {
198 10626
                bprintf(buf1, "%s_%s", instance, name);
199 10626
                name = buf1;
200 10626
        }
201
202 10626
        PTOK(pthread_mutex_lock(&macro_mtx));
203 172305
        VTAILQ_FOREACH(m, &macro_list, list)
204 171720
                if (!strcmp(name, m->name))
205 10041
                        break;
206 10626
        if (m != NULL) {
207 10041
                if (!vtc_stop)
208 540
                        vtc_log(vl, 4, "macro undef %s", name);
209 10041
                CHECK_OBJ(m, MACRO_MAGIC);
210 10041
                VTAILQ_REMOVE(&macro_list, m, list);
211 10041
                free(m->name);
212 10041
                free(m->val);
213 10041
                FREE_OBJ(m);
214 10041
        }
215 10626
        PTOK(pthread_mutex_unlock(&macro_mtx));
216 10626
}
217
218
unsigned
219 5598
macro_isdef(const char *instance, const char *name)
220
{
221
        char buf1[256];
222
        struct macro *m;
223
224 5598
        if (instance != NULL) {
225 0
                bprintf(buf1, "%s_%s", instance, name);
226 0
                name = buf1;
227 0
        }
228
229 5598
        PTOK(pthread_mutex_lock(&macro_mtx));
230 102690
        VTAILQ_FOREACH(m, &macro_list, list)
231 97092
                if (!strcmp(name, m->name))
232 0
                        break;
233 5598
        PTOK(pthread_mutex_unlock(&macro_mtx));
234
235 5598
        return (m != NULL);
236
}
237
238
void
239 35292
macro_cat(struct vtclog *vl, struct vsb *vsb, const char *b, const char *e)
240
{
241
        struct macro *m;
242 35292
        char **argv, *retval = NULL;
243 35292
        const char *err = NULL;
244
        int argc;
245
246 35292
        AN(b);
247 35292
        if (e == NULL)
248 18696
                e = strchr(b, '\0');
249 35292
        AN(e);
250
251 35292
        argv = VAV_ParseTxt(b, e, &argc, ARGV_COMMA);
252 35292
        AN(argv);
253
254 35292
        if (*argv != NULL)
255 0
                vtc_fatal(vl, "Macro ${%.*s} parsing failed: %s",
256 0
                    (int)(e - b), b, *argv);
257
258 35292
        assert(argc >= 2);
259
260 35292
        PTOK(pthread_mutex_lock(&macro_mtx));
261 329931
        VTAILQ_FOREACH(m, &macro_list, list) {
262 329781
                CHECK_OBJ_NOTNULL(m, MACRO_MAGIC);
263 329781
                if (!strcmp(argv[1], m->name))
264 35142
                        break;
265 294639
        }
266 35292
        if (m != NULL) {
267 35142
                if (m->func != NULL) {
268 6555
                        AZ(m->val);
269 6555
                        retval = m->func(argc, argv, &err);
270 6555
                        if (err == NULL)
271 6555
                                AN(retval);
272 6555
                } else {
273 28587
                        AN(m->val);
274 28587
                        if (argc == 2)
275 28587
                                REPLACE(retval, m->val);
276
                        else
277 0
                                err = "macro does not take arguments";
278
                }
279 35142
        }
280 35292
        PTOK(pthread_mutex_unlock(&macro_mtx));
281
282 35292
        VAV_Free(argv);
283
284 35292
        if (err != NULL)
285 0
                vtc_fatal(vl, "Macro ${%.*s} failed: %s",
286 0
                    (int)(e - b), b, err);
287
288 35292
        if (retval == NULL) {
289 150
                if (!ign_unknown_macro)
290 0
                        vtc_fatal(vl, "Macro ${%.*s} not found",
291 0
                            (int)(e - b), b);
292 150
                VSB_printf(vsb, "${%.*s}", (int)(e - b), b);
293 150
                return;
294
        }
295
296 35142
        VSB_cat(vsb, retval);
297 35142
        free(retval);
298 35292
}
299
300
struct vsb *
301 4219
macro_expandf(struct vtclog *vl, const char *fmt, ...)
302
{
303
        va_list ap;
304
        struct vsb *vsb1, *vsb2;
305
306 4219
        vsb1 = VSB_new_auto();
307 4219
        AN(vsb1);
308 4219
        va_start(ap, fmt);
309 4219
        VSB_vprintf(vsb1, fmt, ap);
310 4219
        va_end(ap);
311 4219
        AZ(VSB_finish(vsb1));
312 4219
        vsb2 = macro_expand(vl, VSB_data(vsb1));
313 4219
        VSB_destroy(&vsb1);
314 4219
        return (vsb2);
315
}
316
317
struct vsb *
318 15786
macro_expand(struct vtclog *vl, const char *text)
319
{
320
        struct vsb *vsb;
321
        const char *p, *q;
322
323 15786
        vsb = VSB_new_auto();
324 15786
        AN(vsb);
325 32379
        while (*text != '\0') {
326 26763
                p = strstr(text, "${");
327 26763
                if (p == NULL) {
328 10170
                        VSB_cat(vsb, text);
329 10170
                        break;
330
                }
331 16593
                VSB_bcat(vsb, text, p - text);
332 16593
                q = strchr(p, '}');
333 16593
                if (q == NULL) {
334 0
                        VSB_cat(vsb, text);
335 0
                        break;
336
                }
337 16593
                assert(p[0] == '$');
338 16593
                assert(p[1] == '{');
339 16593
                assert(q[0] == '}');
340 16593
                p += 2;
341 16593
                macro_cat(vl, vsb, p, q);
342 16593
                text = q + 1;
343
        }
344 15786
        AZ(VSB_finish(vsb));
345 15786
        return (vsb);
346
}
347
348
/**********************************************************************
349
 * Parse a string
350
 *
351
 * We make a copy of the string and deliberately leak it, so that all
352
 * the cmd functions we call don't have to strdup(3) all over the place.
353
 *
354
 * Static checkers like Coverity may bitch about this, but we don't care.
355
 */
356
357
358
void
359 23448
parse_string(struct vtclog *vl, void *priv, const char *spec)
360
{
361
        char *token_s[MAX_TOKENS], *token_e[MAX_TOKENS];
362
        struct vsb *token_exp;
363
        char *e, *p, *q, *f, *buf;
364
        int nest_brace;
365
        int tn;
366
        unsigned n, m;
367
        const struct cmds *cp;
368
369 23448
        AN(spec);
370 23448
        buf = strdup(spec);
371 23448
        AN(buf);
372 23448
        e = strchr(buf, '\0');
373 23448
        AN(e);
374 306276
        for (p = buf; p < e; p++) {
375 282918
                if (vtc_error || vtc_stop)
376 76
                        break;
377
                /* Start of line */
378 282860
                if (isspace(*p))
379 165265
                        continue;
380 117595
                if (*p == '\n')
381 0
                        continue;
382
383 117595
                if (*p == '#') {
384 270670
                        for (; *p != '\0' && *p != '\n'; p++)
385
                                ;
386 6555
                        if (*p == '\0')
387 0
                                break;
388 6555
                        continue;
389
                }
390
391 111008
                q = strchr(p, '\n');
392 111008
                if (q == NULL)
393 1119
                        q = strchr(p, '\0');
394 111008
                if (q - p > 60)
395 8711
                        vtc_log(vl, 2, "=== %.60s...", p);
396
                else
397 102297
                        vtc_log(vl, 2, "=== %.*s", (int)(q - p), p);
398
399
                /* First content on line, collect tokens */
400 111008
                memset(token_s, 0, sizeof token_s);
401 111008
                memset(token_e, 0, sizeof token_e);
402 111008
                tn = 0;
403 111008
                f = p;
404 748844
                while (p < e) {
405 747751
                        assert(tn < MAX_TOKENS);
406 747751
                        assert(p < e);
407 747751
                        if (*p == '\n') { /* End on NL */
408 109915
                                break;
409
                        }
410 637836
                        if (isspace(*p)) { /* Inter-token whitespace */
411 270665
                                p++;
412 270665
                                continue;
413
                        }
414 367171
                        if (*p == '\\' && p[1] == '\n') { /* line-cont */
415 2922
                                p += 2;
416 2922
                                continue;
417
                        }
418 364249
                        if (*p == '"') { /* quotes */
419 35153
                                token_s[tn] = ++p;
420 35153
                                q = p;
421 849321
                                for (; *p != '\0'; p++) {
422 849273
                                        assert(p < e);
423 849273
                                        if (*p == '"')
424 35105
                                                break;
425 814168
                                        if (*p == '\\') {
426 8349
                                                p += VAV_BackSlash(p, q) - 1;
427 8349
                                                q++;
428 8349
                                        } else {
429 805819
                                                if (*p == '\n')
430 0
                                                        vtc_fatal(vl,
431
                                "Unterminated quoted string in line: %*.*s",
432 0
                                (int)(p - f), (int)(p - f), f);
433 805819
                                                assert(*p != '\n');
434 805819
                                                *q++ = *p;
435
                                        }
436 814168
                                }
437 35153
                                token_e[tn++] = q;
438 35153
                                p++;
439 364249
                        } else if (*p == '{') { /* Braces */
440 22669
                                nest_brace = 0;
441 22669
                                token_s[tn] = p + 1;
442 3672714
                                for (; p < e; p++) {
443 3672714
                                        if (*p == '{')
444 41494
                                                nest_brace++;
445 3631220
                                        else if (*p == '}') {
446 41494
                                                if (--nest_brace == 0)
447 22669
                                                        break;
448 18825
                                        }
449 3650045
                                }
450 22669
                                assert(*p == '}');
451 22669
                                token_e[tn++] = p++;
452 22669
                        } else { /* other tokens */
453 306427
                                token_s[tn] = p;
454 14290959
                                for (; p < e && !isspace(*p); p++)
455 13984532
                                        continue;
456 306427
                                token_e[tn++] = p;
457
                        }
458
                }
459
460 111008
                assert(p <= e);
461 111008
                assert(tn < MAX_TOKENS);
462 111008
                token_s[tn] = NULL;
463 475264
                for (tn = 0; token_s[tn] != NULL; tn++) {
464 364256
                        AN(token_e[tn]);        /*lint !e771 */
465 364256
                        *token_e[tn] = '\0';    /*lint !e771 */
466 364256
                        if (NULL != strstr(token_s[tn], "${")) {
467 3186
                                token_exp = macro_expand(vl, token_s[tn]);
468 3186
                                if (vtc_error)
469 0
                                        return;
470 3186
                                token_s[tn] = VSB_data(token_exp);
471 3186
                                token_e[tn] = strchr(token_s[tn], '\0');
472 3186
                        }
473 364256
                }
474
475
476
/* SECTION: loop loop
477
 *
478
 * loop NUMBER STRING
479
 *         Process STRING as a specification, NUMBER times.
480
 *
481
 * This works inside all specification strings
482
 */
483
484 111008
                if (!strcmp(token_s[0], "loop")) {
485 130
                        n = strtoul(token_s[1], NULL, 0);
486 5405
                        for (m = 0; m < n; m++) {
487 5275
                                vtc_log(vl, 4, "Loop #%u", m);
488 5275
                                parse_string(vl, priv, token_s[2]);
489 5275
                        }
490 130
                        continue;
491
                }
492
493 110878
                AN(vl->cmds);
494 1959979
                for (cp = vl->cmds; cp->name != NULL; cp++)
495 1954612
                        if (!strcmp(token_s[0], cp->name))
496 105511
                                break;
497
498 110878
                if (cp->name == NULL) {
499 9987
                        for (cp = global_cmds; cp->name != NULL; cp++)
500 9987
                                if (!strcmp(token_s[0], cp->name))
501 5367
                                        break;
502 5367
                }
503
504 110878
                if (cp->name == NULL)
505 0
                        vtc_fatal(vl, "Unknown command: \"%s\"", token_s[0]);
506
507 110878
                assert(cp->cmd != NULL);
508 110878
                cp->cmd(token_s, priv, vl);
509 110878
        }
510 23398
}
511
512
/**********************************************************************
513
 * Reset commands (between tests)
514
 */
515
516
static void
517 6042
reset_cmds(const struct cmds *cmd)
518
{
519
520 60420
        for (; cmd->name != NULL; cmd++)
521 54378
                cmd->cmd(NULL, NULL, NULL);
522 6042
}
523
524
/**********************************************************************
525
 * Execute a file
526
 */
527
528
int
529 3021
fail_out(void)
530
{
531
        unsigned old_err;
532
        static int once = 0;
533
534 3021
        if (once++) {
535 0
                vtc_log(vltop, 1, "failure during reset");
536 0
                return (vtc_error);
537
        }
538 3021
        old_err = vtc_error;
539 3021
        if (!vtc_stop)
540 2976
                vtc_stop = 1;
541 3021
        vtc_log(vltop, 1, "RESETTING after %s", tfn);
542 3021
        reset_cmds(global_cmds);
543 3021
        reset_cmds(top_cmds);
544 3021
        vtc_error |= old_err;
545
546 3021
        if (vtc_error)
547 6
                vtc_log(vltop, 1, "TEST %s FAILED", tfn);
548
        else
549 3015
                vtc_log(vltop, 1, "TEST %s completed", tfn);
550
551 3021
        if (vtc_stop > 1)
552 45
                return (1);
553 2976
        return (vtc_error);
554 3021
}
555
556
int
557 3021
exec_file(const char *fn, const char *script, const char *tmpdir,
558
    char *logbuf, unsigned loglen)
559
{
560
        FILE *f;
561
        struct vsb *vsb;
562
        const char *p;
563
564 3021
        (void)signal(SIGPIPE, SIG_IGN);
565
566 3021
        PTOK(pthread_mutex_init(&vtc_vrnd_mtx, NULL));
567 3021
        VRND_Lock = vtc_vrnd_lock;
568 3021
        VRND_Unlock = vtc_vrnd_unlock;
569 3021
        VRND_SeedAll();
570
571 3021
        tfn = fn;
572 3021
        vtc_loginit(logbuf, loglen);
573 3021
        vltop = vtc_logopen("top");
574 3021
        AN(vltop);
575 3021
        vtc_log_set_cmd(vltop, top_cmds);
576
577 3021
        vtc_log(vltop, 1, "TEST %s starting", fn);
578
579 3021
        init_macro();
580 3021
        init_server();
581 3021
        init_syslog();
582 3021
        init_tunnel();
583
584 3021
        vsb = VSB_new_auto();
585 3021
        AN(vsb);
586 3021
        if (*fn != '/')
587 2991
                macro_cat(vltop, vsb, "pwd", NULL);
588 3021
        p = strrchr(fn, '/');
589 3021
        if (p != NULL) {
590 2997
                VSB_putc(vsb, '/');
591 2997
                VSB_bcat(vsb, fn, p - fn);
592 2997
        }
593 3021
        if (VSB_len(vsb) == 0)
594 0
                VSB_putc(vsb, '/');
595 3021
        AZ(VSB_finish(vsb));
596 3021
        macro_def(vltop, NULL, "testdir", "%s", VSB_data(vsb));
597 3021
        VSB_destroy(&vsb);
598
599
        /* Move into our tmpdir */
600 3021
        AZ(chdir(tmpdir));
601 3021
        macro_def(vltop, NULL, "tmpdir", "%s", tmpdir);
602 3021
        p = strrchr(tmpdir, '/');
603 3021
        AN(p);
604 3021
        p++;
605 3021
        AN(*p);
606 3021
        macro_def(vltop, NULL, "vtcid", "%s", p);
607
608
        /* Drop file to tell what was going on here */
609 3021
        f = fopen("INFO", "w");
610 3021
        AN(f);
611 3021
        fprintf(f, "Test case: %s\n", fn);
612 3021
        AZ(fclose(f));
613
614 3021
        vtc_stop = 0;
615
616 3021
        vtc_thread = pthread_self();
617 3021
        parse_string(vltop, NULL, script);
618 3021
        return (fail_out());
619
}