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.
28 #include <ccan/btree/btree.h>
29 #include <ccan/str/str.h>
30 #include <ccan/str_talloc/str_talloc.h>
31 #include <ccan/talloc/talloc.h>
32 #include <ccan/opt/opt.h>
33 #include <ccan/foreach/foreach.h>
34 #include <ccan/grab_file/grab_file.h>
35 #include <ccan/cast/cast.h>
38 static LIST_HEAD(compulsory_tests);
39 static LIST_HEAD(normal_tests);
40 static LIST_HEAD(finished_tests);
41 bool safe_mode = false;
42 static struct btree *cmdline_exclude;
43 static struct btree *info_exclude;
44 static unsigned int timeout;
46 /* These are overridden at runtime if we can find config.h */
47 const char *compiler = NULL;
48 const char *cflags = NULL;
50 const char *config_header;
53 static void indent_print(const char *string)
56 unsigned int line = strcspn(string, "\n");
57 printf("\t%.*s", line, string);
58 if (string[line] == '\n') {
67 bool ask(const char *question)
71 printf("%s ", question);
74 return fgets(reply, sizeof(reply), stdin) != NULL
75 && toupper(reply[0]) == 'Y';
78 static const char *should_skip(struct manifest *m, struct ccanlint *i)
80 if (btree_lookup(cmdline_exclude, i->key))
81 return "excluded on command line";
83 if (btree_lookup(info_exclude, i->key))
84 return "excluded in _info file";
90 return "dependency failed";
97 static bool run_test(struct ccanlint *i,
99 unsigned int *running_score,
100 unsigned int *running_total,
103 unsigned int timeleft;
104 const struct dependent *d;
108 //one less test to run through
109 list_for_each(&i->dependencies, d, node)
110 d->dependent->num_depends--;
112 score = talloc(m, struct score);
113 list_head_init(&score->per_file_errors);
119 skip = should_skip(m, i);
123 if (verbose && !streq(skip, "not relevant to target"))
124 printf("%s: skipped (%s)\n", i->name, skip);
126 /* If we're skipping this because a prereq failed, we fail:
127 * count it as a score of 1. */
132 list_add_tail(&finished_tests, &i->list);
133 list_for_each(&i->dependencies, d, node) {
134 if (d->dependent->skip)
136 d->dependent->skip = "dependency was skipped";
137 d->dependent->skip_fail = i->skip_fail;
139 return i->skip_fail ? false : true;
142 timeleft = timeout ? timeout : default_timeout_ms;
143 i->check(m, i->keep_results, &timeleft, score);
144 if (timeout && timeleft == 0) {
149 assert(score->score <= score->total);
150 if ((!score->pass && !quiet)
151 || (score->score < score->total && verbose)
153 printf("%s (%s): %s", i->name, i->key, score->pass ? "PASS" : "FAIL");
154 if (score->total > 1)
155 printf(" (+%u/%u)", score->score, score->total);
159 if ((!quiet && !score->pass) || verbose) {
161 printf("%s%s", score->error,
162 strends(score->error, "\n") ? "" : "\n");
165 if (!quiet && score->score < score->total && i->handle)
168 *running_score += score->score;
169 *running_total += score->total;
172 list_add_tail(&finished_tests, &i->list);
175 /* Skip any tests which depend on this one. */
176 list_for_each(&i->dependencies, d, node) {
177 if (d->dependent->skip)
179 d->dependent->skip = "dependency failed";
180 d->dependent->skip_fail = true;
186 static void register_test(struct list_head *h, struct ccanlint *test)
188 list_add(h, &test->list);
192 * get_next_test - retrieves the next test to be processed
194 static inline struct ccanlint *get_next_test(struct list_head *test)
198 if (list_empty(test))
201 list_for_each(test, i, list) {
202 if (i->num_depends == 0)
205 errx(1, "Can't make process; test dependency cycle");
208 static struct ccanlint *find_test(const char *key)
212 list_for_each(&compulsory_tests, i, list)
213 if (streq(i->key, key))
216 list_for_each(&normal_tests, i, list)
217 if (streq(i->key, key))
224 #define REGISTER_TEST(name, ...) extern struct ccanlint name
225 #include "generated-normal-tests"
226 #include "generated-compulsory-tests"
228 static void init_tests(void)
231 struct btree *keys, *names;
232 struct list_head *list;
235 #define REGISTER_TEST(name) register_test(&normal_tests, &name)
236 #include "generated-normal-tests"
238 #define REGISTER_TEST(name) register_test(&compulsory_tests, &name)
239 #include "generated-compulsory-tests"
241 /* Initialize dependency lists. */
242 foreach_ptr(list, &compulsory_tests, &normal_tests) {
243 list_for_each(list, c, list) {
244 list_head_init(&c->dependencies);
248 /* Resolve dependencies. */
249 foreach_ptr(list, &compulsory_tests, &normal_tests) {
250 list_for_each(list, c, list) {
251 char **deps = strsplit(NULL, c->needs, " ");
254 for (i = 0; deps[i]; i++) {
255 struct ccanlint *dep;
256 struct dependent *dchild;
258 dep = find_test(deps[i]);
260 errx(1, "BUG: unknown dep '%s' for %s",
262 dchild = talloc(NULL, struct dependent);
263 dchild->dependent = c;
264 list_add_tail(&dep->dependencies,
272 /* Self-consistency check: make sure no two tests
273 have the same key or name. */
274 keys = btree_new(btree_strcmp);
275 names = btree_new(btree_strcmp);
276 foreach_ptr(list, &compulsory_tests, &normal_tests) {
277 list_for_each(list, c, list) {
278 if (!btree_insert(keys, c->key))
279 errx(1, "BUG: Duplicate test key '%s'",
281 if (!btree_insert(names, c->name))
282 errx(1, "BUG: Duplicate test name '%s'",
290 static void print_test_depends(void)
292 struct list_head *list;
294 foreach_ptr(list, &compulsory_tests, &normal_tests) {
296 printf("\%s Tests\n",
297 list == &compulsory_tests ? "Compulsory" : "Normal");
299 list_for_each(list, c, list) {
300 if (!list_empty(&c->dependencies)) {
301 const struct dependent *d;
302 printf("These depend on %s:\n", c->key);
303 list_for_each(&c->dependencies, d, node)
304 printf("\t%s\n", d->dependent->key);
310 static int show_tmpdir(const char *dir)
312 printf("You can find ccanlint working files in '%s'\n", dir);
316 static char *keep_test(const char *testname, void *unused)
320 if (streq(testname, "all")) {
321 struct list_head *list;
322 foreach_ptr(list, &compulsory_tests, &normal_tests) {
323 list_for_each(list, i, list)
324 i->keep_results = true;
327 i = find_test(testname);
329 errx(1, "No test %s to --keep", testname);
330 i->keep_results = true;
333 /* Don't automatically destroy temporary dir. */
334 talloc_set_destructor(temp_dir(NULL), show_tmpdir);
338 static char *skip_test(const char *testname, void *unused)
340 btree_insert(cmdline_exclude, testname);
344 static void print_tests(struct list_head *tests, const char *type)
348 printf("%s tests:\n", type);
349 /* This makes them print in topological order. */
350 while ((i = get_next_test(tests)) != NULL) {
351 const struct dependent *d;
352 printf(" %-25s %s\n", i->key, i->name);
354 list_for_each(&i->dependencies, d, node)
355 d->dependent->num_depends--;
359 static char *list_tests(void *arg)
361 print_tests(&compulsory_tests, "Compulsory");
362 print_tests(&normal_tests, "Normal");
366 static void test_dgraph_vertices(struct list_head *tests, const char *style)
368 const struct ccanlint *i;
370 list_for_each(tests, i, list) {
372 * todo: escape labels in case ccanlint test keys have
373 * characters interpreted as GraphViz syntax.
375 printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style);
379 static void test_dgraph_edges(struct list_head *tests)
381 const struct ccanlint *i;
382 const struct dependent *d;
384 list_for_each(tests, i, list)
385 list_for_each(&i->dependencies, d, node)
386 printf("\t\"%p\" -> \"%p\"\n", d->dependent, i);
389 static char *test_dependency_graph(void *arg)
393 test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow");
394 test_dgraph_vertices(&normal_tests, "");
396 test_dgraph_edges(&compulsory_tests);
397 test_dgraph_edges(&normal_tests);
404 /* Remove empty lines. */
405 static char **collapse(char **lines, unsigned int *nump)
408 for (i = j = 0; lines[i]; i++) {
410 lines[j++] = lines[i];
417 static void add_info_options(struct ccan_file *info, bool mark_fails)
419 struct doc_section *d;
421 struct ccanlint *test;
423 list_for_each(get_ccan_file_docs(info), d, list) {
424 if (!streq(d->type, "ccanlint"))
427 for (i = 0; i < d->num_lines; i++) {
428 char **words = collapse(strsplit(d, d->lines[i], " \t"),
433 if (strncmp(words[0], "//", 2) == 0)
436 test = find_test(words[0]);
438 warnx("%s: unknown ccanlint test '%s'",
439 info->fullname, words[0]);
444 warnx("%s: no argument to test '%s'",
445 info->fullname, words[0]);
450 if (strcasecmp(words[1], "FAIL") == 0) {
452 btree_insert(info_exclude, words[0]);
454 if (!test->takes_options)
455 warnx("%s: %s doesn't take options",
456 info->fullname, words[0]);
457 /* Copy line exactly into options. */
458 test->options = strstr(d->lines[i], words[0])
465 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
467 const struct dependent *d;
472 list_for_each(&i->dependencies, d, node) {
473 if (depends_on(d->dependent, target))
479 /* O(N^2), who cares? */
480 static void skip_unrelated_tests(struct ccanlint *target)
483 struct list_head *list;
485 foreach_ptr(list, &compulsory_tests, &normal_tests)
486 list_for_each(list, i, list)
487 if (!depends_on(i, target))
488 i->skip = "not relevant to target";
491 static char *demangle_string(char *string)
494 const char mapfrom[] = "abfnrtv";
495 const char mapto[] = "\a\b\f\n\r\t\v";
497 if (!strchr(string, '"'))
499 string = strchr(string, '"') + 1;
500 if (!strrchr(string, '"'))
502 *strrchr(string, '"') = '\0';
504 for (i = 0; i < strlen(string); i++) {
505 if (string[i] == '\\') {
508 const char *p = strchr(mapfrom, string[i+1]);
510 repl = mapto[p - mapfrom];
512 } else if (strlen(string+i+1) >= 3) {
513 if (string[i+1] == 'x') {
514 repl = (string[i+2]-'0')*16
517 } else if (cisdigit(string[i+1])) {
518 repl = (string[i+2]-'0')*8*8
519 + (string[i+3]-'0')*8
530 memmove(string + i + 1, string + i + len + 1,
531 strlen(string + i + len + 1) + 1);
539 static void read_config_header(void)
541 char *fname = talloc_asprintf(NULL, "%s/config.h", ccan_dir);
545 config_header = grab_file(NULL, fname, NULL);
546 if (!config_header) {
551 lines = strsplit(config_header, config_header, "\n");
552 for (i = 0; i < talloc_array_length(lines) - 1; i++) {
554 const char **line = (const char **)&lines[i];
556 if (!get_token(line, "#"))
558 if (!get_token(line, "define"))
560 sym = get_symbol_token(lines, line);
561 if (streq(sym, "CCAN_COMPILER") && !compiler) {
562 compiler = demangle_string(lines[i]);
564 errx(1, "%s:%u:could not parse CCAN_COMPILER",
567 printf("%s: compiler set to '%s'\n",
569 } else if (streq(sym, "CCAN_CFLAGS") && !cflags) {
570 cflags = demangle_string(lines[i]);
572 errx(1, "%s:%u:could not parse CCAN_CFLAGS",
575 printf("%s: compiler flags set to '%s'\n",
580 compiler = CCAN_COMPILER;
582 compiler = CCAN_CFLAGS;
585 static char *opt_set_const_charp(const char *arg, const char **p)
587 return opt_set_charp(arg, cast_const2(char **, p));
590 int main(int argc, char *argv[])
592 bool summary = false, pass = true;
593 unsigned int score = 0, total_score = 0;
596 const char *prefix = "";
597 char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
601 cmdline_exclude = btree_new(btree_strcmp);
602 info_exclude = btree_new(btree_strcmp);
604 opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
605 "use this directory");
606 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
607 "do not compile anything");
608 opt_register_noarg("-l|--list-tests", list_tests, NULL,
609 "list tests ccanlint performs (and exit)");
610 opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
611 "print dependency graph of tests in Graphviz .dot format");
612 opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
613 "keep results of <testname>"
614 " (can be used multiple times, or 'all')");
615 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
616 "simply give one line summary");
617 opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
618 "verbose mode (up to -vvvv)");
619 opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
620 "exclude <testname> (can be used multiple times)");
621 opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
623 "ignore (terminate) tests that are slower than this");
624 opt_register_arg("--target <testname>", opt_set_charp,
626 "only run one test (and its prerequisites)");
627 opt_register_arg("--compiler <compiler>", opt_set_const_charp,
628 NULL, &compiler, "set the compiler");
629 opt_register_arg("--cflags <flags>", opt_set_const_charp,
630 NULL, &cflags, "set the compiler flags");
631 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
632 "\nA program for checking and guiding development"
634 "This usage message");
636 /* We move into temporary directory, so gcov dumps its files there. */
637 if (chdir(temp_dir(talloc_autofree_context())) != 0)
638 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
640 opt_parse(&argc, argv, opt_log_stderr_exit);
643 dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
644 while (strends(dir, "/"))
645 dir[strlen(dir)-1] = '\0';
647 prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
649 compile_verbose = true;
650 print_test_depends();
653 tools_verbose = true;
655 m = get_manifest(talloc_autofree_context(), dir);
656 read_config_header();
658 /* Create a symlink from temp dir back to src dir's test directory. */
659 if (symlink(talloc_asprintf(m, "%s/test", dir),
660 talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0)
661 err(1, "Creating test symlink in %s", temp_dir(NULL));
664 struct ccanlint *test;
666 test = find_test(target);
668 errx(1, "Unknown test to run '%s'", target);
669 skip_unrelated_tests(test);
672 /* If you don't pass the compulsory tests, you get a score of 0. */
673 while ((i = get_next_test(&compulsory_tests)) != NULL) {
674 if (!run_test(i, summary, &score, &total_score, m)) {
675 printf("%sTotal score: 0/%u\n", prefix, total_score);
676 errx(1, "%s%s failed", prefix, i->name);
680 /* --target overrides known FAIL from _info */
682 add_info_options(m->info_file, !target);
684 while ((i = get_next_test(&normal_tests)) != NULL)
685 pass &= run_test(i, summary, &score, &total_score, m);
687 printf("%sTotal score: %u/%u\n", prefix, score, total_score);