/*
* ccanlint: assorted checks and advice for a ccan package
- * Copyright (C) 2008 Rusty Russell
+ * 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
* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "ccanlint.h"
+#include "../tools.h"
#include <unistd.h>
-#include <getopt.h>
-#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#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>
+#include <ccan/opt/opt.h>
+#include <ccan/foreach/foreach.h>
-static unsigned int verbose = 0;
-static LIST_HEAD(tests);
+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 *cmdline_exclude;
+static struct btree *info_exclude;
+static unsigned int timeout;
-static void usage(const char *name)
-{
- fprintf(stderr, "Usage: %s [-s] [-v] [-d <dirname>]\n"
- " -v: verbose mode\n"
- " -s: simply give one line per FAIL and total score\n"
- " -d: use this directory instead of the current one\n",
- name);
- exit(1);
-}
-
+#if 0
static void indent_print(const char *string)
{
while (*string) {
string += line;
}
}
+#endif
bool ask(const char *question)
{
- char reply[2];
+ char reply[80];
printf("%s ", question);
fflush(stdout);
&& toupper(reply[0]) == 'Y';
}
-static bool run_test(const struct ccanlint *i,
- bool summary,
- unsigned int *score,
- unsigned int *total_score,
+static const char *should_skip(struct manifest *m, struct ccanlint *i)
+{
+ 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)
+ return i->skip;
+
+ if (i->skip_fail)
+ return "dependency failed";
+
+ if (i->can_run)
+ return i->can_run(m);
+ return NULL;
+}
+
+static bool run_test(struct ccanlint *i,
+ bool quiet,
+ unsigned int *running_score,
+ unsigned int *running_total,
struct manifest *m)
{
- void *result;
- unsigned int this_score;
+ unsigned int timeleft;
+ const struct dependent *d;
+ const char *skip;
+ struct score *score;
- 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) {
- if (verbose)
- printf(" %s: OK\n", i->name);
- if (i->total_score)
- *score += i->total_score;
- return true;
+ 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 && !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:
+ * count it as a score of 1. */
+ if (i->skip_fail)
+ (*running_total)++;
+
+ list_del(&i->list);
+ list_add_tail(&finished_tests, &i->list);
+ list_for_each(&i->dependencies, d, node) {
+ if (d->dependent->skip)
+ continue;
+ d->dependent->skip = "dependency was skipped";
+ d->dependent->skip_fail = i->skip_fail;
+ }
+ return i->skip_fail ? false : true;
}
- if (i->score)
- this_score = i->score(m, result);
- else
- this_score = 0;
+ timeleft = timeout ? timeout : default_timeout_ms;
+ i->check(m, i->keep_results, &timeleft, score);
+ if (timeout && timeleft == 0) {
+ skip = "timeout";
+ goto skip;
+ }
- *score += this_score;
- if (summary) {
- printf("%s FAILED (%u/%u)\n",
- i->name, this_score, i->total_score);
+ assert(score->score <= score->total);
+ if ((!score->pass && !quiet)
+ || (score->score < score->total && verbose)
+ || verbose > 1) {
+ 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 (verbose)
- indent_print(i->describe(m, result));
- return false;
+ if ((!quiet && !score->pass) || verbose) {
+ if (score->error) {
+ printf("%s%s", score->error,
+ strends(score->error, "\n") ? "" : "\n");
+ }
+ if (!quiet && !score->pass && i->handle)
+ i->handle(m, score);
}
- printf("%s\n", i->describe(m, result));
+ *running_score += score->score;
+ *running_total += score->total;
- if (i->handle)
- i->handle(m, result);
+ list_del(&i->list);
+ list_add_tail(&finished_tests, &i->list);
- return false;
+ if (!score->pass) {
+ /* Skip any tests which depend on this one. */
+ list_for_each(&i->dependencies, d, node) {
+ if (d->dependent->skip)
+ continue;
+ d->dependent->skip = "dependency failed";
+ d->dependent->skip_fail = true;
+ }
+ }
+ return score->pass;
}
-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;
+ list_add(h, &test->list);
+}
+
+/**
+ * get_next_test - retrieves the next test to be processed
+ **/
+static inline struct ccanlint *get_next_test(struct list_head *test)
+{
+ struct ccanlint *i;
- list_add(&tests, &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);
+ if (list_empty(test))
+ return NULL;
- //dependant(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++;
+ list_for_each(test, i, list) {
+ if (i->num_depends == 0)
+ return i;
}
- va_end(ap);
+ 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(&name, __VA_ARGS__)
-#include "generated-init-tests"
+#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)
+#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, " ");
+ 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);
+ 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;
- list_for_each(&tests, i, list) {
- printf("%s depends on %u others\n", i->name, i->num_depends);
- if (!list_empty(&i->dependencies)) {
+ foreach_ptr(list, &compulsory_tests, &normal_tests) {
+ printf("\%s Tests\n",
+ list == &compulsory_tests ? "Compulsory" : "Normal");
+
+ 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);
}
}
}
-int main(int argc, char *argv[])
+static int show_tmpdir(char *dir)
+{
+ printf("You can find ccanlint working files in '%s'\n", dir);
+ return 0;
+}
+
+static char *keep_test(const char *testname, void *unused)
+{
+ struct ccanlint *i;
+
+ if (streq(testname, "all")) {
+ struct list_head *list;
+ foreach_ptr(list, &compulsory_tests, &normal_tests) {
+ list_for_each(list, i, list)
+ i->keep_results = true;
+ }
+ } else {
+ i = find_test(testname);
+ 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;
+}
+
+static char *skip_test(const char *testname, void *unused)
+{
+ btree_insert(cmdline_exclude, testname);
+ return NULL;
+}
+
+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 char *list_tests(void *arg)
+{
+ print_tests(&compulsory_tests, "Compulsory");
+ print_tests(&normal_tests, "Normal");
+ exit(0);
+}
+
+static void test_dgraph_vertices(struct list_head *tests, const char *style)
{
- int c;
- bool summary = false;
- unsigned int score, total_score;
- struct manifest *m;
const struct ccanlint *i;
- /* I'd love to use long options, but that's not standard. */
- /* FIXME: getopt_long ccan package? */
- while ((c = getopt(argc, argv, "sd:v")) != -1) {
- switch (c) {
- case 'd':
- if (chdir(optarg) != 0)
- err(1, "Changing into directory '%s'", optarg);
- break;
- case 's':
- summary = true;
- break;
- case 'v':
- verbose++;
- break;
- default:
- usage(argv[0]);
+ 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)
+{
+ unsigned int i, j;
+ for (i = j = 0; lines[i]; i++) {
+ if (lines[i][0])
+ lines[j++] = lines[i];
+ }
+ if (nump)
+ *nump = j;
+ return lines;
+}
+
+static void add_info_options(struct ccan_file *info, bool mark_fails)
+{
+ struct doc_section *d;
+ unsigned int i;
+ struct ccanlint *test;
+
+ list_for_each(get_ccan_file_docs(info), d, list) {
+ if (!streq(d->type, "ccanlint"))
+ continue;
+
+ for (i = 0; i < d->num_lines; i++) {
+ char **words = collapse(strsplit(d, d->lines[i], " \t"),
+ NULL);
+ if (!words[0])
+ continue;
+
+ if (strncmp(words[0], "//", 2) == 0)
+ continue;
+
+ test = find_test(words[0]);
+ if (!test) {
+ warnx("%s: unknown ccanlint test '%s'",
+ info->fullname, words[0]);
+ continue;
+ }
+
+ if (!words[1]) {
+ warnx("%s: no argument to test '%s'",
+ info->fullname, words[0]);
+ continue;
+ }
+
+ /* Known failure? */
+ if (strcasecmp(words[1], "FAIL") == 0) {
+ if (mark_fails)
+ btree_insert(info_exclude, words[0]);
+ } else {
+ if (!test->takes_options)
+ warnx("%s: %s doesn't take options",
+ info->fullname, words[0]);
+ /* Copy line exactly into options. */
+ test->options = strstr(d->lines[i], words[0])
+ + strlen(words[0]);
+ }
}
}
+}
- if (optind < argc)
- usage(argv[0]);
+static bool depends_on(struct ccanlint *i, struct ccanlint *target)
+{
+ const struct dependent *d;
- m = get_manifest();
+ 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;
+ unsigned int score = 0, total_score = 0;
+ struct manifest *m;
+ struct ccanlint *i;
+ const char *prefix = "";
+ char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
+
init_tests();
- /* If you don't pass the compulsory tests, you don't even get a score */
- if (verbose)
- printf("Compulsory tests:\n");
- list_for_each(&tests, i, list)
- if (!i->total_score)
- if (!run_test(i, summary, &score, &total_score, m))
- exit(1);
+ cmdline_exclude = btree_new(btree_strcmp);
+ info_exclude = btree_new(btree_strcmp);
+
+ opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
+ "use this directory");
+ opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
+ "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, or 'all')");
+ 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 (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.",
+ "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)
+ compile_verbose = true;
+ if (verbose >= 4)
+ tools_verbose = true;
+
+ 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 (target) {
+ struct ccanlint *test;
+
+ test = find_test(target);
+ if (!test)
+ errx(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);
+ }
+ }
- if (verbose)
- printf("\nNormal tests:\n");
- score = total_score = 0;
- list_for_each(&tests, i, list)
- if (i->total_score)
- run_test(i, summary, &score, &total_score, m);
+ /* --target overrides known FAIL from _info */
+ add_info_options(m->info_file, !target);
- 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;
}
projects / ccan / blobdiff