/*
* 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
#include "ccanlint.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/talloc/talloc.h>
static unsigned int verbose = 0;
-static LIST_HEAD(tests);
-
-static void init_tests(void)
-{
-#include "generated-init-tests"
-}
+static LIST_HEAD(compulsory_tests);
+static LIST_HEAD(normal_tests);
+static LIST_HEAD(finished_tests);
+bool safe_mode = false;
static void usage(const char *name)
{
- fprintf(stderr, "Usage: %s [-s] [-v] [-d <dirname>]\n"
+ fprintf(stderr, "Usage: %s [-s] [-n] [-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",
+ " -d: use this directory instead of the current one\n"
+ " -n: do not compile anything\n",
name);
exit(1);
}
&& toupper(reply[0]) == 'Y';
}
-static bool run_test(const struct ccanlint *i,
+static const char *should_skip(struct manifest *m, struct ccanlint *i)
+{
+ 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,
unsigned int *score,
unsigned int *total_score,
{
void *result;
unsigned int this_score;
+ const struct dependent *d;
+ const char *skip;
+
+ //one less test to run through
+ list_for_each(&i->dependencies, d, node)
+ d->dependent->num_depends--;
- if (i->total_score)
- *total_score += i->total_score;
+ skip = should_skip(m, i);
+ if (skip) {
+ if (verbose)
+ 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;
+ }
result = i->check(m);
if (!result) {
if (verbose)
printf(" %s: OK\n", i->name);
- if (i->total_score)
+ if (i->total_score) {
*score += i->total_score;
+ *total_score += i->total_score;
+ }
+
+ list_del(&i->list);
+ list_add_tail(&finished_tests, &i->list);
return true;
}
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)
indent_print(i->describe(m, result));
- return false;
- }
+ } else {
+ printf("%s\n", i->describe(m, result));
- printf("%s\n", i->describe(m, result));
+ if (i->handle)
+ i->handle(m, result);
+ }
- if (i->handle)
- i->handle(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;
+ }
return false;
}
+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)
+{
+ const struct ccanlint *i;
+
+#undef REGISTER_TEST
+#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"
+
+ 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);
+ }
+ }
+
+ 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);
+ }
+ }
+}
+
int main(int argc, char *argv[])
{
int c;
bool summary = false;
unsigned int score, total_score;
struct manifest *m;
- const struct ccanlint *i;
+ 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) {
+ while ((c = getopt(argc, argv, "sd:vn")) != -1) {
switch (c) {
case 'd':
if (chdir(optarg) != 0)
case 'v':
verbose++;
break;
+ case 'n':
+ safe_mode = true;
+ break;
default:
usage(argv[0]);
}
if (optind < argc)
usage(argv[0]);
- m = get_manifest();
+ m = get_manifest(talloc_autofree_context());
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);
+
+ while ((i = get_next_test(&compulsory_tests)) != NULL) {
+ if (!run_test(i, summary, &score, &total_score, m))
+ exit(1);
+ }
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);
+ while ((i = get_next_test(&normal_tests)) != NULL)
+ run_test(i, summary, &score, &total_score, m);
printf("Total score: %u/%u\n", score, total_score);
-
return 0;
}