git.ozlabs.org Git - ccan/blob - tools/ccanlint/ccanlint.c

   1 /*
   2  * ccanlint: assorted checks and advice for a ccan package
   3  * Copyright (C) 2008 Rusty Russell, Idris Soule
   4  *
   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)
   8  * any later version.
   9  *
  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
  13  * more details.
  14  *
  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.
  18  */
  19 #include "ccanlint.h"
  20 #include "../tools.h"
  21 #include <unistd.h>
  22 #include <getopt.h>
  23 #include <stdarg.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <err.h>
  28 #include <ctype.h>
  29 #include <ccan/btree/btree.h>
  30 #include <ccan/str/str.h>
  31 #include <ccan/str_talloc/str_talloc.h>
  32 #include <ccan/talloc/talloc.h>
  33
  34 static unsigned int verbose = 0;
  35 static LIST_HEAD(compulsory_tests);
  36 static LIST_HEAD(normal_tests);
  37 static LIST_HEAD(finished_tests);
  38 bool safe_mode = false;
  39 static struct btree *exclude;
  40 static unsigned int timeout;
  41
  42 static void usage(const char *name)
  43 {
  44         fprintf(stderr, "Usage: %s [-s] [-n] [-v] [-t <ms>] [-d <dirname>] [-x <tests>] [-k <test>]*\n"
  45                 "   -v: verbose mode\n"
  46                 "   -s: simply give one line summary\n"
  47                 "   -d: use this directory instead of the current one\n"
  48                 "   -n: do not compile anything\n"
  49                 "   -l: list tests ccanlint performs\n"
  50                 "   -k: keep results of this test (can be used multiple times)\n"
  51                 "   -x: exclude tests (e.g. -x trailing_whitespace,valgrind)\n"
  52                 "   -t: ignore (terminate) tests that are slower than this\n",
  53                 name);
  54         exit(1);
  55 }
  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[2];
  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 static const char *should_skip(struct manifest *m, struct ccanlint *i)
  84 {
  85         if (btree_lookup(exclude, i->key))
  86                 return "excluded on command line";
  87
  88         if (i->skip_fail)
  89                 return "dependency failed";
  90
  91         if (i->skip)
  92                 return "dependency was skipped";
  93
  94         if (i->can_run)
  95                 return i->can_run(m);
  96         return NULL;
  97 }
  98
  99 static bool run_test(struct ccanlint *i,
 100                      bool quiet,
 101                      unsigned int *score,
 102                      unsigned int *total_score,
 103                      struct manifest *m)
 104 {
 105         void *result;
 106         unsigned int this_score, timeleft;
 107         const struct dependent *d;
 108         const char *skip;
 109         bool failed;
 110
 111         //one less test to run through
 112         list_for_each(&i->dependencies, d, node)
 113                 d->dependent->num_depends--;
 114
 115         skip = should_skip(m, i);
 116
 117         if (skip) {
 118         skip:
 119                 if (verbose)
 120                         printf("  %s: skipped (%s)\n", i->name, skip);
 121
 122                 /* If we're skipping this because a prereq failed, we fail. */
 123                 if (i->skip_fail)
 124                         *total_score += i->total_score;
 125
 126                 list_del(&i->list);
 127                 list_add_tail(&finished_tests, &i->list);
 128                 list_for_each(&i->dependencies, d, node) {
 129                         d->dependent->skip = true;
 130                         d->dependent->skip_fail = i->skip_fail;
 131                 }
 132                 return true;
 133         }
 134
 135         timeleft = timeout ? timeout : default_timeout_ms;
 136         result = i->check(m, i->keep_results, &timeleft);
 137         if (timeout && timeleft == 0) {
 138                 skip = "timeout";
 139                 goto skip;
 140         }
 141
 142         if (!result)
 143                 this_score = i->total_score ? i->total_score : 1;
 144         else if (i->score)
 145                 this_score = i->score(m, result);
 146         else
 147                 this_score = 0;
 148
 149         failed = (this_score == 0);
 150
 151         if (verbose) {
 152                 printf("  %s: %s", i->name, failed ? "FAIL" : "OK");
 153                 if (i->total_score)
 154                         printf(" (+%u/%u)",
 155                                        this_score, i->total_score);
 156                 printf("\n");
 157         }
 158
 159         if (!quiet && result) {
 160                 if (i->describe && (failed || verbose))
 161                         printf("    %s\n", i->describe(m, result));
 162                 if (i->handle)
 163                         i->handle(m, result);
 164         }
 165
 166         if (i->total_score) {
 167                 *score += this_score;
 168                 *total_score += i->total_score;
 169         }
 170
 171         list_del(&i->list);
 172         list_add_tail(&finished_tests, &i->list);
 173
 174         if (failed) {
 175                 /* Skip any tests which depend on this one. */
 176                 list_for_each(&i->dependencies, d, node) {
 177                         d->dependent->skip = true;
 178                         d->dependent->skip_fail = true;
 179                 }
 180         }
 181         return !failed;
 182 }
 183
 184 static void register_test(struct list_head *h, struct ccanlint *test, ...)
 185 {
 186         va_list ap;
 187         struct ccanlint *depends;
 188         struct dependent *dchild;
 189
 190         list_add(h, &test->list);
 191
 192         va_start(ap, test);
 193         /* Careful: we might have been initialized by a dependent. */
 194         if (test->dependencies.n.next == NULL)
 195                 list_head_init(&test->dependencies);
 196
 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);
 205                 test->num_depends++;
 206         }
 207         va_end(ap);
 208 }
 209
 210 /**
 211  * get_next_test - retrieves the next test to be processed
 212  **/
 213 static inline struct ccanlint *get_next_test(struct list_head *test)
 214 {
 215         struct ccanlint *i;
 216
 217         if (list_empty(test))
 218                 return NULL;
 219
 220         list_for_each(test, i, list) {
 221                 if (i->num_depends == 0)
 222                         return i;
 223         }
 224         errx(1, "Can't make process; test dependency cycle");
 225 }
 226
 227 static void init_tests(void)
 228 {
 229         const struct ccanlint *i;
 230         struct btree *keys, *names;
 231
 232 #undef REGISTER_TEST
 233 #define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__)
 234 #include "generated-normal-tests"
 235 #undef REGISTER_TEST
 236 #define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__)
 237 #include "generated-compulsory-tests"
 238
 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);
 248         }
 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);
 254         }
 255         btree_delete(keys);
 256         btree_delete(names);
 257
 258         if (!verbose)
 259                 return;
 260
 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);
 269                 }
 270         }
 271
 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);
 280                 }
 281         }
 282 }
 283
 284 static struct ccanlint *find_test(const char *key)
 285 {
 286         struct ccanlint *i;
 287
 288         list_for_each(&compulsory_tests, i, list)
 289                 if (streq(i->key, key))
 290                         return i;
 291
 292         list_for_each(&normal_tests, i, list)
 293                 if (streq(i->key, key))
 294                         return i;
 295
 296         return NULL;
 297 }
 298
 299 static void keep_test(const char *testname)
 300 {
 301         struct ccanlint *i = find_test(testname);
 302         if (!i)
 303                 errx(1, "No test %s to --keep", testname);
 304         i->keep_results = true;
 305 }
 306
 307 static void print_tests(struct list_head *tests, const char *type)
 308 {
 309         struct ccanlint *i;
 310
 311         printf("%s tests:\n", type);
 312         /* This makes them print in topological order. */
 313         while ((i = get_next_test(tests)) != NULL) {
 314                 const struct dependent *d;
 315                 printf("   %-25s %s\n", i->key, i->name);
 316                 list_del(&i->list);
 317                 list_for_each(&i->dependencies, d, node)
 318                         d->dependent->num_depends--;
 319         }
 320 }
 321
 322 static void list_tests(void)
 323 {
 324         print_tests(&compulsory_tests, "Compulsory");
 325         print_tests(&normal_tests, "Normal");
 326         exit(0);
 327 }
 328
 329 int main(int argc, char *argv[])
 330 {
 331         int c;
 332         bool summary = false;
 333         unsigned int score = 0, total_score = 0;
 334         struct manifest *m;
 335         struct ccanlint *i;
 336         const char *prefix = "", *dir = talloc_getcwd(NULL);
 337
 338         init_tests();
 339
 340         exclude = btree_new(btree_strcmp);
 341
 342         /* I'd love to use long options, but that's not standard. */
 343         /* FIXME: popt ccan package? */
 344         while ((c = getopt(argc, argv, "sd:vnlx:t:k:")) != -1) {
 345                 switch (c) {
 346                 case 'd':
 347                         if (optarg[0] != '/')
 348                                 dir = talloc_asprintf_append(NULL, "%s/%s",
 349                                                              dir, optarg);
 350                         else
 351                                 dir = optarg;
 352                         prefix = talloc_append_string(talloc_basename(NULL,
 353                                                                       optarg),
 354                                                       ": ");
 355                         break;
 356                 case 'l':
 357                         list_tests();
 358                 case 's':
 359                         summary = true;
 360                         break;
 361                 case 'v':
 362                         verbose++;
 363                         break;
 364                 case 'n':
 365                         safe_mode = true;
 366                         break;
 367                 case 'k':
 368                         keep_test(optarg);
 369                         break;
 370                 case 'x': {
 371                         char **exclude_strs = strsplit(NULL, optarg, ",", NULL);
 372                         size_t i;
 373                         for (i = 0; exclude_strs[i]; i++)
 374                                 btree_insert(exclude, exclude_strs[i]);
 375                 } break;
 376                 case 't':
 377                         timeout = atoi(optarg);
 378                         if (!timeout)
 379                                 errx(1, "Invalid timeout %s: 1 ms minumum",
 380                                      optarg);
 381                         break;
 382                 default:
 383                         usage(argv[0]);
 384                 }
 385         }
 386
 387         if (optind < argc)
 388                 usage(argv[0]);
 389
 390         /* We move into temporary directory, so gcov dumps its files there. */
 391         if (chdir(temp_dir(talloc_autofree_context())) != 0)
 392                 err(1, "Error changing to %s temporary dir", temp_dir(NULL));
 393
 394         m = get_manifest(talloc_autofree_context(), dir);
 395
 396         /* If you don't pass the compulsory tests, you don't even get a score */
 397         if (verbose)
 398                 printf("Compulsory tests:\n");
 399
 400         while ((i = get_next_test(&compulsory_tests)) != NULL) {
 401                 if (!run_test(i, summary, &score, &total_score, m)) {
 402                         errx(1, "%s%s failed", prefix, i->name);
 403                 }
 404         }
 405
 406         if (verbose)
 407                 printf("\nNormal tests:\n");
 408         while ((i = get_next_test(&normal_tests)) != NULL)
 409                 run_test(i, summary, &score, &total_score, m);
 410
 411         printf("%sTotal score: %u/%u\n", prefix, score, total_score);
 412         return 0;
 413 }