X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=3ffe38b2cf5f3ff54629515e76dc4b2acf1850e0;hp=179f270344cd00a4a8109e18384bb6d555bf5d21;hb=8ffd9b98c7f87177445a86e65334e5ad1d66a8af;hpb=0b8137768bbfe8b078763b44d5e3dec52ad60e0f

diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c
index 179f2703..3ffe38b2 100644
--- a/tools/ccanlint/ccanlint.c
+++ b/tools/ccanlint/ccanlint.c
@@ -1,6 +1,7 @@
 /*
  * ccanlint: assorted checks and advice for a ccan package
  * 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
@@ -19,8 +20,6 @@
 #include "ccanlint.h"
 #include "../tools.h"
 #include <unistd.h>
-#include <getopt.h>
-#include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -30,30 +29,18 @@
 #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>
 
-unsigned int verbose = 0;
+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 (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"
-		"   -t: ignore (terminate) tests that are slower than this\n",
-		name);
-	exit(1);
-}
-
 #if 0
 static void indent_print(const char *string)
 {
@@ -71,7 +58,7 @@ static void indent_print(const char *string)
 
 bool ask(const char *question)
 {
-	char reply[2];
+	char reply[80];
 
 	printf("%s ", question);
 	fflush(stdout);
@@ -82,15 +69,18 @@ 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)
+		return i->skip;
+
 	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;
@@ -98,116 +88,94 @@ static const char *should_skip(struct manifest *m, struct ccanlint *i)
 
 static bool run_test(struct ccanlint *i,
 		     bool quiet,
-		     unsigned int *score,
-		     unsigned int *total_score,
+		     unsigned int *running_score,
+		     unsigned int *running_total,
 		     struct manifest *m)
 {
-	void *result;
-	unsigned int this_score, timeleft;
+	unsigned int timeleft;
 	const struct dependent *d;
 	const char *skip;
-	bool bad, good;
+	struct score *score;
 
 	//one less test to run through
 	list_for_each(&i->dependencies, d, node)
 		d->dependent->num_depends--;
 
+	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)
-			printf("  %s: skipped (%s)\n", i->name, 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. */
+		/* If we're skipping this because a prereq failed, we fail:
+		 * count it as a score of 1. */
 		if (i->skip_fail)
-			*total_score += i->total_score;
+			(*running_total)++;
 			
 		list_del(&i->list);
 		list_add_tail(&finished_tests, &i->list);
 		list_for_each(&i->dependencies, d, node) {
-			d->dependent->skip = true;
+			if (d->dependent->skip)
+				continue;
+			d->dependent->skip = "dependency was skipped";
 			d->dependent->skip_fail = i->skip_fail;
 		}
-		return true;
+		return i->skip_fail ? false : true;
 	}
 
 	timeleft = timeout ? timeout : default_timeout_ms;
-	result = i->check(m, i->keep_results, &timeleft);
+	i->check(m, i->keep_results, &timeleft, score);
 	if (timeout && timeleft == 0) {
 		skip = "timeout";
 		goto skip;
 	}
 
-	if (!result)
-		this_score = i->total_score ? i->total_score : 1;
-	else if (i->score)
-		this_score = i->score(m, result);
-	else
-		this_score = 0;
-
-	bad = (this_score == 0);
-	good = (this_score >= i->total_score);
-
-	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);
+	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 (!quiet && result) {
-		const char *desc;
-		if (i->describe && (desc = i->describe(m, result)) != NULL) 
-			printf("    %s\n", desc);
-		if (i->handle)
-			i->handle(m, result);
+	if ((!quiet && !score->pass) || verbose) {
+		if (score->error)
+			printf("%s", score->error);
+		if (!quiet && !score->pass && i->handle)
+			i->handle(m, score);
 	}
 
-	if (i->total_score) {
-		*score += this_score;
-		*total_score += i->total_score;
-	}
+	*running_score += score->score;
+	*running_total += score->total;
 
 	list_del(&i->list);
 	list_add_tail(&finished_tests, &i->list);
 
-	if (bad) {
+	if (!score->pass) {
 		/* Skip any tests which depend on this one. */
 		list_for_each(&i->dependencies, d, node) {
-			d->dependent->skip = true;
+			if (d->dependent->skip)
+				continue;
+			d->dependent->skip = "dependency failed";
 			d->dependent->skip_fail = true;
 		}
 	}
-	return good;
+	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);
 }
 
 /**
@@ -227,84 +195,135 @@ 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__)
+#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__)
+#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;
+	printf("You can find ccanlint working files in '%s'\n", dir);
+	return 0;
+}
 
-	list_for_each(&compulsory_tests, i, list)
-		if (streq(i->key, key))
-			return i;
+static char *keep_test(const char *testname, void *unused)
+{
+	struct ccanlint *i;
 
-	list_for_each(&normal_tests, i, list)
-		if (streq(i->key, key))
-			return 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 void keep_test(const char *testname)
+static char *skip_test(const char *testname, void *unused)
 {
-	struct ccanlint *i = find_test(testname);
-	if (!i)
-		errx(1, "No test %s to --keep", testname);
-	i->keep_results = true;
+	btree_insert(cmdline_exclude, testname);
+	return NULL;
 }
 
 static void print_tests(struct list_head *tests, const char *type)
@@ -322,81 +341,197 @@ static void print_tests(struct list_head *tests, const char *type)
 	}
 }
 
-static void list_tests(void)
+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)
+{
+	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)
+{
+	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), 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]);
+			}
+		}
+	}
+}
+
+static bool depends_on(struct ccanlint *i, struct ccanlint *target)
+{
+	const struct dependent *d;
+
+	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[])
 {
-	int c;
 	bool summary = false;
 	unsigned int score = 0, total_score = 0;
 	struct manifest *m;
 	struct ccanlint *i;
-	const char *prefix = "", *dir = talloc_getcwd(NULL);
+	const char *prefix = "";
+	char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
 	
 	init_tests();
 
-	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':
-			if (optarg[0] != '/')
-				dir = talloc_asprintf_append(NULL, "%s/%s",
-							     dir, optarg);
-			else
-				dir = optarg;
-			prefix = talloc_append_string(talloc_basename(NULL,
-								      optarg),
-						      ": ");
-			break;
-		case 'l':
-			list_tests();
-		case 's':
-			summary = true;
-			break;
-		case 'v':
-			verbose++;
-			break;
-		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]);
-		}
-	}
-
-	if (optind < argc)
-		usage(argv[0]);
-
-	if (verbose >= 3)
-		tools_verbose = true;
+	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. */
@@ -404,18 +539,26 @@ int main(int argc, char *argv[])
 		    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");
+	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");
+	/* --target overrides known FAIL from _info */
+	add_info_options(m->info_file, !target);
+
 	while ((i = get_next_test(&normal_tests)) != NULL)
 		run_test(i, summary, &score, &total_score, m);