X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=5b45f4d2f2b2ca7294f7e2859d76cd7409e63b19;hp=51962de8582f9a290b272e95b75cc19347065c51;hb=0ea24c2371174de37c61fe9af37201f21a67f50e;hpb=8d70667887ba081d76075e8959adafb22983b03a diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 51962de8..5b45f4d2 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 @@ -30,6 +31,7 @@ #include #include #include +#include int verbose = 0; static LIST_HEAD(compulsory_tests); @@ -57,7 +59,7 @@ static void indent_print(const char *string) bool ask(const char *question) { - char reply[2]; + char reply[80]; printf("%s ", question); fflush(stdout); @@ -74,12 +76,12 @@ static const char *should_skip(struct manifest *m, struct ccanlint *i) if (btree_lookup(info_exclude, i->key)) return "excluded in _info file"; + if (i->skip) + return i->skip; + if (i->skip_fail) return "dependency failed"; - if (i->skip) - return "dependency was skipped"; - if (i->can_run) return i->can_run(m); return NULL; @@ -87,93 +89,107 @@ static const char *should_skip(struct manifest *m, struct ccanlint *i) static bool run_test(struct ccanlint *i, bool quiet, - unsigned int *score, - unsigned int *total_score, + unsigned int *running_score, + unsigned int *running_total, struct manifest *m) { - void *result; - unsigned int this_score, max_score, timeleft; + unsigned int timeleft; const struct dependent *d; const char *skip; - bool bad, good; + struct score *score; //one less test to run through list_for_each(&i->dependencies, d, node) d->dependent->num_depends--; + score = talloc(m, struct score); + list_head_init(&score->per_file_errors); + score->error = NULL; + score->pass = false; + score->score = 0; + score->total = 1; + skip = should_skip(m, i); if (skip) { skip: - if (verbose) - printf(" %s: skipped (%s)\n", i->name, skip); + if (verbose && !streq(skip, "not relevant to target")) + printf("%s: skipped (%s)\n", i->name, skip); - /* If we're skipping this because a prereq failed, we fail. */ + /* If we're skipping this because a prereq failed, we fail: + * count it as a score of 1. */ if (i->skip_fail) - *total_score += i->total_score; + (*running_total)++; list_del(&i->list); list_add_tail(&finished_tests, &i->list); list_for_each(&i->dependencies, d, node) { - d->dependent->skip = true; + if (d->dependent->skip) + continue; + d->dependent->skip = "dependency was skipped"; d->dependent->skip_fail = i->skip_fail; } - return true; + return i->skip_fail ? false : true; } timeleft = timeout ? timeout : default_timeout_ms; - result = i->check(m, i->keep_results, &timeleft); + i->check(m, i->keep_results, &timeleft, score); if (timeout && timeleft == 0) { skip = "timeout"; goto skip; } - max_score = i->total_score; - if (!max_score) - max_score = 1; - - if (!result) - this_score = max_score; - else if (i->score) - this_score = i->score(m, result); - else - this_score = 0; - - bad = (this_score == 0); - good = (this_score >= max_score); - - if (verbose || (!good && !quiet)) { - printf(" %s: %s", i->name, - bad ? "FAIL" : good ? "PASS" : "PARTIAL"); - if (max_score > 1) - printf(" (+%u/%u)", this_score, max_score); + assert(score->score <= score->total); + if ((!score->pass && !quiet) + || (score->score < score->total && verbose) + || verbose > 1) { + printf("%s: %s", i->name, score->pass ? "PASS" : "FAIL"); + if (score->total > 1) + printf(" (+%u/%u)", score->score, score->total); printf("\n"); } - if (!quiet && result) { - const char *desc; - if (i->describe && (desc = i->describe(m, result)) != NULL) - printf(" %s\n", desc); - if (i->handle) - i->handle(m, result); + if ((!quiet && !score->pass) || verbose) { + struct file_error *f; + unsigned int lines = 1; + + if (score->error) + printf("%s%s\n", score->error, + list_empty(&score->per_file_errors) ? "" : ":"); + + 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 (verbose < 2 && ++lines > 5) { + printf("... more (use -vv to see them all)\n"); + break; + } + } + if (!quiet && !score->pass && i->handle) + i->handle(m, score); } - if (i->total_score) { - *score += this_score; - *total_score += i->total_score; - } + *running_score += score->score; + *running_total += score->total; list_del(&i->list); list_add_tail(&finished_tests, &i->list); - if (bad) { + if (!score->pass) { /* Skip any tests which depend on this one. */ list_for_each(&i->dependencies, d, node) { - d->dependent->skip = true; + if (d->dependent->skip) + continue; + d->dependent->skip = "dependency failed"; d->dependent->skip_fail = true; } } - return good; + return score->pass; } static void register_test(struct list_head *h, struct ccanlint *test, ...) @@ -302,7 +318,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; } @@ -328,25 +344,129 @@ 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]); + } + } + } +} + +static bool depends_on(struct ccanlint *i, struct ccanlint *target) +{ + const struct dependent *d; + + if (i == target) + return true; + + list_for_each(&i->dependencies, d, node) { + if (depends_on(d->dependent, target)) + return true; } + return false; +} + +/* O(N^2), who cares? */ +static void skip_unrelated_tests(struct ccanlint *target) +{ + struct ccanlint *i; + struct list_head *list; + + foreach_ptr(list, &compulsory_tests, &normal_tests) + list_for_each(list, i, list) + if (!depends_on(i, target)) + i->skip = "not relevant to target"; } int main(int argc, char *argv[]) @@ -356,31 +476,36 @@ int main(int argc, char *argv[]) struct manifest *m; struct ccanlint *i; const char *prefix = ""; - char *dir = talloc_getcwd(NULL), *base_dir = dir; + char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL; init_tests(); cmdline_exclude = btree_new(btree_strcmp); info_exclude = btree_new(btree_strcmp); - opt_register_arg("--dir/-d", opt_set_charp, opt_show_charp, &dir, + opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir, "use this directory"); - opt_register_noarg("-n/--safe-mode", opt_set_bool, &safe_mode, + opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode, "do not compile anything"); - opt_register_noarg("-l/--list-tests", list_tests, NULL, + opt_register_noarg("-l|--list-tests", list_tests, NULL, "list tests ccanlint performs (and exit)"); - opt_register_arg("-k/--keep ", keep_test, NULL, NULL, + 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, + 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)"); - opt_register_arg("-x/--exclude ", skip_test, NULL, NULL, + opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose, + "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, + opt_register_arg("-t|--timeout ", opt_set_uintval, NULL, &timeout, "ignore (terminate) tests that are slower than this"); - opt_register_noarg("-?/-h/--help", opt_usage_and_exit, + opt_register_arg("--target ", opt_set_charp, + NULL, &target, + "only run one test (and its prerequisites)"); + opt_register_noarg("-?|-h|--help", opt_usage_and_exit, "\nA program for checking and guiding development" " of CCAN modules.", "This usage message"); @@ -391,9 +516,9 @@ int main(int argc, char *argv[]) dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir); 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. */ @@ -407,20 +532,26 @@ int main(int argc, char *argv[]) talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0) err(1, "Creating test symlink in %s", temp_dir(NULL)); - /* If you don't pass the compulsory tests, you don't even get a score */ - if (verbose) - printf("Compulsory tests:\n"); + if (target) { + struct ccanlint *test; + + test = find_test(target); + if (!test) + errx(1, "Unknown test to run '%s'", target); + skip_unrelated_tests(test); + } + /* If you don't pass the compulsory tests, you get a score of 0. */ while ((i = get_next_test(&compulsory_tests)) != NULL) { if (!run_test(i, summary, &score, &total_score, m)) { + printf("%sTotal score: 0/%u\n", prefix, total_score); errx(1, "%s%s failed", prefix, i->name); } } - add_info_fails(m->info_file); + /* --target overrides known FAIL from _info */ + add_info_options(m->info_file, !target); - if (verbose) - printf("\nNormal tests:\n"); while ((i = get_next_test(&normal_tests)) != NULL) run_test(i, summary, &score, &total_score, m);