Skip to content

Commit

Permalink
refactor: Move file streaming test to its own file.
Browse files Browse the repository at this point in the history
It can't easily be ported to events.
  • Loading branch information
iphydf committed Jan 14, 2024
1 parent acdc673 commit d30c81a
Show file tree
Hide file tree
Showing 4 changed files with 277 additions and 48 deletions.
3 changes: 2 additions & 1 deletion auto_tests/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ auto_test(crypto)
#auto_test(dht) # Doesn't work with UNITY_BUILD.
auto_test(dht_getnodes_api)
auto_test(encryptsave)
auto_test(file_transfer)
auto_test(file_saving)
auto_test(file_streaming)
auto_test(file_transfer)
auto_test(forwarding)
auto_test(friend_connection)
auto_test(friend_request)
Expand Down
5 changes: 5 additions & 0 deletions auto_tests/Makefile.inc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ TESTS = \
crypto_test \
encryptsave_test \
file_saving_test \
file_streaming_test \
file_transfer_test \
forwarding_test \
friend_connection_test \
Expand Down Expand Up @@ -103,6 +104,10 @@ file_saving_test_SOURCES = ../auto_tests/file_saving_test.c
file_saving_test_CFLAGS = $(AUTOTEST_CFLAGS)
file_saving_test_LDADD = $(AUTOTEST_LDADD)

file_streaming_test_SOURCES = ../auto_tests/file_streaming_test.c
file_streaming_test_CFLAGS = $(AUTOTEST_CFLAGS)
file_streaming_test_LDADD = $(AUTOTEST_LDADD)

file_transfer_test_SOURCES = ../auto_tests/file_transfer_test.c
file_transfer_test_CFLAGS = $(AUTOTEST_CFLAGS)
file_transfer_test_LDADD = $(AUTOTEST_LDADD)
Expand Down
270 changes: 270 additions & 0 deletions auto_tests/file_streaming_test.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,270 @@
/* File transfer test: streaming version (no known size).
*/

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>

#include "../testing/misc_tools.h"
#include "../toxcore/ccompat.h"
#include "../toxcore/tox.h"
#include "../toxcore/util.h"
#include "auto_test_support.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 FORCE_TESTS_IPV6
#define TOX_LOCALHOST "::1"
#else
#define TOX_LOCALHOST "127.0.0.1"
#endif

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) {
tox_friend_add_norequest(m, public_key, nullptr);
}
}

static uint64_t size_recv;
static uint64_t sending_pos;

static uint8_t file_cmp_id[TOX_FILE_ID_LENGTH];
static uint32_t file_accepted;
static uint64_t file_size;
static void tox_file_receive(Tox *tox, uint32_t friend_number, uint32_t file_number, uint32_t kind, uint64_t filesize,
const uint8_t *filename, size_t filename_length, void *userdata)
{
ck_assert_msg(kind == TOX_FILE_KIND_DATA, "bad kind");

Check warning on line 40 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L40

MISRA 21.8 rule

ck_assert_msg(filename_length == sizeof("Gentoo.exe")

Check warning on line 42 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L42

MISRA 21.8 rule
&& memcmp(filename, "Gentoo.exe", sizeof("Gentoo.exe")) == 0, "bad filename");

uint8_t file_id[TOX_FILE_ID_LENGTH];

ck_assert_msg(tox_file_get_file_id(tox, friend_number, file_number, file_id, nullptr), "tox_file_get_file_id error");

ck_assert_msg(memcmp(file_id, file_cmp_id, TOX_FILE_ID_LENGTH) == 0, "bad file_id");

Check warning on line 49 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L49

MISRA 21.8 rule

uint8_t empty[TOX_FILE_ID_LENGTH] = {0};

ck_assert_msg(memcmp(empty, file_cmp_id, TOX_FILE_ID_LENGTH) != 0, "empty file_id");

Check warning on line 53 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L53

MISRA 21.8 rule

file_size = filesize;

if (filesize) {
sending_pos = size_recv = 1337;

Tox_Err_File_Seek err_s;

ck_assert_msg(tox_file_seek(tox, friend_number, file_number, 1337, &err_s), "tox_file_seek error");

ck_assert_msg(err_s == TOX_ERR_FILE_SEEK_OK, "tox_file_seek wrong error");

Check warning on line 64 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L64

MISRA 21.8 rule

} else {
sending_pos = size_recv = 0;

Check warning on line 67 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L67

MISRA 13.4 rule
}

Tox_Err_File_Control error;

ck_assert_msg(tox_file_control(tox, friend_number, file_number, TOX_FILE_CONTROL_RESUME, &error),
"tox_file_control failed. %i", error);
++file_accepted;

Tox_Err_File_Seek err_s;

ck_assert_msg(!tox_file_seek(tox, friend_number, file_number, 1234, &err_s), "tox_file_seek no error");

Check warning on line 78 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L78

MISRA 21.8 rule

ck_assert_msg(err_s == TOX_ERR_FILE_SEEK_DENIED, "tox_file_seek wrong error");

Check warning on line 80 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L80

MISRA 21.8 rule
}

