test/parser: Fixed uninitialized variable warning
[petitboot] / test / parser / utils.c
1
2 #include <assert.h>
3 #include <err.h>
4 #include <fcntl.h>
5 #include <stdlib.h>
6 #include <string.h>
7 #include <ctype.h>
8 #include <sys/stat.h>
9 #include <sys/types.h>
10
11 #include <talloc/talloc.h>
12 #include <types/types.h>
13 #include <url/url.h>
14
15 #include "device-handler.h"
16 #include "parser.h"
17 #include "resource.h"
18 #include "event.h"
19 #include "platform.h"
20 #include "paths.h"
21 #include "parser-conf.h"
22
23 #include "parser-test.h"
24
25 struct p_item {
26         struct list_item list;
27         struct parser *parser;
28 };
29
30 struct test_file {
31         struct discover_device  *dev;
32         enum {
33                 TEST_FILE,
34                 TEST_DIR,
35         }                       type;
36         const char              *name;
37         void                    *data;
38         int                     size;
39         struct list_item        list;
40 };
41
42 STATIC_LIST(parsers);
43
44 void __register_parser(struct parser *parser)
45 {
46         struct p_item* i = talloc(NULL, struct p_item);
47
48         i->parser = parser;
49         list_add(&parsers, &i->list);
50 }
51
52 static void __attribute__((destructor)) __cleanup_parsers(void)
53 {
54         struct p_item *item, *tmp;
55
56         list_for_each_entry_safe(&parsers, item, tmp, list)
57                 talloc_free(item);
58 }
59
60 static struct discover_device *test_create_device_simple(
61                 struct parser_test *test)
62 {
63         static int dev_idx;
64         char name[10];
65
66         sprintf(name, "__test%d", dev_idx++);
67
68         return test_create_device(test, name);
69 }
70
71 struct discover_device *test_create_device(struct parser_test *test,
72                 const char *name)
73 {
74         struct discover_device *dev;
75
76         dev = discover_device_create(test->handler, NULL, name);
77
78         dev->device->id = talloc_strdup(dev, name);
79         dev->device_path = talloc_asprintf(dev, "/dev/%s", name);
80         dev->mount_path = talloc_asprintf(dev, "/test/mount/%s", name);
81         dev->mounted = true;
82
83         return dev;
84 }
85
86 static struct discover_context *test_create_context(struct parser_test *test)
87 {
88         struct discover_context *ctx;
89
90         ctx = talloc_zero(test, struct discover_context);
91         assert(ctx);
92
93         list_init(&ctx->boot_options);
94         ctx->device = test_create_device_simple(test);
95         ctx->test_data = test;
96         ctx->handler = test->handler;
97         device_handler_add_device(test->handler, ctx->device);
98
99         return ctx;
100 }
101
102 /* define our own test platform */
103 static bool test_platform_probe(struct platform *p __attribute__((unused)),
104                 void *ctx __attribute__((unused)))
105 {
106         return true;
107 }
108
109 struct platform test_platform = {
110         .name = "test",
111         .probe = test_platform_probe,
112 };
113
114 register_platform(test_platform);
115
116 struct parser_test *test_init(void)
117 {
118         struct parser_test *test;
119
120         test = talloc_zero(NULL, struct parser_test);
121         platform_init(NULL);
122         test->handler = device_handler_init(NULL, NULL, 0);
123         test->ctx = test_create_context(test);
124         list_init(&test->files);
125
126         return test;
127 }
128
129 void test_fini(struct parser_test *test)
130 {
131         device_handler_destroy(test->handler);
132         talloc_free(test);
133         platform_fini();
134 }
135
136 void __test_read_conf_data(struct parser_test *test,
137                 struct discover_device *dev, const char *conf_file,
138                 const char *buf, size_t len)
139 {
140         test_add_file_data(test, dev, conf_file, buf, len);
141 }
142
143 void test_read_conf_file(struct parser_test *test, const char *filename,
144                 const char *conf_file)
145 {
146         struct stat stat;
147         size_t size;
148         char *path;
149         int fd, rc;
150         char *buf;
151
152         path = talloc_asprintf(test, "%s/%s", TEST_CONF_BASE, filename);
153
154         fd = open(path, O_RDONLY);
155         if (fd < 0)
156                 err(EXIT_FAILURE, "Can't open test conf file %s\n", path);
157
158         rc = fstat(fd, &stat);
159         assert(!rc);
160         (void)rc;
161
162         size = stat.st_size;
163         buf = talloc_array(test, char, size + 1);
164
165         rc = read(fd, buf, size);
166         assert(rc == (ssize_t)size);
167
168         *(buf + size) = '\0';
169
170         close(fd);
171         talloc_free(path);
172
173         test_add_file_data(test, test->ctx->device, conf_file, buf, size);
174 }
175
176 void test_add_file_data(struct parser_test *test, struct discover_device *dev,
177                 const char *filename, const void *data, int size)
178 {
179         struct test_file *file;
180
181         file = talloc_zero(test, struct test_file);
182         file->type = TEST_FILE;
183         file->dev = dev;
184         file->name = filename;
185         file->data = talloc_memdup(test, data, size);
186         file->size = size;
187         list_add(&test->files, &file->list);
188 }
189
190 void test_add_dir(struct parser_test *test, struct discover_device *dev,
191                 const char *dirname)
192 {
193         struct test_file *file;
194
195         file = talloc_zero(test, struct test_file);
196         file->type = TEST_DIR;
197         file->dev = dev;
198         file->name = dirname;
199         /* Pick a non-zero size for directories so that "[ -s <dir
200          * path> ]" sees that the file has non-zero size. */
201         file->size = 1;
202         list_add(&test->files, &file->list);
203 }
204
205 void test_set_event_source(struct parser_test *test)
206 {
207         test->ctx->event = talloc_zero(test->ctx, struct event);
208 }
209
210 void test_set_event_param(struct event *event, const char *name,
211                 const char *value)
212 {
213         event_set_param(event, name, value);
214 }
215
216 void test_set_event_device(struct event *event, const char *dev)
217 {
218         event->device = talloc_strdup(event, dev);
219 }
220
221 int parser_request_file(struct discover_context *ctx,
222                 struct discover_device *dev, const char *filename,
223                 char **buf, int *len)
224 {
225         struct parser_test *test = ctx->test_data;
226         struct test_file *file;
227         char *tmp;
228
229         list_for_each_entry(&test->files, file, list) {
230                 if (file->dev != dev)
231                         continue;
232                 if (strcmp(file->name, filename))
233                         continue;
234                 if (file->type != TEST_FILE)
235                         continue;
236
237                 /* the read_file() interface always adds a trailing null
238                  * for string-safety; do the same here */
239                 tmp = talloc_array(test, char, file->size + 1);
240                 memcpy(tmp, file->data, file->size);
241                 tmp[file->size] = '\0';
242                 *buf = tmp;
243                 *len = file->size;
244                 return 0;
245         }
246
247         return -1;
248 }
249
250 int parser_stat_path(struct discover_context *ctx,
251                 struct discover_device *dev, const char *path,
252                 struct stat *statbuf)
253 {
254         struct parser_test *test = ctx->test_data;
255         struct test_file *file;
256
257         list_for_each_entry(&test->files, file, list) {
258                 if (file->dev != dev)
259                         continue;
260                 if (strcmp(file->name, path))
261                         continue;
262
263                 statbuf->st_size = (off_t)file->size;
264                 switch (file->type) {
265                 case TEST_FILE:
266                         statbuf->st_mode = S_IFREG;
267                         break;
268                 case TEST_DIR:
269                         statbuf->st_mode = S_IFDIR;
270                         break;
271                 default:
272                         fprintf(stderr, "%s: bad test file mode %d!", __func__,
273                                 file->type);
274                         exit(EXIT_FAILURE);
275                 }
276
277                 return 0;
278         }
279
280         return -1;
281 }
282
283 int parser_replace_file(struct discover_context *ctx,
284                 struct discover_device *dev, const char *filename,
285                 char *buf, int len)
286 {
287         struct parser_test *test = ctx->test_data;
288         struct test_file *f, *file = NULL;
289
290         list_for_each_entry(&test->files, f, list) {
291                 if (f->dev != dev)
292                         continue;
293                 if (strcmp(f->name, filename))
294                         continue;
295
296                 file = f;
297                 break;
298         }
299
300         if (!file) {
301                 file = talloc_zero(test, struct test_file);
302                 file->dev = dev;
303                 file->name = filename;
304                 list_add(&test->files, &file->list);
305         }
306
307         file->data = talloc_memdup(test, buf, len);
308         file->size = len;
309         return 0;
310 }
311
312 struct load_url_result *load_url_async(void *ctx, struct pb_url *url,
313                 load_url_complete async_cb, void *async_data,
314                 waiter_cb stdout_cb, void *stdout_data)
315 {
316         struct conf_context *conf = async_data;
317         struct parser_test *test = conf->dc->test_data;
318         struct load_url_result *result;
319         char tmp[] = "/tmp/pb-XXXXXX";
320         ssize_t rc = -1, sz = 0;
321         struct test_file *file;
322         int fd;
323
324         /* Ignore the stdout callback for tests */
325         (void)stdout_cb;
326         (void)stdout_data;
327
328         fd = mkstemp(tmp);
329
330         if (fd < 0)
331                 return NULL;
332
333         /* Some parsers will expect to need to read a file, so write the
334          * specified file to a temporary file */
335         list_for_each_entry(&test->files, file, list) {
336                 if (file->dev)
337                         continue;
338
339                 if (strcmp(file->name, url->full))
340                         continue;
341
342                 while (sz < file->size) {
343                         rc = write(fd, file->data, file->size);
344                         if (rc < 0) {
345                                 fprintf(stderr,
346                                         "Failed to write to tmpfile, %m\n");
347                                 break;
348                         }
349                         sz += rc;
350                 }
351                 break;
352         }
353
354         close(fd);
355
356         result = talloc_zero(ctx, struct load_url_result);
357         if (!result)
358                 return NULL;
359
360         result->local = talloc_strdup(result, tmp);
361         result->url = url;
362         if (rc < 0)
363                 result->status = LOAD_ERROR;
364         else
365                 result->status = result->local ? LOAD_OK : LOAD_ERROR;
366         result->cleanup_local = true;
367
368         async_cb(result, conf);
369
370         return result;
371 }
372
373 int parser_request_url(struct discover_context *ctx, struct pb_url *url,
374                 char **buf, int *len)
375 {
376         struct parser_test *test = ctx->test_data;
377         struct test_file *file;
378         char *tmp;
379
380         list_for_each_entry(&test->files, file, list) {
381                 if (file->dev)
382                         continue;
383
384                 if (strcmp(file->name, url->full))
385                         continue;
386
387                 /* the read_file() interface always adds a trailing null
388                  * for string-safety; do the same here */
389                 tmp = talloc_array(test, char, file->size + 1);
390                 memcpy(tmp, file->data, file->size);
391                 tmp[file->size] = '\0';
392                 *buf = tmp;
393                 *len = file->size;
394                 return 0;
395         }
396
397         return -1;
398 }
399
400 int test_run_parser(struct parser_test *test, const char *parser_name)
401 {
402         struct p_item* i;
403
404         list_for_each_entry(&parsers, i, list) {
405                 if (strcmp(i->parser->name, parser_name))
406                         continue;
407                 test->ctx->parser = i->parser;
408                 return i->parser->parse(test->ctx);
409         }
410
411         errx(EXIT_FAILURE, "%s: parser '%s' not found", __func__, parser_name);
412 }
413
414 bool resource_resolve(struct device_handler *handler, struct parser *parser,
415                 struct resource *resource)
416 {
417         if (!resource)
418                 return true;
419         if (resource->resolved)
420                 return true;
421
422         assert(parser);
423         assert(parser->resolve_resource);
424
425         return parser->resolve_resource(handler, resource);
426 }
427
428 void boot_option_resolve(struct device_handler *handler,
429                 struct discover_boot_option *opt)
430 {
431         resource_resolve(handler, opt->source, opt->boot_image);
432         resource_resolve(handler, opt->source, opt->initrd);
433         resource_resolve(handler, opt->source, opt->icon);
434 }
435
436 void test_hotplug_device(struct parser_test *test, struct discover_device *dev)
437 {
438         struct discover_boot_option *opt;
439
440         device_handler_add_device(test->handler, dev);
441
442         list_for_each_entry(&test->ctx->boot_options, opt, list)
443                 boot_option_resolve(test->handler, opt);
444 }
445
446 void test_remove_device(struct parser_test *test, struct discover_device *dev)
447 {
448         struct discover_boot_option *opt, *tmp;
449
450         if (dev == test->ctx->device) {
451                 list_for_each_entry_safe(&test->ctx->boot_options,
452                                 opt, tmp, list) {
453                         list_remove(&opt->list);
454                         talloc_free(opt);
455                 }
456         }
457
458         device_handler_remove(test->handler, dev);
459 }
460
461 struct discover_boot_option *get_boot_option(struct discover_context *ctx,
462                 int idx)
463 {
464         struct discover_boot_option *opt;
465         int i = 0;
466
467         list_for_each_entry(&ctx->boot_options, opt, list) {
468                 if (i++ == idx)
469                         return opt;
470         }
471
472         assert(0);
473
474         return NULL;
475 }
476
477 void __check_boot_option_count(struct discover_context *ctx, int count,
478                 const char *file, int line)
479 {
480         struct discover_boot_option *opt;
481         int defaults = 0, i = 0;
482
483         list_for_each_entry(&ctx->boot_options, opt, list) {
484                 i++;
485                 if (opt->option->is_default)
486                         defaults++;
487         }
488
489         if (defaults > 1) {
490                 fprintf(stderr, "%s:%d: parser returned multiple default "
491                                 "options\n", file, line);
492                 exit(EXIT_FAILURE);
493         }
494
495         if (i == count)
496                 return;
497
498         fprintf(stderr, "%s:%d: boot option count check failed\n", file, line);
499         fprintf(stderr, "expected %d options, got %d:\n", count, i);
500
501         i = 1;
502         list_for_each_entry(&ctx->boot_options, opt, list)
503                 fprintf(stderr, "  %2d: %s [%s]\n", i++, opt->option->name,
504                                 opt->option->id);
505
506         exit(EXIT_FAILURE);
507 }
508
509 void __check_args(struct discover_boot_option *opt, const char *args,
510                 const char *file, int line)
511 {
512         int rc;
513
514         if (!opt->option->boot_args && !args)
515                 return;
516
517         if (!opt->option->boot_args) {
518                 fprintf(stderr, "%s:%d: arg check failed\n", file, line);
519                 fprintf(stderr, "  no arguments parsed\n");
520                 fprintf(stderr, "  expected '%s'\n", args);
521                 exit(EXIT_FAILURE);
522         }
523
524         rc = strcmp(opt->option->boot_args, args);
525         if (rc) {
526                 fprintf(stderr, "%s:%d: arg check failed\n", file, line);
527                 fprintf(stderr, "  got      '%s'\n", opt->option->boot_args);
528                 fprintf(stderr, "  expected '%s'\n", args);
529                 exit(EXIT_FAILURE);
530         }
531 }
532
533 void __check_name(struct discover_boot_option *opt, const char *name,
534                 const char *file, int line)
535 {
536         int rc;
537
538         rc = strcmp(opt->option->name, name);
539         if (rc) {
540                 fprintf(stderr, "%s:%d: name check failed\n", file, line);
541                 fprintf(stderr, "  got      '%s'\n", opt->option->name);
542                 fprintf(stderr, "  expected '%s'\n", name);
543                 exit(EXIT_FAILURE);
544         }
545 }
546
547 void __check_is_default(struct discover_boot_option *opt,
548                 const char *file, int line)
549 {
550         if (opt->option->is_default)
551                 return;
552
553         fprintf(stderr, "%s:%d: default check failed\n", file, line);
554         exit(EXIT_FAILURE);
555 }
556
557 void __check_resolved_local_resource(struct resource *res,
558                 struct discover_device *dev, const char *local_path,
559                 const char *file, int line)
560 {
561         const char *exp_url, *got_url;
562
563         if (!res)
564                 errx(EXIT_FAILURE, "%s:%d: No resource", file, line);
565
566         if (!res->resolved)
567                 errx(EXIT_FAILURE, "%s:%d: Resource is not resolved",
568                                 file, line);
569
570         exp_url = talloc_asprintf(res, "file://%s%s",
571                         dev->mount_path, local_path);
572         got_url = pb_url_to_string(res->url);
573
574         if (strcmp(got_url, exp_url)) {
575                 fprintf(stderr, "%s:%d: Resource mismatch\n", file, line);
576                 fprintf(stderr, "  got      '%s'\n", got_url);
577                 fprintf(stderr, "  expected '%s'\n", exp_url);
578                 exit(EXIT_FAILURE);
579         }
580 }
581
582 void __check_resolved_url_resource(struct resource *res,
583                 const char *url, const char *file, int line)
584 {
585         char *res_url;
586
587         if (!res)
588                 errx(EXIT_FAILURE, "%s:%d: No resource", file, line);
589
590         if (!res->resolved)
591                 errx(EXIT_FAILURE, "%s:%d: Resource is not resolved",
592                                 file, line);
593
594         res_url = pb_url_to_string(res->url);
595         if (strcmp(url, res_url)) {
596                 fprintf(stderr, "%s:%d: Resource mismatch\n", file, line);
597                 fprintf(stderr, "  got      '%s'\n", res_url);
598                 fprintf(stderr, "  expected '%s'\n", url);
599                 exit(EXIT_FAILURE);
600         }
601 }
602 void __check_unresolved_resource(struct resource *res,
603                 const char *file, int line)
604 {
605         if (!res)
606                 errx(EXIT_FAILURE, "%s:%d: No resource", file, line);
607
608         if (res->resolved)
609                 errx(EXIT_FAILURE, "%s:%d: Resource is resolved", file, line);
610 }
611
612 void __check_not_present_resource(struct resource *res,
613                 const char *file, int line)
614 {
615         if (res)
616                 errx(EXIT_FAILURE, "%s:%d: Resource present", file, line);
617 }
618
619 static void dump_file_data(const void *buf, int len)
620 {
621         int i, j, hex_len = strlen("00 ");
622         const int row_len = 16;
623
624         for (i = 0; i < len; i += row_len) {
625                 char hbuf[row_len * hex_len + 1];
626                 char cbuf[row_len + strlen("|") + 1];
627
628                 for (j = 0; (j < row_len) && ((i+j) < len); j++) {
629                         char c = ((const char *)buf)[i + j];
630
631                         snprintf(hbuf + j * hex_len, hex_len + 1, "%02x ", c);
632
633                         if (!isprint(c))
634                                 c = '.';
635
636                         snprintf(cbuf + j, hex_len + 1, "%c", c);
637                 }
638
639                 strcat(cbuf, "|");
640
641                 fprintf(stderr, "%08x  %*s |%s\n", i,
642                                 0 - (int)sizeof(hbuf) + 1, hbuf, cbuf);
643         }
644 }
645
646 void __check_file_contents(struct parser_test *test,
647                 struct discover_device *dev, const char *filename,
648                 const char *buf, int len,
649                 const char *srcfile, int srcline)
650 {
651         struct test_file *f, *file = NULL;
652
653         list_for_each_entry(&test->files, f, list) {
654                 if (f->dev != dev)
655                         continue;
656                 if (strcmp(f->name, filename))
657                         continue;
658
659                 file = f;
660                 break;
661         }
662
663         if (!file)
664                 errx(EXIT_FAILURE, "%s:%d: File '%s' not found",
665                                 srcfile, srcline, filename);
666
667         if (file->size != len || memcmp(file->data, buf, len)) {
668                 fprintf(stderr, "%s:%d: File '%s' data/size mismatch\n",
669                                 srcfile, srcline, filename);
670                 fprintf(stderr, "Expected:\n");
671                 dump_file_data(buf, len);
672                 fprintf(stderr, "Got:\n");
673                 dump_file_data(file->data, file->size);
674                 exit(EXIT_FAILURE);
675         }
676 }