X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=f2c79795a5c50a215b99a1a71fff61abcad64549;hp=29ad7c6093164ad5f4e25c21c972e55b6a9874d3;hb=6ceee26828dcb8bf1d607a8221f0d9f8261d448b;hpb=d4aa9aa33a6b479fa684a3a77f25c539b6660b63

diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c
index 29ad7c60..f2c79795 100644
--- a/tools/ccanlint/ccanlint.c
+++ b/tools/ccanlint/ccanlint.c
@@ -1,6 +1,6 @@
 /*
  * ccanlint: assorted checks and advice for a ccan package
- * Copyright (C) 2008 Rusty Russell
+ * Copyright (C) 2008 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
@@ -17,32 +17,31 @@
  * 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);
-
-static void init_tests(void)
-{
-#include "generated-init-tests" 
-}
-
-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);
-}
+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;
 
+#if 0
 static void indent_print(const char *string)
 {
 	while (*string) {
@@ -55,6 +54,7 @@ static void indent_print(const char *string)
 		string += line;
 	}
 }
+#endif
 
 bool ask(const char *question)
 {
@@ -67,100 +67,407 @@ bool ask(const char *question)
 		&& toupper(reply[0]) == 'Y';
 }
 
-static bool run_test(const struct ccanlint *i,
-		     bool summary,
+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 *score,
 		     unsigned int *total_score,
 		     struct manifest *m)
 {
 	void *result;
-	unsigned int this_score;
+	unsigned int this_score, max_score, timeleft;
+	const struct dependent *d;
+	const char *skip;
+	bool bad, good;
 
-	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;
+	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. */
+		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) {
+			if (d->dependent->skip)
+				continue;
+			d->dependent->skip = "dependency was skipped";
+			d->dependent->skip_fail = i->skip_fail;
+		}
 		return true;
 	}
 
-	if (i->score)
+	timeleft = timeout ? timeout : default_timeout_ms;
+	result = i->check(m, i->keep_results, &timeleft);
+	if (timeout && timeleft == 0) {
+		skip = "timeout";
+		goto skip;
+	}
+
+	max_score = i->total_score;
+	if (!max_score)
+		max_score = 1;
+
+	if (!result)
+		this_score = max_score;
+	else if (i->score)
 		this_score = i->score(m, result);
 	else
 		this_score = 0;
 
-	*score += this_score;
-	if (summary) {
-		printf("%s FAILED (%u/%u)\n",
-		       i->name, this_score, i->total_score);
+	bad = (this_score == 0);
+	good = (this_score >= max_score);
+
+	if (verbose || (!good && !quiet)) {
+		printf("  %s: %s", i->name,
+		       bad ? "FAIL" : good ? "PASS" : "PARTIAL");
+		if (max_score > 1)
+			printf(" (+%u/%u)", this_score, max_score);
+		printf("\n");
+	}
 
-		if (verbose)
-			indent_print(i->describe(m, result));
-		return false;
+	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);
 	}
 
-	printf("%s\n", i->describe(m, result));
+	if (i->total_score) {
+		*score += this_score;
+		*total_score += i->total_score;
+	}
 
-	if (i->handle)
-		i->handle(m, result);
+	list_del(&i->list);
+	list_add_tail(&finished_tests, &i->list);
 
-	return false;
+	if (bad) {
+		/* 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 good;
 }
 
-int main(int argc, char *argv[])
+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);
+}
+
+/**
+ * get_next_test - retrieves the next test to be processed
+ **/
+static inline struct ccanlint *get_next_test(struct list_head *test)
+{
+	struct ccanlint *i;
+
+	if (list_empty(test))
+		return NULL;
+
+	list_for_each(test, i, list) {
+		if (i->num_depends == 0)
+			return i;
+	}
+	errx(1, "Can't make process; test dependency cycle");
+}
+
+static void init_tests(void)
 {
-	int c;
-	bool summary = false;
-	unsigned int score, total_score;
-	struct manifest *m;
 	const struct ccanlint *i;
+	struct btree *keys, *names;
 
-	/* 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]);
+#undef REGISTER_TEST
+#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__, NULL)
+#include "generated-normal-tests"
+#undef REGISTER_TEST
+#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__, NULL)
+#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;
+
+	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);
 		}
 	}
 
-	if (optind < argc)
-		usage(argv[0]);
+	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)) {
+			const struct dependent *d;
+			printf("These depend on us:\n");
+			list_for_each(&i->dependencies, d, node)
+				printf("\t%s\n", d->dependent->name);
+		}
+	}
+}
+
+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 char *keep_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;
+	return NULL;
+}
+
+static char *skip_test(const char *testname, void *unused)
+{
+	btree_insert(cmdline_exclude, optarg);
+	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 char *strip(const void *ctx, const char *line)
+{
+	line += strcspn(line, IDENT_CHARS "-");
+	return talloc_strndup(ctx, line, strspn(line, IDENT_CHARS "-"));
+}
+
+static void add_info_fails(struct ccan_file *info)
+{
+	struct doc_section *d;
+	unsigned int i;
+
+	list_for_each(get_ccan_file_docs(info), d, list) {
+		if (!streq(d->type, "fails"))
+			continue;
+
+		for (i = 0; i < d->num_lines; i++)
+			btree_insert(info_exclude, strip(info, d->lines[i]));
+		break;
+	}
+}
+
+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 */
+	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_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,
+			   "simply give one line summary");
+	opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
+			   "verbose mode (can specify more than once)");
+	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");
+
+	opt_parse(&argc, argv, opt_log_stderr_exit);
+
+	if (dir[0] != '/')
+		dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
+	if (dir != base_dir)
+		prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
+	if (verbose >= 2)
+		compile_verbose = true;
+	if (verbose >= 3)
+		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. */
+	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)
+			err(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. */
 	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);
+
+	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);
+		}
+	}
+
+	add_info_fails(m->info_file);
 
 	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);
-
-	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;
 }