2 * ccanlint: assorted checks and advice for a ccan package
3 * Copyright (C) 2008 Rusty Russell, Idris Soule
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * 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", i->name, score->pass ? "PASS" : "FAIL");
146 if (score->total > 1)
147 printf(" (+%u/%u)", score->score, score->total);
151 if (!quiet && !score->pass) {
152 struct file_error *f;
155 printf("%s:\n", score->error);
157 list_for_each(&score->per_file_errors, f, list) {
160 f->file->fullname, f->line, f->error);
162 printf("%s:%s\n", f->file->fullname, f->error);
164 printf("%s\n", f->error);
170 *running_score += score->score;
171 *running_total += score->total;
174 list_add_tail(&finished_tests, &i->list);
177 /* Skip any tests which depend on this one. */
178 list_for_each(&i->dependencies, d, node) {
179 if (d->dependent->skip)
181 d->dependent->skip = "dependency failed";
182 d->dependent->skip_fail = true;
188 static void register_test(struct list_head *h, struct ccanlint *test, ...)
191 struct ccanlint *depends;
192 struct dependent *dchild;
194 list_add(h, &test->list);
197 /* Careful: we might have been initialized by a dependent. */
198 if (test->dependencies.n.next == NULL)
199 list_head_init(&test->dependencies);
201 //dependent(s) args (if any), last one is NULL
202 while ((depends = va_arg(ap, struct ccanlint *)) != NULL) {
203 dchild = malloc(sizeof(*dchild));
204 dchild->dependent = test;
205 /* The thing we depend on might not be initialized yet! */
206 if (depends->dependencies.n.next == NULL)
207 list_head_init(&depends->dependencies);
208 list_add_tail(&depends->dependencies, &dchild->node);
215 * get_next_test - retrieves the next test to be processed
217 static inline struct ccanlint *get_next_test(struct list_head *test)
221 if (list_empty(test))
224 list_for_each(test, i, list) {
225 if (i->num_depends == 0)
228 errx(1, "Can't make process; test dependency cycle");
231 static void init_tests(void)
233 const struct ccanlint *i;
234 struct btree *keys, *names;
237 #define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__, NULL)
238 #include "generated-normal-tests"
240 #define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__, NULL)
241 #include "generated-compulsory-tests"
243 /* Self-consistency check: make sure no two tests
244 have the same key or name. */
245 keys = btree_new(btree_strcmp);
246 names = btree_new(btree_strcmp);
247 list_for_each(&compulsory_tests, i, list) {
248 if (!btree_insert(keys, i->key))
249 errx(1, "BUG: Duplicate test key '%s'", i->key);
250 if (!btree_insert(keys, i->name))
251 errx(1, "BUG: Duplicate test name '%s'", i->name);
253 list_for_each(&normal_tests, i, list) {
254 if (!btree_insert(keys, i->key))
255 errx(1, "BUG: Duplicate test key '%s'", i->key);
256 if (!btree_insert(keys, i->name))
257 errx(1, "BUG: Duplicate test name '%s'", i->name);
265 printf("\nCompulsory Tests\n");
266 list_for_each(&compulsory_tests, i, list) {
267 printf("%s depends on %u others\n", i->name, i->num_depends);
268 if (!list_empty(&i->dependencies)) {
269 const struct dependent *d;
270 printf("These depend on us:\n");
271 list_for_each(&i->dependencies, d, node)
272 printf("\t%s\n", d->dependent->name);
276 printf("\nNormal Tests\n");
277 list_for_each(&normal_tests, i, list) {
278 printf("%s depends on %u others\n", i->name, i->num_depends);
279 if (!list_empty(&i->dependencies)) {
280 const struct dependent *d;
281 printf("These depend on us:\n");
282 list_for_each(&i->dependencies, d, node)
283 printf("\t%s\n", d->dependent->name);
288 static struct ccanlint *find_test(const char *key)
292 list_for_each(&compulsory_tests, i, list)
293 if (streq(i->key, key))
296 list_for_each(&normal_tests, i, list)
297 if (streq(i->key, key))
303 static char *keep_test(const char *testname, void *unused)
305 struct ccanlint *i = find_test(testname);
307 errx(1, "No test %s to --keep", testname);
308 i->keep_results = true;
312 static char *skip_test(const char *testname, void *unused)
314 btree_insert(cmdline_exclude, optarg);
318 static void print_tests(struct list_head *tests, const char *type)
322 printf("%s tests:\n", type);
323 /* This makes them print in topological order. */
324 while ((i = get_next_test(tests)) != NULL) {
325 const struct dependent *d;
326 printf(" %-25s %s\n", i->key, i->name);
328 list_for_each(&i->dependencies, d, node)
329 d->dependent->num_depends--;
333 static char *list_tests(void *arg)
335 print_tests(&compulsory_tests, "Compulsory");
336 print_tests(&normal_tests, "Normal");
340 static char *strip(const void *ctx, const char *line)
342 line += strcspn(line, IDENT_CHARS "-");
343 return talloc_strndup(ctx, line, strspn(line, IDENT_CHARS "-"));
346 static void add_info_fails(struct ccan_file *info)
348 struct doc_section *d;
351 list_for_each(get_ccan_file_docs(info), d, list) {
352 if (!streq(d->type, "fails"))
355 for (i = 0; i < d->num_lines; i++)
356 btree_insert(info_exclude, strip(info, d->lines[i]));
361 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
363 const struct dependent *d;
368 list_for_each(&i->dependencies, d, node) {
369 if (depends_on(d->dependent, target))
375 /* O(N^2), who cares? */
376 static void skip_unrelated_tests(struct ccanlint *target)
379 struct list_head *list;
381 foreach_ptr(list, &compulsory_tests, &normal_tests)
382 list_for_each(list, i, list)
383 if (!depends_on(i, target))
384 i->skip = "not relevant to target";
387 int main(int argc, char *argv[])
389 bool summary = false;
390 unsigned int score = 0, total_score = 0;
393 const char *prefix = "";
394 char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
398 cmdline_exclude = btree_new(btree_strcmp);
399 info_exclude = btree_new(btree_strcmp);
401 opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
402 "use this directory");
403 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
404 "do not compile anything");
405 opt_register_noarg("-l|--list-tests", list_tests, NULL,
406 "list tests ccanlint performs (and exit)");
407 opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
408 "keep results of <testname> (can be used multiple times)");
409 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
410 "simply give one line summary");
411 opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
412 "verbose mode (can specify more than once)");
413 opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
414 "exclude <testname> (can be used multiple times)");
415 opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
417 "ignore (terminate) tests that are slower than this");
418 opt_register_arg("--target <testname>", opt_set_charp,
420 "only run one test (and its prerequisites)");
421 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
422 "\nA program for checking and guiding development"
424 "This usage message");
426 opt_parse(&argc, argv, opt_log_stderr_exit);
429 dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
431 prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
433 compile_verbose = true;
435 tools_verbose = true;
437 /* We move into temporary directory, so gcov dumps its files there. */
438 if (chdir(temp_dir(talloc_autofree_context())) != 0)
439 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
441 m = get_manifest(talloc_autofree_context(), dir);
443 /* Create a symlink from temp dir back to src dir's test directory. */
444 if (symlink(talloc_asprintf(m, "%s/test", dir),
445 talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0)
446 err(1, "Creating test symlink in %s", temp_dir(NULL));
449 struct ccanlint *test;
451 test = find_test(target);
453 err(1, "Unknown test to run '%s'", target);
454 skip_unrelated_tests(test);
457 /* If you don't pass the compulsory tests, you get a score of 0. */
458 while ((i = get_next_test(&compulsory_tests)) != NULL) {
459 if (!run_test(i, summary, &score, &total_score, m)) {
460 printf("%sTotal score: 0/%u\n", prefix, total_score);
461 errx(1, "%s%s failed", prefix, i->name);
465 add_info_fails(m->info_file);
466 while ((i = get_next_test(&normal_tests)) != NULL)
467 run_test(i, summary, &score, &total_score, m);
469 printf("%sTotal score: %u/%u\n", prefix, score, total_score);