varnish-cache/bin/varnishtest/vtest2/src/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 34062
vtc_vrnd_lock(void)
59
{
60 34062
        PTOK(pthread_mutex_lock(&vtc_vrnd_mtx));
61 34062
}
62
63
static void
64 34062
vtc_vrnd_unlock(void)
65
{
66 34062
        PTOK(pthread_mutex_unlock(&vtc_vrnd_mtx));
67 34062
}
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 51162
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 684776
        VTAILQ_FOREACH(m, &macro_list, list)
107 634694
                if (!strcmp(name, m->name))
108 1080
                        break;
109 51162
        if (m == NULL) {
110 50082
                ALLOC_OBJ(m, MACRO_MAGIC);
111 50082
                AN(m);
112 50082
                REPLACE(m->name, name);
113 50082
                AN(m->name);
114 50082
                VTAILQ_INSERT_TAIL(&macro_list, m, list);
115 50082
        }
116 51162
        AN(m);
117 51162
        if (func != NULL) {
118 4036
                AZ(fmt);
119 4036
                m->func = func;
120 4036
        } else {
121 47126
                AN(fmt);
122 47126
                vbprintf(buf, fmt, ap);
123 47126
                REPLACE(m->val, buf);
124 47126
                AN(m->val);
125
        }
126 51162
        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 22112
extmacro_def(const char *name, macro_f *func, const char *fmt, ...)
137
{
138
        va_list ap;
139
140 22112
        va_start(ap, fmt);
141 22112
        (void)macro_def_int(name, func, fmt, ap);
142 22112
        va_end(ap);
143 22112
}
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 2050
init_macro(void)
153
{
154
        struct macro *m;
155
156
        /* Dump the extmacros for completeness */
157 24542
        VTAILQ_FOREACH(m, &macro_list, list) {
158 22492
                if (m->val != NULL)
159 36784
                        vtc_log(vltop, 4,
160 18392
                            "extmacro def %s=%s", m->name, m->val);
161
                else
162 4100
                        vtc_log(vltop, 4, "extmacro def %s(...)", m->name);
163 22492
        }
164
165 2050
        PTOK(pthread_mutex_init(&macro_mtx, NULL));
166 2050
}
167
168
void
169 29050
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 29050
        AN(fmt);
177
178 29050
        if (instance != NULL) {
179 22900
                bprintf(buf1, "%s_%s", instance, name);
180 22900
                name = buf1;
181 22900
        }
182
183 29050
        PTOK(pthread_mutex_lock(&macro_mtx));
184 29050
        va_start(ap, fmt);
185 29050
        m = macro_def_int(name, NULL, fmt, ap);
186 29050
        va_end(ap);
187 29050
        vtc_log(vl, 4, "macro def %s=%s", name, m->val);
188 29050
        PTOK(pthread_mutex_unlock(&macro_mtx));
