X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=d19ede6200e01ac2856c162f42c1c8f7c8936727;hp=1399edcbc0772dc9eb17a021ab03a772286b88fd;hb=b6425505ff03ea9336692adf0ebd5fa14560fb5f;hpb=156dfda864bc2a0fe2ba63f69c22864b2348876f diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 1399edcb..d19ede62 100644 --- a/tools/ccanlint/ccanlint.c +++ b/tools/ccanlint/ccanlint.c @@ -17,6 +17,7 @@ * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include "ccanlint.h" +#include "../tools.h" #include #include #include @@ -25,25 +26,36 @@ #include #include #include +#include +#include +#include #include -static unsigned int verbose = 0; +unsigned int verbose = 0; static LIST_HEAD(compulsory_tests); static LIST_HEAD(normal_tests); static LIST_HEAD(finished_tests); bool safe_mode = false; +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] [-d ]\n" - " -v: verbose mode\n" - " -s: simply give one line per FAIL and total score\n" + 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", + " -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) { while (*string) { @@ -56,6 +68,7 @@ static void indent_print(const char *string) string += line; } } +#endif bool ask(const char *question) { @@ -70,6 +83,12 @@ bool ask(const char *question) static const char *should_skip(struct manifest *m, struct ccanlint *i) { + if (btree_lookup(cmdline_exclude, i->key)) + return "excluded on command line"; + + if (btree_lookup(info_exclude, i->key)) + return "excluded in _info file"; + if (i->skip_fail) return "dependency failed"; @@ -82,22 +101,25 @@ static const char *should_skip(struct manifest *m, struct ccanlint *i) } static bool run_test(struct ccanlint *i, - bool summary, + bool quiet, unsigned int *score, unsigned int *total_score, struct manifest *m) { void *result; - unsigned int this_score; + unsigned int this_score, max_score, timeleft; const struct dependent *d; const char *skip; + bool bad, good; //one less test to run through list_for_each(&i->dependencies, d, node) d->dependent->num_depends--; skip = should_skip(m, i); + if (skip) { + skip: if (verbose) printf(" %s: skipped (%s)\n", i->name, skip); @@ -114,50 +136,59 @@ static bool run_test(struct ccanlint *i, return true; } - result = i->check(m); - if (!result) { - if (verbose) - printf(" %s: OK\n", i->name); - if (i->total_score) { - *score += i->total_score; - *total_score += i->total_score; - } - - list_del(&i->list); - list_add_tail(&finished_tests, &i->list); - return true; + timeleft = timeout ? timeout : default_timeout_ms; + result = i->check(m, i->keep_results, &timeleft); + if (timeout && timeleft == 0) { + skip = "timeout"; + goto skip; } - if (i->score) + 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; - list_del(&i->list); - list_add_tail(&finished_tests, &i->list); - - *total_score += i->total_score; - *score += this_score; - if (summary) { - printf("%s FAILED (%u/%u)\n", - i->name, this_score, i->total_score); + bad = (this_score == 0); + good = (this_score >= max_score); - if (verbose) - indent_print(i->describe(m, result)); - } else { - printf("%s\n", i->describe(m, result)); + 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); + 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); } - /* Skip any tests which depend on this one. */ - list_for_each(&i->dependencies, d, node) { - d->dependent->skip = true; - d->dependent->skip_fail = true; + if (i->total_score) { + *score += this_score; + *total_score += i->total_score; } - return false; + list_del(&i->list); + list_add_tail(&finished_tests, &i->list); + + if (bad) { + /* Skip any tests which depend on this one. */ + list_for_each(&i->dependencies, d, node) { + d->dependent->skip = true; + d->dependent->skip_fail = true; + } + } + return good; } static void register_test(struct list_head *h, struct ccanlint *test, ...) @@ -206,14 +237,34 @@ static inline struct ccanlint *get_next_test(struct list_head *test) static void init_tests(void) { const struct ccanlint *i; + struct btree *keys, *names; #undef REGISTER_TEST -#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__) +#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__, NULL) #include "generated-normal-tests" #undef REGISTER_TEST -#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__) +#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__, NULL) #include "generated-compulsory-tests" + /* 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); + } + btree_delete(keys); + btree_delete(names); + if (!verbose) return; @@ -240,22 +291,102 @@ static void init_tests(void) } } +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 void keep_test(const char *testname) +{ + struct ccanlint *i = find_test(testname); + if (!i) + errx(1, "No test %s to --keep", testname); + i->keep_results = true; +} + +static void print_tests(struct list_head *tests, const char *type) +{ + struct ccanlint *i; + + printf("%s tests:\n", type); + /* This makes them print in topological order. */ + while ((i = get_next_test(tests)) != NULL) { + const struct dependent *d; + printf(" %-25s %s\n", i->key, i->name); + list_del(&i->list); + list_for_each(&i->dependencies, d, node) + d->dependent->num_depends--; + } +} + +static void list_tests(void) +{ + print_tests(&compulsory_tests, "Compulsory"); + print_tests(&normal_tests, "Normal"); + exit(0); +} + +static char *strip(const void *ctx, const char *line) +{ + line += strcspn(line, IDENT_CHARS "-"); + return talloc_strndup(ctx, line, strspn(line, IDENT_CHARS "-")); +} + +static void add_info_fails(struct ccan_file *info) +{ + struct doc_section *d; + unsigned int i; + + list_for_each(get_ccan_file_docs(info), d, list) { + if (!streq(d->type, "fails")) + continue; + + for (i = 0; i < d->num_lines; i++) + btree_insert(info_exclude, strip(info, d->lines[i])); + break; + } +} + int main(int argc, char *argv[]) { int c; bool summary = false; - unsigned int score, total_score; + unsigned int score = 0, total_score = 0; struct manifest *m; struct ccanlint *i; + const char *prefix = "", *dir = talloc_getcwd(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: getopt_long ccan package? */ - while ((c = getopt(argc, argv, "sd:vn")) != -1) { + /* FIXME: popt ccan package? */ + while ((c = getopt(argc, argv, "sd:vnlx:t:k:")) != -1) { switch (c) { case 'd': - if (chdir(optarg) != 0) - err(1, "Changing into directory '%s'", optarg); + 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; @@ -265,6 +396,18 @@ int main(int argc, char *argv[]) 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]); } @@ -273,25 +416,39 @@ int main(int argc, char *argv[]) if (optind < argc) usage(argv[0]); - m = get_manifest(talloc_autofree_context()); + if (verbose >= 2) + compile_verbose = true; + if (verbose >= 3) + tools_verbose = true; - init_tests(); + /* We move into temporary directory, so gcov dumps its files there. */ + if (chdir(temp_dir(talloc_autofree_context())) != 0) + err(1, "Error changing to %s temporary dir", temp_dir(NULL)); + + m = get_manifest(talloc_autofree_context(), dir); + + /* Create a symlink from temp dir back to src dir's test directory. */ + if (symlink(talloc_asprintf(m, "%s/test", dir), + 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"); while ((i = get_next_test(&compulsory_tests)) != NULL) { - if (!run_test(i, summary, &score, &total_score, m)) - exit(1); + if (!run_test(i, summary, &score, &total_score, m)) { + errx(1, "%s%s failed", prefix, i->name); + } } + add_info_fails(m->info_file); + if (verbose) printf("\nNormal tests:\n"); - score = total_score = 0; while ((i = get_next_test(&normal_tests)) != NULL) run_test(i, summary, &score, &total_score, m); - printf("Total score: %u/%u\n", score, total_score); + printf("%sTotal score: %u/%u\n", prefix, score, total_score); return 0; }