]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/tests/examples_run.c
ccanlint: try running example code.
[ccan] / tools / ccanlint / tests / examples_run.c
diff --git a/tools/ccanlint/tests/examples_run.c b/tools/ccanlint/tests/examples_run.c
new file mode 100644 (file)
index 0000000..522feb0
--- /dev/null
@@ -0,0 +1,304 @@
+#include <tools/ccanlint/ccanlint.h>
+#include <tools/tools.h>
+#include <ccan/talloc/talloc.h>
+#include <ccan/foreach/foreach.h>
+#include <ccan/str/str.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <stdint.h>
+#include <string.h>
+#include <unistd.h>
+#include <ctype.h>
+#include <assert.h>
+
+static const char *can_run(struct manifest *m)
+{
+       if (safe_mode)
+               return "Safe mode enabled";
+       return NULL;
+}
+
+struct score {
+       unsigned int score;
+       char *errors;
+};
+
+/* Very dumb scanner, allocates %s-strings. */
+static bool scan_forv(const void *ctx,
+                     const char *input, const char *fmt, const va_list *args)
+{
+       va_list ap;
+       bool ret;
+
+       if (input[0] == '\0' || fmt[0] == '\0')
+               return input[0] == fmt[0];
+
+       va_copy(ap, *args);
+
+       if (isspace(fmt[0])) {
+               /* One format space can swallow many input spaces */
+               ret = false;
+               while (isspace(input[0])) {
+                       if (scan_forv(ctx, ++input, fmt+1, &ap)) {
+                               ret = true;
+                               break;
+                       }
+               }
+       } else if (fmt[0] != '%') {
+               if (toupper(input[0]) != toupper(fmt[0]))
+                       ret = false;
+               else
+                       ret = scan_forv(ctx, input+1, fmt+1, &ap);
+       } else {
+               char **p = va_arg(ap, char **);
+               unsigned int len;
+
+               ret = false;
+               assert(fmt[1] == 's');
+               for (len = 1; input[len-1]; len++) {
+                       ret = scan_forv(ctx, input + len, fmt+2, &ap);
+                       if (ret) {
+                               *p = talloc_strndup(ctx, input, len);
+                               ret = true;
+                               break;
+                       }
+               }
+       }
+       va_end(ap);
+       return ret;
+}
+
+static bool scan_for(const void *ctx, const char *input, const char *fmt, ...)
+{
+       bool ret;
+       va_list ap;
+
+       va_start(ap, fmt);
+       ret = scan_forv(ctx, input, fmt, &ap);
+       va_end(ap);
+       return ret;
+}
+
+static char *find_expect(struct ccan_file *file,
+                        char **lines, char **input, bool *exact,
+                        unsigned *line)
+{
+       char *expect;
+       const char *fmt;
+
+       for (; lines[*line]; (*line)++) {
+               char *p = lines[*line] + strspn(lines[*line], " \t");
+               if (!strstarts(p, "//"))
+                       continue;
+               p += strspn(p, "/ ");
+               foreach_ptr(fmt,
+                           "given '%s', outputs '%s'",
+                           "given '%s' outputs '%s'",
+                           "given \"%s\", outputs \"%s\"",
+                           "given \"%s\" outputs \"%s\"") {
+                       if (scan_for(file, p, fmt, input, &expect)) {
+                               *exact = true;
+                               return expect;
+                       }
+               }
+
+               foreach_ptr(fmt,
+                           "given '%s', output contains '%s'",
+                           "given '%s' output contains '%s'",
+                           "given \"%s\", output contains \"%s\"",
+                           "given \"%s\" output contains \"%s\"") {
+                       if (scan_for(file, p, fmt, input, &expect)) {
+                               *exact = false;
+                               return expect;
+                       }
+               }
+
+               foreach_ptr(fmt, "outputs '%s'", "outputs \"%s\"") {
+                       if (scan_for(file, p, fmt, &expect)) {
+                               *input = "";
+                               *exact = true;
+                               return expect;
+                       }
+               }
+
+               foreach_ptr(fmt,
+                           "given '%s', output contains '%s'",
+                           "given '%s' output contains '%s'",
+                           "given \"%s\", output contains \"%s\"",
+                           "given \"%s\" output contains \"%s\"") {
+                       if (scan_for(file, p, fmt, input, &expect)) {
+                               *exact = false;
+                               return expect;
+                       }
+               }
+
+               /* Unquoted versions... we can get this wrong! */
+               foreach_ptr(fmt,
+                           "given %s, outputs '%s'",
+                           "given '%s', outputs %s",
+                           "given %s, outputs \"%s\"",
+                           "given \"%s\", outputs %s",
+                           "given %s, outputs %s",
+                           "given %s outputs '%s'",
+                           "given '%s' outputs %s",
+                           "given %s outputs \"%s\"",
+                           "given \"%s\" outputs %s",
+                           "given %s outputs %s") {
+                       if (scan_for(file, p, fmt, input, &expect)) {
+                               *exact = true;
+                               return expect;
+                       }
+               }
+
+               foreach_ptr(fmt,
+                           "given %s, output contains '%s'",
+                           "given '%s', output contains %s",
+                           "given %s, output contains \"%s\"",
+                           "given \"%s\", output contains %s",
+                           "given %s, output contains %s",
+                           "given %s output contains '%s'",
+                           "given '%s' output contains %s",
+                           "given %s output contains \"%s\"",
+                           "given \"%s\" output contains %s",
+                           "given %s output contains %s") {
+                       if (scan_for(file, p, fmt, input, &expect)) {
+                               *exact = false;
+                               return expect;
+                       }
+               }
+
+               foreach_ptr(fmt,
+                           "outputs '%s'",
+                           "outputs \"%s\"",
+                           "outputs %s") {
+                       if (scan_for(file, p, fmt, &expect)) {
+                               *input = "";
+                               *exact = true;
+                               return expect;
+                       }
+               }
+
+               foreach_ptr(fmt,
+                           "output contains '%s'",
+                           "output contains \"%s\"",
+                           "output contains %s") {
+                       if (scan_for(file, p, fmt, &expect)) {
+                               *input = "";
+                               *exact = false;
+                               return expect;
+                       }
+               }
+       }               
+       return NULL;
+}
+
+static char *trim(char *string)
+{
+       while (strends(string, "\n"))
+              string[strlen(string)-1] = '\0';
+       return string;
+}
+
+static char *unexpected(struct ccan_file *i, const char *input,
+                       const char *expect, bool exact)
+{
+       char *output, *cmd;
+       bool ok;
+       unsigned int default_time = default_timeout_ms;
+
+       cmd = talloc_asprintf(i, "echo '%s' | %s %s",
+                             input, i->compiled, input);
+
+       output = run_with_timeout(i, cmd, &ok, &default_time);
+       if (!ok)
+               return talloc_asprintf(i, "Exited with non-zero status\n");
+
+       if (exact) {
+               if (streq(output, expect) || streq(trim(output), expect))
+                       return NULL;
+       } else {
+               if (strstr(output, expect))
+                       return NULL;
+       }
+       return output;
+}
+
+static void *run_examples(struct manifest *m, bool keep,
+                         unsigned int *timeleft)
+{
+       struct ccan_file *i;
+       struct list_head *list;
+       struct score *score = talloc(m, struct score);
+
+       score->score = 0;
+       score->errors = talloc_strdup(score, "");
+
+       examples_run.total_score = 0;
+       foreach_ptr(list, &m->examples, &m->mangled_examples) {
+               list_for_each(list, i, list) {
+                       char **lines, *expect, *input, *output;
+                       unsigned int linenum = 0;
+                       bool exact;
+
+                       if (i->compiled == NULL)
+                               continue;
+
+                       lines = get_ccan_file_lines(i);
+
+                       for (expect = find_expect(i, lines, &input, &exact,
+                                                 &linenum);
+                            expect;
+                            linenum++,
+                                    expect = find_expect(i, lines, &input,
+                                                         &exact, &linenum)) {
+                               examples_run.total_score++;
+                               output = unexpected(i, input, expect, exact);
+                               if (!output)
+                                       score->score++;
+                               else {
+                                       score->errors = talloc_asprintf_append(
+                                               score->errors,
+                                               "%s: output '%s' didn't"
+                                               " %s '%s'\n",
+                                               i->name, output,
+                                               exact ? "match" : "contain",
+                                               expect);
+                               }
+                       }
+               }
+       }
+
+       if (strcmp(score->errors, "") == 0) {
+               talloc_free(score);
+               return NULL;
+       }
+       return score;
+}
+
+static unsigned int score_examples(struct manifest *m, void *check_result)
+{
+       struct score *score = check_result;
+       return score->score;
+}
+
+static const char *describe(struct manifest *m, void *check_result)
+{
+       struct score *score = check_result;
+       if (verbose)
+               return talloc_asprintf(m, "Wrong output running examples:\n"
+                                      "%s", score->errors);
+       return NULL;
+}
+
+struct ccanlint examples_run = {
+       .key = "examples-run",
+       .name = "Module examples with expected output give that output",
+       .score = score_examples,
+       .total_score = 3, /* This gets changed to # testable, if we run. */
+       .check = run_examples,
+       .describe = describe,
+       .can_run = can_run,
+};
+
+REGISTER_TEST(examples_run, &examples_compile, NULL);