X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=d09f68da19dc94932f4ba05d09a44d550e121608;hp=8f4c5fe0aa959c8a410f004307735da78543ac72;hb=7ddfc6696d29eacb3d4d896aac93721aee45d844;hpb=e84320817ba6480a675de9ac5e261d0b2bea19f8 diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 8f4c5fe0..d09f68da 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 @@ -30,8 +30,10 @@ #include #include #include +#include +#include -unsigned int verbose = 0; +int verbose = 0; static LIST_HEAD(compulsory_tests); static LIST_HEAD(normal_tests); static LIST_HEAD(finished_tests); @@ -40,21 +42,6 @@ static struct btree *cmdline_exclude; static struct btree *info_exclude; static unsigned int timeout; -static void usage(const char *name) -{ - fprintf(stderr, "Usage: %s [-s] [-n] [-v] [-t ] [-d ] [-x ]* [-k ]*\n" - " -v: verbose mode (can specify more than once)\n" - " -s: simply give one line summary\n" - " -d: use this directory instead of the current one\n" - " -n: do not compile anything\n" - " -l: list tests ccanlint performs\n" - " -k: keep results of this test (can be used multiple times)\n" - " -x: exclude tests (can be used multiple times)\n" - " -t: ignore (terminate) tests that are slower than this\n", - name); - exit(1); -} - #if 0 static void indent_print(const char *string) { @@ -72,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); @@ -89,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; @@ -102,90 +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, 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; } - if (!result) - this_score = i->total_score ? i->total_score : 1; - else if (i->score) - this_score = i->score(m, result); - else - this_score = 0; - - bad = (this_score == 0); - good = (this_score >= i->total_score); - - if (verbose || (bad && !quiet)) { - printf(" %s: %s", i->name, - bad ? "FAIL" : good ? "PASS" : "PARTIAL"); - if (i->total_score) - printf(" (+%u/%u)", - this_score, i->total_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) ? "" : ":"); - if (i->total_score) { - *score += this_score; - *total_score += i->total_score; + 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); } + *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, ...) @@ -303,12 +307,19 @@ static struct ccanlint *find_test(const char *key) return NULL; } -static void keep_test(const char *testname) +static char *keep_test(const char *testname, void *unused) { struct ccanlint *i = find_test(testname); if (!i) errx(1, "No test %s to --keep", testname); i->keep_results = true; + return NULL; +} + +static char *skip_test(const char *testname, void *unused) +{ + btree_insert(cmdline_exclude, optarg); + return NULL; } static void print_tests(struct list_head *tests, const char *type) @@ -326,7 +337,7 @@ static void print_tests(struct list_head *tests, const char *type) } } -static void list_tests(void) +static char *list_tests(void *arg) { print_tests(&compulsory_tests, "Compulsory"); print_tests(&normal_tests, "Normal"); @@ -354,68 +365,80 @@ static void add_info_fails(struct ccan_file *info) } } +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[]) { - int c; bool summary = false; unsigned int score = 0, total_score = 0; struct manifest *m; struct ccanlint *i; - const char *prefix = "", *dir = talloc_getcwd(NULL); + const char *prefix = ""; + char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL; init_tests(); cmdline_exclude = btree_new(btree_strcmp); info_exclude = btree_new(btree_strcmp); - /* I'd love to use long options, but that's not standard. */ - /* FIXME: popt ccan package? */ - while ((c = getopt(argc, argv, "sd:vnlx:t:k:")) != -1) { - switch (c) { - case 'd': - if (optarg[0] != '/') - dir = talloc_asprintf_append(NULL, "%s/%s", - dir, optarg); - else - dir = optarg; - prefix = talloc_append_string(talloc_basename(NULL, - optarg), - ": "); - break; - case 'l': - list_tests(); - case 's': - summary = true; - break; - case 'v': - verbose++; - break; - case 'n': - safe_mode = true; - break; - case 'k': - keep_test(optarg); - break; - case 'x': - btree_insert(cmdline_exclude, optarg); - break; - case 't': - timeout = atoi(optarg); - if (!timeout) - errx(1, "Invalid timeout %s: 1 ms minumum", - optarg); - break; - default: - usage(argv[0]); - } - } - - if (optind < argc) - usage(argv[0]); - - if (verbose >= 2) - compile_verbose = true; + 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, + "do not compile anything"); + opt_register_noarg("-l|--list-tests", list_tests, NULL, + "list tests ccanlint performs (and exit)"); + 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 (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, + NULL, &timeout, + "ignore (terminate) tests that are slower than this"); + 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"); + + opt_parse(&argc, argv, opt_log_stderr_exit); + + if (dir[0] != '/') + dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir); + if (dir != base_dir) + prefix = talloc_append_string(talloc_basename(NULL, dir), ": "); if (verbose >= 3) + compile_verbose = true; + if (verbose >= 4) tools_verbose = true; /* We move into temporary directory, so gcov dumps its files there. */ @@ -429,20 +452,27 @@ 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) + err(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 _info excludes */ + if (!target) + add_info_fails(m->info_file); - if (verbose) - printf("\nNormal tests:\n"); while ((i = get_next_test(&normal_tests)) != NULL) run_test(i, summary, &score, &total_score, m);