]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.c
jmap: fix aliasing issues, one real testcase bug
[ccan] / tools / ccanlint / ccanlint.c
index 179f270344cd00a4a8109e18384bb6d555bf5d21..ab805806144670e29dc01e05db63c80706c8030c 100644 (file)
@@ -19,7 +19,6 @@
 #include "ccanlint.h"
 #include "../tools.h"
 #include <unistd.h>
-#include <getopt.h>
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <ccan/str/str.h>
 #include <ccan/str_talloc/str_talloc.h>
 #include <ccan/talloc/talloc.h>
+#include <ccan/opt/opt.h>
 
-unsigned int verbose = 0;
+int verbose = 0;
 static LIST_HEAD(compulsory_tests);
 static LIST_HEAD(normal_tests);
 static LIST_HEAD(finished_tests);
 bool safe_mode = false;
-static struct btree *exclude;
+static struct btree *cmdline_exclude;
+static struct btree *info_exclude;
 static unsigned int timeout;
 
-static void usage(const char *name)
-{
-       fprintf(stderr, "Usage: %s [-s] [-n] [-v] [-t <ms>] [-d <dirname>] [-x <tests>] [-k <test>]*\n"
-               "   -v: verbose mode (can specify more than once)\n"
-               "   -s: simply give one line summary\n"
-               "   -d: use this directory instead of the current one\n"
-               "   -n: do not compile anything\n"
-               "   -l: list tests ccanlint performs\n"
-               "   -k: keep results of this test (can be used multiple times)\n"
-               "   -x: exclude tests (e.g. -x trailing_whitespace,valgrind)\n"
-               "   -t: ignore (terminate) tests that are slower than this\n",
-               name);
-       exit(1);
-}
-
 #if 0
 static void indent_print(const char *string)
 {
@@ -82,8 +68,11 @@ bool ask(const char *question)
 
 static const char *should_skip(struct manifest *m, struct ccanlint *i)
 {
-       if (btree_lookup(exclude, i->key))
+       if (btree_lookup(cmdline_exclude, i->key))
                return "excluded on command line";
+
+       if (btree_lookup(info_exclude, i->key))
+               return "excluded in _info file";
        
        if (i->skip_fail)
                return "dependency failed";
@@ -103,7 +92,7 @@ static bool run_test(struct ccanlint *i,
                     struct manifest *m)
 {
        void *result;
-       unsigned int this_score, timeleft;
+       unsigned int this_score, max_score, timeleft;
        const struct dependent *d;
        const char *skip;
        bool bad, good;
@@ -139,22 +128,25 @@ static bool run_test(struct ccanlint *i,
                goto skip;
        }
 
+       max_score = i->total_score;
+       if (!max_score)
+               max_score = 1;
+
        if (!result)
-               this_score = i->total_score ? i->total_score : 1;
+               this_score = max_score;
        else if (i->score)
                this_score = i->score(m, result);
        else
                this_score = 0;
 
        bad = (this_score == 0);
-       good = (this_score >= i->total_score);
+       good = (this_score >= max_score);
 
-       if (verbose || (bad && !quiet)) {
+       if (verbose || (!good && !quiet)) {
                printf("  %s: %s", i->name,
                       bad ? "FAIL" : good ? "PASS" : "PARTIAL");
-               if (i->total_score)
-                       printf(" (+%u/%u)",
-                                      this_score, i->total_score);
+               if (max_score > 1)
+                       printf(" (+%u/%u)", this_score, max_score);
                printf("\n");
        }
 
@@ -233,10 +225,10 @@ static void init_tests(void)
        struct btree *keys, *names;
 
 #undef REGISTER_TEST
-#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__)
+#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__, NULL)
 #include "generated-normal-tests"
 #undef REGISTER_TEST
-#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__)
+#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__, NULL)
 #include "generated-compulsory-tests"
 
        /* Self-consistency check: make sure no two tests
@@ -299,12 +291,19 @@ static struct ccanlint *find_test(const char *key)
        return NULL;
 }
 
-static void keep_test(const char *testname)
+static char *keep_test(const char *testname, void *unused)
 {
        struct ccanlint *i = find_test(testname);
        if (!i)
                errx(1, "No test %s to --keep", testname);
        i->keep_results = true;
+       return NULL;
+}
+
+static char *skip_test(const char *testname, void *unused)
+{
+       btree_insert(cmdline_exclude, optarg);
+       return NULL;
 }
 
 static void print_tests(struct list_head *tests, const char *type)
@@ -322,74 +321,78 @@ static void print_tests(struct list_head *tests, const char *type)
        }
 }
 
-static void list_tests(void)
+static char *list_tests(void *arg)
 {
        print_tests(&compulsory_tests, "Compulsory");
        print_tests(&normal_tests, "Normal");
        exit(0);
 }
 
+static char *strip(const void *ctx, const char *line)
+{
+       line += strcspn(line, IDENT_CHARS "-");
+       return talloc_strndup(ctx, line, strspn(line, IDENT_CHARS "-"));
+}
+
+static void add_info_fails(struct ccan_file *info)
+{
+       struct doc_section *d;
+       unsigned int i;
+
+       list_for_each(get_ccan_file_docs(info), d, list) {
+               if (!streq(d->type, "fails"))
+                       continue;
+
+               for (i = 0; i < d->num_lines; i++)
+                       btree_insert(info_exclude, strip(info, d->lines[i]));
+               break;
+       }
+}
+
 int main(int argc, char *argv[])
 {
-       int c;
        bool summary = false;
        unsigned int score = 0, total_score = 0;
        struct manifest *m;
        struct ccanlint *i;
-       const char *prefix = "", *dir = talloc_getcwd(NULL);
+       const char *prefix = "";
+       char *dir = talloc_getcwd(NULL), *base_dir = dir;
        
        init_tests();
 
-       exclude = btree_new(btree_strcmp);
-
-       /* I'd love to use long options, but that's not standard. */
-       /* FIXME: popt ccan package? */
-       while ((c = getopt(argc, argv, "sd:vnlx:t:k:")) != -1) {
-               switch (c) {
-               case 'd':
-                       if (optarg[0] != '/')
-                               dir = talloc_asprintf_append(NULL, "%s/%s",
-                                                            dir, optarg);
-                       else
-                               dir = optarg;
-                       prefix = talloc_append_string(talloc_basename(NULL,
-                                                                     optarg),
-                                                     ": ");
-                       break;
-               case 'l':
-                       list_tests();
-               case 's':
-                       summary = true;
-                       break;
-               case 'v':
-                       verbose++;
-                       break;
-               case 'n':
-                       safe_mode = true;
-                       break;
-               case 'k':
-                       keep_test(optarg);
-                       break;
-               case 'x': {
-                       char **exclude_strs = strsplit(NULL, optarg, ",", NULL);
-                       size_t i;
-                       for (i = 0; exclude_strs[i]; i++)
-                               btree_insert(exclude, exclude_strs[i]);
-               } break;
-               case 't':
-                       timeout = atoi(optarg);
-                       if (!timeout)
-                               errx(1, "Invalid timeout %s: 1 ms minumum",
-                                    optarg);
-                       break;
-               default:
-                       usage(argv[0]);
-               }
-       }
-
-       if (optind < argc)
-               usage(argv[0]);
-
+       cmdline_exclude = btree_new(btree_strcmp);
+       info_exclude = btree_new(btree_strcmp);
+
+       opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir,
+                        "use this directory");
+       opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
+                        "do not compile anything");
+       opt_register_noarg("-l|--list-tests", list_tests, NULL,
+                        "list tests ccanlint performs (and exit)");
+       opt_register_arg("-k|--keep <testname>", keep_test, NULL, NULL,
+                          "keep results of <testname> (can be used multiple times)");
+       opt_register_noarg("--summary|-s", opt_set_bool, &summary,
+                          "simply give one line summary");
+       opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose,
+                          "verbose mode (can specify more than once)");
+       opt_register_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
+                        "exclude <testname> (can be used multiple times)");
+       opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
+                        NULL, &timeout,
+                        "ignore (terminate) tests that are slower than this");
+       opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
+                          "\nA program for checking and guiding development"
+                          " of CCAN modules.",
+                          "This usage message");
+
+       opt_parse(&argc, argv, opt_log_stderr_exit);
+
+       if (dir[0] != '/')
+               dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir);
+       if (dir != base_dir)
+               prefix = talloc_append_string(talloc_basename(NULL, dir), ": ");
+       if (verbose >= 2)
+               compile_verbose = true;
        if (verbose >= 3)
                tools_verbose = true;
 
@@ -414,6 +417,8 @@ int main(int argc, char *argv[])
                }
        }
 
+       add_info_fails(m->info_file);
+
        if (verbose)
                printf("\nNormal tests:\n");
        while ((i = get_next_test(&normal_tests)) != NULL)