1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/common/allocator.h>
#include <aws/common/device_random.h>
#include <aws/common/file.h>
#include <aws/common/string.h>
#include <aws/common/system_info.h>
#include <aws/testing/aws_test_harness.h>
#include <fcntl.h>
static int s_aws_fopen_test_helper(char *file_path, char *content) {
char read_result[100];
AWS_ZERO_ARRAY(read_result);
FILE *file = aws_fopen(file_path, "w+");
ASSERT_NOT_NULL(file);
fprintf(file, "%s", content);
fclose(file);
FILE *readfile = aws_fopen(file_path, "r");
ASSERT_NOT_NULL(readfile);
size_t read_len = fread(read_result, sizeof(char), strlen(content), readfile);
ASSERT_UINT_EQUALS(strlen(content), read_len);
fclose(readfile);
ASSERT_SUCCESS(strcmp(content, read_result));
#ifdef _WIN32
wchar_t w_file_path[1000];
/* plus one for the EOS */
size_t file_path_len = strlen(file_path) + 1;
MultiByteToWideChar(CP_UTF8, 0, file_path, -1, w_file_path, (int)file_path_len);
ASSERT_SUCCESS(_wremove(w_file_path));
#else
ASSERT_SUCCESS(remove(file_path));
#endif
return AWS_OP_SUCCESS;
}
static int s_aws_fopen_content_matches(char *file_path, char *content) {
char read_result[100];
AWS_ZERO_ARRAY(read_result);
FILE *file = aws_fopen(file_path, "rb");
ASSERT_NOT_NULL(file);
size_t read_len = fread(read_result, sizeof(char), strlen(content), file);
ASSERT_UINT_EQUALS(strlen(content), read_len);
fclose(file);
ASSERT_SUCCESS(strcmp(content, read_result));
return AWS_OP_SUCCESS;
}
static int s_aws_fopen_non_ascii_read_existing_file_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)allocator;
(void)ctx;
char expected_content[] = "This is a non-ascii file path file.";
char file_path[] = "Å Éxample.txt";
char read_result[100];
AWS_ZERO_ARRAY(read_result);
FILE *readfile = aws_fopen(file_path, "r");
ASSERT_NOT_NULL(readfile);
size_t read_len = fread(read_result, sizeof(char), strlen(expected_content), readfile);
ASSERT_UINT_EQUALS(strlen(expected_content), read_len);
fclose(readfile);
ASSERT_SUCCESS(strcmp(expected_content, read_result));
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(aws_fopen_non_ascii_read_existing_file_test, s_aws_fopen_non_ascii_read_existing_file_test_fn)
static int s_aws_fopen_non_ascii_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)allocator;
(void)ctx;
char file_path[] = "Éxample.txt";
char content[] = "samples";
ASSERT_SUCCESS(s_aws_fopen_test_helper(file_path, content));
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(aws_fopen_non_ascii_test, s_aws_fopen_non_ascii_test_fn)
static int s_aws_fopen_ascii_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)allocator;
(void)ctx;
char file_path[] = "sample.txt";
char content[] = "samples";
ASSERT_SUCCESS(s_aws_fopen_test_helper(file_path, content));
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(aws_fopen_ascii_test, s_aws_fopen_ascii_test_fn)
struct directory_traversal_test_data {
bool child_dir_verified;
bool child_file_verified;
bool root_file_verified;
};
static const char *s_first_child_dir_path = "dir_traversal_test" AWS_PATH_DELIM_STR "first_child_dir";
static const char *s_first_child_file_path =
"dir_traversal_test" AWS_PATH_DELIM_STR "first_child_dir" AWS_PATH_DELIM_STR "child.txt";
static const char *s_root_child_path = "dir_traversal_test" AWS_PATH_DELIM_STR "root_child.txt";
bool s_on_directory_entry(const struct aws_directory_entry *entry, void *user_data) {
struct directory_traversal_test_data *test_data = user_data;
if (aws_byte_cursor_eq_c_str(&entry->relative_path, s_root_child_path)) {
test_data->root_file_verified =
entry->file_type & AWS_FILE_TYPE_FILE && entry->file_size &&
s_aws_fopen_content_matches((char *)entry->relative_path.ptr, "dir_traversal_test->root_child.txt") ==
AWS_OP_SUCCESS;
return true;
}
if (aws_byte_cursor_eq_c_str(&entry->relative_path, s_first_child_file_path)) {
test_data->child_file_verified =
entry->file_type & AWS_FILE_TYPE_FILE && entry->file_size &&
s_aws_fopen_content_matches(
(char *)entry->relative_path.ptr, "dir_traversal_test->first_child_dir->child.txt") == AWS_OP_SUCCESS;
return true;
}
if (aws_byte_cursor_eq_c_str(&entry->relative_path, s_first_child_dir_path)) {
test_data->child_dir_verified = entry->file_type & AWS_FILE_TYPE_DIRECTORY;
return true;
}
return false;
}
static int s_directory_traversal_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "dir_traversal_test");
struct directory_traversal_test_data test_data;
AWS_ZERO_STRUCT(test_data);
ASSERT_SUCCESS(aws_directory_traverse(allocator, path, true, s_on_directory_entry, &test_data));
ASSERT_TRUE(test_data.child_dir_verified);
ASSERT_TRUE(test_data.root_file_verified);
ASSERT_TRUE(test_data.child_file_verified);
AWS_ZERO_STRUCT(test_data);
ASSERT_SUCCESS(aws_directory_traverse(allocator, path, false, s_on_directory_entry, &test_data));
ASSERT_TRUE(test_data.child_dir_verified);
ASSERT_TRUE(test_data.root_file_verified);
ASSERT_FALSE(test_data.child_file_verified);
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_traversal_test, s_directory_traversal_test_fn)
static int s_directory_iteration_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "dir_traversal_test");
struct aws_directory_iterator *iterator = aws_directory_entry_iterator_new(allocator, path);
ASSERT_NOT_NULL(iterator);
const struct aws_directory_entry *first_entry = aws_directory_entry_iterator_get_value(iterator);
ASSERT_NOT_NULL(first_entry);
bool first_child_dir_found = false;
bool root_file_found = false;
do {
const struct aws_directory_entry *entry = aws_directory_entry_iterator_get_value(iterator);
if (entry->file_type == AWS_FILE_TYPE_DIRECTORY) {
struct aws_byte_cursor first_child_dir_path_cur = aws_byte_cursor_from_c_str(s_first_child_dir_path);
ASSERT_BIN_ARRAYS_EQUALS(
first_child_dir_path_cur.ptr,
first_child_dir_path_cur.len,
entry->relative_path.ptr,
entry->relative_path.len);
first_child_dir_found = true;
struct aws_string *next_path = aws_string_new_from_cursor(allocator, &entry->relative_path);
struct aws_directory_iterator *next_iter = aws_directory_entry_iterator_new(allocator, next_path);
aws_string_destroy(next_path);
ASSERT_NOT_NULL(next_iter);
entry = aws_directory_entry_iterator_get_value(next_iter);
struct aws_byte_cursor first_child_file_path_cur = aws_byte_cursor_from_c_str(s_first_child_file_path);
ASSERT_BIN_ARRAYS_EQUALS(
first_child_file_path_cur.ptr,
first_child_file_path_cur.len,
entry->relative_path.ptr,
entry->relative_path.len);
ASSERT_INT_EQUALS(AWS_FILE_TYPE_FILE, entry->file_type);
ASSERT_ERROR(AWS_ERROR_LIST_EMPTY, aws_directory_entry_iterator_next(next_iter));
aws_directory_entry_iterator_destroy(next_iter);
} else {
struct aws_byte_cursor root_child_file_path_cur = aws_byte_cursor_from_c_str(s_root_child_path);
ASSERT_BIN_ARRAYS_EQUALS(
root_child_file_path_cur.ptr,
root_child_file_path_cur.len,
entry->relative_path.ptr,
entry->relative_path.len);
ASSERT_INT_EQUALS(AWS_FILE_TYPE_FILE, entry->file_type);
root_file_found = true;
}
} while (aws_directory_entry_iterator_next(iterator) == AWS_OP_SUCCESS);
ASSERT_ERROR(AWS_ERROR_LIST_EMPTY, aws_directory_entry_iterator_next(iterator));
ASSERT_SUCCESS(aws_directory_entry_iterator_previous(iterator));
ASSERT_PTR_EQUALS(first_entry, aws_directory_entry_iterator_get_value(iterator));
aws_directory_entry_iterator_destroy(iterator);
aws_string_destroy(path);
ASSERT_TRUE(root_file_found);
ASSERT_TRUE(first_child_dir_found);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_iteration_test, s_directory_iteration_test_fn)
static int s_directory_iteration_non_existent_directory_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "dir_traversal_test_non_existent");
struct aws_directory_iterator *iterator = aws_directory_entry_iterator_new(allocator, path);
ASSERT_NULL(iterator);
ASSERT_INT_EQUALS(aws_last_error(), AWS_ERROR_FILE_INVALID_PATH);
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_iteration_non_existent_directory_test, s_directory_iteration_non_existent_directory_test_fn)
struct directory_traversal_abort_test_data {
int times_called;
};
bool directory_traversal_abort_test_data(const struct aws_directory_entry *entry, void *user_data) {
(void)entry;
struct directory_traversal_abort_test_data *test_data = user_data;
test_data->times_called += 1;
return false;
}
static int s_directory_traversal_stop_traversal_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "dir_traversal_test");
struct directory_traversal_abort_test_data test_data;
AWS_ZERO_STRUCT(test_data);
ASSERT_ERROR(
AWS_ERROR_OPERATION_INTERUPTED,
aws_directory_traverse(allocator, path, true, directory_traversal_abort_test_data, &test_data));
ASSERT_INT_EQUALS(1, test_data.times_called);
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_traversal_stop_traversal, s_directory_traversal_stop_traversal_fn)
static int s_directory_traversal_on_file_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "dir_traversal_test/root_child.txt");
struct directory_traversal_test_data test_data;
AWS_ZERO_STRUCT(test_data);
ASSERT_ERROR(
AWS_ERROR_FILE_INVALID_PATH, aws_directory_traverse(allocator, path, true, s_on_directory_entry, &test_data));
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_traversal_on_file_test, s_directory_traversal_on_file_test_fn)
static int s_directory_existence_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "dir_traversal_test");
ASSERT_TRUE(aws_directory_exists(path));
aws_string_destroy(path);
path = aws_string_new_from_c_str(allocator, "dir_traversal_test_blah");
ASSERT_FALSE(aws_directory_exists(path));
aws_string_destroy(path);
path = aws_string_new_from_c_str(allocator, "dir_traversal_test/root_child.txt");
ASSERT_FALSE(aws_directory_exists(path));
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_existence_test, s_directory_existence_test_fn)
static int s_directory_creation_deletion_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "temp_dir");
ASSERT_SUCCESS(aws_directory_create(path));
/* should be idempotent */
ASSERT_SUCCESS(aws_directory_create(path));
ASSERT_TRUE(aws_directory_exists(path));
ASSERT_SUCCESS(aws_directory_delete(path, false));
ASSERT_FALSE(aws_directory_exists(path));
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_creation_deletion_test, s_directory_creation_deletion_test_fn)
static int s_directory_non_empty_deletion_fails_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "dir_traversal_test");
ASSERT_TRUE(aws_directory_exists(path));
ASSERT_ERROR(AWS_ERROR_DIRECTORY_NOT_EMPTY, aws_directory_delete(path, false));
ASSERT_TRUE(aws_directory_exists(path));
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_non_empty_deletion_fails_test, s_directory_non_empty_deletion_fails_test_fn)
static int s_directory_non_empty_deletion_recursively_succeeds_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "non_empty_dir_del_test_dir_1");
ASSERT_SUCCESS(aws_directory_create(path));
const char *nested_dir = "non_empty_dir_del_test_dir_1" AWS_PATH_DELIM_STR "test_dir_2";
struct aws_string *nested_dir_path = aws_string_new_from_c_str(allocator, nested_dir);
ASSERT_SUCCESS(aws_directory_create(nested_dir_path));
const char *nested_file =
"non_empty_dir_del_test_dir_1" AWS_PATH_DELIM_STR "test_dir_2" AWS_PATH_DELIM_STR "nested_file.txt";
FILE *nested_file_ptr = aws_fopen(nested_file, "w");
ASSERT_NOT_NULL(nested_file_ptr);
fclose(nested_file_ptr);
ASSERT_SUCCESS(aws_directory_delete(path, true));
ASSERT_FALSE(aws_directory_exists(path));
aws_string_destroy(nested_dir_path);
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(
directory_non_empty_deletion_recursively_succeeds_test,
s_directory_non_empty_deletion_recursively_succeeds_test_fn)
static int s_directory_move_succeeds_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "directory_move_succeeds_test_dir_1");
ASSERT_SUCCESS(aws_directory_create(path));
struct aws_string *to_path = aws_string_new_from_c_str(allocator, "directory_move_succeeds_test_dir_2");
ASSERT_SUCCESS(aws_directory_or_file_move(path, to_path));
ASSERT_FALSE(aws_directory_exists(path));
ASSERT_TRUE(aws_directory_exists(to_path));
ASSERT_SUCCESS(aws_directory_delete(to_path, true));
aws_string_destroy(to_path);
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_move_succeeds_test, s_directory_move_succeeds_test_fn)
static int s_directory_move_src_non_existent_test_fn(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *path = aws_string_new_from_c_str(allocator, "directory_move_src_non_existent_test_dir_1");
struct aws_string *to_path = aws_string_new_from_c_str(allocator, "directory_move_src_non_existent_test_dir_2");
ASSERT_ERROR(AWS_ERROR_FILE_INVALID_PATH, aws_directory_or_file_move(path, to_path));
aws_string_destroy(to_path);
aws_string_destroy(path);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(directory_move_src_non_existent_test, s_directory_move_src_non_existent_test_fn)
static int s_test_home_directory_not_null(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *home_directory = aws_get_home_directory(allocator);
ASSERT_TRUE(home_directory != NULL);
aws_string_destroy(home_directory);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(test_home_directory_not_null, s_test_home_directory_not_null);
static int s_test_normalize_posix_directory_separator(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *buffer = aws_string_new_from_c_str(allocator, "./test/path/abc");
struct aws_byte_buf path_buf = aws_byte_buf_from_array(buffer->bytes, buffer->len);
aws_normalize_directory_separator(&path_buf);
for (size_t i = 0; i < path_buf.len; ++i) {
if (aws_is_any_directory_separator((char)path_buf.buffer[i])) {
ASSERT_INT_EQUALS(aws_get_platform_directory_separator(), path_buf.buffer[i]);
}
}
aws_string_destroy(buffer);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(test_normalize_posix_directory_separator, s_test_normalize_posix_directory_separator);
static int s_test_normalize_windows_directory_separator(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_string *buffer = aws_string_new_from_c_str(allocator, ".\\test\\path\\abc");
struct aws_byte_buf path_buf = aws_byte_buf_from_array(buffer->bytes, buffer->len);
aws_normalize_directory_separator(&path_buf);
for (size_t i = 0; i < path_buf.len; ++i) {
if (aws_is_any_directory_separator((char)path_buf.buffer[i])) {
ASSERT_INT_EQUALS(aws_get_platform_directory_separator(), path_buf.buffer[i]);
}
}
aws_string_destroy(buffer);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(test_normalize_windows_directory_separator, s_test_normalize_windows_directory_separator);
static int s_check_byte_buf_from_file(const struct aws_byte_buf *buf, struct aws_byte_cursor expected_contents) {
ASSERT_TRUE(aws_byte_cursor_eq_byte_buf(&expected_contents, buf), "Contents should match");
ASSERT_TRUE(buf->capacity > buf->len, "Buffer should end with null-terminator");
ASSERT_UINT_EQUALS(0, buf->buffer[buf->len], "Buffer should end with null-terminator");
return AWS_OP_SUCCESS;
}
static int s_create_file_then_read_it(struct aws_allocator *allocator, struct aws_byte_cursor contents) {
/* create file */
const char *filename = "testy";
FILE *f = aws_fopen(filename, "wb");
ASSERT_UINT_EQUALS(contents.len, fwrite(contents.ptr, 1, contents.len, f));
ASSERT_INT_EQUALS(0, fclose(f));
struct aws_byte_buf buf;
/* check aws_byte_buf_init_from_file() */
ASSERT_SUCCESS(aws_byte_buf_init_from_file(&buf, allocator, filename));
ASSERT_SUCCESS(s_check_byte_buf_from_file(&buf, contents));
aws_byte_buf_clean_up(&buf);
/* now check aws_byte_buf_init_from_file_with_size_hint() ... */
/* size_hint more then big enough */
size_t size_hint = contents.len * 2;
ASSERT_SUCCESS(aws_byte_buf_init_from_file_with_size_hint(&buf, allocator, filename, size_hint));
ASSERT_SUCCESS(s_check_byte_buf_from_file(&buf, contents));
aws_byte_buf_clean_up(&buf);
/* size_hint not big enough for null-terminator */
size_hint = contents.len;
ASSERT_SUCCESS(aws_byte_buf_init_from_file_with_size_hint(&buf, allocator, filename, size_hint));
ASSERT_SUCCESS(s_check_byte_buf_from_file(&buf, contents));
aws_byte_buf_clean_up(&buf);
/* size_hint 0 */
size_hint = 0;
ASSERT_SUCCESS(aws_byte_buf_init_from_file_with_size_hint(&buf, allocator, filename, size_hint));
ASSERT_SUCCESS(s_check_byte_buf_from_file(&buf, contents));
aws_byte_buf_clean_up(&buf);
/* size_hint 1 */
size_hint = 1;
ASSERT_SUCCESS(aws_byte_buf_init_from_file_with_size_hint(&buf, allocator, filename, size_hint));
ASSERT_SUCCESS(s_check_byte_buf_from_file(&buf, contents));
aws_byte_buf_clean_up(&buf);
remove(filename);
return AWS_OP_SUCCESS;
}
/* Read an actual "special file" (if it exists on this machine) */
static int s_read_special_file(struct aws_allocator *allocator, const char *filename) {
struct aws_string *filename_str = aws_string_new_from_c_str(allocator, filename);
bool exists = aws_path_exists(filename_str);
aws_string_destroy(filename_str);
if (!exists) {
return AWS_OP_SUCCESS;
}
struct aws_byte_buf buf;
ASSERT_SUCCESS(aws_byte_buf_init_from_file(&buf, allocator, filename));
ASSERT_TRUE(buf.capacity > buf.len, "Buffer should end with null-terminator");
ASSERT_UINT_EQUALS(0, buf.buffer[buf.len], "Buffer should end with null-terminator");
if (strcmp("/dev/null", filename) == 0) {
ASSERT_UINT_EQUALS(0, buf.len, "expected /dev/null to be empty");
} else {
ASSERT_TRUE(buf.len > 0, "expected special file to have data");
}
aws_byte_buf_clean_up(&buf);
return AWS_OP_SUCCESS;
}
static int s_test_byte_buf_init_from_file(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
/* simple text file */
ASSERT_SUCCESS(s_create_file_then_read_it(allocator, aws_byte_cursor_from_c_str("asdf")));
/* empty file */
ASSERT_SUCCESS(s_create_file_then_read_it(allocator, aws_byte_cursor_from_c_str("")));
/* large 3MB+1byte binary file */
struct aws_byte_buf big_rando;
aws_byte_buf_init(&big_rando, allocator, (1024 * 1024 * 3) + 1);
ASSERT_SUCCESS(aws_device_random_buffer(&big_rando));
ASSERT_SUCCESS(s_create_file_then_read_it(allocator, aws_byte_cursor_from_buf(&big_rando)));
aws_byte_buf_clean_up(&big_rando);
/* test some "special files" (if they exist) */
ASSERT_SUCCESS(s_read_special_file(allocator, "/proc/cpuinfo"));
ASSERT_SUCCESS(s_read_special_file(allocator, "/proc/net/tcp"));
ASSERT_SUCCESS(s_read_special_file(allocator, "/sys/devices/virtual/dmi/id/sys_vendor"));
ASSERT_SUCCESS(s_read_special_file(allocator, "/dev/null"));
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(test_byte_buf_init_from_file, s_test_byte_buf_init_from_file)
struct aws_file_path_read_from_offset_tester {
struct aws_allocator *alloc;
struct aws_allocator *aligned_allocator;
size_t page_size;
struct aws_string *file_path;
struct aws_byte_buf content;
size_t file_length;
};
static int s_file_path_read_from_offset_tester_init(
struct aws_file_path_read_from_offset_tester *tester,
struct aws_allocator *allocator,
char *file_path,
size_t file_length) {
tester->alloc = allocator;
tester->page_size = aws_system_info_page_size();
tester->aligned_allocator = aws_explicit_aligned_allocator_new(tester->page_size);
if (!tester->aligned_allocator) {
return AWS_OP_ERR;
}
tester->file_path = aws_string_new_from_c_str(tester->aligned_allocator, file_path);
tester->file_length = file_length;
struct aws_byte_cursor content = aws_byte_cursor_from_c_str("0123456789abcdef");
aws_byte_buf_init_copy_from_cursor(&tester->content, allocator, content);
FILE *file = aws_fopen(file_path, "w+");
ASSERT_NOT_NULL(file);
/* Write to the file, repeating the content until the file length is met */
size_t bytes_written = 0;
while (bytes_written < file_length) {
size_t bytes_to_write = aws_min_size(content.len, file_length - bytes_written);
size_t written = fwrite(content.ptr, 1, bytes_to_write, file);
if (written != bytes_to_write) {
fclose(file);
return AWS_OP_ERR;
}
bytes_written += written;
}
fclose(file);
return AWS_OP_SUCCESS;
}
static void s_file_path_read_from_offset_tester_cleanup(struct aws_file_path_read_from_offset_tester *tester) {
aws_byte_buf_clean_up(&tester->content);
remove(aws_string_c_str(tester->file_path));
aws_string_destroy(tester->file_path);
aws_explicit_aligned_allocator_destroy(tester->aligned_allocator);
}
static int s_test_file_path_read_from_offset_direct_io(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
#if defined(__linux__)
struct aws_file_path_read_from_offset_tester tester;
char file_path[] = "test_file_path_read_from_offset_direct_io.txt";
/* Create a file that's at least 2 pages in size to test offset reading */
size_t page_size = aws_system_info_page_size();
size_t file_size = page_size * 2;
ASSERT_SUCCESS(s_file_path_read_from_offset_tester_init(&tester, allocator, file_path, file_size));
/* Test 1: Read the first page and check the result matches expectation */
struct aws_byte_buf output_buf;
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, tester.aligned_allocator, page_size));
size_t actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset_direct_io(tester.file_path, 0, page_size, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(page_size, actual_read);
ASSERT_UINT_EQUALS(page_size, output_buf.len);
/* Verify the content matches what we expect from the first page */
struct aws_byte_cursor expected_content = aws_byte_cursor_from_c_str("0123456789abcdef");
for (size_t i = 0; i < page_size; i++) {
size_t pattern_index = i % expected_content.len;
ASSERT_UINT_EQUALS(expected_content.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 2: Set offset to the page size, and read the next page */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, tester.aligned_allocator, page_size));
actual_read = 0;
ASSERT_SUCCESS(
aws_file_path_read_from_offset_direct_io(tester.file_path, page_size, page_size, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(page_size, actual_read);
ASSERT_UINT_EQUALS(page_size, output_buf.len);
/* Verify the content matches what we expect from the second page */
for (size_t i = 0; i < page_size; i++) {
size_t file_position = page_size + i;
size_t pattern_index = file_position % expected_content.len;
ASSERT_UINT_EQUALS(expected_content.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 3: Test unaligned offset - should fail with AWS_ERROR_INVALID_ARGUMENT */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, tester.aligned_allocator, page_size));
size_t unaligned_offset = 1; /* Not aligned to page boundary */
ASSERT_FAILS(aws_file_path_read_from_offset_direct_io(
tester.file_path, unaligned_offset, page_size, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(AWS_ERROR_INVALID_ARGUMENT, aws_last_error());
aws_byte_buf_clean_up(&output_buf);
/* Test 4: Test unaligned size - should fail with AWS_ERROR_INVALID_ARGUMENT */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, tester.aligned_allocator, page_size));
size_t unaligned_size = page_size - 1; /* Not aligned to page boundary */
ASSERT_FAILS(
aws_file_path_read_from_offset_direct_io(tester.file_path, 0, unaligned_size, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(AWS_ERROR_INVALID_ARGUMENT, aws_last_error());
aws_byte_buf_clean_up(&output_buf);
/* Cleanup */
s_file_path_read_from_offset_tester_cleanup(&tester);
#else
struct aws_string *file_path =
aws_string_new_from_c_str(allocator, "test_file_path_read_from_offset_direct_io.txt");
ASSERT_FAILS(aws_file_path_read_from_offset_direct_io(file_path, 0, 10, NULL, NULL));
ASSERT_UINT_EQUALS(AWS_ERROR_UNSUPPORTED_OPERATION, aws_last_error());
aws_string_destroy(file_path);
#endif
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(test_file_path_read_from_offset_direct_io, s_test_file_path_read_from_offset_direct_io)
static int s_test_file_path_read_from_offset(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
struct aws_file_path_read_from_offset_tester tester;
char file_path[] = "test_file_path_read_from_offset.txt";
/* Create a test file with known content */
size_t file_size = 1024; /* 1KB file for testing */
ASSERT_SUCCESS(s_file_path_read_from_offset_tester_init(&tester, allocator, file_path, file_size));
/* Test 1: Read from the beginning of the file */
struct aws_byte_buf output_buf;
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, allocator, 100));
size_t actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset(tester.file_path, 0, 100, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(100, actual_read);
ASSERT_UINT_EQUALS(100, output_buf.len);
/* Verify the content matches what we expect from the beginning */
struct aws_byte_cursor expected_content = aws_byte_cursor_from_c_str("0123456789abcdef");
for (size_t i = 0; i < 100; i++) {
size_t pattern_index = i % expected_content.len;
ASSERT_UINT_EQUALS(expected_content.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 2: Read from an offset in the middle of the file */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, allocator, 50));
size_t offset = 200;
actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset(tester.file_path, offset, 50, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(50, actual_read);
ASSERT_UINT_EQUALS(50, output_buf.len);
/* Verify the content matches what we expect from the offset position */
for (size_t i = 0; i < 50; i++) {
size_t file_position = offset + i;
size_t pattern_index = file_position % expected_content.len;
ASSERT_UINT_EQUALS(expected_content.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 3: Read near the end of the file */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, allocator, 100));
offset = file_size - 50; /* Read the last 50 bytes */
actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset(tester.file_path, offset, 100, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(50, actual_read); /* Should only read 50 bytes since that's all that's left */
ASSERT_UINT_EQUALS(50, output_buf.len);
/* Verify the content matches what we expect from near the end */
for (size_t i = 0; i < 50; i++) {
size_t file_position = offset + i;
size_t pattern_index = file_position % expected_content.len;
ASSERT_UINT_EQUALS(expected_content.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 4: Try to read beyond the end of the file */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, allocator, 100));
offset = file_size + 10; /* Beyond the end of the file */
actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset(tester.file_path, offset, 100, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(0, actual_read); /* Should read 0 bytes */
ASSERT_UINT_EQUALS(0, output_buf.len);
aws_byte_buf_clean_up(&output_buf);
/* Test 5: Read with unaligned offset and size (should work fine for regular read) */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, allocator, 37));
offset = 13; /* Arbitrary unaligned offset */
actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset(tester.file_path, offset, 37, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(37, actual_read);
ASSERT_UINT_EQUALS(37, output_buf.len);
/* Verify the content matches what we expect from the unaligned offset */
for (size_t i = 0; i < 37; i++) {
size_t file_position = offset + i;
size_t pattern_index = file_position % expected_content.len;
ASSERT_UINT_EQUALS(expected_content.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 6: Test with zero-length read */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, allocator, 0));
actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset(tester.file_path, 0, 0, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(0, actual_read);
ASSERT_UINT_EQUALS(0, output_buf.len);
aws_byte_buf_clean_up(&output_buf);
/* Cleanup */
s_file_path_read_from_offset_tester_cleanup(&tester);
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(test_file_path_read_from_offset, s_test_file_path_read_from_offset)
static int s_test_file_path_read_from_offset_direct_io_chunking(struct aws_allocator *allocator, void *ctx) {
(void)ctx;
#if defined(__linux__)
struct aws_file_path_read_from_offset_tester tester;
char file_path[] = "test_direct_io_chunking.txt";
/* Instead of creating a 2GiB file to test, we use the separate API that allows us to pass in the chunk size. */
size_t chunk_size = 8192;
size_t page_size = aws_system_info_page_size();
size_t file_size = chunk_size * 2 + page_size; /* Ensure it's larger than chunk size */
ASSERT_SUCCESS(s_file_path_read_from_offset_tester_init(&tester, allocator, file_path, file_size));
/* Test 1: Read exactly chunk_size bytes - should not trigger chunking */
struct aws_byte_buf output_buf;
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, tester.aligned_allocator, chunk_size));
size_t actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset_direct_io_with_chunk_size(
tester.file_path, 0, chunk_size, chunk_size, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(chunk_size, actual_read);
ASSERT_UINT_EQUALS(chunk_size, output_buf.len);
/* Verify the content matches our expected pattern */
struct aws_byte_cursor expected_pattern = aws_byte_cursor_from_c_str("0123456789abcdef");
for (size_t i = 0; i < chunk_size; i++) {
size_t pattern_index = i % expected_pattern.len;
ASSERT_UINT_EQUALS(expected_pattern.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 2: Read more than chunk_size bytes - should trigger chunking */
size_t large_read_size = chunk_size + page_size; /* Ensure it's page-aligned */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, tester.aligned_allocator, large_read_size));
actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset_direct_io_with_chunk_size(
tester.file_path, 0, large_read_size, chunk_size, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(large_read_size, actual_read);
ASSERT_UINT_EQUALS(large_read_size, output_buf.len);
/* Verify the content matches our expected pattern across the entire read */
for (size_t i = 0; i < large_read_size; i++) {
size_t pattern_index = i % expected_pattern.len;
ASSERT_UINT_EQUALS(expected_pattern.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Test 3: Read much more than chunk_size - multiple chunks */
size_t very_large_read_size = file_size; /* Ensure it's page-aligned */
ASSERT_SUCCESS(aws_byte_buf_init(&output_buf, tester.aligned_allocator, very_large_read_size));
actual_read = 0;
ASSERT_SUCCESS(aws_file_path_read_from_offset_direct_io_with_chunk_size(
tester.file_path, 0, very_large_read_size, chunk_size, &output_buf, &actual_read));
ASSERT_UINT_EQUALS(very_large_read_size, actual_read);
ASSERT_UINT_EQUALS(very_large_read_size, output_buf.len);
/* Verify the content matches our expected pattern across the entire read */
for (size_t i = 0; i < very_large_read_size; i++) {
size_t pattern_index = i % expected_pattern.len;
ASSERT_UINT_EQUALS(expected_pattern.ptr[pattern_index], output_buf.buffer[i]);
}
aws_byte_buf_clean_up(&output_buf);
/* Cleanup */
s_file_path_read_from_offset_tester_cleanup(&tester);
#else
/* On non-Linux platforms, the function should return AWS_ERROR_UNSUPPORTED_OPERATION */
struct aws_string *file_path = aws_string_new_from_c_str(allocator, "test_direct_io_chunking.txt");
struct aws_byte_buf dummy_buf;
aws_byte_buf_init(&dummy_buf, allocator, 1024);
size_t dummy_read = 0;
ASSERT_FAILS(aws_file_path_read_from_offset_direct_io(file_path, 0, 1024, &dummy_buf, &dummy_read));
ASSERT_UINT_EQUALS(AWS_ERROR_UNSUPPORTED_OPERATION, aws_last_error());
aws_byte_buf_clean_up(&dummy_buf);
aws_string_destroy(file_path);
#endif
return AWS_OP_SUCCESS;
}
AWS_TEST_CASE(test_file_path_read_from_offset_direct_io_chunking, s_test_file_path_read_from_offset_direct_io_chunking)
|