static uint32_t sendf_ok;
static void file_print_control(Tox *tox, uint32_t friend_number, uint32_t file_number, Tox_File_Control control,
void *userdata)
{
/* First send file num is 0.*/
if (file_number == 0 && control == TOX_FILE_CONTROL_RESUME) {
sendf_ok = 1;
}
}

static uint64_t max_sending;
static bool m_send_reached;
static uint8_t sending_num;
static bool file_sending_done;
static void tox_file_chunk_request(Tox *tox, uint32_t friend_number, uint32_t file_number, uint64_t position,
size_t length, void *user_data)
{
ck_assert_msg(sendf_ok, "didn't get resume control");

ck_assert_msg(sending_pos == position, "bad position %lu", (unsigned long)position);

Check warning on line 102 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L102

MISRA 21.8 rule

if (length == 0) {
ck_assert_msg(!file_sending_done, "file sending already done");

file_sending_done = 1;
return;
}

if (position + length > max_sending) {
ck_assert_msg(!m_send_reached, "requested done file transfer");

length = max_sending - position;

Check warning on line 114 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L114

MISRA 17.8 rule
m_send_reached = 1;
}

VLA(uint8_t, f_data, length);

Check warning on line 118 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L118

MISRA 18.8 rule
memset(f_data, sending_num, length);

Tox_Err_File_Send_Chunk error;
tox_file_send_chunk(tox, friend_number, file_number, position, f_data, length, &error);


ck_assert_msg(error == TOX_ERR_FILE_SEND_CHUNK_OK,

Check warning on line 125 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L125

MISRA 21.8 rule
"could not send chunk, error num=%d pos=%d len=%d", (int)error, (int)position, (int)length);

++sending_num;
sending_pos += length;
}


static uint8_t num;
static bool file_recv;
static void write_file(Tox *tox, uint32_t friendnumber, uint32_t filenumber, uint64_t position, const uint8_t *data,
size_t length, void *user_data)
{
ck_assert_msg(size_recv == position, "bad position");

Check warning on line 138 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L138

MISRA 21.8 rule

if (length == 0) {
file_recv = 1;
return;
}

VLA(uint8_t, f_data, length);
memset(f_data, num, length);
++num;

ck_assert_msg(memcmp(f_data, data, length) == 0, "FILE_CORRUPTED");

Check warning on line 149 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L149

MISRA 21.8 rule

size_recv += length;
}

