]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.c
ccanlint: -k should not pollute module directory.
[ccan] / tools / ccanlint / ccanlint.c
index 58ca1f537d7d0d3f5d75058b534edac722016d3c..42da05afad85719a09ebe66f9bb0d9849608d96b 100644 (file)
@@ -20,7 +20,6 @@
 #include "ccanlint.h"
 #include "../tools.h"
 #include <unistd.h>
-#include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -143,33 +142,15 @@ static bool run_test(struct ccanlint *i,
        if ((!score->pass && !quiet)
            || (score->score < score->total && verbose)
            || verbose > 1) {
-               printf("%s: %s", i->name, score->pass ? "PASS" : "FAIL");
+               printf("%s (%s): %s", i->name, i->key, score->pass ? "PASS" : "FAIL");
                if (score->total > 1)
                        printf(" (+%u/%u)", score->score, score->total);
                printf("\n");
        }
 
        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;
-                       }
-               }
+                       printf("%s", score->error);
                if (!quiet && !score->pass && i->handle)
                        i->handle(m, score);
        }
@@ -192,30 +173,9 @@ static bool run_test(struct ccanlint *i,
        return score->pass;
 }
 
-static void register_test(struct list_head *h, struct ccanlint *test, ...)
+static void register_test(struct list_head *h, struct ccanlint *test)
 {
-       va_list ap;
-       struct ccanlint *depends;
-       struct dependent *dchild;
-
        list_add(h, &test->list);
-
-       va_start(ap, test);
-       /* Careful: we might have been initialized by a dependent. */
-       if (test->dependencies.n.next == NULL)
-               list_head_init(&test->dependencies);
-
-       //dependent(s) args (if any), last one is NULL
-       while ((depends = va_arg(ap, struct ccanlint *)) != NULL) {
-               dchild = malloc(sizeof(*dchild));
-               dchild->dependent = test;
-               /* The thing we depend on might not be initialized yet! */
-               if (depends->dependencies.n.next == NULL)
-                       list_head_init(&depends->dependencies);
-               list_add_tail(&depends->dependencies, &dchild->node);
-               test->num_depends++;
-       }
-       va_end(ap);
 }
 
 /**
@@ -235,76 +195,107 @@ static inline struct ccanlint *get_next_test(struct list_head *test)
        errx(1, "Can't make process; test dependency cycle");
 }
 
+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;
+}
+
+#undef REGISTER_TEST
+#define REGISTER_TEST(name, ...) extern struct ccanlint name
+#include "generated-normal-tests"
+#include "generated-compulsory-tests"
+
 static void init_tests(void)
 {
-       const struct ccanlint *i;
+       struct ccanlint *c;
        struct btree *keys, *names;
+       struct list_head *list;
 
 #undef REGISTER_TEST
-#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__, NULL)
+#define REGISTER_TEST(name) register_test(&normal_tests, &name)
 #include "generated-normal-tests"
 #undef REGISTER_TEST
-#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__, NULL)
+#define REGISTER_TEST(name) register_test(&compulsory_tests, &name)
 #include "generated-compulsory-tests"
 
+       /* Initialize dependency lists. */
+       foreach_ptr(list, &compulsory_tests, &normal_tests) {
+               list_for_each(list, c, list) {
+                       list_head_init(&c->dependencies);
+               }
+       }
+
+       /* Resolve dependencies. */
+       foreach_ptr(list, &compulsory_tests, &normal_tests) {
+               list_for_each(list, c, list) {
+                       char **deps = strsplit(NULL, c->needs, " ", NULL);
+                       unsigned int i;
+
+                       for (i = 0; deps[i]; i++) {
+                               struct ccanlint *dep;
+                               struct dependent *dchild;
+
+                               dep = find_test(deps[i]);
+                               if (!dep)
+                                       errx(1, "BUG: unknown dep '%s' for %s",
+                                            deps[i], c->key);
+                               dchild = talloc(NULL, struct dependent);
+                               dchild->dependent = c;
+                               list_add_tail(&dep->dependencies,
+                                             &dchild->node);
+                               c->num_depends++;
+                       }
+                       talloc_free(deps);
+               }
+       }
+
        /* 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);
+       foreach_ptr(list, &compulsory_tests, &normal_tests) {
+               list_for_each(list, c, list) {
+                       if (!btree_insert(keys, c->key))
+                               errx(1, "BUG: Duplicate test key '%s'",
+                                    c->key);
+                       if (!btree_insert(names, c->name))
+                               errx(1, "BUG: Duplicate test name '%s'",
+                                    c->name);
+               }
        }
        btree_delete(keys);
        btree_delete(names);
-       
+
        if (!verbose)
                return;
 
-       printf("\nCompulsory Tests\n");
-       list_for_each(&compulsory_tests, i, list) {
-               printf("%s depends on %u others\n", i->name, i->num_depends);
-               if (!list_empty(&i->dependencies)) {
-                       const struct dependent *d;
-                       printf("These depend on us:\n");
-                       list_for_each(&i->dependencies, d, node)
-                               printf("\t%s\n", d->dependent->name);
-               }
-       }
+       foreach_ptr(list, &compulsory_tests, &normal_tests) {
+               printf("\%s Tests\n",
+                      list == &compulsory_tests ? "Compulsory" : "Normal");
 
-       printf("\nNormal Tests\n");
-       list_for_each(&normal_tests, i, list) {
-               printf("%s depends on %u others\n", i->name, i->num_depends);
-               if (!list_empty(&i->dependencies)) {
+               if (!list_empty(&c->dependencies)) {
                        const struct dependent *d;
                        printf("These depend on us:\n");
-                       list_for_each(&i->dependencies, d, node)
+                       list_for_each(&c->dependencies, d, node)
                                printf("\t%s\n", d->dependent->name);
                }
        }
 }
 
-static struct ccanlint *find_test(const char *key)
+static int show_tmpdir(char *dir)
 {
-       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;
+       printf("You can find ccanlint working files in '%s'\n", dir);
+       return 0;
 }
 
 static char *keep_test(const char *testname, void *unused)
@@ -313,6 +304,9 @@ static char *keep_test(const char *testname, void *unused)
        if (!i)
                errx(1, "No test %s to --keep", testname);
        i->keep_results = true;
+
+       /* Don't automatically destroy temporary dir. */
+       talloc_set_destructor(temp_dir(NULL), show_tmpdir);
        return NULL;
 }
 
