Fix a bug in strncpy and add some tests that verify the behavior

embrace-io · Dec 28, 2024 · d18c9a1 · d18c9a1
1 parent e537269
commit d18c9a1
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 6 deletions.
diff --git a/embrace-android-sdk/src/main/cpp/utils/string_utils.c b/embrace-android-sdk/src/main/cpp/utils/string_utils.c
@@ -1,14 +1,20 @@
 #include "string_utils.h"
 #include "../schema/stack_frames.h"
 
-void emb_strncpy(char *dst, const char *src, size_t len) {
-    if (dst == NULL || src == NULL) {
+/**
+ * Copy a string from source to destination. If the source is larger than the destination, it will be truncated.
+ * @param destination The destination buffer.
+ * @param source The source buffer.
+ * @param destination_len The length of the destination buffer.
+ */
+void emb_strncpy(char *destination, const char *source, size_t destination_len) {
+    if (destination == NULL || source == NULL) {
         return;
     }
     int i = 0;
-    while (i <= len) {
-        char current = src[i];
-        dst[i] = current;
+    while (i < destination_len && source[i] != '\0') {
+        char current = source[i];
+        destination[i] = current;
         if (current == '\0') {
             break;
         }

diff --git a/embrace-android-sdk/src/main/cpp/utils/string_utils.h b/embrace-android-sdk/src/main/cpp/utils/string_utils.h
@@ -5,7 +5,7 @@
 extern "C" {
 #endif
 
-void emb_strncpy(char *dst, const char *src, size_t len);
+void emb_strncpy(char *destination, const char *source, size_t destination_len);
 void emb_convert_to_hex_addr(uint64_t addr, char *buffer);
 
 #ifdef __cplusplus

diff --git a/embrace-android-sdk/src/test/cpp/testcases/utilities/test_string_utils.c b/embrace-android-sdk/src/test/cpp/testcases/utilities/test_string_utils.c
@@ -29,9 +29,27 @@ TEST convert_to_hex(void) {
     PASS();
 }
 
+TEST test_string_copy_larger_source(void) {
+    char dst[2];
+    char src[] = "123456";
+    emb_strncpy(dst, src, sizeof(dst));
+    ASSERT_STR_EQ("12", dst);
+    PASS();
+}
+
+TEST test_string_copy_larger_destination(void) {
+    char dst[6] = {0};
+    char src[] = "12";
+    emb_strncpy(dst, src, sizeof(dst));
+    ASSERT_STR_EQ("12", dst);
+    PASS();
+}
+
 SUITE(suite_utilities) {
     RUN_TEST(string_copy_success);
     RUN_TEST(string_null_src);
     RUN_TEST(string_null_dst);
     RUN_TEST(convert_to_hex);
+    RUN_TEST(test_string_copy_larger_source);
+    RUN_TEST(test_string_copy_larger_destination);
 }