189 29050
}
190
191
void
192 7137
macro_undef(struct vtclog *vl, const char *instance, const char *name)
193
{
194
        char buf1[256];
195
        struct macro *m;
196
197 7137
        if (instance != NULL) {
198 7137
                bprintf(buf1, "%s_%s", instance, name);
199 7137
                name = buf1;
200 7137
        }
201
202 7137
        PTOK(pthread_mutex_lock(&macro_mtx));
203 115919
        VTAILQ_FOREACH(m, &macro_list, list)
204 115502
                if (!strcmp(name, m->name))
205 6720
                        break;
206 7137
        if (m != NULL) {
207 6720
                if (!vtc_stop)
208 374
                        vtc_log(vl, 4, "macro undef %s", name);
209 6720
                CHECK_OBJ(m, MACRO_MAGIC);
210 6720
                VTAILQ_REMOVE(&macro_list, m, list);
211 6720
                free(m->name);
212 6720
                free(m->val);
213 6720
                FREE_OBJ(m);
214 6720
        }
215 7137
        PTOK(pthread_mutex_unlock(&macro_mtx));
216 7137
}
217
218
unsigned
219 3836
macro_isdef(const char *instance, const char *name)
220
{
221
        char buf1[256];
222
        struct macro *m;
223
224 3836
        if (instance != NULL) {
225 0
                bprintf(buf1, "%s_%s", instance, name);
226 0
                name = buf1;
227 0
        }
228
229 3836
        PTOK(pthread_mutex_lock(&macro_mtx));
230 70356
        VTAILQ_FOREACH(m, &macro_list, list)
231 66520
                if (!strcmp(name, m->name))
232 0
                        break;
233 3836
        PTOK(pthread_mutex_unlock(&macro_mtx));
234
235 3836
        return (m != NULL);
236
}
237
238
void
239 24153
macro_cat(struct vtclog *vl, struct vsb *vsb, const char *b, const char *e)
240
{
241
        struct macro *m;
242 24153
        char **argv, *retval = NULL;
243 24153
        const char *err = NULL;
244
        int argc;
245
246 24153
        AN(b);
247 24153
        if (e == NULL)
248 12801
                e = strchr(b, '\0');
249 24153
        AN(e);
250
251 24153
        argv = VAV_ParseTxt(b, e, &argc, ARGV_COMMA);
252 24153
        AN(argv);
253
254 24153
        if (*argv != NULL)
255 0
                vtc_fatal(vl, "Macro ${%.*s} parsing failed: %s",
256 0
                    (int)(e - b), b, *argv);
257
258 24153
        assert(argc >= 2);
259
260 24153
        PTOK(pthread_mutex_lock(&macro_mtx));
261 226632
        VTAILQ_FOREACH(m, &macro_list, list) {
262 226504
                CHECK_OBJ_NOTNULL(m, MACRO_MAGIC);
263 226504
                if (!strcmp(argv[1], m->name))
264 24025
                        break;
265 202479
        }
266 24153
        if (m != NULL) {
267 24025
                if (m->func != NULL) {
268 4435
                        AZ(m->val);
269 4435
                        retval = m->func(argc, argv, &err);
270 4435
                        if (err == NULL)
271 4435
                                AN(retval);
272 4435
                } else {
273 19590
                        AN(m->val);
274 19590
                        if (argc == 2)
275 19590
                                REPLACE(retval, m->val);
276
                        else
277 0
                                err = "macro does not take arguments";
278
                }
279 24025
        }
280 24153
        PTOK(pthread_mutex_unlock(&macro_mtx));
281
282 24153
        VAV_Free(argv);
283
284 24153
        if (err != NULL)
285 0
                vtc_fatal(vl, "Macro ${%.*s} failed: %s",
286 0
                    (int)(e - b), b, err);
287
288 24153
        if (retval == NULL) {
289 128
                if (!ign_unknown_macro)
290 0
                        vtc_fatal(vl, "Macro ${%.*s} not found",
291 0
                            (int)(e - b), b);
292 128
                VSB_printf(vsb, "${%.*s}", (int)(e - b), b);
293 128
                return;
294
        }
295
296 24025
        VSB_cat(vsb, retval);
297 24025
        free(retval);
298 24153
}
299
300
struct vsb *
301 2862
macro_expandf(struct vtclog *vl, const char *fmt, ...)
302
{
303
        va_list ap;
304
        struct vsb *vsb1, *vsb2;
305
306 2862
        vsb1 = VSB_new_auto();
307 2862
        AN(vsb1);
308 2862
        va_start(ap, fmt);
309 2862
        VSB_vprintf(vsb1, fmt, ap);
310 2862
        va_end(ap);
311 2862
        AZ(VSB_finish(vsb1));
312 2862
        vsb2 = macro_expand(vl, VSB_data(vsb1));
313 2862
        VSB_destroy(&vsb1);
314 2862
        return (vsb2);
315
}
316
317
struct vsb *
318 10698
macro_expand(struct vtclog *vl, const char *text)
319
{
320
        struct vsb *vsb;
321
        const char *p, *q;
322
323 10698
        vsb = VSB_new_auto();
324 10698
        AN(vsb);
325 22046
        while (*text != '\0') {
326 18192
                p = strstr(text, "${");
327 18192
                if (p == NULL) {
328 6844
                        VSB_cat(vsb, text);
329 6844
                        break;
330
                }
331 11348
                VSB_bcat(vsb, text, p - text);
332 11348
                q = strchr(p, '}');
333 11348
                if (q == NULL) {
334 0
                        VSB_cat(vsb, text);
335 0
                        break;
336
                }
337 11348
                assert(p[0] == '$');
338 11348
                assert(p[1] == '{');
339 11348
                assert(q[0] == '}');
340 11348
                p += 2;
341 11348
                macro_cat(vl, vsb, p, q);
342 11348
                text = q + 1;
343
        }
344 10698
        AZ(VSB_finish(vsb));
345 10698
        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 16067
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 16067
        AN(spec);
370 16067
        buf = strdup(spec);
371 16067
        AN(buf);
372 16067
        e = strchr(buf, '\0');
373 16067
        AN(e);
374 209770
        for (p = buf; p < e; p++) {
375 193753
                if (vtc_error || vtc_stop) {
376 100
                        vtc_log(vl, 1, "Aborting execution, test %s",
377 50
                            vtc_error ? "failed" : "ended");
378 50
                        break;
379
                }
380
                /* Start of line */
381 193703
                if (isspace(*p))
382 113572
                        continue;
383 80131
                if (*p == '\n')
384 0
                        continue;
385
386 80131
                if (*p == '#') {
387 184064
                        for (; *p != '\0' && *p != '\n'; p++)
388
                                ;
389 4464
                        if (*p == '\0')
390 0
                                break;
391 4464
                        continue;
392
                }
393
394 75667
                q = strchr(p, '\n');
395 75667
                if (q == NULL)
396 790
                        q = strchr(p, '\0');
397 75667
                if (q - p > 60)
398 5792
                        vtc_log(vl, 2, "=== %.60s...", p);
399
                else
400 69875
                        vtc_log(vl, 2, "=== %.*s", (int)(q - p), p);
401
402
                /* First content on line, collect tokens */
403 75667
                memset(token_s, 0, sizeof token_s);
404 75667
                memset(token_e, 0, sizeof token_e);
405 75667
                tn = 0;
406 75667
                f = p;
407 507941
                while (p < e) {
408 507167
                        assert(tn < MAX_TOKENS);
409 507167
                        assert(p < e);
410 507167
                        if (*p == '\n') { /* End on NL */
411 74893
                                break;
412
                        }
413 432274
                        if (isspace(*p)) { /* Inter-token whitespace */
414 183356
                                p++;
415 183356
                                continue;
416
                        }
417 248918
                        if (*p == '\\' && p[1] == '\n') { /* line-cont */
418 1982
                                p += 2;
419 1982
                                continue;
420
                        }
421 246936
                        if (*p == '"') { /* quotes */
422 23764
                                token_s[tn] = ++p;
423 23764
                                q = p;
424 573678
                                for (; *p != '\0'; p++) {
425 573662
                                        assert(p < e);
426 573662
                                        if (*p == '"')
427 23748
                                                break;
428 549914
                                        if (*p == '\\') {
429 5552
                                                p += VAV_BackSlash(p, q) - 1;
430 5552
                                                q++;
431 5552
                                        } else {
432 544362
                                                if (*p == '\n')
433 0
                                                        vtc_fatal(vl,
434
                                "Unterminated quoted string in line: %*.*s",
435 0
                                (int)(p - f), (int)(p - f), f);
436 544362
                                                assert(*p != '\n');
437 544362
                                                *q++ = *p;
438
                                        }
439 549914
                                }
440 23764
                                token_e[tn++] = q;
441 23764
                                p++;
442 246936
                        } else if (*p == '{') { /* Braces */
443 15482
                                nest_brace = 0;
444 15482
                                token_s[tn] = p + 1;
445 2515104
                                for (; p < e; p++) {
446 2515104
                                        if (*p == '{')
447 28500
                                                nest_brace++;
448 2486604
                                        else if (*p == '}') {
449 28500
                                                if (--nest_brace == 0)
450 15482
                                                        break;
451 13018
                                        }
452 2499622
                                }
453 15482
                                assert(*p == '}');
454 15482
                                token_e[tn++] = p++;
455 15482
                        } else { /* other tokens */
456 207690
                                token_s[tn] = p;
457 9550498
                                for (; p < e && !isspace(*p); p++)
458 9342808
                                        continue;
459 207690
                                token_e[tn++] = p;
460
                        }
461
                }
462
463 75667
                assert(p <= e);
464 75667
                assert(tn < MAX_TOKENS);
465 75667
                token_s[tn] = NULL;
466 322611
                for (tn = 0; token_s[tn] != NULL; tn++) {
467 246944
                        AN(token_e[tn]);        /*lint !e771 */
468 246944
                        *token_e[tn] = '\0';    /*lint !e771 */
469 246944
                        if (NULL != strstr(token_s[tn], "${")) {
470 2108
                                token_exp = macro_expand(vl, token_s[tn]);
471 2108
                                if (vtc_error)
472 0
                                        return;
473 2108
                                token_s[tn] = VSB_data(token_exp);
474 2108
                                token_e[tn] = strchr(token_s[tn], '\0');
475 2108
                        }
476 246944
                }
477
478
479
/* SECTION: loop loop
480
 *
481
 * loop NUMBER STRING
482
 *         Process STRING as a specification, NUMBER times.
483
 *
484
 * This works inside all specification strings
485
 */
486
487 75667
                if (!strcmp(token_s[0], "loop")) {
488 92
                        n = strtoul(token_s[1], NULL, 0);
489 3615
                        for (m = 0; m < n && !vtc_error && !vtc_stop; m++) {
490 3523
                                vtc_log(vl, 4, "Loop #%u", m);
491 3523
                                parse_string(vl, priv, token_s[2]);
492 3523
                        }
493 92
                        continue;
494
                }
495
496 75575
                AN(vl->cmds);
497 1339817
                for (cp = vl->cmds; cp->name != NULL; cp++)
498 1336150
                        if (!strcmp(token_s[0], cp->name))
499 71908
                                break;
500
501 75575
                if (cp->name == NULL) {
502 6768
                        for (cp = global_cmds; cp->name != NULL; cp++)
503 6768
                                if (!strcmp(token_s[0], cp->name))
504 3670
                                        break;
505 3670
                }
506
507 75575
                if (cp->name == NULL)
508 0
                        vtc_fatal(vl, "Unknown command: \"%s\"", token_s[0]);
509
510 75575
                assert(cp->cmd != NULL);
511 75575
                cp->cmd(token_s, priv, vl);
512 75575
        }
513 16047
}
514
515
/**********************************************************************
516
 * Reset commands (between tests)
517
 */
