fix parsing of CommonPrefixes in GetBucketRequest()

Author: DenverM80

src/ds3.c

@@ -13235,6 +13235,7 @@ static ds3_error* _parse_top_level_ds3_list_bucket_result_response(const ds3_cli
     ds3_list_bucket_result_response* response;
     ds3_error* error = NULL;
     GPtrArray* objects_array = g_ptr_array_new();
+    GPtrArray* common_prefixes_array = g_ptr_array_new();
 
     error = _get_request_xml_nodes(xml_blob, &doc, &root, "ListBucketResult");
     if (error != NULL) {
@@ -13246,15 +13247,11 @@ static ds3_error* _parse_top_level_ds3_list_bucket_result_response(const ds3_cli
     for (child_node = root->xmlChildrenNode; child_node != NULL; child_node = child_node->next) {
         if (element_equal(child_node, "CommonPrefixes")) {
             xmlNodePtr loop_node;
-            GPtrArray* common_prefixes_array = g_ptr_array_new();
             int num_nodes = 0;
             for (loop_node = child_node->xmlChildrenNode; loop_node != NULL; loop_node = loop_node->next, num_nodes++) {
                 ds3_str* common_prefixes = xml_get_string(doc, loop_node);
                 g_ptr_array_add(common_prefixes_array, common_prefixes);
             }
-            response->common_prefixes = (ds3_str**)common_prefixes_array->pdata;
-            response->num_common_prefixes = common_prefixes_array->len;
-            g_ptr_array_free(common_prefixes_array, FALSE);
         } else if (element_equal(child_node, "CreationDate")) {
             response->creation_date = xml_get_string(doc, child_node);
         } else if (element_equal(child_node, "Delimiter")) {
@@ -13290,6 +13287,10 @@ static ds3_error* _parse_top_level_ds3_list_bucket_result_response(const ds3_cli
     response->num_objects = objects_array->len;
     g_ptr_array_free(objects_array, FALSE);
 
+    response->common_prefixes = (ds3_str**)common_prefixes_array->pdata;
+    response->num_common_prefixes = common_prefixes_array->len;
+    g_ptr_array_free(common_prefixes_array, FALSE);
+
     xmlFreeDoc(doc);
 
     if (error == NULL) {

test/bucket_tests.cpp

@@ -111,6 +111,44 @@ BOOST_AUTO_TEST_CASE( delimiter ) {
     free_client(client);
 }
 
+BOOST_AUTO_TEST_CASE( common_prefixes ) {
+    printf("-----Testing CommonPrefixes-------\n");
+
+    ds3_request* request;
+    ds3_error* error;
+    ds3_list_bucket_result_response* response;
+    ds3_client* client = get_client();
+    const char* bucket_name = "test_common_prefixes_bucket";
+    ds3_bool found_resources = False;
+    ds3_bool found_resources_2 = False;
+    size_t common_prefix_index;
+
+    populate_with_multi_dir_objects(client, bucket_name);
+
+    request = ds3_init_get_bucket_request(bucket_name);
+    ds3_request_set_delimiter(request, "/");
+    ds3_request_set_prefix(request, "resources");
+    error = ds3_get_bucket_request(client, request, &response);
+    ds3_request_free(request);
+    handle_error(error);
+
+    BOOST_CHECK_EQUAL(response->num_objects, 0);
+    BOOST_CHECK_EQUAL(response->num_common_prefixes, 2);
+    for(common_prefix_index = 0; common_prefix_index < response->num_common_prefixes; common_prefix_index++) {
+        if(strcmp(response->common_prefixes[common_prefix_index]->value, "resources/") == 0) {
+            found_resources = True;
+        } else if (strcmp(response->common_prefixes[common_prefix_index]->value, "resources_2/") == 0) {
+            found_resources_2 = True;
+        }
+    }
+    BOOST_CHECK_EQUAL(found_resources, True);
+    BOOST_CHECK_EQUAL(found_resources_2, True);
+
+    ds3_list_bucket_result_response_free(response);
+    clear_bucket(client, bucket_name);
+    free_client(client);
+}
+
 BOOST_AUTO_TEST_CASE(marker) {
     printf("-----Testing Marker-------\n");
 

test/resources_2/bar.txt

@@ -0,0 +1 @@
+This is bar.

test/resources_2/foo.txt

@@ -0,0 +1 @@
+This is foo.

test/test.cpp

@@ -200,11 +200,27 @@ void populate_with_objects(const ds3_client* client, const char* bucket_name) {
     ds3_str_free(job_id);
 }
 
+void populate_with_multi_dir_objects(const ds3_client* client, const char* bucket_name) {
+    ds3_str* job_id = populate_with_object_list_return_job(client, bucket_name, multi_dirs_object_list());
+    ds3_str_free(job_id);
+}
+
 ds3_bulk_object_list_response* default_object_list() {
     const char* books[5] = {"resources/beowulf.txt", "resources/sherlock_holmes.txt", "resources/tale_of_two_cities.txt", "resources/ulysses.txt", "resources/ulysses_large.txt"};
     return ds3_convert_file_list(books, 5);
 }
 
+ds3_bulk_object_list_response* multi_dirs_object_list() {
+    const char* books[6] = {
+      "resources/beowulf.txt",
+      "resources/sherlock_holmes.txt",
+      "resources/tale_of_two_cities.txt",
+      "resources/ulysses.txt",
+      "resources_2/foo.txt",
+      "resources_2/bar.txt"};
+    return ds3_convert_file_list(books, 6);
+}
+
 ds3_request* populate_bulk_return_request(const ds3_client* client, const char* bucket_name, ds3_bulk_object_list_response* obj_list) {
     ds3_error* error = create_bucket_with_data_policy(client, bucket_name, ids.data_policy_id->value);
     ds3_error_free(error);
@@ -289,19 +305,23 @@ void populate_with_objects_from_bulk(const ds3_client* client, const char* bucke
     ds3_master_object_list_response_free(chunk_response);
 }
 
-ds3_str* populate_with_objects_return_job(const ds3_client* client, const char* bucket_name) {
-    ds3_bulk_object_list_response* bulk_object_list_response = default_object_list();
-    ds3_request* request = populate_bulk_return_request(client, bucket_name, bulk_object_list_response);
+ds3_str* populate_with_object_list_return_job( const ds3_client* client,
+                                               const char* bucket_name,
+                                               ds3_bulk_object_list_response* object_list) {
+    ds3_request* request = populate_bulk_return_request(client, bucket_name, object_list);
     ds3_master_object_list_response* master_object_list_response = populate_bulk_return_response(client, request);
 
     ds3_str* job_id = ds3_str_dup(master_object_list_response->job_id);
     populate_with_objects_from_bulk(client, bucket_name, master_object_list_response);
 
-    ds3_bulk_object_list_response_free(bulk_object_list_response);
     ds3_master_object_list_response_free(master_object_list_response);
     return job_id;
 }
 
+ds3_str* populate_with_objects_return_job(const ds3_client* client, const char* bucket_name) {
+    return populate_with_object_list_return_job(client, bucket_name, default_object_list());
+}
+
 bool contains_object(ds3_list_bucket_result_response* bucket_list, const char* key) {
     uint64_t object_index;
     for (object_index = 0; object_index < bucket_list->num_objects; object_index++) {

test/test.h

@@ -25,6 +25,10 @@ void teardown_after_tests();
 void clear_bucket(const ds3_client* client, const char* bucket_name);
 
 void populate_with_objects(const ds3_client* client, const char* bucket_name);
+void populate_with_multi_dir_objects(const ds3_client* client, const char* bucket_name);
+ds3_str* populate_with_object_list_return_job( const ds3_client* client,
+                                               const char* bucket_name,
+                                               ds3_bulk_object_list_response* object_list);
 ds3_str* populate_with_objects_return_job(const ds3_client* client, const char* bucket_name);
 ds3_str* populate_with_empty_objects(const ds3_client* client, const char* bucket_name);
 
@@ -41,6 +45,7 @@ void handle_error(ds3_error* error);
 void free_client(ds3_client* client);
 
 ds3_bulk_object_list_response* default_object_list();
+ds3_bulk_object_list_response* multi_dirs_object_list();
 
 ds3_error* create_bucket_with_data_policy(const ds3_client* client, const char* bucket_id, const char* data_policy_id);