X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=8acad9329e4c7280d0fef58eb8b833cf9ca7cd72;hp=31406cccbfa0386a8cda1b3f451a094b11984150;hb=2b46b6e66a6a842923640c881cd235166a4c9ad5;hpb=7a163ea2dcafc056fdafc8c71ef011e2bfdbeb65 diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 31406ccc..8acad932 100644 --- a/tools/ccanlint/ccanlint.c +++ b/tools/ccanlint/ccanlint.c @@ -1,6 +1,7 @@ /* * ccanlint: assorted checks and advice for a ccan package * Copyright (C) 2008 Rusty Russell, Idris Soule + * Copyright (C) 2010 Rusty Russell, Idris Soule * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the Free @@ -19,7 +20,6 @@ #include "ccanlint.h" #include "../tools.h" #include -#include #include #include #include @@ -58,7 +58,7 @@ static void indent_print(const char *string) bool ask(const char *question) { - char reply[2]; + char reply[80]; printf("%s ", question); fflush(stdout); @@ -142,28 +142,16 @@ static bool run_test(struct ccanlint *i, if ((!score->pass && !quiet) || (score->score < score->total && verbose) || verbose > 1) { - printf("%s: %s", i->name, score->pass ? "PASS" : "FAIL"); + printf("%s (%s): %s", i->name, i->key, score->pass ? "PASS" : "FAIL"); if (score->total > 1) printf(" (+%u/%u)", score->score, score->total); printf("\n"); } - if (!quiet && !score->pass) { - struct file_error *f; - + if ((!quiet && !score->pass) || verbose) { if (score->error) - printf("%s:\n", score->error); - - list_for_each(&score->per_file_errors, f, list) { - if (f->line) - printf("%s:%u:%s\n", - f->file->fullname, f->line, f->error); - else if (f->file) - printf("%s:%s\n", f->file->fullname, f->error); - else - printf("%s\n", f->error); - } - if (i->handle) + printf("%s", score->error); + if (!quiet && !score->pass && i->handle) i->handle(m, score); } @@ -185,30 +173,9 @@ static bool run_test(struct ccanlint *i, return score->pass; } -static void register_test(struct list_head *h, struct ccanlint *test, ...) +static void register_test(struct list_head *h, struct ccanlint *test) { - va_list ap; - struct ccanlint *depends; - struct dependent *dchild; - list_add(h, &test->list); - - va_start(ap, test); - /* Careful: we might have been initialized by a dependent. */ - if (test->dependencies.n.next == NULL) - list_head_init(&test->dependencies); - - //dependent(s) args (if any), last one is NULL - while ((depends = va_arg(ap, struct ccanlint *)) != NULL) { - dchild = malloc(sizeof(*dchild)); - dchild->dependent = test; - /* The thing we depend on might not be initialized yet! */ - if (depends->dependencies.n.next == NULL) - list_head_init(&depends->dependencies); - list_add_tail(&depends->dependencies, &dchild->node); - test->num_depends++; - } - va_end(ap); } /** @@ -228,78 +195,103 @@ static inline struct ccanlint *get_next_test(struct list_head *test) errx(1, "Can't make process; test dependency cycle"); } +static struct ccanlint *find_test(const char *key) +{ + struct ccanlint *i; + + list_for_each(&compulsory_tests, i, list) + if (streq(i->key, key)) + return i; + + list_for_each(&normal_tests, i, list) + if (streq(i->key, key)) + return i; + + return NULL; +} + +#undef REGISTER_TEST +#define REGISTER_TEST(name, ...) extern struct ccanlint name +#include "generated-normal-tests" +#include "generated-compulsory-tests" + static void init_tests(void) { - const struct ccanlint *i; + struct ccanlint *c; struct btree *keys, *names; + struct list_head *list; #undef REGISTER_TEST -#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__, NULL) +#define REGISTER_TEST(name) register_test(&normal_tests, &name) #include "generated-normal-tests" #undef REGISTER_TEST -#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__, NULL) +#define REGISTER_TEST(name) register_test(&compulsory_tests, &name) #include "generated-compulsory-tests" + /* Initialize dependency lists. */ + foreach_ptr(list, &compulsory_tests, &normal_tests) { + list_for_each(list, c, list) { + list_head_init(&c->dependencies); + } + } + + /* Resolve dependencies. */ + foreach_ptr(list, &compulsory_tests, &normal_tests) { + list_for_each(list, c, list) { + char **deps = strsplit(NULL, c->needs, " ", NULL); + unsigned int i; + + for (i = 0; deps[i]; i++) { + struct ccanlint *dep; + struct dependent *dchild; + + dep = find_test(deps[i]); + if (!dep) + errx(1, "BUG: unknown dep '%s' for %s", + deps[i], c->key); + dchild = talloc(NULL, struct dependent); + dchild->dependent = c; + list_add_tail(&dep->dependencies, + &dchild->node); + c->num_depends++; + } + talloc_free(deps); + } + } + /* Self-consistency check: make sure no two tests have the same key or name. */ keys = btree_new(btree_strcmp); names = btree_new(btree_strcmp); - list_for_each(&compulsory_tests, i, list) { - if (!btree_insert(keys, i->key)) - errx(1, "BUG: Duplicate test key '%s'", i->key); - if (!btree_insert(keys, i->name)) - errx(1, "BUG: Duplicate test name '%s'", i->name); - } - list_for_each(&normal_tests, i, list) { - if (!btree_insert(keys, i->key)) - errx(1, "BUG: Duplicate test key '%s'", i->key); - if (!btree_insert(keys, i->name)) - errx(1, "BUG: Duplicate test name '%s'", i->name); + foreach_ptr(list, &compulsory_tests, &normal_tests) { + list_for_each(list, c, list) { + if (!btree_insert(keys, c->key)) + errx(1, "BUG: Duplicate test key '%s'", + c->key); + if (!btree_insert(names, c->name)) + errx(1, "BUG: Duplicate test name '%s'", + c->name); + } } btree_delete(keys); btree_delete(names); - + if (!verbose) return; - printf("\nCompulsory Tests\n"); - list_for_each(&compulsory_tests, i, list) { - printf("%s depends on %u others\n", i->name, i->num_depends); - if (!list_empty(&i->dependencies)) { - const struct dependent *d; - printf("These depend on us:\n"); - list_for_each(&i->dependencies, d, node) - printf("\t%s\n", d->dependent->name); - } - } + foreach_ptr(list, &compulsory_tests, &normal_tests) { + printf("\%s Tests\n", + list == &compulsory_tests ? "Compulsory" : "Normal"); - printf("\nNormal Tests\n"); - list_for_each(&normal_tests, i, list) { - printf("%s depends on %u others\n", i->name, i->num_depends); - if (!list_empty(&i->dependencies)) { + if (!list_empty(&c->dependencies)) { const struct dependent *d; printf("These depend on us:\n"); - list_for_each(&i->dependencies, d, node) + list_for_each(&c->dependencies, d, node) printf("\t%s\n", d->dependent->name); } } } -static struct ccanlint *find_test(const char *key) -{ - struct ccanlint *i; - - list_for_each(&compulsory_tests, i, list) - if (streq(i->key, key)) - return i; - - list_for_each(&normal_tests, i, list) - if (streq(i->key, key)) - return i; - - return NULL; -} - static char *keep_test(const char *testname, void *unused) { struct ccanlint *i = find_test(testname); @@ -311,7 +303,7 @@ static char *keep_test(const char *testname, void *unused) static char *skip_test(const char *testname, void *unused) { - btree_insert(cmdline_exclude, optarg); + btree_insert(cmdline_exclude, testname); return NULL; } @@ -337,24 +329,102 @@ static char *list_tests(void *arg) exit(0); } -static char *strip(const void *ctx, const char *line) +static void test_dgraph_vertices(struct list_head *tests, const char *style) +{ + const struct ccanlint *i; + + list_for_each(tests, i, list) { + /* + * todo: escape labels in case ccanlint test keys have + * characters interpreted as GraphViz syntax. + */ + printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style); + } +} + +static void test_dgraph_edges(struct list_head *tests) +{ + const struct ccanlint *i; + const struct dependent *d; + + list_for_each(tests, i, list) + list_for_each(&i->dependencies, d, node) + printf("\t\"%p\" -> \"%p\"\n", d->dependent, i); +} + +static char *test_dependency_graph(void *arg) +{ + puts("digraph G {"); + + test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow"); + test_dgraph_vertices(&normal_tests, ""); + + test_dgraph_edges(&compulsory_tests); + test_dgraph_edges(&normal_tests); + + puts("}"); + + exit(0); +} + +/* Remove empty lines. */ +static char **collapse(char **lines, unsigned int *nump) { - line += strcspn(line, IDENT_CHARS "-"); - return talloc_strndup(ctx, line, strspn(line, IDENT_CHARS "-")); + unsigned int i, j; + for (i = j = 0; lines[i]; i++) { + if (lines[i][0]) + lines[j++] = lines[i]; + } + if (nump) + *nump = j; + return lines; } -static void add_info_fails(struct ccan_file *info) +static void add_info_options(struct ccan_file *info, bool mark_fails) { struct doc_section *d; unsigned int i; + struct ccanlint *test; list_for_each(get_ccan_file_docs(info), d, list) { - if (!streq(d->type, "fails")) + if (!streq(d->type, "ccanlint")) continue; - for (i = 0; i < d->num_lines; i++) - btree_insert(info_exclude, strip(info, d->lines[i])); - break; + for (i = 0; i < d->num_lines; i++) { + char **words = collapse(strsplit(d, d->lines[i], " \t", + NULL), NULL); + if (!words[0]) + continue; + + if (strncmp(words[0], "//", 2) == 0) + continue; + + test = find_test(words[0]); + if (!test) { + warnx("%s: unknown ccanlint test '%s'", + info->fullname, words[0]); + continue; + } + + if (!words[1]) { + warnx("%s: no argument to test '%s'", + info->fullname, words[0]); + continue; + } + + /* Known failure? */ + if (strcasecmp(words[1], "FAIL") == 0) { + if (mark_fails) + btree_insert(info_exclude, words[0]); + } else { + if (!test->takes_options) + warnx("%s: %s doesn't take options", + info->fullname, words[0]); + /* Copy line exactly into options. */ + test->options = strstr(d->lines[i], words[0]) + + strlen(words[0]); + } + } } } @@ -404,12 +474,14 @@ int main(int argc, char *argv[]) "do not compile anything"); opt_register_noarg("-l|--list-tests", list_tests, NULL, "list tests ccanlint performs (and exit)"); + opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL, + "print dependency graph of tests in Graphviz .dot format"); opt_register_arg("-k|--keep ", keep_test, NULL, NULL, "keep results of (can be used multiple times)"); opt_register_noarg("--summary|-s", opt_set_bool, &summary, "simply give one line summary"); opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose, - "verbose mode (can specify more than once)"); + "verbose mode (up to -vvvv)"); opt_register_arg("-x|--exclude ", skip_test, NULL, NULL, "exclude (can be used multiple times)"); opt_register_arg("-t|--timeout ", opt_set_uintval, @@ -427,11 +499,13 @@ int main(int argc, char *argv[]) if (dir[0] != '/') dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir); + while (strends(dir, "/")) + dir[strlen(dir)-1] = '\0'; if (dir != base_dir) prefix = talloc_append_string(talloc_basename(NULL, dir), ": "); - if (verbose >= 2) - compile_verbose = true; if (verbose >= 3) + compile_verbose = true; + if (verbose >= 4) tools_verbose = true; /* We move into temporary directory, so gcov dumps its files there. */ @@ -450,7 +524,7 @@ int main(int argc, char *argv[]) test = find_test(target); if (!test) - err(1, "Unknown test to run '%s'", target); + errx(1, "Unknown test to run '%s'", target); skip_unrelated_tests(test); } @@ -462,7 +536,9 @@ int main(int argc, char *argv[]) } } - add_info_fails(m->info_file); + /* --target overrides known FAIL from _info */ + add_info_options(m->info_file, !target); + while ((i = get_next_test(&normal_tests)) != NULL) run_test(i, summary, &score, &total_score, m);