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