#include // assert #include // calloc, free #include "check_compat.h" #include "../testing/misc_tools.h" #include "../toxcore/Messenger.h" #include "../toxcore/mono_time.h" #include "../toxcore/tox_dispatch.h" #include "../toxcore/tox_events.h" #include "../toxcore/tox_struct.h" #include "auto_test_support.h" #ifndef ABORT_ON_LOG_ERROR #define ABORT_ON_LOG_ERROR true #endif #ifndef USE_IPV6 #define USE_IPV6 1 #endif Run_Auto_Options default_run_auto_options(void) { return (Run_Auto_Options) { .graph = GRAPH_COMPLETE, .init_autotox = nullptr, .tcp_port = 33188, .events = true, }; } // List of live bootstrap nodes. These nodes should have TCP server enabled. static const struct BootstrapNodes { const char *ip; uint16_t port; const uint8_t key[32]; } bootstrap_nodes[] = { { "tox.abilinski.com", 33445, 0x10, 0xC0, 0x0E, 0xB2, 0x50, 0xC3, 0x23, 0x3E, 0x34, 0x3E, 0x2A, 0xEB, 0xA0, 0x71, 0x15, 0xA5, 0xC2, 0x89, 0x20, 0xE9, 0xC8, 0xD2, 0x94, 0x92, 0xF6, 0xD0, 0x0B, 0x29, 0x04, 0x9E, 0xDC, 0x7E, }, { "tox.initramfs.io", 33445, 0x02, 0x80, 0x7C, 0xF4, 0xF8, 0xBB, 0x8F, 0xB3, 0x90, 0xCC, 0x37, 0x94, 0xBD, 0xF1, 0xE8, 0x44, 0x9E, 0x9A, 0x83, 0x92, 0xC5, 0xD3, 0xF2, 0x20, 0x00, 0x19, 0xDA, 0x9F, 0x1E, 0x81, 0x2E, 0x46, }, { "tox.plastiras.org", 33445, 0x8E, 0x8B, 0x63, 0x29, 0x9B, 0x3D, 0x52, 0x0F, 0xB3, 0x77, 0xFE, 0x51, 0x00, 0xE6, 0x5E, 0x33, 0x22, 0xF7, 0xAE, 0x5B, 0x20, 0xA0, 0xAC, 0xED, 0x29, 0x81, 0x76, 0x9F, 0xC5, 0xB4, 0x37, 0x25, }, { "tox.novg.net", 33445, 0xD5, 0x27, 0xE5, 0x84, 0x7F, 0x83, 0x30, 0xD6, 0x28, 0xDA, 0xB1, 0x81, 0x4F, 0x0A, 0x42, 0x2F, 0x6D, 0xC9, 0xD0, 0xA3, 0x00, 0xE6, 0xC3, 0x57, 0x63, 0x4E, 0xE2, 0xDA, 0x88, 0xC3, 0x54, 0x63, }, { nullptr, 0, 0 }, }; void bootstrap_tox_live_network(Tox *tox, bool enable_tcp) { ck_assert(tox != nullptr); for (size_t j = 0; bootstrap_nodes[j].ip != nullptr; ++j) { const char *ip = bootstrap_nodes[j].ip; uint16_t port = bootstrap_nodes[j].port; const uint8_t *key = bootstrap_nodes[j].key; Tox_Err_Bootstrap err; tox_bootstrap(tox, ip, port, key, &err); if (err != TOX_ERR_BOOTSTRAP_OK) { fprintf(stderr, "Failed to bootstrap node %zu (%s): error %d\n", j, ip, err); } if (enable_tcp) { tox_add_tcp_relay(tox, ip, port, key, &err); if (err != TOX_ERR_BOOTSTRAP_OK) { fprintf(stderr, "Failed to add TCP relay %zu (%s): error %d\n", j, ip, err); } } } } bool all_connected(const AutoTox *autotoxes, uint32_t tox_count) { if (tox_count) { ck_assert(autotoxes != nullptr); } for (uint32_t i = 0; i < tox_count; ++i) { if (tox_self_get_connection_status(autotoxes[i].tox) == TOX_CONNECTION_NONE) { return false; } } return true; } bool all_friends_connected(const AutoTox *autotoxes, uint32_t tox_count) { if (tox_count) { ck_assert(autotoxes != nullptr); } for (uint32_t i = 0; i < tox_count; ++i) { const size_t friend_count = tox_self_get_friend_list_size(autotoxes[i].tox); for (size_t j = 0; j < friend_count; ++j) { if (tox_friend_get_connection_status(autotoxes[i].tox, j, nullptr) == TOX_CONNECTION_NONE) { return false; } } } return true; } void iterate_all_wait(AutoTox *autotoxes, uint32_t tox_count, uint32_t wait) { if (tox_count) { ck_assert(autotoxes != nullptr); } for (uint32_t i = 0; i < tox_count; ++i) { if (autotoxes[i].alive) { if (autotoxes[i].events) { Tox_Err_Events_Iterate err; Tox_Events *events = tox_events_iterate(autotoxes[i].tox, true, &err); ck_assert(err == TOX_ERR_EVENTS_ITERATE_OK); tox_dispatch_invoke(autotoxes[i].dispatch, events, &autotoxes[i]); tox_events_free(events); } else { tox_iterate(autotoxes[i].tox, &autotoxes[i]); } autotoxes[i].clock += wait; } } /* Also actually sleep a little, to allow for local network processing */ c_sleep(5); } static uint64_t get_state_clock_callback(void *user_data) { const uint64_t *clock = (const uint64_t *)user_data; return *clock; } void set_mono_time_callback(AutoTox *autotox) { ck_assert(autotox != nullptr); Mono_Time *mono_time = autotox->tox->mono_time; autotox->clock = current_time_monotonic(mono_time); ck_assert_msg(autotox->clock >= 1000, "clock is too low (not initialised?): %lu", (unsigned long)autotox->clock); mono_time_set_current_time_callback(mono_time, nullptr, nullptr); // set to default first mono_time_set_current_time_callback(mono_time, get_state_clock_callback, &autotox->clock); } void save_autotox(AutoTox *autotox) { ck_assert(autotox != nullptr); fprintf(stderr, "Saving #%u\n", autotox->index); free(autotox->save_state); autotox->save_state = nullptr; autotox->save_size = tox_get_savedata_size(autotox->tox); ck_assert_msg(autotox->save_size > 0, "save is invalid size %u", (unsigned)autotox->save_size); autotox->save_state = (uint8_t *)malloc(autotox->save_size); ck_assert_msg(autotox->save_state != nullptr, "malloc failed"); tox_get_savedata(autotox->tox, autotox->save_state); } void kill_autotox(AutoTox *autotox) { ck_assert(autotox != nullptr); ck_assert(autotox->alive); fprintf(stderr, "Killing #%u\n", autotox->index); autotox->alive = false; tox_dispatch_free(autotox->dispatch); tox_kill(autotox->tox); } void reload(AutoTox *autotox) { ck_assert(autotox != nullptr); if (autotox->alive) { kill_autotox(autotox); } fprintf(stderr, "Reloading #%u\n", autotox->index); ck_assert(autotox->save_state != nullptr); struct Tox_Options *const options = tox_options_new(nullptr); ck_assert(options != nullptr); tox_options_set_ipv6_enabled(options, USE_IPV6); tox_options_set_savedata_type(options, TOX_SAVEDATA_TYPE_TOX_SAVE); tox_options_set_savedata_data(options, autotox->save_state, autotox->save_size); autotox->tox = tox_new_log(options, nullptr, &autotox->index); ck_assert(autotox->tox != nullptr); autotox->dispatch = tox_dispatch_new(nullptr); ck_assert(autotox->dispatch != nullptr); if (autotox->events) { tox_events_init(autotox->tox); } tox_options_free(options); set_mono_time_callback(autotox); autotox->alive = true; } static void initialise_autotox(struct Tox_Options *options, AutoTox *autotox, uint32_t index, uint32_t state_size, Run_Auto_Options *autotest_opts) { autotox->index = index; autotox->events = autotest_opts->events; Tox_Err_New err = TOX_ERR_NEW_OK; if (index == 0) { struct Tox_Options *default_opts = tox_options_new(nullptr); ck_assert(default_opts != nullptr); tox_options_set_ipv6_enabled(default_opts, USE_IPV6); if (options == nullptr) { options = default_opts; } if (tox_options_get_udp_enabled(options)) { tox_options_set_tcp_port(options, 0); autotest_opts->tcp_port = 0; autotox->tox = tox_new_log(options, &err, &autotox->index); ck_assert_msg(err == TOX_ERR_NEW_OK, "unexpected tox_new error: %d", err); } else { // Try a few ports for the TCP relay. for (uint16_t tcp_port = autotest_opts->tcp_port; tcp_port < autotest_opts->tcp_port + 200; ++tcp_port) { tox_options_set_tcp_port(options, tcp_port); autotox->tox = tox_new_log(options, &err, &autotox->index); if (autotox->tox != nullptr) { autotest_opts->tcp_port = tcp_port; break; } ck_assert_msg(err == TOX_ERR_NEW_PORT_ALLOC, "unexpected tox_new error (expected PORT_ALLOC): %d", err); } } tox_options_free(default_opts); } else { // No TCP relay enabled for all the other toxes. if (options != nullptr) { tox_options_set_tcp_port(options, 0); } autotox->tox = tox_new_log(options, &err, &autotox->index); } ck_assert_msg(autotox->tox != nullptr, "failed to create tox instance #%u (error = %d)", index, err); set_mono_time_callback(autotox); autotox->dispatch = tox_dispatch_new(nullptr); ck_assert(autotox->dispatch != nullptr); if (autotox->events) { tox_events_init(autotox->tox); } autotox->alive = true; autotox->save_state = nullptr; if (state_size > 0) { autotox->state = calloc(1, state_size); ck_assert(autotox->state != nullptr); ck_assert_msg(autotox->state != nullptr, "failed to allocate state"); } else { autotox->state = nullptr; } if (autotest_opts->init_autotox != nullptr) { autotest_opts->init_autotox(autotox, index); } } static void autotox_add_friend(AutoTox *autotoxes, uint32_t adding, uint32_t added) { uint8_t public_key[TOX_PUBLIC_KEY_SIZE]; tox_self_get_public_key(autotoxes[added].tox, public_key); Tox_Err_Friend_Add err; tox_friend_add_norequest(autotoxes[adding].tox, public_key, &err); ck_assert(err == TOX_ERR_FRIEND_ADD_OK); } static void initialise_friend_graph(Graph_Type graph, uint32_t num_toxes, AutoTox *autotoxes) { if (graph == GRAPH_LINEAR) { printf("toxes #%d-#%u each add adjacent toxes as friends\n", 0, num_toxes - 1); for (uint32_t i = 0; i < num_toxes; ++i) { for (uint32_t j = i - 1; j != i + 3; j += 2) { if (j < num_toxes) { autotox_add_friend(autotoxes, i, j); } } } } else if (graph == GRAPH_COMPLETE) { printf("toxes #%d-#%u add each other as friends\n", 0, num_toxes - 1); for (uint32_t i = 0; i < num_toxes; ++i) { for (uint32_t j = 0; j < num_toxes; ++j) { if (i != j) { autotox_add_friend(autotoxes, i, j); } } } } else { ck_abort_msg("Unknown graph type"); } } static void bootstrap_autotoxes(const Tox_Options *options, uint32_t tox_count, const Run_Auto_Options *autotest_opts, AutoTox *autotoxes) { const bool udp_enabled = options != nullptr ? tox_options_get_udp_enabled(options) : true; printf("bootstrapping all toxes off tox 0\n"); uint8_t dht_key[TOX_PUBLIC_KEY_SIZE]; tox_self_get_dht_id(autotoxes[0].tox, dht_key); const uint16_t dht_port = tox_self_get_udp_port(autotoxes[0].tox, nullptr); for (uint32_t i = 1; i < tox_count; ++i) { Tox_Err_Bootstrap err; tox_bootstrap(autotoxes[i].tox, "localhost", dht_port, dht_key, &err); ck_assert_msg(err == TOX_ERR_BOOTSTRAP_OK, "bootstrap error for port %d: %d", dht_port, err); } if (!udp_enabled) { ck_assert(autotest_opts->tcp_port != 0); printf("bootstrapping all toxes to local TCP relay running on port %d\n", autotest_opts->tcp_port); for (uint32_t i = 0; i < tox_count; ++i) { Tox_Err_Bootstrap err; tox_add_tcp_relay(autotoxes[i].tox, "localhost", autotest_opts->tcp_port, dht_key, &err); ck_assert(err == TOX_ERR_BOOTSTRAP_OK); } } } typedef void autotox_test_cb(AutoTox *autotoxes); void run_auto_test(struct Tox_Options *options, uint32_t tox_count, autotox_test_cb *test, uint32_t state_size, Run_Auto_Options *autotest_opts) { printf("initialising %u toxes\n", tox_count); AutoTox *autotoxes = (AutoTox *)calloc(tox_count, sizeof(AutoTox)); ck_assert(autotoxes != nullptr); for (uint32_t i = 0; i < tox_count; ++i) { initialise_autotox(options, &autotoxes[i], i, state_size, autotest_opts); } initialise_friend_graph(autotest_opts->graph, tox_count, autotoxes); bootstrap_autotoxes(options, tox_count, autotest_opts, autotoxes); do { iterate_all_wait(autotoxes, tox_count, ITERATION_INTERVAL); } while (!all_connected(autotoxes, tox_count)); printf("toxes are online\n"); do { iterate_all_wait(autotoxes, tox_count, ITERATION_INTERVAL); } while (!all_friends_connected(autotoxes, tox_count)); printf("tox clients connected\n"); test(autotoxes); for (uint32_t i = 0; i < tox_count; ++i) { tox_dispatch_free(autotoxes[i].dispatch); tox_kill(autotoxes[i].tox); free(autotoxes[i].state); free(autotoxes[i].save_state); } free(autotoxes); } static const char *tox_log_level_name(Tox_Log_Level level) { switch (level) { case TOX_LOG_LEVEL_TRACE: return "TRACE"; case TOX_LOG_LEVEL_DEBUG: return "DEBUG"; case TOX_LOG_LEVEL_INFO: return "INFO"; case TOX_LOG_LEVEL_WARNING: return "WARNING"; case TOX_LOG_LEVEL_ERROR: return "ERROR"; } return ""; } void print_debug_log(Tox *m, Tox_Log_Level level, const char *file, uint32_t line, const char *func, const char *message, void *user_data) { if (level == TOX_LOG_LEVEL_TRACE) { return; } const uint32_t index = user_data ? *(uint32_t *)user_data : 0; fprintf(stderr, "[#%u] %s %s:%u\t%s:\t%s\n", index, tox_log_level_name(level), file, line, func, message); if (level == TOX_LOG_LEVEL_ERROR && ABORT_ON_LOG_ERROR) { fputs("Aborting test program\n", stderr); abort(); } } void print_debug_logger(void *context, Logger_Level level, const char *file, int line, const char *func, const char *message, void *userdata) { print_debug_log(nullptr, (Tox_Log_Level) level, file, (uint32_t) line, func, message, userdata); } Tox *tox_new_log_lan(struct Tox_Options *options, Tox_Err_New *err, void *log_user_data, bool lan_discovery) { struct Tox_Options *log_options = options; if (log_options == nullptr) { log_options = tox_options_new(nullptr); } assert(log_options != nullptr); tox_options_set_ipv6_enabled(log_options, USE_IPV6); tox_options_set_local_discovery_enabled(log_options, lan_discovery); // Use a higher start port for non-LAN-discovery tests so it's more likely for the LAN discovery // test to get the default port 33445. const uint16_t start_port = lan_discovery ? 33445 : 33545; tox_options_set_start_port(log_options, start_port); tox_options_set_end_port(log_options, start_port + 2000); tox_options_set_log_callback(log_options, &print_debug_log); tox_options_set_log_user_data(log_options, log_user_data); Tox *tox = tox_new(log_options, err); if (options == nullptr) { tox_options_free(log_options); } return tox; } Tox *tox_new_log(struct Tox_Options *options, Tox_Err_New *err, void *log_user_data) { return tox_new_log_lan(options, err, log_user_data, false); }