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);
189 test->options = talloc_array(NULL, char *, 1);
190 test->options[0] = NULL;
194 * get_next_test - retrieves the next test to be processed
196 static inline struct ccanlint *get_next_test(struct list_head *test)
200 if (list_empty(test))
203 list_for_each(test, i, list) {
204 if (i->num_depends == 0)
207 errx(1, "Can't make process; test dependency cycle");
210 static struct ccanlint *find_test(const char *key)
214 list_for_each(&compulsory_tests, i, list)
215 if (streq(i->key, key))
218 list_for_each(&normal_tests, i, list)
219 if (streq(i->key, key))
225 bool is_excluded(const char *name)
227 return btree_lookup(cmdline_exclude, name) != NULL
228 || btree_lookup(info_exclude, name) != NULL
229 || find_test(name)->skip != NULL;
233 #define REGISTER_TEST(name, ...) extern struct ccanlint name
234 #include "generated-normal-tests"
235 #include "generated-compulsory-tests"
237 static void init_tests(void)
240 struct btree *keys, *names;
241 struct list_head *list;
244 #define REGISTER_TEST(name) register_test(&normal_tests, &name)
245 #include "generated-normal-tests"
247 #define REGISTER_TEST(name) register_test(&compulsory_tests, &name)
248 #include "generated-compulsory-tests"
250 /* Initialize dependency lists. */
251 foreach_ptr(list, &compulsory_tests, &normal_tests) {
252 list_for_each(list, c, list) {
253 list_head_init(&c->dependencies);
257 /* Resolve dependencies. */
258 foreach_ptr(list, &compulsory_tests, &normal_tests) {
259 list_for_each(list, c, list) {
260 char **deps = strsplit(NULL, c->needs, " ");
263 for (i = 0; deps[i]; i++) {
264 struct ccanlint *dep;
265 struct dependent *dchild;
267 dep = find_test(deps[i]);
269 errx(1, "BUG: unknown dep '%s' for %s",
271 dchild = talloc(NULL, struct dependent);
272 dchild->dependent = c;
273 list_add_tail(&dep->dependencies,
281 /* Self-consistency check: make sure no two tests
282 have the same key or name. */
283 keys = btree_new(btree_strcmp);
284 names = btree_new(btree_strcmp);
285 foreach_ptr(list, &compulsory_tests, &normal_tests) {
286 list_for_each(list, c, list) {
287 if (!btree_insert(keys, c->key))
288 errx(1, "BUG: Duplicate test key '%s'",
290 if (!btree_insert(names, c->name))
291 errx(1, "BUG: Duplicate test name '%s'",
299 static void print_test_depends(void)
301 struct list_head *list;
303 foreach_ptr(list, &compulsory_tests, &normal_tests) {
305 printf("\%s Tests\n",
306 list == &compulsory_tests ? "Compulsory" : "Normal");
308 list_for_each(list, c, list) {
309 if (!list_empty(&c->dependencies)) {
310 const struct dependent *d;
311 printf("These depend on %s:\n", c->key);
312 list_for_each(&c->dependencies, d, node)
313 printf("\t%s\n", d->dependent->key);
319 static int show_tmpdir(const char *dir)
321 printf("You can find ccanlint working files in '%s'\n", dir);
325 static char *keep_test(const char *testname, void *unused)
329 if (streq(testname, "all")) {
330 struct list_head *list;
331 foreach_ptr(list, &compulsory_tests, &normal_tests) {
332 list_for_each(list, i, list)
333 i->keep_results = true;
336 i = find_test(testname);
338 errx(1, "No test %s to --keep", testname);
339 i->keep_results = true;
342 /* Don't automatically destroy temporary dir. */
343 talloc_set_destructor(temp_dir(NULL), show_tmpdir);
347 static char *skip_test(const char *testname, void *unused)
349 btree_insert(cmdline_exclude, testname);
353 static void print_tests(struct list_head *tests, const char *type)
357 printf("%s tests:\n", type);
358 /* This makes them print in topological order. */
359 while ((i = get_next_test(tests)) != NULL) {
360 const struct dependent *d;
361 printf(" %-25s %s\n", i->key, i->name);
363 list_for_each(&i->dependencies, d, node)
364 d->dependent->num_depends--;
368 static char *list_tests(void *arg)
370 print_tests(&compulsory_tests, "Compulsory");
371 print_tests(&normal_tests, "Normal");
375 static void test_dgraph_vertices(struct list_head *tests, const char *style)
377 const struct ccanlint *i;
379 list_for_each(tests, i, list) {
381 * todo: escape labels in case ccanlint test keys have
382 * characters interpreted as GraphViz syntax.
384 printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style);
388 static void test_dgraph_edges(struct list_head *tests)
390 const struct ccanlint *i;
391 const struct dependent *d;
393 list_for_each(tests, i, list)
394 list_for_each(&i->dependencies, d, node)
395 printf("\t\"%p\" -> \"%p\"\n", d->dependent, i);
398 static char *test_dependency_graph(void *arg)
402 test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow");
403 test_dgraph_vertices(&normal_tests, "");
405 test_dgraph_edges(&compulsory_tests);
406 test_dgraph_edges(&normal_tests);
413 /* Remove empty lines. */
414 static char **collapse(char **lines, unsigned int *nump)
417 for (i = j = 0; lines[i]; i++) {
419 lines[j++] = lines[i];
428 static void add_options(struct ccanlint *test, char **options,
429 unsigned int num_options)
436 /* -1, because last one is NULL. */
437 num = talloc_array_length(test->options) - 1;
439 test->options = talloc_realloc(NULL, test->options,
441 num + num_options + 1);
442 memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *));
445 static void add_info_options(struct ccan_file *info, bool mark_fails)
447 struct doc_section *d;
449 struct ccanlint *test;
451 list_for_each(get_ccan_file_docs(info), d, list) {
452 if (!streq(d->type, "ccanlint"))
455 for (i = 0; i < d->num_lines; i++) {
456 unsigned int num_words;
457 char **words = collapse(strsplit(d, d->lines[i], " \t"),
462 if (strncmp(words[0], "//", 2) == 0)
465 test = find_test(words[0]);
467 warnx("%s: unknown ccanlint test '%s'",
468 info->fullname, words[0]);
473 warnx("%s: no argument to test '%s'",
474 info->fullname, words[0]);
479 if (strcasecmp(words[1], "FAIL") == 0) {
481 btree_insert(info_exclude, words[0]);
483 if (!test->takes_options)
484 warnx("%s: %s doesn't take options",
485 info->fullname, words[0]);
486 add_options(test, words+1, num_words-1);
492 /* If options are of form "filename:<option>" they only apply to that file */
493 char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
496 unsigned int i, j = 0;
499 if (!test->options[0])
500 return test->options;
502 ret = talloc_array(f, char *, talloc_array_length(test->options));
503 for (i = 0; test->options[i]; i++) {
506 if (!test->options[i] || !strchr(test->options[i], ':')) {
507 optname = test->options[i];
508 } else if (strstarts(test->options[i], f->name)
509 && test->options[i][strlen(f->name)] == ':') {
510 optname = test->options[i] + strlen(f->name) + 1;
514 /* FAIL overrides anything else. */
515 if (streq(optname, "FAIL")) {
516 ret = talloc_array(f, char *, 2);
517 ret[0] = (char *)"FAIL";
525 /* Shrink it to size so talloc_array_length() works as expected. */
526 return talloc_realloc(NULL, ret, char *, j + 1);
529 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
531 const struct dependent *d;
536 list_for_each(&i->dependencies, d, node) {
537 if (depends_on(d->dependent, target))
543 /* O(N^2), who cares? */
544 static void skip_unrelated_tests(struct ccanlint *target)
547 struct list_head *list;
549 foreach_ptr(list, &compulsory_tests, &normal_tests)
550 list_for_each(list, i, list)
551 if (!depends_on(i, target))
552 i->skip = "not relevant to target";
555 static char *demangle_string(char *string)
558 const char mapfrom[] = "abfnrtv";
559 const char mapto[] = "\a\b\f\n\r\t\v";
561 if (!strchr(string, '"'))
563 string = strchr(string, '"') + 1;
564 if (!strrchr(string, '"'))
566 *strrchr(string, '"') = '\0';
568 for (i = 0; i < strlen(string); i++) {
569 if (string[i] == '\\') {
572 const char *p = strchr(mapfrom, string[i+1]);
574 repl = mapto[p - mapfrom];
576 } else if (strlen(string+i+1) >= 3) {
577 if (string[i+1] == 'x') {
578 repl = (string[i+2]-'0')*16
581 } else if (cisdigit(string[i+1])) {
582 repl = (string[i+2]-'0')*8*8
583 + (string[i+3]-'0')*8
594 memmove(string + i + 1, string + i + len + 1,
595 strlen(string + i + len + 1) + 1);
603 static void read_config_header(void)
605 char *fname = talloc_asprintf(NULL, "%s/config.h", ccan_dir);
609 config_header = grab_file(NULL, fname, NULL);
610 if (!config_header) {
615 lines = strsplit(config_header, config_header, "\n");
616 for (i = 0; i < talloc_array_length(lines) - 1; i++) {
618 const char **line = (const char **)&lines[i];
620 if (!get_token(line, "#"))
622 if (!get_token(line, "define"))
624 sym = get_symbol_token(lines, line);
625 if (streq(sym, "CCAN_COMPILER") && !compiler) {
626 compiler = demangle_string(lines[i]);
628 errx(1, "%s:%u:could not parse CCAN_COMPILER",
631 printf("%s: compiler set to '%s'\n",
633 } else if (streq(sym, "CCAN_CFLAGS") && !cflags) {
634 cflags = demangle_string(lines[i]);
636 errx(1, "%s:%u:could not parse CCAN_CFLAGS",
639 printf("%s: compiler flags set to '%s'\n",
644 compiler = CCAN_COMPILER;
646 compiler = CCAN_CFLAGS;
649 static char *opt_set_const_charp(const char *arg, const char **p)
651 return opt_set_charp(arg, cast_const2(char **, p));
654 int main(int argc, char *argv[])
656 bool summary = false, pass = true;
657 unsigned int score = 0, total_score = 0;
660 const char *prefix = "";
661 char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
665 cmdline_exclude = btree_new(btree_strcmp);
666 info_exclude = btree_new(btree_strcmp);
668 opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
669 "use this directory");
670 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
671 "do not compile anything");
672 opt_register_noarg("-l|--list-tests", list_tests, NULL,
673 "list tests ccanlint performs (and exit)");
674 opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
675 "print dependency graph of tests in Graphviz .dot format");
676 opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
677 "keep results of <testname>"
678 " (can be used multiple times, or 'all')");
679 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
680 "simply give one line summary");
681 opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
682 "verbose mode (up to -vvvv)");
683 opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
684 "exclude <testname> (can be used multiple times)");
685 opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
687 "ignore (terminate) tests that are slower than this");
688 opt_register_arg("--target <testname>", opt_set_charp,
690 "only run one test (and its prerequisites)");
691 opt_register_arg("--compiler <compiler>", opt_set_const_charp,
692 NULL, &compiler, "set the compiler");
693 opt_register_arg("--cflags <flags>", opt_set_const_charp,
694 NULL, &cflags, "set the compiler flags");
695 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
696 "\nA program for checking and guiding development"
698 "This usage message");
700 /* We move into temporary directory, so gcov dumps its files there. */
701 if (chdir(temp_dir(talloc_autofree_context())) != 0)
702 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
704 opt_parse(&argc, argv, opt_log_stderr_exit);
707 dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
708 while (strends(dir, "/"))
709 dir[strlen(dir)-1] = '\0';
711 prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
713 compile_verbose = true;
714 print_test_depends();
717 tools_verbose = true;
719 m = get_manifest(talloc_autofree_context(), dir);
720 read_config_header();
722 /* Create a symlink from temp dir back to src dir's test directory. */
723 if (symlink(talloc_asprintf(m, "%s/test", dir),
724 talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0)
725 err(1, "Creating test symlink in %s", temp_dir(NULL));
728 struct ccanlint *test;
730 test = find_test(target);
732 errx(1, "Unknown test to run '%s'", target);
733 skip_unrelated_tests(test);
736 /* If you don't pass the compulsory tests, you get a score of 0. */
737 while ((i = get_next_test(&compulsory_tests)) != NULL) {
738 if (!run_test(i, summary, &score, &total_score, m)) {
739 printf("%sTotal score: 0/%u\n", prefix, total_score);
740 errx(1, "%s%s failed", prefix, i->name);
744 /* --target overrides known FAIL from _info */
746 add_info_options(m->info_file, !target);
748 while ((i = get_next_test(&normal_tests)) != NULL)
749 pass &= run_test(i, summary, &score, &total_score, m);
751 printf("%sTotal score: %u/%u\n", prefix, score, total_score);