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'",
292 foreach_ptr(list, &compulsory_tests, &normal_tests) {
293 printf("\%s Tests\n",
294 list == &compulsory_tests ? "Compulsory" : "Normal");
296 if (!list_empty(&c->dependencies)) {
297 const struct dependent *d;
298 printf("These depend on us:\n");
299 list_for_each(&c->dependencies, d, node)
300 printf("\t%s\n", d->dependent->name);
305 static int show_tmpdir(const char *dir)
307 printf("You can find ccanlint working files in '%s'\n", dir);
311 static char *keep_test(const char *testname, void *unused)
315 if (streq(testname, "all")) {
316 struct list_head *list;
317 foreach_ptr(list, &compulsory_tests, &normal_tests) {
318 list_for_each(list, i, list)
319 i->keep_results = true;
322 i = find_test(testname);
324 errx(1, "No test %s to --keep", testname);
325 i->keep_results = true;
328 /* Don't automatically destroy temporary dir. */
329 talloc_set_destructor(temp_dir(NULL), show_tmpdir);
333 static char *skip_test(const char *testname, void *unused)
335 btree_insert(cmdline_exclude, testname);
339 static void print_tests(struct list_head *tests, const char *type)
343 printf("%s tests:\n", type);
344 /* This makes them print in topological order. */
345 while ((i = get_next_test(tests)) != NULL) {
346 const struct dependent *d;
347 printf(" %-25s %s\n", i->key, i->name);
349 list_for_each(&i->dependencies, d, node)
350 d->dependent->num_depends--;
354 static char *list_tests(void *arg)
356 print_tests(&compulsory_tests, "Compulsory");
357 print_tests(&normal_tests, "Normal");
361 static void test_dgraph_vertices(struct list_head *tests, const char *style)
363 const struct ccanlint *i;
365 list_for_each(tests, i, list) {
367 * todo: escape labels in case ccanlint test keys have
368 * characters interpreted as GraphViz syntax.
370 printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style);
374 static void test_dgraph_edges(struct list_head *tests)
376 const struct ccanlint *i;
377 const struct dependent *d;
379 list_for_each(tests, i, list)
380 list_for_each(&i->dependencies, d, node)
381 printf("\t\"%p\" -> \"%p\"\n", d->dependent, i);
384 static char *test_dependency_graph(void *arg)
388 test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow");
389 test_dgraph_vertices(&normal_tests, "");
391 test_dgraph_edges(&compulsory_tests);
392 test_dgraph_edges(&normal_tests);
399 /* Remove empty lines. */
400 static char **collapse(char **lines, unsigned int *nump)
403 for (i = j = 0; lines[i]; i++) {
405 lines[j++] = lines[i];
412 static void add_info_options(struct ccan_file *info, bool mark_fails)
414 struct doc_section *d;
416 struct ccanlint *test;
418 list_for_each(get_ccan_file_docs(info), d, list) {
419 if (!streq(d->type, "ccanlint"))
422 for (i = 0; i < d->num_lines; i++) {
423 char **words = collapse(strsplit(d, d->lines[i], " \t"),
428 if (strncmp(words[0], "//", 2) == 0)
431 test = find_test(words[0]);
433 warnx("%s: unknown ccanlint test '%s'",
434 info->fullname, words[0]);
439 warnx("%s: no argument to test '%s'",
440 info->fullname, words[0]);
445 if (strcasecmp(words[1], "FAIL") == 0) {
447 btree_insert(info_exclude, words[0]);
449 if (!test->takes_options)
450 warnx("%s: %s doesn't take options",
451 info->fullname, words[0]);
452 /* Copy line exactly into options. */
453 test->options = strstr(d->lines[i], words[0])
460 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
462 const struct dependent *d;
467 list_for_each(&i->dependencies, d, node) {
468 if (depends_on(d->dependent, target))
474 /* O(N^2), who cares? */
475 static void skip_unrelated_tests(struct ccanlint *target)
478 struct list_head *list;
480 foreach_ptr(list, &compulsory_tests, &normal_tests)
481 list_for_each(list, i, list)
482 if (!depends_on(i, target))
483 i->skip = "not relevant to target";
486 static char *demangle_string(char *string)
489 const char mapfrom[] = "abfnrtv";
490 const char mapto[] = "\a\b\f\n\r\t\v";
492 if (!strchr(string, '"'))
494 string = strchr(string, '"') + 1;
495 if (!strrchr(string, '"'))
497 *strrchr(string, '"') = '\0';
499 for (i = 0; i < strlen(string); i++) {
500 if (string[i] == '\\') {
503 const char *p = strchr(mapfrom, string[i+1]);
505 repl = mapto[p - mapfrom];
507 } else if (strlen(string+i+1) >= 3) {
508 if (string[i+1] == 'x') {
509 repl = (string[i+2]-'0')*16
512 } else if (cisdigit(string[i+1])) {
513 repl = (string[i+2]-'0')*8*8
514 + (string[i+3]-'0')*8
525 memmove(string + i + 1, string + i + len + 1,
526 strlen(string + i + len + 1) + 1);
534 static void read_config_header(void)
536 char *fname = talloc_asprintf(NULL, "%s/config.h", ccan_dir);
540 config_header = grab_file(NULL, fname, NULL);
541 if (!config_header) {
546 lines = strsplit(config_header, config_header, "\n");
547 for (i = 0; i < talloc_array_length(lines) - 1; i++) {
549 const char **line = (const char **)&lines[i];
551 if (!get_token(line, "#"))
553 if (!get_token(line, "define"))
555 sym = get_symbol_token(lines, line);
556 if (streq(sym, "CCAN_COMPILER") && !compiler) {
557 compiler = demangle_string(lines[i]);
559 errx(1, "%s:%u:could not parse CCAN_COMPILER",
562 printf("%s: compiler set to '%s'\n",
564 } else if (streq(sym, "CCAN_CFLAGS") && !cflags) {
565 cflags = demangle_string(lines[i]);
567 errx(1, "%s:%u:could not parse CCAN_CFLAGS",
570 printf("%s: compiler flags set to '%s'\n",
575 compiler = CCAN_COMPILER;
577 compiler = CCAN_CFLAGS;
580 static char *opt_set_const_charp(const char *arg, const char **p)
582 return opt_set_charp(arg, cast_const2(char **, p));
585 int main(int argc, char *argv[])
587 bool summary = false, pass = true;
588 unsigned int score = 0, total_score = 0;
591 const char *prefix = "";
592 char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
596 cmdline_exclude = btree_new(btree_strcmp);
597 info_exclude = btree_new(btree_strcmp);
599 opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
600 "use this directory");
601 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
602 "do not compile anything");
603 opt_register_noarg("-l|--list-tests", list_tests, NULL,
604 "list tests ccanlint performs (and exit)");
605 opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
606 "print dependency graph of tests in Graphviz .dot format");
607 opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
608 "keep results of <testname>"
609 " (can be used multiple times, or 'all')");
610 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
611 "simply give one line summary");
612 opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
613 "verbose mode (up to -vvvv)");
614 opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
615 "exclude <testname> (can be used multiple times)");
616 opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
618 "ignore (terminate) tests that are slower than this");
619 opt_register_arg("--target <testname>", opt_set_charp,
621 "only run one test (and its prerequisites)");
622 opt_register_arg("--compiler <compiler>", opt_set_const_charp,
623 NULL, &compiler, "set the compiler");
624 opt_register_arg("--cflags <flags>", opt_set_const_charp,
625 NULL, &cflags, "set the compiler flags");
626 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
627 "\nA program for checking and guiding development"
629 "This usage message");
631 /* We move into temporary directory, so gcov dumps its files there. */
632 if (chdir(temp_dir(talloc_autofree_context())) != 0)
633 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
635 opt_parse(&argc, argv, opt_log_stderr_exit);
638 dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
639 while (strends(dir, "/"))
640 dir[strlen(dir)-1] = '\0';
642 prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
644 compile_verbose = true;
646 tools_verbose = true;
648 m = get_manifest(talloc_autofree_context(), dir);
649 read_config_header();
651 /* Create a symlink from temp dir back to src dir's test directory. */
652 if (symlink(talloc_asprintf(m, "%s/test", dir),
653 talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0)
654 err(1, "Creating test symlink in %s", temp_dir(NULL));
657 struct ccanlint *test;
659 test = find_test(target);
661 errx(1, "Unknown test to run '%s'", target);
662 skip_unrelated_tests(test);
665 /* If you don't pass the compulsory tests, you get a score of 0. */
666 while ((i = get_next_test(&compulsory_tests)) != NULL) {
667 if (!run_test(i, summary, &score, &total_score, m)) {
668 printf("%sTotal score: 0/%u\n", prefix, total_score);
669 errx(1, "%s%s failed", prefix, i->name);
673 /* --target overrides known FAIL from _info */
675 add_info_options(m->info_file, !target);
677 while ((i = get_next_test(&normal_tests)) != NULL)
678 pass &= run_test(i, summary, &score, &total_score, m);
680 printf("%sTotal score: %u/%u\n", prefix, score, total_score);