ensure save data unchanged after save and load

1 files changed, 101 insertions, 20 deletions

diff --git a/auto_tests/save_load_test.c b/auto_tests/save_load_test.c
index cdaf3d3d..1e360b1b 100644
--- a/auto_tests/save_load_test.c
+++ b/auto_tests/save_load_test.c
@@ -16,6 +16,22 @@
 #include "../toxcore/util.h"
 #include "check_compat.h"
 
+/* The Travis-CI container responds poorly to ::1 as a localhost address
+ * You're encouraged to -D FORCE_TESTS_IPV6 on a local test  */
+#ifdef TOX_LOCALHOST
+#undef TOX_LOCALHOST
+#endif
+#ifdef FORCE_TESTS_IPV6
+#define TOX_LOCALHOST "::1"
+#else
+#define TOX_LOCALHOST "127.0.0.1"
+#endif
+
+#ifdef TCP_RELAY_PORT
+#undef TCP_RELAY_PORT
+#endif
+#define TCP_RELAY_PORT 33430
+
 static void accept_friend_request(Tox *m, const uint8_t *public_key, const uint8_t *data, size_t length, void *userdata)
 {
     if (length == 7 && memcmp("Gentoo", data, 7) == 0) {
@@ -35,21 +51,91 @@ static void tox_connection_status(Tox *tox, Tox_Connection connection_status, vo
     connected_t1 = connection_status;
 }
 
+/* validate that:
+ * a) saving stays within the confined space
+ * b) a saved state can be loaded back successfully
+ * c) a second save is of equal size
+ * d) the second save is of equal content */
+static void reload_tox(Tox **tox, struct Tox_Options *const in_opts, void *user_data)
+{
+    const size_t extra = 64;
+    const size_t save_size1 = tox_get_savedata_size(*tox);
+    ck_assert_msg(save_size1 != 0, "save is invalid size %u", (unsigned)save_size1);
+    printf("%u\n", (unsigned)save_size1);
+
+    uint8_t *buffer = (uint8_t *)malloc(save_size1 + 2 * extra);
+    ck_assert_msg(buffer != nullptr, "malloc failed");
+    memset(buffer, 0xCD, extra);
+    memset(buffer + extra + save_size1, 0xCD, extra);
+    tox_get_savedata(*tox, buffer + extra);
+    tox_kill(*tox);
+
+    for (size_t i = 0; i < extra; ++i) {
+        ck_assert_msg(buffer[i] == 0xCD, "Buffer underwritten from tox_get_savedata() @%u", (unsigned)i);
+        ck_assert_msg(buffer[extra + save_size1 + i] == 0xCD, "Buffer overwritten from tox_get_savedata() @%u", (unsigned)i);
+    }
+
+    struct Tox_Options *const options = (in_opts == nullptr) ? tox_options_new(nullptr) : in_opts;
+
+    tox_options_set_savedata_type(options, TOX_SAVEDATA_TYPE_TOX_SAVE);
+
+    tox_options_set_savedata_data(options, buffer + extra, save_size1);
+
+    *tox = tox_new_log(options, nullptr, user_data);
+
+    if (in_opts == nullptr) {
+        tox_options_free(options);
+    }
+
+    ck_assert_msg(*tox != nullptr, "Failed to load back stored buffer");
+
+    const size_t save_size2 = tox_get_savedata_size(*tox);
+
+    ck_assert_msg(save_size1 == save_size2, "Tox save data changed in size from a store/load cycle: %u -> %u",
+                  (unsigned)save_size1, (unsigned)save_size2);
+
+    uint8_t *buffer2 = (uint8_t *)malloc(save_size2);
+
+    ck_assert_msg(buffer2 != nullptr, "malloc failed");
+
+    tox_get_savedata(*tox, buffer2);
+
+    ck_assert_msg(!memcmp(buffer + extra, buffer2, save_size2), "Tox state changed by store/load/store cycle");
+
+    free(buffer2);
+
+    free(buffer);
+}
+
 static void test_few_clients(void)
 {
     uint32_t index[] = { 1, 2, 3 };
     time_t con_time = 0, cur_time = time(nullptr);
-    Tox *tox1 = tox_new_log(nullptr, nullptr, &index[0]);
-    Tox *tox2 = tox_new_log(nullptr, nullptr, &index[1]);
-    Tox *tox3 = tox_new_log(nullptr, nullptr, &index[2]);
+
+    struct Tox_Options *opts1 = tox_options_new(nullptr);
+    tox_options_set_tcp_port(opts1, TCP_RELAY_PORT);
+    Tox *tox1 = tox_new_log(opts1, nullptr, &index[0]);
+    tox_options_free(opts1);
+
+    struct Tox_Options *opts2 = tox_options_new(nullptr);
+    tox_options_set_udp_enabled(opts2, false);
+    tox_options_set_local_discovery_enabled(opts2, false);
+    Tox *tox2 = tox_new_log(opts2, nullptr, &index[1]);
+
+    struct Tox_Options *opts3 = tox_options_new(nullptr);
+    tox_options_set_local_discovery_enabled(opts3, false);
+    Tox *tox3 = tox_new_log(opts3, nullptr, &index[2]);
 
     ck_assert_msg(tox1 && tox2 && tox3, "Failed to create 3 tox instances");
 
-    printf("bootstrapping tox2 and tox3 off tox1\n");
     uint8_t dht_key[TOX_PUBLIC_KEY_SIZE];
     tox_self_get_dht_id(tox1, dht_key);
     const uint16_t dht_port = tox_self_get_udp_port(tox1, nullptr);
 
+    printf("using tox1 as tcp relay for tox2\n");
+    tox_add_tcp_relay(tox2, TOX_LOCALHOST, TCP_RELAY_PORT, dht_key, nullptr);
+
+    printf("bootstrapping toxes off tox1\n");
     tox_bootstrap(tox2, "localhost", dht_port, dht_key, nullptr);
     tox_bootstrap(tox3, "localhost", dht_port, dht_key, nullptr);
 
@@ -76,8 +162,8 @@ static void test_few_clients(void)
                 off = 0;
             }
 
-            if (tox_friend_get_connection_status(tox2, 0, nullptr) == TOX_CONNECTION_UDP
-                    && tox_friend_get_connection_status(tox3, 0, nullptr) == TOX_CONNECTION_UDP) {
+            if (tox_friend_get_connection_status(tox2, 0, nullptr) == TOX_CONNECTION_TCP
+                    && tox_friend_get_connection_status(tox3, 0, nullptr) == TOX_CONNECTION_TCP) {
                 break;
             }
         }
@@ -88,19 +174,12 @@ static void test_few_clients(void)
     ck_assert_msg(connected_t1, "Tox1 isn't connected. %u", connected_t1);
     printf("tox clients connected took %lu seconds\n", (unsigned long)(time(nullptr) - con_time));
 
-    const size_t save_size1 = tox_get_savedata_size(tox2);
-    ck_assert_msg(save_size1 != 0, "save is invalid size %u", (unsigned)save_size1);
-    printf("%u\n", (unsigned)save_size1);
-    VLA(uint8_t, save1, save_size1);
-    tox_get_savedata(tox2, save1);
-    tox_kill(tox2);
+    reload_tox(&tox2, opts2, &index[1]);
+
+    reload_tox(&tox3, opts3, &index[2]);
 
-    struct Tox_Options *const options = tox_options_new(nullptr);
-    tox_options_set_savedata_type(options, TOX_SAVEDATA_TYPE_TOX_SAVE);
-    tox_options_set_savedata_data(options, save1, save_size1);
-    tox_options_set_local_discovery_enabled(options, false);
-    tox2 = tox_new_log(options, nullptr, &index[1]);
     cur_time = time(nullptr);
+
     off = 1;
 
     while (true) {
@@ -116,8 +195,8 @@ static void test_few_clients(void)
                 off = 0;
             }
 
-            if (tox_friend_get_connection_status(tox2, 0, nullptr) == TOX_CONNECTION_UDP
-                    && tox_friend_get_connection_status(tox3, 0, nullptr) == TOX_CONNECTION_UDP) {
+            if (tox_friend_get_connection_status(tox2, 0, nullptr) == TOX_CONNECTION_TCP
+                    && tox_friend_get_connection_status(tox3, 0, nullptr) == TOX_CONNECTION_TCP) {
                 break;
             }
         }
@@ -129,10 +208,12 @@ static void test_few_clients(void)
 
     printf("test_few_clients succeeded, took %lu seconds\n", (unsigned long)(time(nullptr) - cur_time));
 
-    tox_options_free(options);
     tox_kill(tox1);
     tox_kill(tox2);
     tox_kill(tox3);
+
+    tox_options_free(opts2);
+    tox_options_free(opts3);
 }
 
 int main(void)