tools: use tal/path instead of writing own path handlers.
[ccan] / tools / ccanlint / ccanlint.c
1 /*
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
5  *
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)
9  * any later version.
10  *
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
14  * more details.
15  *
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.
19  */
20 #include "ccanlint.h"
21 #include "../tools.h"
22 #include "../read_config_header.h"
23 #include <unistd.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <err.h>
28 #include <ctype.h>
29 #include <ccan/str/str.h>
30 #include <ccan/take/take.h>
31 #include <ccan/opt/opt.h>
32 #include <ccan/foreach/foreach.h>
33 #include <ccan/cast/cast.h>
34 #include <ccan/tlist/tlist.h>
35 #include <ccan/tal/path/path.h>
36 #include <ccan/strmap/strmap.h>
37
38 struct ccanlint_map {
39         STRMAP_MEMBERS(struct ccanlint *);
40 };
41
42 int verbose = 0;
43 static struct ccanlint_map tests;
44 bool safe_mode = false;
45 bool keep_results = false;
46 static bool targeting = false;
47 static unsigned int timeout;
48
49 /* These are overridden at runtime if we can find config.h */
50 const char *compiler = NULL;
51 const char *cflags = NULL;
52
53 const char *config_header;
54
55 const char *ccan_dir;
56
57 #if 0
58 static void indent_print(const char *string)
59 {
60         while (*string) {
61                 unsigned int line = strcspn(string, "\n");
62                 printf("\t%.*s", line, string);
63                 if (string[line] == '\n') {
64                         printf("\n");
65                         line++;
66                 }
67                 string += line;
68         }
69 }
70 #endif
71
72 bool ask(const char *question)
73 {
74         char reply[80];
75
76         printf("%s ", question);
77         fflush(stdout);
78
79         return fgets(reply, sizeof(reply), stdin) != NULL
80                 && toupper(reply[0]) == 'Y';
81 }
82
83 /* Skip, but don't remove. */
84 static bool skip_test(struct dgraph_node *node, const char *why)
85 {
86         struct ccanlint *c = container_of(node, struct ccanlint, node);
87         c->skip = why;
88         return true;
89 }
90
91 static const char *dep_failed(struct manifest *m)
92 {
93         return "dependency couldn't run";
94 }
95
96 static bool cannot_run(struct dgraph_node *node, void *unused)
97 {
98         struct ccanlint *c = container_of(node, struct ccanlint, node);
99         c->can_run = dep_failed;
100         return true;
101 }
102
103 struct run_info {
104         bool quiet;
105         unsigned int score, total;
106         struct manifest *m;
107         const char *prefix;
108         bool pass;
109 };
110
111 static bool run_test(struct dgraph_node *n, struct run_info *run)
112 {
113         struct ccanlint *i = container_of(n, struct ccanlint, node);
114         unsigned int timeleft;
115         struct score *score;
116
117         if (i->done)
118                 return true;
119
120         score = tal(run->m, struct score);
121         list_head_init(&score->per_file_errors);
122         score->error = NULL;
123         score->pass = false;
124         score->score = 0;
125         score->total = 1;
126
127         /* We can see skipped things in two cases:
128          * (1) _info excluded them (presumably because they fail).
129          * (2) A prerequisite failed.
130          */
131         if (i->skip) {
132                 if (verbose)
133                         printf("%s%s: skipped (%s)\n",
134                                run->prefix, i->name, i->skip);
135                 /* Pass us up to the test which failed, not us. */
136                 score->pass = true;
137                 goto out;
138         }
139
140         if (i->can_run) {
141                 i->skip = i->can_run(run->m);
142                 if (i->skip) {
143                         /* Test doesn't apply, or can't run?  That's OK. */
144                         if (verbose > 1)
145                                 printf("%s%s: skipped (%s)\n",
146                                        run->prefix, i->name, i->skip);
147                         /* Mark our dependencies to skip. */
148                         dgraph_traverse_from(&i->node, cannot_run, NULL);
149                         score->pass = true;
150                         score->total = 0;
151                         goto out;
152                 }
153         }
154
155         timeleft = timeout ? timeout : default_timeout_ms;
156         i->check(run->m, &timeleft, score);
157         if (timeout && timeleft == 0) {
158                 i->skip = "timeout";
159                 if (verbose)
160                         printf("%s%s: skipped (%s)\n",
161                                run->prefix, i->name, i->skip);
162                 /* Mark our dependencies to skip. */
163                 dgraph_traverse_from(&i->node, skip_test,
164                                      "dependency timed out");
165                 score->pass = true;
166                 score->total = 0;
167                 goto out;
168         }
169
170         assert(score->score <= score->total);
171         if ((!score->pass && !run->quiet)
172             || (score->score < score->total && verbose)
173             || verbose > 1) {
174                 printf("%s%s (%s): %s",
175                        run->prefix, i->name, i->key,
176                        score->pass ? "PASS" : "FAIL");
177                 if (score->total > 1)
178                         printf(" (+%u/%u)", score->score, score->total);
179                 printf("\n");
180         }
181
182         if ((!run->quiet && !score->pass) || verbose) {
183                 if (score->error) {
184                         printf("%s%s", score->error,
185                                strends(score->error, "\n") ? "" : "\n");
186                 }
187         }
188         if (!run->quiet && score->score < score->total && i->handle)
189                 i->handle(run->m, score);
190
191         if (!score->pass) {
192                 /* Skip any tests which depend on this one. */
193                 dgraph_traverse_from(&i->node, skip_test, "dependency failed");
194         }
195
196 out:
197         run->score += score->score;
198         run->total += score->total;
199
200         /* FIXME: Free score. */
201         run->pass &= score->pass;
202         i->done = true;
203
204         if (!score->pass && i->compulsory) {
205                 warnx("%s%s failed", run->prefix, i->name);
206                 run->score = 0;
207                 return false;
208         }
209         return true;
210 }
211
212 static void register_test(struct ccanlint *test)
213 {
214         if (!strmap_add(&tests, test->key, test))
215                 err(1, "Adding test %s", test->key);
216         test->options = tal_arr(NULL, char *, 1);
217         test->options[0] = NULL;
218         dgraph_init_node(&test->node);
219 }
220
221 static bool get_test(const char *member, struct ccanlint *i,
222                      struct ccanlint **ret)
223 {
224         if (tlist_empty(&i->node.edge[DGRAPH_TO])) {
225                 *ret = i;
226                 return false;
227         }
228         return true;
229 }
230
231 /**
232  * get_next_test - retrieves the next test to be processed
233  **/
234 static inline struct ccanlint *get_next_test(void)
235 {
236         struct ccanlint *i = NULL;
237
238         strmap_iterate(&tests, get_test, &i);
239         if (i)
240                 return i;
241
242         if (strmap_empty(&tests))
243                 return NULL;
244
245         errx(1, "Can't make process; test dependency cycle");
246 }
247
248 static struct ccanlint *find_test(const char *key)
249 {
250         return strmap_get(&tests, key);
251 }
252
253 bool is_excluded(const char *name)
254 {
255         return find_test(name)->skip != NULL;
256 }
257
258 static bool init_deps(const char *member, struct ccanlint *c, void *unused)
259 {
260         char **deps = tal_strsplit(NULL, c->needs, " ", STR_EMPTY_OK);
261         unsigned int i;
262
263         for (i = 0; deps[i]; i++) {
264                 struct ccanlint *dep;
265
266                 dep = find_test(deps[i]);
267                 if (!dep)
268                         errx(1, "BUG: unknown dep '%s' for %s",
269                              deps[i], c->key);
270                 dgraph_add_edge(&dep->node, &c->node);
271         }
272         tal_free(deps);
273         return true;
274 }
275
276 static bool check_names(const char *member, struct ccanlint *c,
277                         struct ccanlint_map *names)
278 {
279         if (!strmap_add(names, c->name, c))
280                 err(1, "Duplicate name %s", c->name);
281         return true;
282 }
283
284 static void init_tests(void)
285 {
286         struct ccanlint_map names;
287         struct ccanlint **table;
288         size_t i, num;
289
290         strmap_init(&tests);
291
292         table = autodata_get(ccanlint_tests, &num);
293         for (i = 0; i < num; i++)
294                 register_test(table[i]);
295         autodata_free(table);
296
297         strmap_iterate(&tests, init_deps, NULL);
298
299         /* Check for duplicate names. */
300         strmap_init(&names);
301         strmap_iterate(&tests, check_names, &names);
302         strmap_clear(&names);
303 }
304
305 static bool reset_test(struct dgraph_node *node, void *unused)
306 {
307         struct ccanlint *c = container_of(node, struct ccanlint, node);
308         c->skip = NULL;
309         c->done = false;
310         return true;
311 }
312
313 static void reset_tests(struct dgraph_node *all)
314 {
315         dgraph_traverse_to(all, reset_test, NULL);
316 }
317
318 static bool print_deps(const char *member, struct ccanlint *c, void *unused)
319 {
320         if (!tlist_empty(&c->node.edge[DGRAPH_FROM])) {
321                 struct dgraph_edge *e;
322
323                 printf("These depend on %s:\n", c->key);
324                 dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) {
325                         struct ccanlint *to = container_of(e->n[DGRAPH_TO],
326                                                            struct ccanlint,
327                                                            node);
328                         printf("\t%s\n", to->key);
329                 }
330         }
331         return true;
332 }
333
334 static void print_test_depends(void)
335 {
336         printf("Tests:\n");
337
338         strmap_iterate(&tests, print_deps, NULL);
339 }
340
341
342 static void show_tmpdir(const char *dir)
343 {
344         printf("You can find ccanlint working files in '%s'\n", dir);
345 }
346
347 static char *keep_tests(void *unused)
348 {
349         keep_results = true;
350
351         /* Don't automatically destroy temporary dir. */
352         keep_temp_dir();
353         tal_add_destructor(temp_dir(), show_tmpdir);
354         return NULL;
355 }
356
357 static bool remove_test(struct dgraph_node *node, const char *why)
358 {
359         struct ccanlint *c = container_of(node, struct ccanlint, node);
360         c->skip = why;
361         dgraph_clear_node(node);
362         return true;
363 }
364
365 static char *exclude_test(const char *testname, void *unused)
366 {
367         struct ccanlint *i = find_test(testname);
368         if (!i)
369                 return tal_fmt(NULL, "No test %s to --exclude", testname);
370
371         /* Remove this, and everything which depends on it. */
372         dgraph_traverse_from(&i->node, remove_test, "excluded on command line");
373         remove_test(&i->node, "excluded on command line");
374         return NULL;
375 }
376
377 static void skip_test_and_deps(struct ccanlint *c, const char *why)
378 {
379         /* Skip this, and everything which depends on us. */
380         dgraph_traverse_from(&c->node, skip_test, why);
381         skip_test(&c->node, why);
382 }
383
384 static char *list_tests(void *arg)
385 {
386         struct ccanlint *i;
387
388         printf("Tests:\n");
389         /* This makes them print in topological order. */
390         while ((i = get_next_test()) != NULL) {
391                 printf("   %-25s %s\n", i->key, i->name);
392                 dgraph_clear_node(&i->node);
393                 strmap_del(&tests, i->key, NULL);
394         }
395         exit(0);
396 }
397
398 static bool draw_test(const char *member, struct ccanlint *c, const char *style)
399 {
400         /*
401          * todo: escape labels in case ccanlint test keys have
402          *       characters interpreted as GraphViz syntax.
403          */
404         printf("\t\"%p\" [label=\"%s\"%s]\n", c, c->key, style);
405         return true;
406 }
407
408 static void test_dgraph_vertices(const char *style)
409 {
410         strmap_iterate(&tests, draw_test, style);
411 }
412
413 static bool draw_edges(const char *member, struct ccanlint *c, void *unused)
414 {
415         struct dgraph_edge *e;
416
417         dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) {
418                 struct ccanlint *to = container_of(e->n[DGRAPH_TO],
419                                                    struct ccanlint,
420                                                    node);
421                 printf("\t\"%p\" -> \"%p\"\n", c->name, to->name);
422         }
423         return true;
424 }
425
426 static void test_dgraph_edges(void)
427 {
428         strmap_iterate(&tests, draw_edges, NULL);
429 }
430
431 static char *test_dependency_graph(void *arg)
432 {
433         puts("digraph G {");
434
435         test_dgraph_vertices("");
436         test_dgraph_edges();
437
438         puts("}");
439
440         exit(0);
441 }
442
443 static void add_options(struct ccanlint *test, char **options,
444                         unsigned int num_options)
445 {
446         unsigned int num;
447
448         if (!test->options)
449                 num = 0;
450         else
451                 /* -1, because last one is NULL. */
452                 num = tal_count(test->options) - 1;
453
454         tal_resize(&test->options, num + num_options + 1);
455         memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *));
456 }
457
458 void add_info_options(struct ccan_file *info)
459 {
460         struct doc_section *d;
461         unsigned int i;
462         struct ccanlint *test;
463
464         list_for_each(get_ccan_file_docs(info), d, list) {
465                 if (!streq(d->type, "ccanlint"))
466                         continue;
467
468                 for (i = 0; i < d->num_lines; i++) {
469                         char **words = tal_strsplit(d, d->lines[i], " \t",
470                                                     STR_NO_EMPTY);
471                         if (!words[0])
472                                 continue;
473
474                         if (strncmp(words[0], "//", 2) == 0)
475                                 continue;
476
477                         test = find_test(words[0]);
478                         if (!test) {
479                                 warnx("%s: unknown ccanlint test '%s'",
480                                       info->fullname, words[0]);
481                                 continue;
482                         }
483
484                         if (!words[1]) {
485                                 warnx("%s: no argument to test '%s'",
486                                       info->fullname, words[0]);
487                                 continue;
488                         }
489
490                         /* Known failure? */
491                         if (strcasecmp(words[1], "FAIL") == 0) {
492                                 if (!targeting)
493                                         skip_test_and_deps(test,
494                                                            "excluded in _info"
495                                                            " file");
496                         } else {
497                                 if (!test->takes_options)
498                                         warnx("%s: %s doesn't take options",
499                                               info->fullname, words[0]);
500                                 add_options(test, words+1, tal_count(words)-1);
501                         }
502                 }
503         }
504 }
505
506 /* If options are of form "filename:<option>" they only apply to that file */
507 char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
508 {
509         char **ret;
510         unsigned int i, j = 0;
511
512         /* Fast path. */
513         if (!test->options[0])
514                 return test->options;
515
516         ret = tal_arr(f, char *, tal_count(test->options));
517         for (i = 0; test->options[i]; i++) {
518                 char *optname;
519
520                 if (!test->options[i] || !strchr(test->options[i], ':')) {
521                         optname = test->options[i];
522                 } else if (strstarts(test->options[i], f->name)
523                            && test->options[i][strlen(f->name)] == ':') {
524                         optname = test->options[i] + strlen(f->name) + 1;
525                 } else
526                         continue;
527
528                 /* FAIL overrides anything else. */
529                 if (streq(optname, "FAIL")) {
530                         ret = tal_arr(f, char *, 2);
531                         ret[0] = (char *)"FAIL";
532                         ret[1] = NULL;
533                         return ret;
534                 }
535                 ret[j++] = optname;
536         }
537         ret[j] = NULL;
538
539         /* Shrink it to size so tal_array_length() works as expected. */
540         tal_resize(&ret, j + 1);
541         return ret;
542 }
543
544 static char *opt_set_const_charp(const char *arg, const char **p)
545 {
546         return opt_set_charp(arg, cast_const2(char **, p));
547 }
548
549 static char *opt_set_target(const char *arg, struct dgraph_node *all)
550 {
551         struct ccanlint *t = find_test(arg);
552         if (!t)
553                 return tal_fmt(NULL, "unknown --target %s", arg);
554
555         targeting = true;
556         dgraph_add_edge(&t->node, all);
557         return NULL;
558 }
559
560 static bool run_tests(struct dgraph_node *all,
561                       bool summary,
562                       struct manifest *m,
563                       const char *prefix)
564 {
565         struct run_info run;
566
567         run.quiet = summary;
568         run.m = m;
569         run.prefix = prefix;
570         run.score = run.total = 0;
571         run.pass = true;
572
573         dgraph_traverse_to(all, run_test, &run);
574
575         printf("%sTotal score: %u/%u\n", prefix, run.score, run.total);
576         return run.pass;
577 }
578
579 static bool add_to_all(const char *member, struct ccanlint *c,
580                        struct dgraph_node *all)
581 {
582         /* If we're excluded on cmdline, don't add. */
583         if (!c->skip)
584                 dgraph_add_edge(&c->node, all);
585         return true;
586 }
587
588 int main(int argc, char *argv[])
589 {
590         bool summary = false, pass = true;
591         unsigned int i;
592         struct manifest *m;
593         const char *prefix = "";
594         char *dir = path_cwd(NULL), *base_dir = dir, *testlink;
595         struct dgraph_node all;
596         
597         /* Empty graph node to which we attach everything else. */
598         dgraph_init_node(&all);
599
600         opt_register_early_noarg("--verbose|-v", opt_inc_intval, &verbose,
601                                  "verbose mode (up to -vvvv)");
602         opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
603                          "do not compile anything");
604         opt_register_noarg("-l|--list-tests", list_tests, NULL,
605                          "list tests ccanlint performs (and exit)");
606         opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL,
607                          "print dependency graph of tests in Graphviz .dot format");
608         opt_register_noarg("-k|--keep", keep_tests, NULL,
609                          "do not delete ccanlint working files");
610         opt_register_noarg("--summary|-s", opt_set_bool, &summary,
611                            "simply give one line summary");
612         opt_register_arg("-x|--exclude <testname>", exclude_test, NULL, NULL,
613                          "exclude <testname> (can be used multiple times)");
614         opt_register_arg("--timeout <milleseconds>", opt_set_uintval,
615                          NULL, &timeout,
616                          "ignore (terminate) tests that are slower than this");
617         opt_register_arg("-t|--target <testname>", opt_set_target, NULL, &all,
618                          "only run one test (and its prerequisites)");
619         opt_register_arg("--compiler <compiler>", opt_set_const_charp,
620                          NULL, &compiler, "set the compiler");
621         opt_register_arg("--cflags <flags>", opt_set_const_charp,
622                          NULL, &cflags, "set the compiler flags");
623         opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
624                            "\nA program for checking and guiding development"
625                            " of CCAN modules.",
626                            "This usage message");
627
628         /* Do verbose before anything else... */
629         opt_early_parse(argc, argv, opt_log_stderr_exit);
630
631         /* We move into temporary directory, so gcov dumps its files there. */
632         if (chdir(temp_dir()) != 0)
633                 err(1, "Error changing to %s temporary dir", temp_dir());
634
635         init_tests();
636
637         if (verbose >= 3) {
638                 compile_verbose = true;
639                 print_test_depends();
640         }
641         if (verbose >= 4)
642                 tools_verbose = true;
643
644         opt_parse(&argc, argv, opt_log_stderr_exit);
645
646         if (!targeting)
647                 strmap_iterate(&tests, add_to_all, &all);
648
649         /* This links back to the module's test dir. */
650         testlink = tal_fmt(NULL, "%s/test", temp_dir());
651
652         /* Defaults to pwd. */
653         if (argc == 1) {
654                 i = 1;
655                 goto got_dir;
656         }
657
658         for (i = 1; i < argc; i++) {
659                 dir = argv[i];
660
661                 if (dir[0] != '/')
662                         dir = tal_fmt(NULL, "%s/%s", base_dir, dir);
663                 while (strends(dir, "/"))
664                         dir[strlen(dir)-1] = '\0';
665
666         got_dir:
667                 /* We assume there's a ccan/ in there somewhere... */
668                 if (i == 1) {
669                         ccan_dir = find_ccan_dir(dir);
670                         if (!ccan_dir)
671                                 errx(1, "Cannot find ccan/ base directory in %s",
672                                      dir);
673                         config_header = read_config_header(ccan_dir,
674                                                            &compiler, &cflags,
675                                                            verbose > 1);
676                 }
677
678                 if (dir != base_dir)
679                         prefix = tal_strcat(NULL,
680                                             take(path_basename(NULL,dir)),
681                                             ": ");
682
683                 m = get_manifest(autofree(), dir);
684
685                 /* Create a symlink from temp dir back to src dir's
686                  * test directory. */
687                 unlink(testlink);
688                 if (symlink(tal_fmt(m, "%s/test", dir), testlink) != 0)
689                         err(1, "Creating test symlink in %s", temp_dir());
690
691                 if (!run_tests(&all, summary, m, prefix))
692                         pass = false;
693
694                 reset_tests(&all);
695         }
696         return pass ? 0 : 1;
697 }