ccanlint: Add -k option to keep results.
[ccan] / tools / ccanlint / ccanlint.c
index 9b252735f8187c3f2c3fb554bccf160f61f2a3bc..b7aaef1c9fc0e1c915ec0bd4f8c65b266234e121 100644 (file)
@@ -17,6 +17,7 @@
  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 #include "ccanlint.h"
+#include "../tools.h"
 #include <unistd.h>
 #include <getopt.h>
 #include <stdarg.h>
@@ -25,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;
@@ -32,18 +36,25 @@ 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 per FAIL and total score\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);
 }
 
+#if 0
 static void indent_print(const char *string)
 {
        while (*string) {
@@ -56,6 +67,7 @@ static void indent_print(const char *string)
                string += line;
        }
 }
+#endif
 
 bool ask(const char *question)
 {
@@ -68,27 +80,75 @@ bool ask(const char *question)
                && toupper(reply[0]) == 'Y';
 }
 
+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";
+
+       if (i->skip)
+               return "dependency was skipped";
+
+       if (i->can_run)
+               return i->can_run(m);
+       return NULL;
+}
+
 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, timeleft;
        const struct dependent *d;
+       const char *skip;
 
-       if (i->total_score)
-               *total_score += i->total_score;
        //one less test to run through
        list_for_each(&i->dependencies, d, node)
                d->dependent->num_depends--;
-       result = i->check(m);
-       if (!result) {
+
+       skip = should_skip(m, i);
+
+       if (skip) {
+       skip:
                if (verbose)
-                       printf("  %s: OK\n", i->name);
-               if (i->total_score)
+                       printf("  %s: skipped (%s)\n", i->name, skip);
+
+               /* If we're skipping this because a prereq failed, we fail. */
+               if (i->skip_fail)
+                       *total_score += i->total_score;
+                       
+               list_del(&i->list);
+               list_add_tail(&finished_tests, &i->list);
+               list_for_each(&i->dependencies, d, node) {
+                       d->dependent->skip = true;
+                       d->dependent->skip_fail = i->skip_fail;
+               }
+               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 (!result) {
+               if (verbose) {
+                       printf("  %s: OK", i->name);
+                       if (i->total_score)
+                               printf(" (+%u/%u)",
+                                      i->total_score, i->total_score);
+                       printf("\n");
+               }
+               if (i->total_score) {
                        *score += i->total_score;
+                       *total_score += i->total_score;
+               }
 
                list_del(&i->list);
                list_add_tail(&finished_tests, &i->list);
@@ -100,37 +160,38 @@ static bool run_test(struct ccanlint *i,
        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",
+       if (verbose) {
+               printf("  %s: FAIL (+%u/%u)\n",
                       i->name, this_score, i->total_score);
+       }
+       if (!quiet) {
+               printf("%s\n", i->describe(m, result));
 
-               if (verbose)
-                       indent_print(i->describe(m, result));
-               list_del(&i->list);
-               list_add_tail(&finished_tests, &i->list);
-               return false;
+               if (i->handle)
+                       i->handle(m, result);
        }
 
-       printf("%s\n", i->describe(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->handle)
-               i->handle(m, result);
-       list_del(&i->list);
-       list_add_tail(&finished_tests, &i->list);
        return false;
 }
 
-static void register_test(struct ccanlint *test, ...)
+static void register_test(struct list_head *h, struct ccanlint *test, ...)
 {
        va_list ap;
        struct ccanlint *depends;
        struct dependent *dchild;
 
-       if (!test->total_score)
-               list_add(&compulsory_tests, &test->list);
-       else
-               list_add(&normal_tests, &test->list);
+       list_add(h, &test->list);
 
        va_start(ap, test);
        /* Careful: we might have been initialized by a dependent. */
@@ -170,11 +231,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(&name, __VA_ARGS__)
-#include "generated-init-tests"
+#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__)
+#include "generated-normal-tests"
+#undef REGISTER_TEST
+#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;
 
@@ -201,22 +285,76 @@ 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;
        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 = ".";
+       
+       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':
-                       if (chdir(optarg) != 0)
-                               err(1, "Changing into directory '%s'", optarg);
+                       dir = optarg;
+                       prefix = talloc_append_string(talloc_basename(NULL,
+                                                                     optarg),
+                                                     ": ");
                        break;
+               case 'l':
+                       list_tests();
                case 's':
                        summary = true;
                        break;
@@ -226,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]);
                }
@@ -234,26 +387,23 @@ int main(int argc, char *argv[])
        if (optind < argc)
                usage(argv[0]);
 
-       m = get_manifest(talloc_autofree_context());
-
-       init_tests();
+       m = get_manifest(talloc_autofree_context(), dir);
 
        /* 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);
+               }
        }
 
        if (verbose)
                printf("\nNormal tests:\n");
-       score = total_score = 0;
-       while ((i = get_next_test(&normal_tests)) != NULL) {
-               if (i->total_score)
-                       run_test(i, summary, &score, &total_score, m);
-       }
-       printf("Total score: %u/%u\n", score, total_score);
+       while ((i = get_next_test(&normal_tests)) != NULL)
+               run_test(i, summary, &score, &total_score, m);
+
+       printf("%sTotal score: %u/%u\n", prefix, score, total_score);
        return 0;
 }