static void file_transfer_test(void)
{
printf("Starting test: few_clients\n");
uint32_t index[] = { 1, 2, 3 };
long long unsigned int cur_time = time(nullptr);

Check warning on line 158 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L158

time is Y2038-unsafe
Tox_Err_New t_n_error;
Tox *tox1 = tox_new_log(nullptr, &t_n_error, &index[0]);
ck_assert_msg(t_n_error == TOX_ERR_NEW_OK, "wrong error");

Check warning on line 161 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L161

MISRA 21.8 rule
Tox *tox2 = tox_new_log(nullptr, &t_n_error, &index[1]);
ck_assert_msg(t_n_error == TOX_ERR_NEW_OK, "wrong error");
Tox *tox3 = tox_new_log(nullptr, &t_n_error, &index[2]);
ck_assert_msg(t_n_error == TOX_ERR_NEW_OK, "wrong error");

ck_assert_msg(tox1 && tox2 && tox3, "Failed to create 3 tox instances");

Check warning on line 167 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L167

MISRA 21.8 rule

tox_callback_friend_request(tox2, accept_friend_request);
uint8_t address[TOX_ADDRESS_SIZE];
tox_self_get_address(tox2, address);
uint32_t test = tox_friend_add(tox3, address, (const uint8_t *)"Gentoo", 7, nullptr);
ck_assert_msg(test == 0, "Failed to add friend error code: %u", test);

uint8_t dht_key[TOX_PUBLIC_KEY_SIZE];
tox_self_get_dht_id(tox1, dht_key);
uint16_t dht_port = tox_self_get_udp_port(tox1, nullptr);

tox_bootstrap(tox2, TOX_LOCALHOST, dht_port, dht_key, nullptr);
tox_bootstrap(tox3, TOX_LOCALHOST, dht_port, dht_key, nullptr);

printf("Waiting for toxes to come online\n");

do {
tox_iterate(tox1, nullptr);
tox_iterate(tox2, nullptr);
tox_iterate(tox3, nullptr);

printf("Connections: self (%d, %d, %d), friends (%d, %d)\n",
tox_self_get_connection_status(tox1),
tox_self_get_connection_status(tox2),
tox_self_get_connection_status(tox3),
tox_friend_get_connection_status(tox2, 0, nullptr),
tox_friend_get_connection_status(tox3, 0, nullptr));
c_sleep(ITERATION_INTERVAL);
} while (tox_self_get_connection_status(tox1) == TOX_CONNECTION_NONE ||
tox_self_get_connection_status(tox2) == TOX_CONNECTION_NONE ||
tox_self_get_connection_status(tox3) == TOX_CONNECTION_NONE ||
tox_friend_get_connection_status(tox2, 0, nullptr) == TOX_CONNECTION_NONE ||
tox_friend_get_connection_status(tox3, 0, nullptr) == TOX_CONNECTION_NONE);

printf("Starting file transfer test: 100MiB file.\n");

file_accepted = file_size = sendf_ok = size_recv = 0;
file_recv = 0;
max_sending = UINT64_MAX;
uint64_t totalf_size = 100 * 1024 * 1024;

printf("Starting file streaming transfer test.\n");

file_sending_done = 0;
file_accepted = 0;
file_size = 0;
sendf_ok = 0;
size_recv = 0;
file_recv = 0;
tox_callback_file_recv_chunk(tox3, write_file);
tox_callback_file_recv_control(tox2, file_print_control);
tox_callback_file_chunk_request(tox2, tox_file_chunk_request);
tox_callback_file_recv_control(tox3, file_print_control);
tox_callback_file_recv(tox3, tox_file_receive);
totalf_size = UINT64_MAX;

Check notice on line 222 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L222

Redundant initialization for 'totalf_size'. The initialized value is overwritten before it is read.
Tox_File_Number fnum = tox_file_send(
tox2, 0, TOX_FILE_KIND_DATA, totalf_size, nullptr,
(const uint8_t *)"Gentoo.exe", sizeof("Gentoo.exe"), nullptr);
ck_assert_msg(fnum != UINT32_MAX, "tox_new_file_sender fail");

Check warning on line 226 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L226

MISRA 21.8 rule

Tox_Err_File_Get gfierr;
ck_assert_msg(!tox_file_get_file_id(tox2, 1, fnum, file_cmp_id, &gfierr), "tox_file_get_file_id didn't fail");

Check warning on line 229 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L229

MISRA 21.8 rule
ck_assert_msg(gfierr == TOX_ERR_FILE_GET_FRIEND_NOT_FOUND, "wrong error");

Check warning on line 230 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L230

MISRA 21.8 rule
ck_assert_msg(!tox_file_get_file_id(tox2, 0, fnum + 1, file_cmp_id, &gfierr), "tox_file_get_file_id didn't fail");
ck_assert_msg(gfierr == TOX_ERR_FILE_GET_NOT_FOUND, "wrong error");
ck_assert_msg(tox_file_get_file_id(tox2, 0, fnum, file_cmp_id, &gfierr), "tox_file_get_file_id failed");

Check warning on line 233 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L233

MISRA 21.8 rule
ck_assert_msg(gfierr == TOX_ERR_FILE_GET_OK, "wrong error");

Check warning on line 234 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L234

MISRA 21.8 rule

max_sending = 100 * 1024;
m_send_reached = 0;

do {
tox_iterate(tox1, nullptr);
tox_iterate(tox2, nullptr);
tox_iterate(tox3, nullptr);

uint32_t tox1_interval = tox_iteration_interval(tox1);
uint32_t tox2_interval = tox_iteration_interval(tox2);
uint32_t tox3_interval = tox_iteration_interval(tox3);

c_sleep(min_u32(tox1_interval, min_u32(tox2_interval, tox3_interval)));
} while (!file_sending_done);

ck_assert_msg(sendf_ok && file_recv && m_send_reached && totalf_size == file_size && size_recv == max_sending

Check warning on line 251 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L251

MISRA 21.8 rule
&& sending_pos == size_recv && file_accepted == 1,
"something went wrong in file transfer %u %u %u %u %u %u %u %lu %lu %lu %lu", sendf_ok, file_recv,
m_send_reached, totalf_size == file_size, size_recv == max_sending, sending_pos == size_recv, file_accepted == 1,
(unsigned long)totalf_size, (unsigned long)file_size,
(unsigned long)size_recv, (unsigned long)sending_pos);

printf("file_transfer_test succeeded, took %llu seconds\n", time(nullptr) - cur_time);

Check warning on line 258 in auto_tests/file_streaming_test.c

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

auto_tests/file_streaming_test.c#L258

time is Y2038-unsafe

tox_kill(tox1);
tox_kill(tox2);
tox_kill(tox3);
}

