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 const char *config_header;
54 static void indent_print(const char *string)
57 unsigned int line = strcspn(string, "\n");
58 printf("\t%.*s", line, string);
59 if (string[line] == '\n') {
68 bool ask(const char *question)
72 printf("%s ", question);
75 return fgets(reply, sizeof(reply), stdin) != NULL
76 && toupper(reply[0]) == 'Y';
79 /* Skip, but don't remove. */
80 static bool skip_test(struct dgraph_node *node, const char *why)
82 struct ccanlint *c = container_of(node, struct ccanlint, node);
87 static const char *dep_failed(struct manifest *m)
89 return "dependency couldn't run";
92 static bool cannot_run(struct dgraph_node *node, void *all)
94 struct ccanlint *c = container_of(node, struct ccanlint, node);
95 c->can_run = dep_failed;
102 unsigned int score, total;
108 static bool run_test(struct dgraph_node *n, struct run_info *run)
110 struct ccanlint *i = container_of(n, struct ccanlint, node);
111 unsigned int timeleft;
117 score = tal(run->m, struct score);
118 list_head_init(&score->per_file_errors);
124 /* We can see skipped things in two cases:
125 * (1) _info excluded them (presumably because they fail).
126 * (2) A prerequisite failed.
130 printf("%s%s: skipped (%s)\n",
131 run->prefix, i->name, i->skip);
132 /* Pass us up to the test which failed, not us. */
138 i->skip = i->can_run(run->m);
140 /* Test doesn't apply, or can't run? That's OK. */
142 printf("%s%s: skipped (%s)\n",
143 run->prefix, i->name, i->skip);
144 /* Mark our dependencies to skip. */
145 dgraph_traverse_from(&i->node, cannot_run, NULL);
152 timeleft = timeout ? timeout : default_timeout_ms;
153 i->check(run->m, &timeleft, score);
154 if (timeout && timeleft == 0) {
157 printf("%s%s: skipped (%s)\n",
158 run->prefix, i->name, i->skip);
159 /* Mark our dependencies to skip. */
160 dgraph_traverse_from(&i->node, skip_test,
161 "dependency timed out");
167 assert(score->score <= score->total);
168 if ((!score->pass && !run->quiet)
169 || (score->score < score->total && verbose)
171 printf("%s%s (%s): %s",
172 run->prefix, i->name, i->key,
173 score->pass ? "PASS" : "FAIL");
174 if (score->total > 1)
175 printf(" (+%u/%u)", score->score, score->total);
179 if ((!run->quiet && !score->pass) || verbose) {
181 printf("%s%s", score->error,
182 strends(score->error, "\n") ? "" : "\n");
185 if (!run->quiet && score->score < score->total && i->handle)
186 i->handle(run->m, score);
189 /* Skip any tests which depend on this one. */
190 dgraph_traverse_from(&i->node, skip_test, "dependency failed");
194 run->score += score->score;
195 run->total += score->total;
197 /* FIXME: Free score. */
198 run->pass &= score->pass;
201 if (!score->pass && i->compulsory) {
202 warnx("%s%s failed", run->prefix, i->name);
209 static void register_test(struct ccanlint *test)
211 if (!strmap_add(&tests, test->key, test))
212 err(1, "Adding test %s", test->key);
213 test->options = tal_arr(NULL, char *, 1);
214 test->options[0] = NULL;
215 dgraph_init_node(&test->node);
218 static bool get_test(const char *member, struct ccanlint *i,
219 struct ccanlint **ret)
221 if (tlist_empty(&i->node.edge[DGRAPH_TO])) {
229 * get_next_test - retrieves the next test to be processed
231 static inline struct ccanlint *get_next_test(void)
233 struct ccanlint *i = NULL;
235 strmap_iterate(&tests, get_test, &i);
239 if (strmap_empty(&tests))
242 errx(1, "Can't make process; test dependency cycle");
245 static struct ccanlint *find_test(const char *key)
247 return strmap_get(&tests, key);
250 bool is_excluded(const char *name)
252 return find_test(name)->skip != NULL;
255 static bool init_deps(const char *member, struct ccanlint *c, void *unused)
257 char **deps = tal_strsplit(NULL, c->needs, " ", STR_EMPTY_OK);
260 for (i = 0; deps[i]; i++) {
261 struct ccanlint *dep;
263 dep = find_test(deps[i]);
265 errx(1, "BUG: unknown dep '%s' for %s",
267 dgraph_add_edge(&dep->node, &c->node);
273 static bool check_names(const char *member, struct ccanlint *c,
274 struct ccanlint_map *names)
276 if (!strmap_add(names, c->name, c))
277 err(1, "Duplicate name %s", c->name);
281 static void init_tests(void)
283 struct ccanlint_map names;
284 struct ccanlint **table;
289 table = autodata_get(ccanlint_tests, &num);
290 for (i = 0; i < num; i++)
291 register_test(table[i]);
292 autodata_free(table);
294 strmap_iterate(&tests, init_deps, NULL);
296 /* Check for duplicate names. */
298 strmap_iterate(&tests, check_names, &names);
299 strmap_clear(&names);
302 static bool reset_test(struct dgraph_node *node, void *unused)
304 struct ccanlint *c = container_of(node, struct ccanlint, node);
310 static void reset_tests(struct dgraph_node *all)
312 dgraph_traverse_to(all, reset_test, NULL);
315 static bool print_deps(const char *member, struct ccanlint *c, void *unused)
317 if (!tlist_empty(&c->node.edge[DGRAPH_FROM])) {
318 struct dgraph_edge *e;
320 printf("These depend on %s:\n", c->key);
321 dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) {
322 struct ccanlint *to = container_of(e->n[DGRAPH_TO],
325 printf("\t%s\n", to->key);
331 static void print_test_depends(void)
335 strmap_iterate(&tests, print_deps, NULL);
339 static void show_tmpdir(const char *dir)
341 printf("You can find ccanlint working files in '%s'\n", dir);
344 static char *keep_tests(void *unused)
348 /* Don't automatically destroy temporary dir. */
350 tal_add_destructor(temp_dir(), show_tmpdir);
354 static bool remove_test(struct dgraph_node *node, const char *why)
356 struct ccanlint *c = container_of(node, struct ccanlint, node);
358 dgraph_clear_node(node);
362 static char *exclude_test(const char *testname, void *unused)
364 struct ccanlint *i = find_test(testname);
366 return tal_fmt(NULL, "No test %s to --exclude", testname);
368 /* Remove this, and everything which depends on it. */
369 dgraph_traverse_from(&i->node, remove_test, "excluded on command line");
370 remove_test(&i->node, "excluded on command line");
374 static void skip_test_and_deps(struct ccanlint *c, const char *why)
376 /* Skip this, and everything which depends on us. */
377 dgraph_traverse_from(&c->node, skip_test, why);
378 skip_test(&c->node, why);
381 static char *list_tests(void *arg)
386 /* This makes them print in topological order. */
387 while ((i = get_next_test()) != NULL) {
388 printf(" %-25s %s\n", i->key, i->name);
389 dgraph_clear_node(&i->node);
390 strmap_del(&tests, i->key, NULL);
395 static bool draw_test(const char *member, struct ccanlint *c, const char *style)
398 * todo: escape labels in case ccanlint test keys have
399 * characters interpreted as GraphViz syntax.
401 printf("\t\"%p\" [label=\"%s\"%s]\n", c, c->key, style);
405 static void test_dgraph_vertices(const char *style)
407 strmap_iterate(&tests, draw_test, style);
410 static bool draw_edges(const char *member, struct ccanlint *c, void *unused)
412 struct dgraph_edge *e;
414 dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) {
415 struct ccanlint *to = container_of(e->n[DGRAPH_TO],
418 printf("\t\"%p\" -> \"%p\"\n", c->name, to->name);
423 static void test_dgraph_edges(void)
425 strmap_iterate(&tests, draw_edges, NULL);
428 static char *test_dependency_graph(void *arg)
432 test_dgraph_vertices("");
440 static void add_options(struct ccanlint *test, char **options,
441 unsigned int num_options)
448 /* -1, because last one is NULL. */
449 num = tal_count(test->options) - 1;
451 tal_resize(&test->options, num + num_options + 1);
452 memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *));
455 void add_info_options(struct ccan_file *info)
457 struct doc_section *d;
459 struct ccanlint *test;
461 list_for_each(get_ccan_file_docs(info), d, list) {
462 if (!streq(d->type, "ccanlint"))
465 for (i = 0; i < d->num_lines; i++) {
466 char **words = tal_strsplit(d, d->lines[i], " \t",
471 if (strncmp(words[0], "//", 2) == 0)
474 test = find_test(words[0]);
476 warnx("%s: unknown ccanlint test '%s'",
477 info->fullname, words[0]);
482 warnx("%s: no argument to test '%s'",
483 info->fullname, words[0]);
488 if (strcasecmp(words[1], "FAIL") == 0) {
490 skip_test_and_deps(test,
494 if (!test->takes_options)
495 warnx("%s: %s doesn't take options",
496 info->fullname, words[0]);
497 add_options(test, words+1, tal_count(words)-1);
503 /* If options are of form "filename:<option>" they only apply to that file */
504 char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
507 unsigned int i, j = 0;
510 if (!test->options[0])
511 return test->options;
513 ret = tal_arr(f, char *, tal_count(test->options));
514 for (i = 0; test->options[i]; i++) {
517 if (!test->options[i] || !strchr(test->options[i], ':')) {
518 optname = test->options[i];
519 } else if (strstarts(test->options[i], f->name)
520 && test->options[i][strlen(f->name)] == ':') {
521 optname = test->options[i] + strlen(f->name) + 1;
525 /* FAIL overrides anything else. */
526 if (streq(optname, "FAIL")) {
527 ret = tal_arr(f, char *, 2);
528 ret[0] = (char *)"FAIL";
536 /* Shrink it to size so tal_array_length() works as expected. */
537 tal_resize(&ret, j + 1);
541 static char *opt_set_const_charp(const char *arg, const char **p)
543 return opt_set_charp(arg, cast_const2(char **, p));
546 static char *opt_set_target(const char *arg, struct dgraph_node *all)
548 struct ccanlint *t = find_test(arg);
550 return tal_fmt(NULL, "unknown --target %s", arg);
553 dgraph_add_edge(&t->node, all);
557 static bool run_tests(struct dgraph_node *all,
567 run.score = run.total = 0;
570 dgraph_traverse_to(all, run_test, &run);
572 printf("%sTotal score: %u/%u\n", prefix, run.score, run.total);
576 static bool add_to_all(const char *member, struct ccanlint *c,
577 struct dgraph_node *all)
579 /* If we're excluded on cmdline, don't add. */
581 dgraph_add_edge(&c->node, all);
585 static bool test_module(struct dgraph_node *all,
586 const char *dir, const char *prefix, bool summary)
588 struct manifest *m = get_manifest(autofree(), dir);
589 char *testlink = path_join(NULL, temp_dir(), "test");
591 /* Create a symlink from temp dir back to src dir's
594 if (symlink(path_join(m, dir, "test"), testlink) != 0)
595 err(1, "Creating test symlink in %s", temp_dir());
597 return run_tests(all, summary, m, prefix);
600 int main(int argc, char *argv[])
602 bool summary = false, pass = true;
604 const char *prefix = "";
605 char *cwd = path_cwd(NULL), *dir;
606 struct ccanlint top; /* cannot_run may try to set ->can_run */
607 const char *override_compiler = NULL, *override_cflags = NULL;
609 /* Empty graph node to which we attach everything else. */
610 dgraph_init_node(&top.node);
612 opt_register_early_noarg("--verbose|-v", opt_inc_intval, &verbose,
613 "verbose mode (up to -vvvv)");
614 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
615 "do not compile anything");
616 opt_register_noarg("-l|--list-tests", list_tests, NULL,
617 "list tests ccanlint performs (and exit)");
618 opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
619 "print dependency graph of tests in Graphviz .dot format");
620 opt_register_noarg("-k|--keep", keep_tests, NULL,
621 "do not delete ccanlint working files");
622 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
623 "simply give one line summary");
624 opt_register_arg("-x|--exclude <testname>", exclude_test, NULL, NULL,
625 "exclude <testname> (can be used multiple times)");
626 opt_register_arg("--timeout <milleseconds>", opt_set_uintval,
628 "ignore (terminate) tests that are slower than this");
629 opt_register_arg("-t|--target <testname>", opt_set_target, NULL,
631 "only run one test (and its prerequisites)");
632 opt_register_arg("--compiler <compiler>", opt_set_const_charp,
633 NULL, &override_compiler, "set the compiler");
634 opt_register_arg("--cflags <flags>", opt_set_const_charp,
635 NULL, &override_cflags, "set the compiler flags");
636 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
637 "\nA program for checking and guiding development"
639 "This usage message");
641 /* Do verbose before anything else... */
642 opt_early_parse(argc, argv, opt_log_stderr_exit);
644 /* We move into temporary directory, so gcov dumps its files there. */
645 if (chdir(temp_dir()) != 0)
646 err(1, "Error changing to %s temporary dir", temp_dir());
651 compile_verbose = true;
652 print_test_depends();
655 tools_verbose = true;
657 opt_parse(&argc, argv, opt_log_stderr_exit);
660 strmap_iterate(&tests, add_to_all, &top.node);
665 dir = path_join(NULL, cwd, argv[1]);
667 ccan_dir = find_ccan_dir(dir);
669 errx(1, "Cannot find ccan/ base directory in %s", dir);
670 config_header = read_config_header(ccan_dir, verbose > 1);
672 /* We do this after read_config_header has set compiler & cflags */
674 cflags = override_cflags;
675 if (override_compiler)
676 compiler = override_compiler;
679 pass = test_module(&top.node, cwd, "", summary);
681 for (i = 1; i < argc; i++) {
682 dir = path_canon(NULL,
683 take(path_join(NULL, cwd, argv[i])));
685 err(1, "Cannot get canonical name of '%s'",
688 prefix = path_join(NULL, ccan_dir, "ccan");
689 prefix = path_rel(NULL, take(prefix), dir);
690 prefix = tal_strcat(NULL, take(prefix), ": ");
692 pass &= test_module(&top.node, dir, prefix, summary);
693 reset_tests(&top.node);