add tests

test/Makefile.am

@@ -24,6 +24,7 @@ check_PROGRAMS = \
 	test_src_input_stream \
 	test_src_misc_bits \
 	test_modules_packetizer_hxxx \
+	test_modules_keystore \
 	$(NULL)
 
 check_SCRIPTS = \
@@ -92,6 +93,8 @@ test_src_misc_bits_SOURCES = src/misc/bits.c
 test_src_misc_bits_LDADD = $(LIBVLC)
 test_modules_packetizer_hxxx_SOURCES = modules/packetizer/hxxx.c
 test_modules_packetizer_hxxx_LDADD = $(LIBVLC)
+test_modules_keystore_SOURCES = modules/keystore/test.c
+test_modules_keystore_LDADD = $(LIBVLCCORE) $(LIBVLC)
 
 checkall:
 	$(MAKE) check_PROGRAMS="$(check_PROGRAMS) $(EXTRA_PROGRAMS)" check

test/modules/keystore/test.c

+/*****************************************************************************
+ * test.c: test keystore module
+ *****************************************************************************
+ * Copyright © 2015-2016 VLC authors, VideoLAN and VideoLabs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+#include <vlc/vlc.h>
+
+#include "../../lib/libvlc_internal.h"
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_modules.h>
+#include <vlc_interrupt.h>
+#include <vlc_keystore.h>
+
+#include <assert.h>
+
+#define PLAINTEXT_TEST_FILE "/tmp/vlc.test.keystore"
+
+/* If 1, tester will have time to check keystore entries via an external
+ * program */
+#define LET_CHECK_VALUES 0
+
+static const struct
+{
+    const char *psz_module;
+    int argc;
+    const char * const *argv;
+} keystore_args[] =
+{
+    { "plaintext", 2, (const char *[]) {
+        "--keystore=plaintext,none",
+        "--keystore-plaintext-file=" PLAINTEXT_TEST_FILE
+    } },
+    { "secret", 1, (const char *[]) {
+        "--keystore=secret,none"
+    } },
+    { "kwallet", 1, (const char *[]) {
+        "--keystore=kwallet,none"
+    } },
+};
+
+static void
+values_reinit(const char * ppsz_values[KEY_MAX])
+{
+    VLC_KEYSTORE_VALUES_INIT(ppsz_values);
+    ppsz_values[KEY_REALM] = "libVLC TEST";
+}
+
+static unsigned int
+ks_find(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX],
+        const char* psz_cmp_secret)
+{
+    vlc_keystore_entry *p_entries;
+    unsigned int i_entries = vlc_keystore_find(p_keystore, ppsz_values,
+                                               &p_entries);
+    for (unsigned int i = 0; i < i_entries; ++i)
+    {
+        vlc_keystore_entry *p_entry = &p_entries[i];
+        assert(p_entry->p_secret[p_entry->i_secret_len - 1] == '\0');
+        assert(strcmp((const char *)p_entry->p_secret, psz_cmp_secret) == 0);
+
+        for (unsigned int j = 0; j < KEY_MAX; ++j)
+        {
+            const char *psz_value1 = ppsz_values[j];
+            const char *psz_value2 = p_entry->ppsz_values[j];
+
+            if (!psz_value1)
+                continue;
+            assert(psz_value2);
+            assert(strcmp(psz_value1, psz_value2) == 0);
+        }
+    }
+    return i_entries;
+}
+
+static unsigned int
+ks_remove(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX])
+{
+    return vlc_keystore_remove(p_keystore, ppsz_values);
+}
+
+static void
+ks_store(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX],
+         const uint8_t* p_secret, size_t i_secret_len)
+{
+    assert(vlc_keystore_store(p_keystore, ppsz_values,
+                              (const uint8_t *)p_secret,
+                              i_secret_len,
+                              "libVLC TEST") == VLC_SUCCESS);
+}
+
+static void
+test_module(const char *psz_module, int argc, const char * const *argv)
+{
+#define VALUES_INSERT(i_key, psz_value) ppsz_values[i_key] = psz_value
+#define VALUES_REINIT() values_reinit(ppsz_values)
+#define KS_FIND() do { \
+    i_entries = ks_find(p_keystore, ppsz_values, psz_secret); \
+} while (0)
+#define KS_REMOVE() do { \
+    i_entries = ks_remove(p_keystore, ppsz_values); \
+} while(0)
+#define KS_STORE() ks_store(p_keystore, ppsz_values, (const uint8_t *)psz_secret, -1)
+
+    printf("\n== Testing %s keystore module ==\n\n", psz_module);
+
+    printf("creating libvlc\n");
+    libvlc_instance_t *p_libvlc = libvlc_new(argc, argv);
+    assert(p_libvlc != NULL);
+
+    /* See TODO in kwallet.cpp, VLCKWallet::connect() */
+    if (strcmp(psz_module, "kwallet") == 0)
+        assert(libvlc_InternalAddIntf(p_libvlc->p_libvlc_int, "qt") == VLC_SUCCESS);
+
+    vlc_interrupt_t *ctx = vlc_interrupt_create();
+    assert(ctx != NULL);
+
+    printf("creating %s keystore\n", psz_module);
+    vlc_keystore *p_keystore = vlc_keystore_create(p_libvlc->p_libvlc_int);
+    assert(p_keystore);
+
+    const char *psz_secret = "libvlc test secret";
+    unsigned int i_entries;
+    const char *ppsz_values[KEY_MAX];
+
+    printf("testing that there is no entry\n");
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_PROTOCOL, "http");
+    VALUES_INSERT(KEY_SERVER, "www.example.com");
+    VALUES_INSERT(KEY_PATH, "/example/example.mkv");
+    VALUES_INSERT(KEY_PORT, "88");
+    VALUES_INSERT(KEY_USER, "user1");
+    KS_FIND();
+    assert(i_entries == 0);
+
+    printf("testing adding an entry\n");
+    KS_STORE();
+    KS_FIND();
+    assert(i_entries == 1);
+
+    printf("testing adding an other entry\n");
+    VALUES_INSERT(KEY_USER, "user2");
+    KS_FIND();
+    assert(i_entries == 0);
+    KS_STORE();
+    KS_FIND();
+    assert(i_entries == 1);
+
+    printf("testing finding the 2 previous entries\n");
+    VALUES_INSERT(KEY_USER, NULL);
+    KS_FIND();
+    assert(i_entries == 2);
+
+    printf("testing that we can't store 2 duplicate entries\n");
+    VALUES_INSERT(KEY_USER, "user2");
+    KS_STORE();
+    VALUES_INSERT(KEY_USER, NULL);
+    KS_FIND();
+    assert(i_entries == 2);
+
+    printf("testing that entries are still present after a module unload\n");
+    vlc_keystore_release(p_keystore);
+    p_keystore = vlc_keystore_create(p_libvlc->p_libvlc_int);
+    assert(p_keystore);
+    KS_FIND();
+    assert(i_entries == 2);
+
+    printf("testing adding a third entry from a second running instance\n");
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_PROTOCOL, "smb");
+    VALUES_INSERT(KEY_SERVER, "example");
+    VALUES_INSERT(KEY_PATH, "/example.mkv");
+    VALUES_INSERT(KEY_USER, "user1");
+    KS_FIND();
+    assert(i_entries == 0);
+
+    vlc_keystore *old_keystore = p_keystore;
+    p_keystore = vlc_keystore_create(p_libvlc->p_libvlc_int);
+    assert(p_keystore);
+
+    KS_STORE();
+    KS_FIND();
+    assert(i_entries == 1);
+
+    vlc_keystore_release(p_keystore);
+    p_keystore = old_keystore;
+    KS_FIND();
+    assert(i_entries == 1);
+
+    printf("testing adding a fourth entry (without user/path)\n");
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_PROTOCOL, "ftp");
+    VALUES_INSERT(KEY_SERVER, "example.com");
+    KS_FIND();
+    assert(i_entries == 0);
+    KS_STORE();
+    KS_FIND();
+    assert(i_entries == 1);
+
+    printf("testing finding an entry only by its protocol\n");
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_PROTOCOL, "smb");
+    KS_FIND();
+    assert(i_entries == 1);
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_PROTOCOL, "http");
+    KS_FIND();
+    assert(i_entries == 2);
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_PROTOCOL, "ftp");
+    KS_FIND();
+    assert(i_entries == 1);
+
+    printf("testing finding all previous entries\n");
+    VALUES_REINIT();
+    KS_FIND();
+    assert(i_entries == 4);
+
+#if LET_CHECK_VALUES
+    printf("\nPress ENTER to remove entries\n");
+    getchar();
+#endif
+
+    printf("testing removing entries that match user => user1\n");
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_USER, "user1");
+    KS_REMOVE();
+    assert(i_entries == 2);
+
+    printf("testing removing entries that match user => user2\n");
+    VALUES_INSERT(KEY_USER, "user2");
+    KS_REMOVE();
+    assert(i_entries == 1);
+
+    printf("testing removing entries that match protocol => ftp\n");
+    VALUES_REINIT();
+    VALUES_INSERT(KEY_PROTOCOL, "ftp");
+    KS_REMOVE();
+    assert(i_entries == 1);
+
+    printf("testing that all entries are deleted\n");
+    VALUES_REINIT();
+    KS_FIND();
+    assert(i_entries == 0);
+
+    vlc_keystore_release(p_keystore);
+
+    vlc_interrupt_destroy(ctx);
+
+    libvlc_release(p_libvlc);
+}
+
+int
+main(void)
+{
+#if !LET_CHECK_VALUES
+    alarm(10);
+#endif
+
+    setenv("VLC_PLUGIN_PATH", "../modules", 1);
+    unlink(PLAINTEXT_TEST_FILE);
+
+    for (unsigned int i = 0; i < sizeof(keystore_args)/sizeof(*keystore_args); ++i)
+    {
+        const char *psz_module = keystore_args[i].psz_module;
+        int argc = keystore_args[i].argc;
+        const char * const *argv = keystore_args[i].argv;
+
+        if (!module_exists(psz_module))
+            test_module(psz_module, argc, argv);
+        else
+            printf("not testing %s since the plugin is not found\n", psz_module);
+    }
+    unlink(PLAINTEXT_TEST_FILE);
+
+    return 0;
+}