518
519
static void
520 4100
reset_cmds(const struct cmds *cmd)
521
{
522
523 41000
        for (; cmd->name != NULL; cmd++)
524 36900
                cmd->cmd(NULL, NULL, NULL);
525 4100
}
526
527
/**********************************************************************
528
 * Execute a file
529
 */
530
531
int
532 2050
fail_out(void)
533
{
534
        unsigned old_err;
535
        static int once = 0;
536
537 2050
        if (once++) {
538 0
                vtc_log(vltop, 1, "failure during reset");
539 0
                return (vtc_error);
540
        }
541 2050
        old_err = vtc_error;
542 2050
        if (!vtc_stop)
543 2020
                vtc_stop = 1;
544 2050
        vtc_log(vltop, 1, "RESETTING after %s", tfn);
545 2050
        reset_cmds(global_cmds);
546 2050
        reset_cmds(top_cmds);
547 2050
        vtc_error |= old_err;
548
549 2050
        if (vtc_error)
550 2
                vtc_log(vltop, 1, "TEST %s FAILED", tfn);
551
        else
552 2048
                vtc_log(vltop, 1, "TEST %s completed", tfn);
553
554 2050
        if (vtc_stop > 1)
555 30
                return (1);
556 2020
        return (vtc_error);
557 2050
}
558
559
int
560 2050
exec_file(const char *fn, const char *script, const char *tmpdir,
561
    char *logbuf, unsigned loglen)
