commit 0f070e7858d4270983141a701116de9353fb3fb6 Author: Kevin Butler <haqkrs@gmail.com> Date: Wed Sep 4 23:25:41 2013 +0100 Added test for new write_chunks_to_file behaviour in #1376. --- src/common/util.c | 5 ++- src/test/test_util.c | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 119 insertions(+), 2 deletions(-) diff --git a/src/common/util.c b/src/common/util.c index 4e84d94..695d048 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -2191,11 +2191,12 @@ write_chunks_to_file_impl(const char *fname, const smartlist_t *chunks, } /** Given a smartlist of sized_chunk_t, write them to a file - * <b>fname</b>, overwriting or creating the file as necessary. + * <b>fname</b>, overwriting or creating the file as necessary. * If <b>no_tempfile</b> is 0 then the file will be written * atomically. */ int -write_chunks_to_file(const char *fname, const smartlist_t *chunks, int bin, int no_tempfile) +write_chunks_to_file(const char *fname, const smartlist_t *chunks, int bin, + int no_tempfile) { int flags = OPEN_FLAGS_REPLACE|(bin?O_BINARY:O_TEXT); diff --git a/src/test/test_util.c b/src/test/test_util.c index 05d28d7..6f2bddd 100644 --- a/src/test/test_util.c +++ b/src/test/test_util.c @@ -102,6 +102,121 @@ test_util_read_file_eof_zero_bytes(void *arg) test_util_read_until_eof_impl("tor_test_fifo_empty", 0, 10000); } +/* Test the basic expected behaviour for write_chunks_to_file. +* NOTE: This will need to be updated if we ever change the tempfile location +* or extension */ +static void +test_util_write_chunks_to_file(void *arg) +{ + char *fname; + char *tempname; + char *str; + char *data_str; + char *temp_str; + int r; + int fd = -1; + size_t sz = 999999; + (void)arg; + + /* These should be two different sizes to ensure the data is different + * between the data file and the temp file's 'known string' */ + int temp_str_len = 1024; + int data_str_len = 512; + temp_str = tor_malloc(temp_str_len); + data_str = tor_malloc(data_str_len); + crypto_rand(temp_str, temp_str_len); + crypto_rand(data_str, data_str_len); + tt_assert(temp_str != NULL); + tt_assert(data_str != NULL); + + // Ensure it can write multiple chunks + smartlist_t *chunks = smartlist_new(); + sized_chunk_t c = {data_str, data_str_len/2}; + sized_chunk_t c2 = {data_str + data_str_len/2, data_str_len/2}; + smartlist_add(chunks, &c); + smartlist_add(chunks, &c2); + + /* + * Check if it writes using a tempfile + */ + fname = tor_strdup("tor_test_write_chunks_to_file_with_tempfile"); + tor_asprintf(&tempname, "%s.tmp", fname); + + // write a known string to a file where the tempfile will be + r = write_bytes_to_file(tempname, temp_str, temp_str_len, 1); + tt_int_op(r, ==, 0); + + // call write_chunks_to_file + r = write_chunks_to_file(fname, chunks, 1, 0); + tt_int_op(r, ==, 0); + + // assert the file has been written (expected size) + fd = open(fname, O_RDONLY|O_BINARY); + tt_int_op(fd, >=, 0); + str = read_file_to_str_until_eof(fd, data_str_len*2, &sz); + tt_assert(str != NULL); + tt_int_op(sz, ==, data_str_len); + test_mem_op(data_str, ==, str, sz); + tor_free(str); + close(fd); + + // assert that the tempfile is removed (should not leave artifacts) + fd = open(tempname, O_RDONLY|O_BINARY); + tt_int_op(fd, <, 0); // This might be untrue + str = read_file_to_str_until_eof(fd, temp_str_len*2, &sz); + tt_assert(str == NULL); + + // Remove old testfile for second test + r = unlink(fname); + tt_int_op(r, ==, 0); + tor_free(fname); + tor_free(tempname); + + /* + * Check if it skips using a tempfile with flags + */ + fname = tor_strdup("tor_test_write_chunks_to_file_with_no_tempfile"); + tor_asprintf(&tempname, "%s.tmp", fname); + + // write a known string to a file where the tempfile will be + r = write_bytes_to_file(tempname, temp_str, temp_str_len, 1); + tt_int_op(r, ==, 0); + + // call write_chunks_to_file with no_tempfile = true + r = write_chunks_to_file(fname, chunks, 1, 1); + tt_int_op(r, ==, 0); + + // assert the file has been written (expected size) + fd = open(fname, O_RDONLY|O_BINARY); + tt_int_op(fd, >=, 0); + str = read_file_to_str_until_eof(fd, data_str_len*2, &sz); + tt_assert(str != NULL); + tt_int_op(sz, ==, data_str_len); + test_mem_op(data_str, ==, str, sz); + tor_free(str); + close(fd); + + // assert the tempfile still contains the known string + fd = open(tempname, O_RDONLY|O_BINARY); + tt_int_op(fd, >=, 0); // This might be untrue + str = read_file_to_str_until_eof(fd, temp_str_len*2, &sz); + tt_assert(str != NULL); + tt_int_op(sz, ==, temp_str_len); + test_mem_op(temp_str, ==, str, sz); + + done: + unlink(fname); + unlink(tempname); + smartlist_free(chunks); + tor_free(fname); + tor_free(tempname); + tor_free(str); + tor_free(data_str); + tor_free(temp_str); + if (fd >= 0) + close(fd); +} + static void test_util_time(void) { @@ -3502,6 +3617,7 @@ struct testcase_t util_tests[] = { UTIL_TEST(read_file_eof_tiny_limit, 0), UTIL_TEST(read_file_eof_two_loops, 0), UTIL_TEST(read_file_eof_zero_bytes, 0), + UTIL_TEST(write_chunks_to_file, 0), UTIL_TEST(mathlog, 0), UTIL_TEST(weak_random, 0), UTIL_TEST(socket, TT_FORK),