2 * ccanlint: assorted checks and advice for a ccan package
3 * Copyright (C) 2008 Rusty Russell, Idris Soule
4 * Copyright (C) 2010 Rusty Russell, Idris Soule
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; either version 2 of the License, or (at your option)
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along with
17 * this program; if not, write to the Free Software Foundation, Inc., 51
18 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 #include <ccan/btree/btree.h>
29 #include <ccan/str/str.h>
30 #include <ccan/str_talloc/str_talloc.h>
31 #include <ccan/talloc/talloc.h>
32 #include <ccan/opt/opt.h>
33 #include <ccan/foreach/foreach.h>
36 static LIST_HEAD(compulsory_tests);
37 static LIST_HEAD(normal_tests);
38 static LIST_HEAD(finished_tests);
39 bool safe_mode = false;
40 static struct btree *cmdline_exclude;
41 static struct btree *info_exclude;
42 static unsigned int timeout;
45 static void indent_print(const char *string)
48 unsigned int line = strcspn(string, "\n");
49 printf("\t%.*s", line, string);
50 if (string[line] == '\n') {
59 bool ask(const char *question)
63 printf("%s ", question);
66 return fgets(reply, sizeof(reply), stdin) != NULL
67 && toupper(reply[0]) == 'Y';
70 static const char *should_skip(struct manifest *m, struct ccanlint *i)
72 if (btree_lookup(cmdline_exclude, i->key))
73 return "excluded on command line";
75 if (btree_lookup(info_exclude, i->key))
76 return "excluded in _info file";
82 return "dependency failed";
89 static bool run_test(struct ccanlint *i,
91 unsigned int *running_score,
92 unsigned int *running_total,
95 unsigned int timeleft;
96 const struct dependent *d;
100 //one less test to run through
101 list_for_each(&i->dependencies, d, node)
102 d->dependent->num_depends--;
104 score = talloc(m, struct score);
105 list_head_init(&score->per_file_errors);
111 skip = should_skip(m, i);
115 if (verbose && !streq(skip, "not relevant to target"))
116 printf("%s: skipped (%s)\n", i->name, skip);
118 /* If we're skipping this because a prereq failed, we fail:
119 * count it as a score of 1. */
124 list_add_tail(&finished_tests, &i->list);
125 list_for_each(&i->dependencies, d, node) {
126 if (d->dependent->skip)
128 d->dependent->skip = "dependency was skipped";
129 d->dependent->skip_fail = i->skip_fail;
131 return i->skip_fail ? false : true;
134 timeleft = timeout ? timeout : default_timeout_ms;
135 i->check(m, i->keep_results, &timeleft, score);
136 if (timeout && timeleft == 0) {
141 assert(score->score <= score->total);
142 if ((!score->pass && !quiet)
143 || (score->score < score->total && verbose)
145 printf("%s (%s): %s", i->name, i->key, score->pass ? "PASS" : "FAIL");
146 if (score->total > 1)
147 printf(" (+%u/%u)", score->score, score->total);
151 if ((!quiet && !score->pass) || verbose) {
153 printf("%s%s", score->error,
154 strends(score->error, "\n") ? "" : "\n");
156 if (!quiet && !score->pass && i->handle)
160 *running_score += score->score;
161 *running_total += score->total;
164 list_add_tail(&finished_tests, &i->list);
167 /* Skip any tests which depend on this one. */
168 list_for_each(&i->dependencies, d, node) {
169 if (d->dependent->skip)
171 d->dependent->skip = "dependency failed";
172 d->dependent->skip_fail = true;
178 static void register_test(struct list_head *h, struct ccanlint *test)
180 list_add(h, &test->list);
184 * get_next_test - retrieves the next test to be processed
186 static inline struct ccanlint *get_next_test(struct list_head *test)
190 if (list_empty(test))
193 list_for_each(test, i, list) {
194 if (i->num_depends == 0)
197 errx(1, "Can't make process; test dependency cycle");
200 static struct ccanlint *find_test(const char *key)
204 list_for_each(&compulsory_tests, i, list)
205 if (streq(i->key, key))
208 list_for_each(&normal_tests, i, list)
209 if (streq(i->key, key))
216 #define REGISTER_TEST(name, ...) extern struct ccanlint name
217 #include "generated-normal-tests"
218 #include "generated-compulsory-tests"
220 static void init_tests(void)
223 struct btree *keys, *names;
224 struct list_head *list;
227 #define REGISTER_TEST(name) register_test(&normal_tests, &name)
228 #include "generated-normal-tests"
230 #define REGISTER_TEST(name) register_test(&compulsory_tests, &name)
231 #include "generated-compulsory-tests"
233 /* Initialize dependency lists. */
234 foreach_ptr(list, &compulsory_tests, &normal_tests) {
235 list_for_each(list, c, list) {
236 list_head_init(&c->dependencies);
240 /* Resolve dependencies. */
241 foreach_ptr(list, &compulsory_tests, &normal_tests) {
242 list_for_each(list, c, list) {
243 char **deps = strsplit(NULL, c->needs, " ");
246 for (i = 0; deps[i]; i++) {
247 struct ccanlint *dep;
248 struct dependent *dchild;
250 dep = find_test(deps[i]);
252 errx(1, "BUG: unknown dep '%s' for %s",
254 dchild = talloc(NULL, struct dependent);
255 dchild->dependent = c;
256 list_add_tail(&dep->dependencies,
264 /* Self-consistency check: make sure no two tests
265 have the same key or name. */
266 keys = btree_new(btree_strcmp);
267 names = btree_new(btree_strcmp);
268 foreach_ptr(list, &compulsory_tests, &normal_tests) {
269 list_for_each(list, c, list) {
270 if (!btree_insert(keys, c->key))
271 errx(1, "BUG: Duplicate test key '%s'",
273 if (!btree_insert(names, c->name))
274 errx(1, "BUG: Duplicate test name '%s'",
284 foreach_ptr(list, &compulsory_tests, &normal_tests) {
285 printf("\%s Tests\n",
286 list == &compulsory_tests ? "Compulsory" : "Normal");
288 if (!list_empty(&c->dependencies)) {
289 const struct dependent *d;
290 printf("These depend on us:\n");
291 list_for_each(&c->dependencies, d, node)
292 printf("\t%s\n", d->dependent->name);
297 static int show_tmpdir(char *dir)
299 printf("You can find ccanlint working files in '%s'\n", dir);
303 static char *keep_test(const char *testname, void *unused)
307 if (streq(testname, "all")) {
308 struct list_head *list;
309 foreach_ptr(list, &compulsory_tests, &normal_tests) {
310 list_for_each(list, i, list)
311 i->keep_results = true;
314 i = find_test(testname);
316 errx(1, "No test %s to --keep", testname);
317 i->keep_results = true;
320 /* Don't automatically destroy temporary dir. */
321 talloc_set_destructor(temp_dir(NULL), show_tmpdir);
325 static char *skip_test(const char *testname, void *unused)
327 btree_insert(cmdline_exclude, testname);
331 static void print_tests(struct list_head *tests, const char *type)
335 printf("%s tests:\n", type);
336 /* This makes them print in topological order. */
337 while ((i = get_next_test(tests)) != NULL) {
338 const struct dependent *d;
339 printf(" %-25s %s\n", i->key, i->name);
341 list_for_each(&i->dependencies, d, node)
342 d->dependent->num_depends--;
346 static char *list_tests(void *arg)
348 print_tests(&compulsory_tests, "Compulsory");
349 print_tests(&normal_tests, "Normal");
353 static void test_dgraph_vertices(struct list_head *tests, const char *style)
355 const struct ccanlint *i;
357 list_for_each(tests, i, list) {
359 * todo: escape labels in case ccanlint test keys have
360 * characters interpreted as GraphViz syntax.
362 printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style);
366 static void test_dgraph_edges(struct list_head *tests)
368 const struct ccanlint *i;
369 const struct dependent *d;
371 list_for_each(tests, i, list)
372 list_for_each(&i->dependencies, d, node)
373 printf("\t\"%p\" -> \"%p\"\n", d->dependent, i);
376 static char *test_dependency_graph(void *arg)
380 test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow");
381 test_dgraph_vertices(&normal_tests, "");
383 test_dgraph_edges(&compulsory_tests);
384 test_dgraph_edges(&normal_tests);
391 /* Remove empty lines. */
392 static char **collapse(char **lines, unsigned int *nump)
395 for (i = j = 0; lines[i]; i++) {
397 lines[j++] = lines[i];
404 static void add_info_options(struct ccan_file *info, bool mark_fails)
406 struct doc_section *d;
408 struct ccanlint *test;
410 list_for_each(get_ccan_file_docs(info), d, list) {
411 if (!streq(d->type, "ccanlint"))
414 for (i = 0; i < d->num_lines; i++) {
415 char **words = collapse(strsplit(d, d->lines[i], " \t"),
420 if (strncmp(words[0], "//", 2) == 0)
423 test = find_test(words[0]);
425 warnx("%s: unknown ccanlint test '%s'",
426 info->fullname, words[0]);
431 warnx("%s: no argument to test '%s'",
432 info->fullname, words[0]);
437 if (strcasecmp(words[1], "FAIL") == 0) {
439 btree_insert(info_exclude, words[0]);
441 if (!test->takes_options)
442 warnx("%s: %s doesn't take options",
443 info->fullname, words[0]);
444 /* Copy line exactly into options. */
445 test->options = strstr(d->lines[i], words[0])
452 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
454 const struct dependent *d;
459 list_for_each(&i->dependencies, d, node) {
460 if (depends_on(d->dependent, target))
466 /* O(N^2), who cares? */
467 static void skip_unrelated_tests(struct ccanlint *target)
470 struct list_head *list;
472 foreach_ptr(list, &compulsory_tests, &normal_tests)
473 list_for_each(list, i, list)
474 if (!depends_on(i, target))
475 i->skip = "not relevant to target";
478 int main(int argc, char *argv[])
480 bool summary = false;
481 unsigned int score = 0, total_score = 0;
484 const char *prefix = "";
485 char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
489 cmdline_exclude = btree_new(btree_strcmp);
490 info_exclude = btree_new(btree_strcmp);
492 opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
493 "use this directory");
494 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
495 "do not compile anything");
496 opt_register_noarg("-l|--list-tests", list_tests, NULL,
497 "list tests ccanlint performs (and exit)");
498 opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
499 "print dependency graph of tests in Graphviz .dot format");
500 opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
501 "keep results of <testname>"
502 " (can be used multiple times, or 'all')");
503 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
504 "simply give one line summary");
505 opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
506 "verbose mode (up to -vvvv)");
507 opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
508 "exclude <testname> (can be used multiple times)");
509 opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
511 "ignore (terminate) tests that are slower than this");
512 opt_register_arg("--target <testname>", opt_set_charp,
514 "only run one test (and its prerequisites)");
515 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
516 "\nA program for checking and guiding development"
518 "This usage message");
520 /* We move into temporary directory, so gcov dumps its files there. */
521 if (chdir(temp_dir(talloc_autofree_context())) != 0)
522 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
524 opt_parse(&argc, argv, opt_log_stderr_exit);
527 dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
528 while (strends(dir, "/"))
529 dir[strlen(dir)-1] = '\0';
531 prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
533 compile_verbose = true;
535 tools_verbose = true;
537 m = get_manifest(talloc_autofree_context(), dir);
539 /* Create a symlink from temp dir back to src dir's test directory. */
540 if (symlink(talloc_asprintf(m, "%s/test", dir),
541 talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0)
542 err(1, "Creating test symlink in %s", temp_dir(NULL));
545 struct ccanlint *test;
547 test = find_test(target);
549 errx(1, "Unknown test to run '%s'", target);
550 skip_unrelated_tests(test);
553 /* If you don't pass the compulsory tests, you get a score of 0. */
554 while ((i = get_next_test(&compulsory_tests)) != NULL) {
555 if (!run_test(i, summary, &score, &total_score, m)) {
556 printf("%sTotal score: 0/%u\n", prefix, total_score);
557 errx(1, "%s%s failed", prefix, i->name);
561 /* --target overrides known FAIL from _info */
562 add_info_options(m->info_file, !target);
564 while ((i = get_next_test(&normal_tests)) != NULL)
565 run_test(i, summary, &score, &total_score, m);
567 printf("%sTotal score: %u/%u\n", prefix, score, total_score);