@@ -344,6 +338,44 @@ static char *list_tests(void *arg)
        exit(0);
 }
 
+static void test_dgraph_vertices(struct list_head *tests, const char *style)
+{
+       const struct ccanlint *i;
+
+       list_for_each(tests, i, list) {
+               /*
+                * todo: escape labels in case ccanlint test keys have
+                *       characters interpreted as GraphViz syntax.
+                */
+               printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style);
+       }
+}
+
+static void test_dgraph_edges(struct list_head *tests)
+{
+       const struct ccanlint *i;
+       const struct dependent *d;
+
+       list_for_each(tests, i, list)
+               list_for_each(&i->dependencies, d, node)
+                       printf("\t\"%p\" -> \"%p\"\n", d->dependent, i);
+}
+
+static char *test_dependency_graph(void *arg)
+{
+       puts("digraph G {");
+
+       test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow");
+       test_dgraph_vertices(&normal_tests,     "");
+
+       test_dgraph_edges(&compulsory_tests);
+       test_dgraph_edges(&normal_tests);
+
+       puts("}");
+
+       exit(0);
+}
+
 /* Remove empty lines. */
 static char **collapse(char **lines, unsigned int *nump)
 {
@@ -451,6 +483,8 @@ int main(int argc, char *argv[])
                         "do not compile anything");
        opt_register_noarg("-l|--list-tests", list_tests, NULL,
                         "list tests ccanlint performs (and exit)");
+       opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
+                        "print dependency graph of tests in Graphviz .dot format");
        opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
                           "keep results of <testname> (can be used multiple times)");
        opt_register_noarg("--summary|-s", opt_set_bool, &summary,
@@ -470,10 +504,16 @@ int main(int argc, char *argv[])
                           " of CCAN modules.",
                           "This usage message");
 
+       /* 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));
+
        opt_parse(&argc, argv, opt_log_stderr_exit);
 
        if (dir[0] != '/')
                dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
+       while (strends(dir, "/"))
+               dir[strlen(dir)-1] = '\0';
        if (dir != base_dir)
                prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
        if (verbose >= 3)
@@ -481,10 +521,6 @@ int main(int argc, char *argv[])
        if (verbose >= 4)
                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. */
@@ -497,7 +533,7 @@ int main(int argc, char *argv[])
 
                test = find_test(target);
                if (!test)
-                       err(1, "Unknown test to run '%s'", target);
+                       errx(1, "Unknown test to run '%s'", target);
                skip_unrelated_tests(test);
        }