2 * ccanlint: assorted checks and advice for a ccan package
3 * Copyright (C) 2008 Rusty Russell, Idris Soule
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <ccan/btree/btree.h>
30 #include <ccan/str/str.h>
31 #include <ccan/str_talloc/str_talloc.h>
32 #include <ccan/talloc/talloc.h>
34 static unsigned int verbose = 0;
35 static LIST_HEAD(compulsory_tests);
36 static LIST_HEAD(normal_tests);
37 static LIST_HEAD(finished_tests);
38 bool safe_mode = false;
39 static struct btree *exclude;
40 static bool fastmode = false;
42 static void usage(const char *name)
44 fprintf(stderr, "Usage: %s [-s] [-n] [-v] [-t] [-d <dirname>]\n"
46 " -s: simply give one line summary\n"
47 " -d: use this directory instead of the current one\n"
48 " -n: do not compile anything\n"
49 " -l: list tests ccanlint performs\n"
50 " -x: exclude tests (e.g. -x trailing_whitespace,valgrind)\n"
51 " -t: ignore (terminate) tests that are slow\n",
57 static void indent_print(const char *string)
60 unsigned int line = strcspn(string, "\n");
61 printf("\t%.*s", line, string);
62 if (string[line] == '\n') {
71 bool ask(const char *question)
75 printf("%s ", question);
78 return fgets(reply, sizeof(reply), stdin) != NULL
79 && toupper(reply[0]) == 'Y';
82 static const char *should_skip(struct manifest *m, struct ccanlint *i)
84 if (btree_lookup(exclude, i->key))
85 return "excluded on command line";
88 return "dependency failed";
91 return "dependency was skipped";
98 static bool run_test(struct ccanlint *i,
101 unsigned int *total_score,
105 unsigned int this_score, timeleft;
106 const struct dependent *d;
109 //one less test to run through
110 list_for_each(&i->dependencies, d, node)
111 d->dependent->num_depends--;
113 skip = should_skip(m, i);
118 printf(" %s: skipped (%s)\n", i->name, skip);
120 /* If we're skipping this because a prereq failed, we fail. */
122 *total_score += i->total_score;
125 list_add_tail(&finished_tests, &i->list);
126 list_for_each(&i->dependencies, d, node) {
127 d->dependent->skip = true;
128 d->dependent->skip_fail = i->skip_fail;
133 timeleft = fastmode ? 1000 : default_timeout_ms;
134 result = i->check(m, &timeleft);
135 if (fastmode && timeleft == 0) {
141 printf(" %s: OK", i->name);
144 i->total_score, i->total_score);
147 if (i->total_score) {
148 *score += i->total_score;
149 *total_score += i->total_score;
153 list_add_tail(&finished_tests, &i->list);
158 this_score = i->score(m, result);
163 list_add_tail(&finished_tests, &i->list);
165 *total_score += i->total_score;
166 *score += this_score;
168 printf(" %s: FAIL (+%u/%u)\n",
169 i->name, this_score, i->total_score);
172 printf("%s\n", i->describe(m, result));
175 i->handle(m, result);
178 /* Skip any tests which depend on this one. */
179 list_for_each(&i->dependencies, d, node) {
180 d->dependent->skip = true;
181 d->dependent->skip_fail = true;
187 static void register_test(struct list_head *h, struct ccanlint *test, ...)
190 struct ccanlint *depends;
191 struct dependent *dchild;
193 list_add(h, &test->list);
196 /* Careful: we might have been initialized by a dependent. */
197 if (test->dependencies.n.next == NULL)
198 list_head_init(&test->dependencies);
200 //dependent(s) args (if any), last one is NULL
201 while ((depends = va_arg(ap, struct ccanlint *)) != NULL) {
202 dchild = malloc(sizeof(*dchild));
203 dchild->dependent = test;
204 /* The thing we depend on might not be initialized yet! */
205 if (depends->dependencies.n.next == NULL)
206 list_head_init(&depends->dependencies);
207 list_add_tail(&depends->dependencies, &dchild->node);
214 * get_next_test - retrieves the next test to be processed
216 static inline struct ccanlint *get_next_test(struct list_head *test)
220 if (list_empty(test))
223 list_for_each(test, i, list) {
224 if (i->num_depends == 0)
227 errx(1, "Can't make process; test dependency cycle");
230 static void init_tests(void)
232 const struct ccanlint *i;
233 struct btree *keys, *names;
236 #define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__)
237 #include "generated-normal-tests"
239 #define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__)
240 #include "generated-compulsory-tests"
242 /* Self-consistency check: make sure no two tests
243 have the same key or name. */
244 keys = btree_new(btree_strcmp);
245 names = btree_new(btree_strcmp);
246 list_for_each(&compulsory_tests, i, list) {
247 if (!btree_insert(keys, i->key))
248 errx(1, "BUG: Duplicate test key '%s'", i->key);
249 if (!btree_insert(keys, i->name))
250 errx(1, "BUG: Duplicate test name '%s'", i->name);
252 list_for_each(&normal_tests, i, list) {
253 if (!btree_insert(keys, i->key))
254 errx(1, "BUG: Duplicate test key '%s'", i->key);
255 if (!btree_insert(keys, i->name))
256 errx(1, "BUG: Duplicate test name '%s'", i->name);
264 printf("\nCompulsory Tests\n");
265 list_for_each(&compulsory_tests, i, list) {
266 printf("%s depends on %u others\n", i->name, i->num_depends);
267 if (!list_empty(&i->dependencies)) {
268 const struct dependent *d;
269 printf("These depend on us:\n");
270 list_for_each(&i->dependencies, d, node)
271 printf("\t%s\n", d->dependent->name);
275 printf("\nNormal Tests\n");
276 list_for_each(&normal_tests, i, list) {
277 printf("%s depends on %u others\n", i->name, i->num_depends);
278 if (!list_empty(&i->dependencies)) {
279 const struct dependent *d;
280 printf("These depend on us:\n");
281 list_for_each(&i->dependencies, d, node)
282 printf("\t%s\n", d->dependent->name);
287 static void print_tests(struct list_head *tests, const char *type)
291 printf("%s tests:\n", type);
292 /* This makes them print in topological order. */
293 while ((i = get_next_test(tests)) != NULL) {
294 const struct dependent *d;
295 printf(" %-25s %s\n", i->key, i->name);
297 list_for_each(&i->dependencies, d, node)
298 d->dependent->num_depends--;
302 static void list_tests(void)
305 print_tests(&compulsory_tests, "Compulsory");
306 print_tests(&normal_tests, "Normal");
310 int main(int argc, char *argv[])
313 bool summary = false;
314 unsigned int score = 0, total_score = 0;
317 const char *prefix = "", *dir = ".";
319 exclude = btree_new(btree_strcmp);
321 /* I'd love to use long options, but that's not standard. */
322 /* FIXME: getopt_long ccan package? */
323 while ((c = getopt(argc, argv, "sd:vnlx:t")) != -1) {
327 prefix = talloc_append_string(talloc_basename(NULL,
343 char **exclude_strs = strsplit(NULL, optarg, ",", NULL);
345 for (i = 0; exclude_strs[i]; i++)
346 btree_insert(exclude, exclude_strs[i]);
359 m = get_manifest(talloc_autofree_context(), dir);
363 /* If you don't pass the compulsory tests, you don't even get a score */
365 printf("Compulsory tests:\n");
367 while ((i = get_next_test(&compulsory_tests)) != NULL) {
368 if (!run_test(i, summary, &score, &total_score, m)) {
369 errx(1, "%s%s failed", prefix, i->name);
374 printf("\nNormal tests:\n");
375 while ((i = get_next_test(&normal_tests)) != NULL)
376 run_test(i, summary, &score, &total_score, m);
378 printf("%sTotal score: %u/%u\n", prefix, score, total_score);