test: add generator for random "stub" messages
authorDavid Bremner <bremner@debian.org>
Sun, 5 Aug 2012 18:13:12 +0000 (15:13 -0300)
committerDavid Bremner <bremner@debian.org>
Sun, 2 Dec 2012 19:51:32 +0000 (15:51 -0400)
Initial use case is testing dump and restore, so we only have
message-ids and tags.

The message ID's are nothing like RFC compliant, but it doesn't seem
any harder to roundtrip random UTF-8 strings than RFC-compliant ones.

Tags are UTF-8, even though notmuch is in principle more generous than
that.

updated for id:m2wr04ocro.fsf@guru.guru-group.fi

- talk about Unicode value rather some specific encoding
- call talloc_realloc less times

test/.gitignore
test/Makefile.local
test/basic
test/random-corpus.c [new file with mode: 0644]

index be7ab5eddc536a1200d0c5a189bd78e435d37897..1eff7ce8b845e8737f1edb755259bc59d6a42b4c 100644 (file)
@@ -4,4 +4,5 @@ smtp-dummy
 symbol-test
 arg-test
 hex-xcode
+random-corpus
 tmp.*
index 8479f914eb75930d330816f1d7ec2c8165e09897..6a9f15e81500fc9bec9a5c1802c99dcb451eace3 100644 (file)
@@ -16,6 +16,14 @@ $(dir)/arg-test: $(dir)/arg-test.o command-line-arguments.o util/libutil.a
 $(dir)/hex-xcode: $(dir)/hex-xcode.o command-line-arguments.o util/libutil.a
        $(call quiet,CC) -I. $^ -o $@ -ltalloc
 
+random_corpus_deps =  $(dir)/random-corpus.o  $(dir)/database-test.o \
+                       notmuch-config.o command-line-arguments.o \
+                       lib/libnotmuch.a util/libutil.a \
+                       parse-time-string/libparse-time-string.a
+
+$(dir)/random-corpus: $(random_corpus_deps)
+       $(call quiet,CC) $(CFLAGS_FINAL) $^ -o $@ $(CONFIGURE_LDFLAGS)
+
 $(dir)/smtp-dummy: $(smtp_dummy_modules)
        $(call quiet,CC) $^ -o $@
 
@@ -29,6 +37,7 @@ $(dir)/parse-time: $(dir)/parse-time.o parse-time-string/parse-time-string.o
 
 TEST_BINARIES=$(dir)/arg-test \
              $(dir)/hex-xcode \
+             $(dir)/random-corpus \
              $(dir)/parse-time \
              $(dir)/smtp-dummy \
              $(dir)/symbol-test
@@ -46,5 +55,6 @@ CLEAN := $(CLEAN) $(dir)/smtp-dummy $(dir)/smtp-dummy.o \
         $(dir)/arg-test $(dir)/arg-test.o \
         $(dir)/hex-xcode $(dir)/hex-xcode.o \
         $(dir)/database-test.o \
+        $(dir)/random-corpus $(dir)/random-corpus.o \
         $(dir)/parse-time $(dir)/parse-time.o \
         $(dir)/corpus.mail $(dir)/test-results $(dir)/tmp.*
