ccanlint: Add -k option to keep results.
[ccan] / tools / ccanlint / ccanlint.c
index 330866d15f1f9365ba336893bb7e36382ccb55fa..b7aaef1c9fc0e1c915ec0bd4f8c65b266234e121 100644 (file)
@@ -26,6 +26,9 @@
 #include <string.h>
 #include <err.h>
 #include <ctype.h>
+#include <ccan/btree/btree.h>
+#include <ccan/str/str.h>
+#include <ccan/str_talloc/str_talloc.h>
 #include <ccan/talloc/talloc.h>
 
 static unsigned int verbose = 0;
@@ -33,14 +36,20 @@ static LIST_HEAD(compulsory_tests);
 static LIST_HEAD(normal_tests);
 static LIST_HEAD(finished_tests);
 bool safe_mode = false;
+static struct btree *exclude;
+static unsigned int timeout;
 
 static void usage(const char *name)
 {
-       fprintf(stderr, "Usage: %s [-s] [-n] [-v] [-d <dirname>]\n"
+       fprintf(stderr, "Usage: %s [-s] [-n] [-v] [-t <ms>] [-d <dirname>] [-x <tests>] [-k <test>]*\n"
                "   -v: verbose mode\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 (e.g. -x trailing_whitespace,valgrind)\n"
+               "   -t: ignore (terminate) tests that are slower than this\n",
                name);
        exit(1);
 }
@@ -73,6 +82,9 @@ bool ask(const char *question)
 
 static const char *should_skip(struct manifest *m, struct ccanlint *i)
 {
+       if (btree_lookup(exclude, i->key))
+               return "excluded on command line";
+       
        if (i->skip_fail)
                return "dependency failed";
 
@@ -91,7 +103,7 @@ static bool run_test(struct ccanlint *i,
                     struct manifest *m)
 {
        void *result;
-       unsigned int this_score;
+       unsigned int this_score, timeleft;
        const struct dependent *d;
        const char *skip;
 
@@ -100,7 +112,9 @@ static bool run_test(struct ccanlint *i,
                d->dependent->num_depends--;
 
        skip = should_skip(m, i);
+
        if (skip) {
+       skip:
                if (verbose)
                        printf("  %s: skipped (%s)\n", i->name, skip);
 
@@ -117,7 +131,12 @@ static bool run_test(struct ccanlint *i,
                return true;
        }
 
-       result = i->check(m);
+       timeleft = timeout ? timeout : default_timeout_ms;
+       result = i->check(m, i->keep_results, &timeleft);
+       if (timeout && timeleft == 0) {
+               skip = "timeout";
+               goto skip;
+       }
        if (!result) {
                if (verbose) {
                        printf("  %s: OK", i->name);
@@ -212,6 +231,7 @@ 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__)
@@ -220,6 +240,25 @@ static void init_tests(void)
 #define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__)
 #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;
 
@@ -246,6 +285,51 @@ 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);
+}
+
 int main(int argc, char *argv[])
 {
        int c;
@@ -254,10 +338,14 @@ int main(int argc, char *argv[])
        struct manifest *m;
        struct ccanlint *i;
        const char *prefix = "", *dir = ".";
+       
+       init_tests();
+
+       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) {
+       while ((c = getopt(argc, argv, "sd:vnlx:t:k:")) != -1) {
                switch (c) {
                case 'd':
                        dir = optarg;
@@ -265,6 +353,8 @@ int main(int argc, char *argv[])
                                                                      optarg),
                                                      ": ");
                        break;
+               case 'l':
+                       list_tests();
                case 's':
                        summary = true;
                        break;
@@ -274,6 +364,21 @@ int main(int argc, char *argv[])
                case 'n':
                        safe_mode = true;
                        break;
+               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 't':
+                       timeout = atoi(optarg);
+                       if (!timeout)
+                               errx(1, "Invalid timeout %s: 1 ms minumum",
+                                    optarg);
+                       break;
                default:
                        usage(argv[0]);
                }
@@ -284,8 +389,6 @@ int main(int argc, char *argv[])
 
        m = get_manifest(talloc_autofree_context(), dir);
 
-       init_tests();
-
        /* If you don't pass the compulsory tests, you don't even get a score */
        if (verbose)
                printf("Compulsory tests:\n");