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,
92 unsigned int *total_score,
96 unsigned int this_score, max_score, timeleft;
97 const struct dependent *d;
101 //one less test to run through
102 list_for_each(&i->dependencies, d, node)
103 d->dependent->num_depends--;
105 skip = should_skip(m, i);
109 if (verbose && !streq(skip, "not relevant to target"))
110 printf(" %s: skipped (%s)\n", i->name, skip);
112 /* If we're skipping this because a prereq failed, we fail. */
114 *total_score += i->total_score;
117 list_add_tail(&finished_tests, &i->list);
118 list_for_each(&i->dependencies, d, node) {
119 if (d->dependent->skip)
121 d->dependent->skip = "dependency was skipped";
122 d->dependent->skip_fail = i->skip_fail;
127 timeleft = timeout ? timeout : default_timeout_ms;
128 result = i->check(m, i->keep_results, &timeleft);
129 if (timeout && timeleft == 0) {
134 max_score = i->total_score;
139 this_score = max_score;
141 this_score = i->score(m, result);
145 bad = (this_score == 0);
146 good = (this_score >= max_score);
148 if (verbose || (!good && !quiet)) {
149 printf(" %s: %s", i->name,
150 bad ? "FAIL" : good ? "PASS" : "PARTIAL");
152 printf(" (+%u/%u)", this_score, max_score);
156 if (!quiet && result) {
158 if (i->describe && (desc = i->describe(m, result)) != NULL)
159 printf(" %s\n", desc);
161 i->handle(m, result);
164 if (i->total_score) {
165 *score += this_score;
166 *total_score += i->total_score;
170 list_add_tail(&finished_tests, &i->list);
173 /* Skip any tests which depend on this one. */
174 list_for_each(&i->dependencies, d, node) {
175 if (d->dependent->skip)
177 d->dependent->skip = "dependency failed";
178 d->dependent->skip_fail = true;
184 static void register_test(struct list_head *h, struct ccanlint *test, ...)
187 struct ccanlint *depends;
188 struct dependent *dchild;
190 list_add(h, &test->list);
193 /* Careful: we might have been initialized by a dependent. */
194 if (test->dependencies.n.next == NULL)
195 list_head_init(&test->dependencies);
197 //dependent(s) args (if any), last one is NULL
198 while ((depends = va_arg(ap, struct ccanlint *)) != NULL) {
199 dchild = malloc(sizeof(*dchild));
200 dchild->dependent = test;
201 /* The thing we depend on might not be initialized yet! */
202 if (depends->dependencies.n.next == NULL)
203 list_head_init(&depends->dependencies);
204 list_add_tail(&depends->dependencies, &dchild->node);
211 * get_next_test - retrieves the next test to be processed
213 static inline struct ccanlint *get_next_test(struct list_head *test)
217 if (list_empty(test))
220 list_for_each(test, i, list) {
221 if (i->num_depends == 0)
224 errx(1, "Can't make process; test dependency cycle");
227 static void init_tests(void)
229 const struct ccanlint *i;
230 struct btree *keys, *names;
233 #define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__, NULL)
234 #include "generated-normal-tests"
236 #define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__, NULL)
237 #include "generated-compulsory-tests"
239 /* Self-consistency check: make sure no two tests
240 have the same key or name. */
241 keys = btree_new(btree_strcmp);
242 names = btree_new(btree_strcmp);
243 list_for_each(&compulsory_tests, i, list) {
244 if (!btree_insert(keys, i->key))
245 errx(1, "BUG: Duplicate test key '%s'", i->key);
246 if (!btree_insert(keys, i->name))
247 errx(1, "BUG: Duplicate test name '%s'", i->name);
249 list_for_each(&normal_tests, i, list) {
250 if (!btree_insert(keys, i->key))
251 errx(1, "BUG: Duplicate test key '%s'", i->key);
252 if (!btree_insert(keys, i->name))
253 errx(1, "BUG: Duplicate test name '%s'", i->name);
261 printf("\nCompulsory Tests\n");
262 list_for_each(&compulsory_tests, i, list) {
263 printf("%s depends on %u others\n", i->name, i->num_depends);
264 if (!list_empty(&i->dependencies)) {
265 const struct dependent *d;
266 printf("These depend on us:\n");
267 list_for_each(&i->dependencies, d, node)
268 printf("\t%s\n", d->dependent->name);
272 printf("\nNormal Tests\n");
273 list_for_each(&normal_tests, i, list) {
274 printf("%s depends on %u others\n", i->name, i->num_depends);
275 if (!list_empty(&i->dependencies)) {
276 const struct dependent *d;
277 printf("These depend on us:\n");
278 list_for_each(&i->dependencies, d, node)
279 printf("\t%s\n", d->dependent->name);
284 static struct ccanlint *find_test(const char *key)
288 list_for_each(&compulsory_tests, i, list)
289 if (streq(i->key, key))
292 list_for_each(&normal_tests, i, list)
293 if (streq(i->key, key))
299 static char *keep_test(const char *testname, void *unused)
301 struct ccanlint *i = find_test(testname);
303 errx(1, "No test %s to --keep", testname);
304 i->keep_results = true;
308 static char *skip_test(const char *testname, void *unused)
310 btree_insert(cmdline_exclude, optarg);
314 static void print_tests(struct list_head *tests, const char *type)
318 printf("%s tests:\n", type);
319 /* This makes them print in topological order. */
320 while ((i = get_next_test(tests)) != NULL) {
321 const struct dependent *d;
322 printf(" %-25s %s\n", i->key, i->name);
324 list_for_each(&i->dependencies, d, node)
325 d->dependent->num_depends--;
329 static char *list_tests(void *arg)
331 print_tests(&compulsory_tests, "Compulsory");
332 print_tests(&normal_tests, "Normal");
336 static char *strip(const void *ctx, const char *line)
338 line += strcspn(line, IDENT_CHARS "-");
339 return talloc_strndup(ctx, line, strspn(line, IDENT_CHARS "-"));
342 static void add_info_fails(struct ccan_file *info)
344 struct doc_section *d;
347 list_for_each(get_ccan_file_docs(info), d, list) {
348 if (!streq(d->type, "fails"))
351 for (i = 0; i < d->num_lines; i++)
352 btree_insert(info_exclude, strip(info, d->lines[i]));
357 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
359 const struct dependent *d;
364 list_for_each(&i->dependencies, d, node) {
365 if (depends_on(d->dependent, target))
371 /* O(N^2), who cares? */
372 static void skip_unrelated_tests(struct ccanlint *target)
375 struct list_head *list;
377 foreach_ptr(list, &compulsory_tests, &normal_tests)
378 list_for_each(list, i, list)
379 if (!depends_on(i, target))
380 i->skip = "not relevant to target";
383 int main(int argc, char *argv[])
385 bool summary = false;
386 unsigned int score = 0, total_score = 0;
389 const char *prefix = "";
390 char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
394 cmdline_exclude = btree_new(btree_strcmp);
395 info_exclude = btree_new(btree_strcmp);
397 opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
398 "use this directory");
399 opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
400 "do not compile anything");
401 opt_register_noarg("-l|--list-tests", list_tests, NULL,
402 "list tests ccanlint performs (and exit)");
403 opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
404 "keep results of <testname> (can be used multiple times)");
405 opt_register_noarg("--summary|-s", opt_set_bool, &summary,
406 "simply give one line summary");
407 opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
408 "verbose mode (can specify more than once)");
409 opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
410 "exclude <testname> (can be used multiple times)");
411 opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
413 "ignore (terminate) tests that are slower than this");
414 opt_register_arg("--target <testname>", opt_set_charp,
416 "only run one test (and its prerequisites)");
417 opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
418 "\nA program for checking and guiding development"
420 "This usage message");
422 opt_parse(&argc, argv, opt_log_stderr_exit);
425 dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
427 prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
429 compile_verbose = true;
431 tools_verbose = true;
433 /* We move into temporary directory, so gcov dumps its files there. */
434 if (chdir(temp_dir(talloc_autofree_context())) != 0)
435 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
437 m = get_manifest(talloc_autofree_context(), dir);
439 /* Create a symlink from temp dir back to src dir's test directory. */
440 if (symlink(talloc_asprintf(m, "%s/test", dir),
441 talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0)
442 err(1, "Creating test symlink in %s", temp_dir(NULL));
445 struct ccanlint *test;
447 test = find_test(target);
449 err(1, "Unknown test to run '%s'", target);
450 skip_unrelated_tests(test);
453 /* If you don't pass the compulsory tests, you get a score of 0. */
455 printf("Compulsory tests:\n");
457 while ((i = get_next_test(&compulsory_tests)) != NULL) {
458 if (!run_test(i, summary, &score, &total_score, m)) {
459 printf("%sTotal score: 0/%u\n", prefix, total_score);
460 errx(1, "%s%s failed", prefix, i->name);
464 add_info_fails(m->info_file);
467 printf("\nNormal tests:\n");
468 while ((i = get_next_test(&normal_tests)) != NULL)
469 run_test(i, summary, &score, &total_score, m);
471 printf("%sTotal score: %u/%u\n", prefix, score, total_score);