]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.c
ccanlint: override _info's Fails: with --target
[ccan] / tools / ccanlint / ccanlint.c
index ab805806144670e29dc01e05db63c80706c8030c..d09f68da19dc94932f4ba05d09a44d550e121608 100644 (file)
@@ -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 <ccan/str_talloc/str_talloc.h>
 #include <ccan/talloc/talloc.h>
 #include <ccan/opt/opt.h>
+#include <ccan/foreach/foreach.h>
 
 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, ...)
@@ -349,6 +365,32 @@ 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[])
 {
        bool summary = false;
@@ -356,7 +398,7 @@ 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();
 
@@ -374,12 +416,15 @@ int main(int argc, char *argv[])
        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 <testname>", skip_test, NULL, NULL,
                         "exclude <testname> (can be used multiple times)");
        opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
                         NULL, &timeout,
                         "ignore (terminate) tests that are slower than this");
+       opt_register_arg("--target <testname>", 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.",
@@ -391,9 +436,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 +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);