2 * ccanlint: assorted checks and advice for a ccan package
3 * Copyright (C) 2008 Rusty Russell, Idris Soule
4 * Copyright (C) 2010 Rusty Russell, Idris Soule
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; either version 2 of the License, or (at your option)
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along with
17 * this program; if not, write to the Free Software Foundation, Inc., 51
18 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "../read_config_header.h"
29 #include <ccan/str/str.h>
30 #include <ccan/take/take.h>
31 #include <ccan/opt/opt.h>
32 #include <ccan/foreach/foreach.h>
33 #include <ccan/cast/cast.h>
34 #include <ccan/tlist/tlist.h>
35 #include <ccan/tal/path/path.h>
36 #include <ccan/strmap/strmap.h>
39 STRMAP_MEMBERS(struct ccanlint *);
43 static struct ccanlint_map tests;
44 bool safe_mode = false;
45 bool keep_results = false;
46 static bool targeting = false;
47 static unsigned int timeout;
49 /* These are overridden at runtime if we can find config.h */
50 const char *compiler = NULL;
51 const char *cflags = NULL;
53 const char *config_header;
58 static void indent_print(const char *string)
61 unsigned int line = strcspn(string, "\n");
62 printf("\t%.*s", line, string);
63 if (string[line] == '\n') {
72 bool ask(const char *question)
76 printf("%s ", question);
79 return fgets(reply, sizeof(reply), stdin) != NULL
80 && toupper(reply[0]) == 'Y';
83 /* Skip, but don't remove. */
84 static bool skip_test(struct dgraph_node *node, const char *why)
86 struct ccanlint *c = container_of(node, struct ccanlint, node);
91 static const char *dep_failed(struct manifest *m)
93 return "dependency couldn't run";
96 static bool cannot_run(struct dgraph_node *node, void *unused)
98 struct ccanlint *c = container_of(node, struct ccanlint, node);
99 c->can_run = dep_failed;
105 unsigned int score, total;
111 static bool run_test(struct dgraph_node *n, struct run_info *run)
113 struct ccanlint *i = container_of(n, struct ccanlint, node);
114 unsigned int timeleft;
120 score = tal(run->m, struct score);
121 list_head_init(&score->per_file_errors);
127 /* We can see skipped things in two cases:
128 * (1) _info excluded them (presumably because they fail).
129 * (2) A prerequisite failed.
133 printf("%s%s: skipped (%s)\n",
134 run->prefix, i->name, i->skip);
135 /* Pass us up to the test which failed, not us. */
141 i->skip = i->can_run(run->m);
143 /* Test doesn't apply, or can't run? That's OK. */
145 printf("%s%s: skipped (%s)\n",
146 run->prefix, i->name, i->skip);
147 /* Mark our dependencies to skip. */
148 dgraph_traverse_from(&i->node, cannot_run, NULL);
155 timeleft = timeout ? timeout : default_timeout_ms;
156 i->check(run->m, &timeleft, score);
157 if (timeout && timeleft == 0) {
160 printf("%s%s: skipped (%s)\n",
161 run->prefix, i->name, i->skip);
162 /* Mark our dependencies to skip. */
163 dgraph_traverse_from(&i->node, skip_test,
164 "dependency timed out");
170 assert(score->score <= score->total);
171 if ((!score->pass && !run->quiet)
172 || (score->score < score->total && verbose)
174 printf("%s%s (%s): %s",
175 run->prefix, i->name, i->key,
176 score->pass ? "PASS" : "FAIL");
177 if (score->total > 1)
178 printf(" (+%u/%u)", score->score, score->total);
182 if ((!run->quiet && !score->pass) || verbose) {
184 printf("%s%s", score->error,
185 strends(score->error, "\n") ? "" : "\n");
188 if (!run->quiet && score->score < score->total && i->handle)
189 i->handle(run->m, score);
192 /* Skip any tests which depend on this one. */
193 dgraph_traverse_from(&i->node, skip_test, "dependency failed");
197 run->score += score->score;
198 run->total += score->total;
200 /* FIXME: Free score. */
201 run->pass &= score->pass;
204 if (!score->pass && i->compulsory) {
205 warnx("%s%s failed", run->prefix, i->name);
212 static void register_test(struct ccanlint *test)
214 if (!strmap_add(&tests, test->key, test))
215 err(1, "Adding test %s", test->key);
216 test->options = tal_arr(NULL, char *, 1);
217 test->options[0] = NULL;
218 dgraph_init_node(&test->node);
221 static bool get_test(const char *member, struct ccanlint *i,
222 struct ccanlint **ret)
224 if (tlist_empty(&i->node.edge[DGRAPH_TO])) {
232 * get_next_test - retrieves the next test to be processed
234 static inline struct ccanlint *get_next_test(void)
236 struct ccanlint *i = NULL;
238 strmap_iterate(&tests, get_test, &i);
242 if (strmap_empty(&tests))
245 errx(1, "Can't make process; test dependency cycle");
248 static struct ccanlint *find_test(const char *key)
250 return strmap_get(&tests, key);
253 bool is_excluded(const char *name)
255 return find_test(name)->skip != NULL;
258 static bool init_deps(const char *member, struct ccanlint *c, void *unused)
260 char **deps = tal_strsplit(NULL, c->needs, " ", STR_EMPTY_OK);
263 for (i = 0; deps[i]; i++) {
264 struct ccanlint *dep;
266 dep = find_test(deps[i]);
268 errx(1, "BUG: unknown dep '%s' for %s",
270 dgraph_add_edge(&dep->node, &c->node);
276 static bool check_names(const char *member, struct ccanlint *c,
277 struct ccanlint_map *names)
279 if (!strmap_add(names, c->name, c))
280 err(1, "Duplicate name %s", c->name);
284 static void init_tests(void)
286 struct ccanlint_map names;
287 struct ccanlint **table;
292 table = autodata_get(ccanlint_tests, &num);
293 for (i = 0; i < num; i++)
294 register_test(table[i]);
295 autodata_free(table);
297 strmap_iterate(&tests, init_deps, NULL);
299 /* Check for duplicate names. */
301 strmap_iterate(&tests, check_names, &names);
302 strmap_clear(&names);
305 static bool reset_test(struct dgraph_node *node, void *unused)
307 struct ccanlint *c = container_of(node, struct ccanlint, node);
313 static void reset_tests(struct dgraph_node *all)
315 dgraph_traverse_to(all, reset_test, NULL);
318 static bool print_deps(const char *member, struct ccanlint *c, void *unused)
320 if (!tlist_empty(&c->node.edge[DGRAPH_FROM])) {
321 struct dgraph_edge *e;
323 printf("These depend on %s:\n", c->key);
324 dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) {
325 struct ccanlint *to = container_of(e->n[DGRAPH_TO],
328 printf("\t%s\n", to->key);
334 static void print_test_depends(void)
338 strmap_iterate(&tests, print_deps, NULL);
342 static void show_tmpdir(const char *dir)
344 printf("You can find ccanlint working files in '%s'\n", dir);
347 static char *keep_tests(void *unused)
351 /* Don't automatically destroy temporary dir. */
353 tal_add_destructor(temp_dir(), show_tmpdir);
357 static bool remove_test(struct dgraph_node *node, const char *why)
359 struct ccanlint *c = container_of(node, struct ccanlint, node);
361 dgraph_clear_node(node);
365 static char *exclude_test(const char *testname, void *unused)
367 struct ccanlint *i = find_test(testname);
369 return tal_fmt(NULL, "No test %s to --exclude", testname);
371 /* Remove this, and everything which depends on it. */
372 dgraph_traverse_from(&i->node, remove_test, "excluded on command line");
373 remove_test(&i->node, "excluded on command line");
377 static void skip_test_and_deps(struct ccanlint *c, const char *why)
379 /* Skip this, and everything which depends on us. */
380 dgraph_traverse_from(&c->node, skip_test, why);
381 skip_test(&c->node, why);
384 static char *list_tests(void *arg)
389 /* This makes them print in topological order. */
390 while ((i = get_next_test()) != NULL) {
391 printf(" %-25s %s\n", i->key, i->name);
392 dgraph_clear_node(&i->node);
393 strmap_del(&tests, i->key, NULL);
398 static bool draw_test(const char *member, struct ccanlint *c, const char *style)
401 * todo: escape labels in case ccanlint test keys have
402 * characters interpreted as GraphViz syntax.
404 printf("\t\"%p\" [label=\"%s\"%s]\n", c, c->key, style);
408 static void test_dgraph_vertices(const char *style)
410 strmap_iterate(&tests, draw_test, style);
413 static bool draw_edges(const char *member, struct ccanlint *c, void *unused)
415 struct dgraph_edge *e;
417 dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) {
418 struct ccanlint *to = container_of(e->n[DGRAPH_TO],
421 printf("\t\"%p\" -> \"%p\"\n", c->name, to->name);
426 static void test_dgraph_edges(void)
428 strmap_iterate(&tests, draw_edges, NULL);
431 static char *test_dependency_graph(void *arg)
435 test_dgraph_vertices("");
443 static void add_options(struct ccanlint *test, char **options,
444 unsigned int num_options)
451 /* -1, because last one is NULL. */
452 num = tal_count(test->options) - 1;
454 tal_resize(&test->options, num + num_options + 1);
455 memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *));
458 void add_info_options(struct ccan_file *info)
460 struct doc_section *d;
462 struct ccanlint *test;
464 list_for_each(get_ccan_file_docs(info), d, list) {
465 if (!streq(d->type, "ccanlint"))
468 for (i = 0; i < d->num_lines; i++) {
469 char **words = tal_strsplit(d, d->lines[i], " \t",
474 if (strncmp(words[0], "//", 2) == 0)
477 test = find_test(words[0]);
479 warnx("%s: unknown ccanlint test '%s'",
480 info->fullname, words[0]);
485 warnx("%s: no argument to test '%s'",
486 info->fullname, words[0]);
491 if (strcasecmp(words[1], "FAIL") == 0) {
493 skip_test_and_deps(test,
497 if (!test->takes_options)
498 warnx("%s: %s doesn't take options",
499 info->fullname, words[0]);
500 add_options(test, words+1, tal_count(words)-1);
506 /* If options are of form "filename:<option>" they only apply to that file */
507 char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
510 unsigned int i, j = 0;
513 if (!test->options[0])
514 return test->options;
516 ret = tal_arr(f, char *, tal_count(test->options));
517 for (i = 0; test->options[i]; i++) {
520 if (!test->options[i] || !strchr(test->options[i], ':')) {
521 optname = test->options[i];
522 } else if (strstarts(test->options[i], f->name)
523 && test->options[i][strlen(f->name)] == ':') {
524 optname = test->options[i] + strlen(f->name) + 1;
528 /* FAIL overrides anything else. */
529 if (streq(optname, "FAIL")) {
530 ret = tal_arr(f, char *, 2);
531 ret[0] = (char *)"FAIL";
539 /* Shrink it to size so tal_array_length() works as expected. */
540 tal_resize(&ret, j + 1);
544 static char *opt_set_const_charp(const char *arg, const char **p)
546 return opt_set_charp(arg, cast_const2(char **, p));
549 static char *opt_set_target(const char *arg, struct dgraph_node *all)
551 struct ccanlint *t = find_test(arg);
553 return tal_fmt(NULL, "unknown --target %s", arg);
556 dgraph_add_edge(&t->node, all);
560 static bool run_tests(struct dgraph_node *all,
570 run.score = run.total = 0;
573 dgraph_traverse_to(all, run_test, &run);
575 printf("%sTotal score: %u/%u\n", prefix, run.score, run.total);
579 static bool add_to_all(const char *member, struct ccanlint *c,
580 struct dgraph_node *all)
582 /* If we're excluded on cmdline, don't add. */
584 dgraph_add_edge(&c->node, all);
588 static bool test_module(struct dgraph_node *all,
589 const char *dir, const char *prefix, bool summary)
591 struct manifest *m = get_manifest(autofree(), dir);
592 char *testlink = path_join(NULL, temp_dir(), "test");
594 /* Create a symlink from temp dir back to src dir's
597 if (symlink(path_join(m, dir, "test"), testlink) != 0)
598 err(1, "Creating test symlink in %s", temp_dir());
600 return run_tests(all, summary, m, prefix);
603 int main(int argc, char *argv[])
605 bool summary = false, pass = true;
607 const char *prefix = "";
608 char *cwd = path_cwd(NULL), *dir;
609 struct dgraph_node all;
611 /* Empty graph node to which we attach everything else. */
612 dgraph_init_node(&all);
614 opt_register_early_noarg("--verbose|-v", opt_inc_intval, &verbose,
615 "verbose mode (up to -vvvv)");
616 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
617 "do not compile anything");
618 opt_register_noarg("-l|--list-tests", list_tests, NULL,
619 "list tests ccanlint performs (and exit)");
620 opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
621 "print dependency graph of tests in Graphviz .dot format");
622 opt_register_noarg("-k|--keep", keep_tests, NULL,
623 "do not delete ccanlint working files");
624 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
625 "simply give one line summary");
626 opt_register_arg("-x|--exclude <testname>", exclude_test, NULL, NULL,
627 "exclude <testname> (can be used multiple times)");
628 opt_register_arg("--timeout <milleseconds>", opt_set_uintval,
630 "ignore (terminate) tests that are slower than this");
631 opt_register_arg("-t|--target <testname>", opt_set_target, NULL, &all,
632 "only run one test (and its prerequisites)");
633 opt_register_arg("--compiler <compiler>", opt_set_const_charp,
634 NULL, &compiler, "set the compiler");
635 opt_register_arg("--cflags <flags>", opt_set_const_charp,
636 NULL, &cflags, "set the compiler flags");
637 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
638 "\nA program for checking and guiding development"
640 "This usage message");
642 /* Do verbose before anything else... */
643 opt_early_parse(argc, argv, opt_log_stderr_exit);
645 /* We move into temporary directory, so gcov dumps its files there. */
646 if (chdir(temp_dir()) != 0)
647 err(1, "Error changing to %s temporary dir", temp_dir());
652 compile_verbose = true;
653 print_test_depends();
656 tools_verbose = true;
658 opt_parse(&argc, argv, opt_log_stderr_exit);
661 strmap_iterate(&tests, add_to_all, &all);
666 dir = path_join(NULL, cwd, argv[1]);
668 ccan_dir = find_ccan_dir(dir);
670 errx(1, "Cannot find ccan/ base directory in %s", dir);
671 config_header = read_config_header(ccan_dir, &compiler, &cflags,
675 pass = test_module(&all, cwd, "", summary);
677 for (i = 1; i < argc; i++) {
678 dir = path_canon(NULL,
679 take(path_join(NULL, cwd, argv[i])));
681 prefix = path_join(NULL, ccan_dir, "ccan");
682 prefix = path_rel(NULL, take(prefix), dir);
683 prefix = tal_strcat(NULL, take(prefix), ": ");
685 pass &= test_module(&all, dir, prefix, summary);