index c448ef8c199cb64cdff2ad0f2b87190f70d38fbe..1b2a7d20d8f31a58e87c7d94e48048f49c852644 100755 (executable)
@@ -59,6 +59,7 @@ available=$(find "$TEST_DIRECTORY" -maxdepth 1 -type f -perm +111  \
     ! -name hex-xcode                  \
     ! -name notmuch-test               \
     ! -name parse-time                 \
+    ! -name random-corpus              \
     ! -name smtp-dummy                 \
     ! -name symbol-test                        \
     ! -name test-verbose               \
diff --git a/test/random-corpus.c b/test/random-corpus.c
new file mode 100644 (file)
index 0000000..f354d4b
--- /dev/null
@@ -0,0 +1,209 @@
+/*
+ * Generate a random corpus of stub messages.
+ *
+ * Initial use case is testing dump and restore, so we only have
+ * message-ids and tags.
+ *
+ * Generated message-id's and tags are intentionally nasty.
+ *
+ * Copyright (c) 2012 David Bremner
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see http://www.gnu.org/licenses/ .
+ *
+ * Author: David Bremner <david@tethera.net>
+ */
+
+#include <stdlib.h>
+#include <assert.h>
+#include <talloc.h>
+#include <string.h>
+#include <glib.h>
+#include <math.h>
+
+#include "notmuch-client.h"
+#include "command-line-arguments.h"
+#include "database-test.h"
+
+/* Current largest Unicode value defined. Note that most of these will
+ * be printed as boxes in most fonts.
+ */
+
+#define GLYPH_MAX 0x10FFFE
+
+
+typedef struct {
+    int weight;
+    int start;
+    int stop;
+} char_class_t;
+
+/*
+ *  Choose about half ascii as test characters, as ascii
+ *  punctation and whitespace is the main cause of problems for
+ *  the (old) restore parser.
+ *
+ *  We then favour code points with 2 byte encodings. Note that
+ *  code points 0xD800-0xDFFF are forbidden in UTF-8.
+ */
+
+static const
+char_class_t char_class[] = { { 0.50 * GLYPH_MAX, 0x0001, 0x007f },
+                             { 0.75 * GLYPH_MAX, 0x0080, 0x07ff },
+                             { 0.88 * GLYPH_MAX, 0x0800, 0xd7ff },
+                             { 0.90 * GLYPH_MAX, 0xE000, 0xffff },
+                             {        GLYPH_MAX, 0x10000, GLYPH_MAX } };
+
+static gunichar
+random_unichar ()
+{
+    int i;
+    int class = random () % GLYPH_MAX;
+    int size;
+
+    for (i = 0; char_class[i].weight < class; i++) /* nothing */;
+
+    size = char_class[i].stop - char_class[i].start + 1;
+
+    return char_class[i].start + (random () % size);
+}
+
+static char *
+random_utf8_string (void *ctx, size_t char_count)
+{
+    size_t offset = 0;
+    size_t i;
+    gchar *buf = NULL;
+    size_t buf_size = 0;
+
+    for (i = 0; i < char_count; i++) {
+       gunichar randomchar;
+       size_t written;
+
+       /* 6 for one glyph, one for null, one for luck */
+       while (buf_size <= offset + 8) {
+           buf_size = 2 * buf_size + 8;
+           buf = talloc_realloc (ctx, buf, gchar, buf_size);
+       }
+
+       randomchar = random_unichar ();
+
+       written = g_unichar_to_utf8 (randomchar, buf + offset);
+
+       if (written <= 0) {
+           fprintf (stderr, "error converting to utf8\n");
+           exit (1);
+       }
+
+       offset += written;
+
+    }
+    buf[offset] = 0;
+    return buf;
+}
+
+
+int
+main (int argc, char **argv)
+{
+
+    void *ctx = talloc_new (NULL);
+
+    char *config_path  = NULL;
+    notmuch_config_t *config;
+    notmuch_database_t *notmuch;
+
+    int num_messages = 500;
+    int max_tags = 10;
+    // leave room for UTF-8 encoding.
+    int tag_len = NOTMUCH_TAG_MAX / 6;
+    // NOTMUCH_MESSAGE_ID_MAX is not exported, so we make a
+    // conservative guess.
+    int message_id_len = (NOTMUCH_TAG_MAX - 20) / 6;
+
+    int seed = 734569;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_STRING, &config_path, "config-path", 'c', 0 },
+       { NOTMUCH_OPT_INT, &num_messages, "num-messages", 'n', 0 },
+       { NOTMUCH_OPT_INT, &max_tags, "max-tags", 'm', 0 },
+       { NOTMUCH_OPT_INT, &message_id_len, "message-id-len", 'M', 0 },
+       { NOTMUCH_OPT_INT, &tag_len, "tag-len", 't', 0 },
+       { NOTMUCH_OPT_INT, &seed, "seed", 's', 0 },
+       { 0, 0, 0, 0, 0 }
+    };
+
+    int opt_index = parse_arguments (argc, argv, options, 1);
+
+    if (opt_index < 0)
+       exit (1);
+
+    if (message_id_len < 1) {
+       fprintf (stderr, "message id's must be least length 1\n");
+       exit (1);
+    }
+
+    if (config_path == NULL) {
+       fprintf (stderr, "configuration path must be specified");
+       exit (1);
+    }
+
+    config = notmuch_config_open (ctx, config_path, NULL);
+    if (config == NULL)
+       return 1;
+
+    if (notmuch_database_open (notmuch_config_get_database_path (config),
+                              NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch))
+       return 1;
+
+    srandom (seed);
+
+    int count;
+    for (count = 0; count < num_messages; count++) {
+       int j;
+       /* explicitly allow zero tags */
+       int num_tags = random () % (max_tags + 1);
+       /* message ids should be non-empty */
+       int this_mid_len = (random () % message_id_len) + 1;
+       const char **tag_list;
+       char *mid;
+       notmuch_status_t status;
+
+       do {
+           mid = random_utf8_string (ctx, this_mid_len);
+
+           tag_list = talloc_realloc (ctx, NULL, const char *, num_tags + 1);
+
+           for (j = 0; j < num_tags; j++) {
+               int this_tag_len = random () % tag_len + 1;
+
+               tag_list[j] = random_utf8_string (ctx, this_tag_len);
+           }
+
+           tag_list[j] = NULL;
+
+           status = notmuch_database_add_stub_message (notmuch, mid, tag_list);
+       } while (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID);
+
+       if (status != NOTMUCH_STATUS_SUCCESS) {
+           fprintf (stderr, "error %d adding message", status);
+           exit (status);
+       }
+    }
+
+    notmuch_database_destroy (notmuch);
+
+    talloc_free (ctx);
+
+    return 0;
+}