562
{
563
        FILE *f;
564
        struct vsb *vsb;
565
        const char *p;
566
567 2050
        AN(tmpdir);
568
569 2050
        (void)signal(SIGPIPE, SIG_IGN);
570
571 2050
        PTOK(pthread_mutex_init(&vtc_vrnd_mtx, NULL));
572 2050
        VRND_Lock = vtc_vrnd_lock;
573 2050
        VRND_Unlock = vtc_vrnd_unlock;
574 2050
        VRND_SeedAll();
575
576 2050
        tfn = fn;
577 2050
        vtc_loginit(logbuf, loglen);
578 2050
        vltop = vtc_logopen("top");
579 2050
        AN(vltop);
580 2050
        vtc_log_set_cmd(vltop, top_cmds);
581
582 2050
        vtc_log(vltop, 1, "TEST %s starting", fn);
583
584 2050
        init_macro();
585 2050
        init_server();
586 2050
        init_syslog();
587 2050
        init_tunnel();
588
589 2050
        vsb = VSB_new_auto();
590 2050
        AN(vsb);
591 2050
        if (*fn != '/')
592 2030
                macro_cat(vltop, vsb, "pwd", NULL);
593 2050
        p = strrchr(fn, '/');
594 2050
        if (p != NULL) {
595 2040
                VSB_putc(vsb, '/');
596 2040
                VSB_bcat(vsb, fn, p - fn);
597 2040
        }
598 2050
        if (VSB_len(vsb) == 0)
599 0
                VSB_putc(vsb, '/');
600 2050
        AZ(VSB_finish(vsb));
601 2050
        macro_def(vltop, NULL, "testdir", "%s", VSB_data(vsb));
602 2050
        VSB_destroy(&vsb);
603
604
        /* Move into our tmpdir */
605 2050
        AZ(chdir(tmpdir));
606 2050
        macro_def(vltop, NULL, "tmpdir", "%s", tmpdir);
607 2050
        p = strrchr(tmpdir, '/');
608 2050
        AN(p);
609 2050
        p++;
610 2050
        AN(*p);
611 2050
        macro_def(vltop, NULL, "vtcid", "%s", p);
612
613
        /* Drop file to tell what was going on here */
614 2050
        f = fopen("INFO", "w");
615 2050
        AN(f);
616 2050
        fprintf(f, "Test case: %s\n", fn);
617 2050
        AZ(fclose(f));
618
619 2050
        vtc_stop = 0;
620
621 2050
        vtc_thread = pthread_self();
622 2050
        parse_string(vltop, NULL, script);
623 2050
        return (fail_out());
624
}