]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.c
ccanlint: allow _info file to specify tests not to bother with.
[ccan] / tools / ccanlint / ccanlint.c
index 3555ad2a09d1ea083c1fba68aafbaed98f24cbc1..17c9f45957ced713dc39b2e36f75cbcb04903865 100644 (file)
 #include <ccan/str_talloc/str_talloc.h>
 #include <ccan/talloc/talloc.h>
 
-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 *exclude;
+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 <ms>] [-d <dirname>] [-x <tests>] [-k <test>]*\n"
-               "   -v: verbose mode\n"
+       fprintf(stderr, "Usage: %s [-s] [-n] [-v] [-t <ms>] [-d <dirname>] [-x <test>]* [-k <test>]*\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 (e.g. -x trailing_whitespace,valgrind)\n"
+               "   -x: exclude tests (can be used multiple times)\n"
                "   -t: ignore (terminate) tests that are slower than this\n",
                name);
        exit(1);
@@ -82,8 +83,11 @@ bool ask(const char *question)
 
 static const char *should_skip(struct manifest *m, struct ccanlint *i)
 {
-       if (btree_lookup(exclude, i->key))
+       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";
@@ -106,7 +110,7 @@ static bool run_test(struct ccanlint *i,
        unsigned int this_score, timeleft;
        const struct dependent *d;
        const char *skip;
-       bool failed;
+       bool bad, good;
 
        //one less test to run through
        list_for_each(&i->dependencies, d, node)
@@ -146,10 +150,12 @@ static bool run_test(struct ccanlint *i,
        else
                this_score = 0;
 
-       failed = (this_score == 0);
+       bad = (this_score == 0);
+       good = (this_score >= i->total_score);
 
-       if (verbose) {
-               printf("  %s: %s", i->name, failed ? "FAIL" : "OK");
+       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);
@@ -157,8 +163,9 @@ static bool run_test(struct ccanlint *i,
        }
 
        if (!quiet && result) {
-               if (i->describe && (failed || verbose))
-                       printf("    %s\n", i->describe(m, result));
+               const char *desc;
+               if (i->describe && (desc = i->describe(m, result)) != NULL) 
+                       printf("    %s\n", desc);
                if (i->handle)
                        i->handle(m, result);
        }
@@ -171,14 +178,14 @@ static bool run_test(struct ccanlint *i,
        list_del(&i->list);
        list_add_tail(&finished_tests, &i->list);
 
-       if (failed) {
+       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 !failed;
+       return good;
 }
 
 static void register_test(struct list_head *h, struct ccanlint *test, ...)
@@ -326,6 +333,27 @@ static void list_tests(void)
        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;
@@ -333,18 +361,23 @@ int main(int argc, char *argv[])
        unsigned int score = 0, total_score = 0;
        struct manifest *m;
        struct ccanlint *i;
-       const char *prefix = "", *dir = ".";
+       const char *prefix = "", *dir = talloc_getcwd(NULL);
        
        init_tests();
 
-       exclude = btree_new(btree_strcmp);
+       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':
-                       dir = optarg;
+                       if (optarg[0] != '/')
+                               dir = talloc_asprintf_append(NULL, "%s/%s",
+                                                            dir, optarg);
+                       else
+                               dir = optarg;
                        prefix = talloc_append_string(talloc_basename(NULL,
                                                                      optarg),
                                                      ": ");
@@ -363,12 +396,9 @@ int main(int argc, char *argv[])
                case 'k':
                        keep_test(optarg);
                        break;
-               case 'x': {
-                       char **exclude_strs = strsplit(NULL, optarg, ",", NULL);
-                       size_t i;
-                       for (i = 0; exclude_strs[i]; i++)
-                               btree_insert(exclude, exclude_strs[i]);
-               } break;
+               case 'x':
+                       btree_insert(cmdline_exclude, optarg);
+                       break;
                case 't':
                        timeout = atoi(optarg);
                        if (!timeout)
@@ -383,8 +413,20 @@ int main(int argc, char *argv[])
        if (optind < argc)
                usage(argv[0]);
 
+       if (verbose >= 3)
+               tools_verbose = true;
+
+       /* 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");
@@ -395,6 +437,8 @@ int main(int argc, char *argv[])
                }
        }
 
+       add_info_fails(m->info_file);
+
        if (verbose)
                printf("\nNormal tests:\n");
        while ((i = get_next_test(&normal_tests)) != NULL)