c0339b89a4f2ca809f6ca27e9ffe9986cf99022a
[petitboot] / test / parser / parser-test.h
1 #ifndef PARSER_TEST_H
2 #define PARSER_TEST_H
3
4 #include <stdlib.h>
5
6 #include "device-handler.h"
7 #include "resource.h"
8
9 struct parser_test {
10         struct device_handler *handler;
11         struct discover_context *ctx;
12         struct list files;
13 };
14
15 /* interface required for parsers */
16 void __register_parser(struct parser *parser);
17
18 /* test functions */
19 struct discover_device *test_create_device(struct parser_test *test,
20                 const char *name);
21
22 #define test_read_conf_data(t, f, d) \
23         __test_read_conf_data(t, t->ctx->device, f, d, sizeof(d))
24
25 void __test_read_conf_data(struct parser_test *test,
26                 struct discover_device *dev, const char *conf_file,
27                 const char *buf, size_t len);
28 void test_read_conf_file(struct parser_test *test, const char *filename,
29                 const char *conf_file);
30
31 int test_run_parser(struct parser_test *test, const char *parser_name);
32
33 void test_hotplug_device(struct parser_test *test, struct discover_device *dev);
34 void test_remove_device(struct parser_test *test, struct discover_device *dev);
35
36 void test_add_file_data(struct parser_test *test, struct discover_device *dev,
37                 const char *filename, const void *data, int size);
38 void test_add_dir(struct parser_test *test, struct discover_device *dev,
39                 const char *dirname);
40 void test_set_event_source(struct parser_test *test);
41 void test_set_event_param(struct event *event, const char *name,
42                 const char *value);
43
44 #define test_add_file_string(test, dev, filename, str) \
45         test_add_file_data(test, dev, filename, str, sizeof(str) - 1)
46
47 struct discover_boot_option *get_boot_option(struct discover_context *ctx,
48                 int idx);
49
50 /* embedded config */
51 extern const char __embedded_config[];
52 extern const size_t __embedded_config_size;
53 #define test_read_conf_embedded(t, f) \
54         __test_read_conf_data(t, t->ctx->device, f, \
55                                 __embedded_config, __embedded_config_size)
56
57 #define test_read_conf_embedded_url(t, u) \
58         __test_read_conf_data(t, NULL, u, \
59                                 __embedded_config, __embedded_config_size)
60
61 /**
62  * Checks for parser results.
63  *
64  * These return void, but will respond to check failures by printing a reason
65  * for the failure, and exit the test with a non-zero exit status.
66  */
67
68 /**
69  * Check that we have an expected number of boot options parsed. If not,
70  * print out what we did find, then exit.
71  */
72 #define check_boot_option_count(ctx, count) \
73         __check_boot_option_count(ctx, count, __FILE__, __LINE__)
74 void __check_boot_option_count(struct discover_context *ctx, int count,
75                 const char *file, int line);
76 /*
77  * Check that a boot option @opt has args @args
78  */
79 void __check_args(struct discover_boot_option *opt, const char *args,
80                 const char *file, int line);
81 #define check_args(opt, args) \
82         __check_args(opt, args, __FILE__, __LINE__)
83
84 /**
85  * Check that a boot option @opt has name @name
86  */
87 void __check_name(struct discover_boot_option *opt, const char *name,
88                 const char *file, int line);
89 #define check_name(opt, name) \
90         __check_name(opt, name, __FILE__, __LINE__)
91
92 /**
93  * Check that a boot option @opt is marked as default
94  */
95 void __check_is_default(struct discover_boot_option *opt,
96                 const char *file, int line);
97 #define check_is_default(opt) \
98         __check_is_default(opt, __FILE__, __LINE__)
99
100 /**
101  * Check that a resource (@res) is present, resolved, and has a local path
102  * (within @dev's mount point) of @path.
103  */
104 #define check_resolved_local_resource(res, dev, path) \
105         __check_resolved_local_resource(res, dev, path, __FILE__, __LINE__)
106
107 void __check_resolved_local_resource(struct resource *res,
108                 struct discover_device *dev, const char *local_path,
109                 const char *file, int line);
110
111 /**
112  * Check that a resource (@res) is present, resolved, and has a URL of
113  * @url.
114  */
115 #define check_resolved_url_resource(res, url) \
116         __check_resolved_url_resource(res, url, __FILE__, __LINE__)
117 void __check_resolved_url_resource(struct resource *res,
118                 const char *url, const char *file, int line);
119 /**
120  * Check that a resource (@res) is present but not resolved
121  */
122 void __check_unresolved_resource(struct resource *res,
123                 const char *file, int line);
124 #define check_unresolved_resource(res) \
125         __check_unresolved_resource(res, __FILE__, __LINE__)
126
127 /**
128  * Check that a resource (@res) is not present
129  */
130 void __check_not_present_resource(struct resource *res,
131                 const char *file, int line);
132 #define check_not_present_resource(res) \
133         __check_not_present_resource(res, __FILE__, __LINE__)
134
135 /**
136  * Check the contents of a file - file @filename must be present on @dev,
137  * and match the @len bytes of @buf.
138  */
139 void __check_file_contents(struct parser_test *test,
140                 struct discover_device *dev, const char *filename,
141                 const char *buf, int len,
142                 const char *srcfile, int srcline);
143 #define check_file_contents(test, dev, filename, buf, len) \
144         __check_file_contents(test, dev, filename, buf, len, __FILE__, __LINE__)
145
146 #endif /* PARSER_TEST_H */