int main(void)
{
setvbuf(stdout, nullptr, _IONBF, 0);
file_transfer_test();
return 0;
}
47 changes: 0 additions & 47 deletions auto_tests/file_transfer_test.c
Original file line number Diff line number Diff line change
Expand Up @@ -261,53 +261,6 @@ static void file_transfer_test(void)

printf("100MiB file sent in %lu seconds\n", (unsigned long)(time(nullptr) - f_time));

printf("Starting file streaming transfer test.\n");

file_sending_done = 0;
file_accepted = 0;
file_size = 0;
sendf_ok = 0;
size_recv = 0;
file_recv = 0;
tox_callback_file_recv_chunk(tox3, write_file);
tox_callback_file_recv_control(tox2, file_print_control);
tox_callback_file_chunk_request(tox2, tox_file_chunk_request);
tox_callback_file_recv_control(tox3, file_print_control);
tox_callback_file_recv(tox3, tox_file_receive);
totalf_size = UINT64_MAX;
fnum = tox_file_send(tox2, 0, TOX_FILE_KIND_DATA, totalf_size, nullptr,
(const uint8_t *)"Gentoo.exe", sizeof("Gentoo.exe"), nullptr);
ck_assert_msg(fnum != UINT32_MAX, "tox_new_file_sender fail");

ck_assert_msg(!tox_file_get_file_id(tox2, 1, fnum, file_cmp_id, &gfierr), "tox_file_get_file_id didn't fail");
ck_assert_msg(gfierr == TOX_ERR_FILE_GET_FRIEND_NOT_FOUND, "wrong error");
ck_assert_msg(!tox_file_get_file_id(tox2, 0, fnum + 1, file_cmp_id, &gfierr), "tox_file_get_file_id didn't fail");
ck_assert_msg(gfierr == TOX_ERR_FILE_GET_NOT_FOUND, "wrong error");
ck_assert_msg(tox_file_get_file_id(tox2, 0, fnum, file_cmp_id, &gfierr), "tox_file_get_file_id failed");
ck_assert_msg(gfierr == TOX_ERR_FILE_GET_OK, "wrong error");

max_sending = 100 * 1024;
m_send_reached = 0;

do {
tox_iterate(tox1, nullptr);
tox_iterate(tox2, nullptr);
tox_iterate(tox3, nullptr);

uint32_t tox1_interval = tox_iteration_interval(tox1);
uint32_t tox2_interval = tox_iteration_interval(tox2);
uint32_t tox3_interval = tox_iteration_interval(tox3);

c_sleep(min_u32(tox1_interval, min_u32(tox2_interval, tox3_interval)));
} while (!file_sending_done);

ck_assert_msg(sendf_ok && file_recv && m_send_reached && totalf_size == file_size && size_recv == max_sending
&& sending_pos == size_recv && file_accepted == 1,
"something went wrong in file transfer %u %u %u %u %u %u %u %lu %lu %lu %lu", sendf_ok, file_recv,
m_send_reached, totalf_size == file_size, size_recv == max_sending, sending_pos == size_recv, file_accepted == 1,
(unsigned long)totalf_size, (unsigned long)file_size,
(unsigned long)size_recv, (unsigned long)sending_pos);

printf("starting file 0 transfer test.\n");

file_sending_done = 0;
Expand Down

0 comments on commit d30c81a

Please sign in to comment.