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>
34 #include <ccan/grab_file/grab_file.h>
35 #include <ccan/cast/cast.h>
38 static struct list_head compulsory_tests;
39 static struct list_head normal_tests;
40 bool safe_mode = false;
41 static struct btree *cmdline_exclude;
42 static struct btree *info_exclude;
43 static unsigned int timeout;
45 /* These are overridden at runtime if we can find config.h */
46 const char *compiler = NULL;
47 const char *cflags = NULL;
49 const char *config_header;
52 static void indent_print(const char *string)
55 unsigned int line = strcspn(string, "\n");
56 printf("\t%.*s", line, string);
57 if (string[line] == '\n') {
66 bool ask(const char *question)
70 printf("%s ", question);
73 return fgets(reply, sizeof(reply), stdin) != NULL
74 && toupper(reply[0]) == 'Y';
77 static const char *should_skip(struct manifest *m, struct ccanlint *i)
79 if (btree_lookup(cmdline_exclude, i->key))
80 return "excluded on command line";
82 if (btree_lookup(info_exclude, i->key))
83 return "excluded in _info file";
89 return "dependency failed";
96 static bool run_test(struct ccanlint *i,
98 unsigned int *running_score,
99 unsigned int *running_total,
103 unsigned int timeleft;
104 const struct dependent *d;
108 //one less test to run through
109 list_for_each(&i->dependencies, d, node)
110 d->dependent->num_depends--;
112 score = talloc(m, struct score);
113 list_head_init(&score->per_file_errors);
119 skip = should_skip(m, i);
123 if (verbose && !streq(skip, "not relevant to target"))
124 printf("%s%s: skipped (%s)\n", prefix, i->name, skip);
126 /* If we're skipping this because a prereq failed, we fail:
127 * count it as a score of 1. */
132 list_for_each(&i->dependencies, d, node) {
133 if (d->dependent->skip)
135 d->dependent->skip = "dependency was skipped";
136 d->dependent->skip_fail = i->skip_fail;
138 return i->skip_fail ? false : true;
141 timeleft = timeout ? timeout : default_timeout_ms;
142 i->check(m, i->keep_results, &timeleft, score);
143 if (timeout && timeleft == 0) {
148 assert(score->score <= score->total);
149 if ((!score->pass && !quiet)
150 || (score->score < score->total && verbose)
152 printf("%s%s (%s): %s",
153 prefix, i->name, i->key, score->pass ? "PASS" : "FAIL");
154 if (score->total > 1)
155 printf(" (+%u/%u)", score->score, score->total);
159 if ((!quiet && !score->pass) || verbose) {
161 printf("%s%s", score->error,
162 strends(score->error, "\n") ? "" : "\n");
165 if (!quiet && score->score < score->total && i->handle)
168 *running_score += score->score;
169 *running_total += score->total;
174 /* Skip any tests which depend on this one. */
175 list_for_each(&i->dependencies, d, node) {
176 if (d->dependent->skip)
178 d->dependent->skip = "dependency failed";
179 d->dependent->skip_fail = true;
185 static void register_test(struct list_head *h, struct ccanlint *test)
187 list_add(h, &test->list);
188 test->options = talloc_array(NULL, char *, 1);
189 test->options[0] = NULL;
191 test->skip_fail = false;
195 * get_next_test - retrieves the next test to be processed
197 static inline struct ccanlint *get_next_test(struct list_head *test)
201 if (list_empty(test))
204 list_for_each(test, i, list) {
205 if (i->num_depends == 0)
208 errx(1, "Can't make process; test dependency cycle");
211 static struct ccanlint *find_test(const char *key)
215 list_for_each(&compulsory_tests, i, list)
216 if (streq(i->key, key))
219 list_for_each(&normal_tests, i, list)
220 if (streq(i->key, key))
226 bool is_excluded(const char *name)
228 return btree_lookup(cmdline_exclude, name) != NULL
229 || btree_lookup(info_exclude, name) != NULL
230 || find_test(name)->skip != NULL;
234 #define REGISTER_TEST(name, ...) extern struct ccanlint name
235 #include "generated-normal-tests"
236 #include "generated-compulsory-tests"
238 static void init_tests(void)
241 struct btree *keys, *names;
242 struct list_head *list;
244 list_head_init(&normal_tests);
245 list_head_init(&compulsory_tests);
248 #define REGISTER_TEST(name) register_test(&normal_tests, &name)
249 #include "generated-normal-tests"
251 #define REGISTER_TEST(name) register_test(&compulsory_tests, &name)
252 #include "generated-compulsory-tests"
254 /* Initialize dependency lists. */
255 foreach_ptr(list, &compulsory_tests, &normal_tests) {
256 list_for_each(list, c, list) {
257 list_head_init(&c->dependencies);
262 /* Resolve dependencies. */
263 foreach_ptr(list, &compulsory_tests, &normal_tests) {
264 list_for_each(list, c, list) {
265 char **deps = strsplit(NULL, c->needs, " ");
268 for (i = 0; deps[i]; i++) {
269 struct ccanlint *dep;
270 struct dependent *dchild;
272 dep = find_test(deps[i]);
274 errx(1, "BUG: unknown dep '%s' for %s",
276 dchild = talloc(NULL, struct dependent);
277 dchild->dependent = c;
278 list_add_tail(&dep->dependencies,
286 /* Self-consistency check: make sure no two tests
287 have the same key or name. */
288 keys = btree_new(btree_strcmp);
289 names = btree_new(btree_strcmp);
290 foreach_ptr(list, &compulsory_tests, &normal_tests) {
291 list_for_each(list, c, list) {
292 if (!btree_insert(keys, c->key))
293 errx(1, "BUG: Duplicate test key '%s'",
295 if (!btree_insert(names, c->name))
296 errx(1, "BUG: Duplicate test name '%s'",
304 static void print_test_depends(void)
306 struct list_head *list;
308 foreach_ptr(list, &compulsory_tests, &normal_tests) {
310 printf("\%s Tests\n",
311 list == &compulsory_tests ? "Compulsory" : "Normal");
313 list_for_each(list, c, list) {
314 if (!list_empty(&c->dependencies)) {
315 const struct dependent *d;
316 printf("These depend on %s:\n", c->key);
317 list_for_each(&c->dependencies, d, node)
318 printf("\t%s\n", d->dependent->key);
324 static int show_tmpdir(const char *dir)
326 printf("You can find ccanlint working files in '%s'\n", dir);
330 static char *keep_test(const char *testname, void *unused)
334 if (streq(testname, "all")) {
335 struct list_head *list;
336 foreach_ptr(list, &compulsory_tests, &normal_tests) {
337 list_for_each(list, i, list)
338 i->keep_results = true;
341 i = find_test(testname);
343 errx(1, "No test %s to --keep", testname);
344 i->keep_results = true;
347 /* Don't automatically destroy temporary dir. */
348 talloc_set_destructor(temp_dir(NULL), show_tmpdir);
352 static char *skip_test(const char *testname, void *unused)
354 btree_insert(cmdline_exclude, testname);
358 static void print_tests(struct list_head *tests, const char *type)
362 printf("%s tests:\n", type);
363 /* This makes them print in topological order. */
364 while ((i = get_next_test(tests)) != NULL) {
365 const struct dependent *d;
366 printf(" %-25s %s\n", i->key, i->name);
368 list_for_each(&i->dependencies, d, node)
369 d->dependent->num_depends--;
373 static char *list_tests(void *arg)
376 print_tests(&compulsory_tests, "Compulsory");
377 print_tests(&normal_tests, "Normal");
381 static void test_dgraph_vertices(struct list_head *tests, const char *style)
383 const struct ccanlint *i;
385 list_for_each(tests, i, list) {
387 * todo: escape labels in case ccanlint test keys have
388 * characters interpreted as GraphViz syntax.
390 printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style);
394 static void test_dgraph_edges(struct list_head *tests)
396 const struct ccanlint *i;
397 const struct dependent *d;
399 list_for_each(tests, i, list)
400 list_for_each(&i->dependencies, d, node)
401 printf("\t\"%p\" -> \"%p\"\n", d->dependent, i);
404 static char *test_dependency_graph(void *arg)
409 test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow");
410 test_dgraph_vertices(&normal_tests, "");
412 test_dgraph_edges(&compulsory_tests);
413 test_dgraph_edges(&normal_tests);
420 /* Remove empty lines. */
421 static char **collapse(char **lines, unsigned int *nump)
424 for (i = j = 0; lines[i]; i++) {
426 lines[j++] = lines[i];
435 static void add_options(struct ccanlint *test, char **options,
436 unsigned int num_options)
443 /* -1, because last one is NULL. */
444 num = talloc_array_length(test->options) - 1;
446 test->options = talloc_realloc(NULL, test->options,
448 num + num_options + 1);
449 memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *));
452 static void add_info_options(struct ccan_file *info, bool mark_fails)
454 struct doc_section *d;
456 struct ccanlint *test;
458 list_for_each(get_ccan_file_docs(info), d, list) {
459 if (!streq(d->type, "ccanlint"))
462 for (i = 0; i < d->num_lines; i++) {
463 unsigned int num_words;
464 char **words = collapse(strsplit(d, d->lines[i], " \t"),
469 if (strncmp(words[0], "//", 2) == 0)
472 test = find_test(words[0]);
474 warnx("%s: unknown ccanlint test '%s'",
475 info->fullname, words[0]);
480 warnx("%s: no argument to test '%s'",
481 info->fullname, words[0]);
486 if (strcasecmp(words[1], "FAIL") == 0) {
488 btree_insert(info_exclude, words[0]);
490 if (!test->takes_options)
491 warnx("%s: %s doesn't take options",
492 info->fullname, words[0]);
493 add_options(test, words+1, num_words-1);
499 /* If options are of form "filename:<option>" they only apply to that file */
500 char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
503 unsigned int i, j = 0;
506 if (!test->options[0])
507 return test->options;
509 ret = talloc_array(f, char *, talloc_array_length(test->options));
510 for (i = 0; test->options[i]; i++) {
513 if (!test->options[i] || !strchr(test->options[i], ':')) {
514 optname = test->options[i];
515 } else if (strstarts(test->options[i], f->name)
516 && test->options[i][strlen(f->name)] == ':') {
517 optname = test->options[i] + strlen(f->name) + 1;
521 /* FAIL overrides anything else. */
522 if (streq(optname, "FAIL")) {
523 ret = talloc_array(f, char *, 2);
524 ret[0] = (char *)"FAIL";
532 /* Shrink it to size so talloc_array_length() works as expected. */
533 return talloc_realloc(NULL, ret, char *, j + 1);
536 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
538 const struct dependent *d;
543 list_for_each(&i->dependencies, d, node) {
544 if (depends_on(d->dependent, target))
550 /* O(N^2), who cares? */
551 static void skip_unrelated_tests(struct ccanlint *target)
554 struct list_head *list;
556 foreach_ptr(list, &compulsory_tests, &normal_tests)
557 list_for_each(list, i, list)
558 if (!depends_on(i, target))
559 i->skip = "not relevant to target";
562 static char *demangle_string(char *string)
565 const char mapfrom[] = "abfnrtv";
566 const char mapto[] = "\a\b\f\n\r\t\v";
568 if (!strchr(string, '"'))
570 string = strchr(string, '"') + 1;
571 if (!strrchr(string, '"'))
573 *strrchr(string, '"') = '\0';
575 for (i = 0; i < strlen(string); i++) {
576 if (string[i] == '\\') {
579 const char *p = strchr(mapfrom, string[i+1]);
581 repl = mapto[p - mapfrom];
583 } else if (strlen(string+i+1) >= 3) {
584 if (string[i+1] == 'x') {
585 repl = (string[i+2]-'0')*16
588 } else if (cisdigit(string[i+1])) {
589 repl = (string[i+2]-'0')*8*8
590 + (string[i+3]-'0')*8
601 memmove(string + i + 1, string + i + len + 1,
602 strlen(string + i + len + 1) + 1);
610 static void read_config_header(void)
612 char *fname = talloc_asprintf(NULL, "%s/config.h", ccan_dir);
616 config_header = grab_file(NULL, fname, NULL);
617 if (!config_header) {
622 lines = strsplit(config_header, config_header, "\n");
623 for (i = 0; i < talloc_array_length(lines) - 1; i++) {
625 const char **line = (const char **)&lines[i];
627 if (!get_token(line, "#"))
629 if (!get_token(line, "define"))
631 sym = get_symbol_token(lines, line);
632 if (streq(sym, "CCAN_COMPILER") && !compiler) {
633 compiler = demangle_string(lines[i]);
635 errx(1, "%s:%u:could not parse CCAN_COMPILER",
638 printf("%s: compiler set to '%s'\n",
640 } else if (streq(sym, "CCAN_CFLAGS") && !cflags) {
641 cflags = demangle_string(lines[i]);
643 errx(1, "%s:%u:could not parse CCAN_CFLAGS",
646 printf("%s: compiler flags set to '%s'\n",
651 compiler = CCAN_COMPILER;
653 compiler = CCAN_CFLAGS;
656 static char *opt_set_const_charp(const char *arg, const char **p)
658 return opt_set_charp(arg, cast_const2(char **, p));
661 int main(int argc, char *argv[])
663 bool summary = false, pass = true;
667 const char *prefix = "";
668 char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL,
671 cmdline_exclude = btree_new(btree_strcmp);
672 info_exclude = btree_new(btree_strcmp);
674 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
675 "do not compile anything");
676 opt_register_noarg("-l|--list-tests", list_tests, NULL,
677 "list tests ccanlint performs (and exit)");
678 opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
679 "print dependency graph of tests in Graphviz .dot format");
680 opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
681 "keep results of <testname>"
682 " (can be used multiple times, or 'all')");
683 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
684 "simply give one line summary");
685 opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
686 "verbose mode (up to -vvvv)");
687 opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
688 "exclude <testname> (can be used multiple times)");
689 opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
691 "ignore (terminate) tests that are slower than this");
692 opt_register_arg("--target <testname>", opt_set_charp,
694 "only run one test (and its prerequisites)");
695 opt_register_arg("--compiler <compiler>", opt_set_const_charp,
696 NULL, &compiler, "set the compiler");
697 opt_register_arg("--cflags <flags>", opt_set_const_charp,
698 NULL, &cflags, "set the compiler flags");
699 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
700 "\nA program for checking and guiding development"
702 "This usage message");
704 /* We move into temporary directory, so gcov dumps its files there. */
705 if (chdir(temp_dir(talloc_autofree_context())) != 0)
706 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
708 opt_parse(&argc, argv, opt_log_stderr_exit);
711 compile_verbose = true;
712 print_test_depends();
715 tools_verbose = true;
717 /* This links back to the module's test dir. */
718 testlink = talloc_asprintf(NULL, "%s/test", temp_dir(NULL));
720 /* Defaults to pwd. */
726 for (i = 1; i < argc; i++) {
727 unsigned int score, total_score;
731 dir = talloc_asprintf_append(NULL, "%s/%s",
733 while (strends(dir, "/"))
734 dir[strlen(dir)-1] = '\0';
738 prefix = talloc_append_string(talloc_basename(NULL,dir),
744 struct ccanlint *test;
746 test = find_test(target);
748 errx(1, "Unknown test to run '%s'", target);
749 skip_unrelated_tests(test);
752 m = get_manifest(talloc_autofree_context(), dir);
754 /* FIXME: This has to come after we've got manifest. */
756 read_config_header();
758 /* Create a symlink from temp dir back to src dir's
761 if (symlink(talloc_asprintf(m, "%s/test", dir), testlink) != 0)
762 err(1, "Creating test symlink in %s", temp_dir(NULL));
764 /* If you don't pass the compulsory tests, score is 0. */
765 score = total_score = 0;
766 while ((t = get_next_test(&compulsory_tests)) != NULL) {
767 if (!run_test(t, summary, &score, &total_score, m,
769 warnx("%s%s failed", prefix, t->name);
770 printf("%sTotal score: 0/%u\n",
771 prefix, total_score);
777 /* --target overrides known FAIL from _info */
779 add_info_options(m->info_file, !target);
781 while ((t = get_next_test(&normal_tests)) != NULL)
782 pass &= run_test(t, summary, &score, &total_score, m,
785 printf("%sTotal score: %u/%u\n", prefix, score, total_score);