chore: Adding fixes and tests for ListMultipartUpload

Author: Dhriti Chopra

google-cloud-storage/src/main/java/com/google/cloud/storage/MultipartUploadHttpRequestManager.java

@@ -140,7 +140,7 @@ ListMultipartUploadsResponse sendListMultipartUploadsRequest(
     String listUri =
         UriTemplate.expand(
             uri.toString() + "{bucket}?uploads{delimiter,encoding-type,key-marker,max-uploads,prefix,upload-id-marker}",
-            params,
+            params.build(),
             false);
     System.out.println(listUri);
     HttpRequest httpRequest = requestFactory.buildGetRequest(new GenericUrl(listUri));

google-cloud-storage/src/main/java/com/google/cloud/storage/multipartupload/model/ListMultipartUploadsResponse.java

@@ -5,7 +5,7 @@
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *       http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,35 +16,69 @@
 
 package com.google.cloud.storage.multipartupload.model;
 
+import com.fasterxml.jackson.annotation.JsonAlias;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 import com.google.api.core.BetaApi;
 import com.google.common.collect.ImmutableList;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Objects;
 
 /**
  * A response from listing all multipart uploads in a bucket.
  *
  * @see <a href="https://cloud.google.com/storage/docs/multipart-uploads#listing-uploads">Listing
- *     multipart uploads</a>
- * @since 2.60.0 This new api is in preview and is subject to breaking changes.
+ * multipart uploads</a>
+ * @since 2.60.1 This new api is in preview and is subject to breaking changes.
  */
 @BetaApi
 public final class ListMultipartUploadsResponse {
 
-  private ImmutableList<MultipartUpload> uploads;
+  @JacksonXmlElementWrapper(useWrapping = false)
+  @JacksonXmlProperty(localName = "Upload")
+  private List<MultipartUpload> uploads;
+
+  @JacksonXmlProperty(localName = "Bucket")
   private String bucket;
+
+  @JacksonXmlProperty(localName = "Delimiter")
   private String delimiter;
+
+  @JacksonXmlProperty(localName = "EncodingType")
   private String encodingType;
+
+  @JacksonXmlProperty(localName = "KeyMarker")
   private String keyMarker;
+
+  @JacksonXmlProperty(localName = "UploadIdMarker")
   private String uploadIdMarker;
+
+  @JacksonXmlProperty(localName = "NextKeyMarker")
   private String nextKeyMarker;
+
+  @JacksonXmlProperty(localName = "NextUploadIdMarker")
   private String nextUploadIdMarker;
+
+  @JacksonXmlProperty(localName = "MaxUploads")
   private int maxUploads;
+
+  @JacksonXmlProperty(localName = "Prefix")
   private String prefix;
+
+  @JsonAlias("truncated")
+  @JacksonXmlProperty(localName = "IsTruncated")
   private boolean isTruncated;
-  private ImmutableList<String> commonPrefixes;
+
+  @JacksonXmlElementWrapper(useWrapping = false)
+  @JacksonXmlProperty(localName = "CommonPrefixes")
+  private List<CommonPrefixHelper> commonPrefixes;
+
+  // Jackson requires a no-arg constructor
+  private ListMultipartUploadsResponse() {}
 
   private ListMultipartUploadsResponse(
-      ImmutableList<MultipartUpload> uploads,
+      List<MultipartUpload> uploads,
       String bucket,
       String delimiter,
       String encodingType,
@@ -55,7 +89,7 @@ private ListMultipartUploadsResponse(
       int maxUploads,
       String prefix,
       boolean isTruncated,
-      ImmutableList<String> commonPrefixes) {
+      List<String> commonPrefixes) {
     this.uploads = uploads;
     this.bucket = bucket;
     this.delimiter = delimiter;
@@ -67,28 +101,21 @@ private ListMultipartUploadsResponse(
     this.maxUploads = maxUploads;
     this.prefix = prefix;
     this.isTruncated = isTruncated;
-    this.commonPrefixes = commonPrefixes;
+    if (commonPrefixes != null) {
+      this.commonPrefixes = new ArrayList<>();
+      for (String p : commonPrefixes) {
+        CommonPrefixHelper h = new CommonPrefixHelper();
+        h.prefix = p;
+        this.commonPrefixes.add(h);
+      }
+    }
   }
 
-  private ListMultipartUploadsResponse() {}
-
-  /**
-   * The list of multipart uploads.
-   *
-   * @return The list of multipart uploads.
-   * @since 2.60.0 This new api is in preview and is subject to breaking changes.
-   */
   @BetaApi
   public ImmutableList<MultipartUpload> getUploads() {
-    return uploads;
+    return uploads == null ? ImmutableList.of() : ImmutableList.copyOf(uploads);
   }
 
-  /**
-   * The bucket that contains the multipart uploads.
-   *
-   * @return The bucket name.
-   * @since 2.60.0 This new api is in preview and is subject to breaking changes.
-   */
   @BetaApi
   public String getBucket() {
     return bucket;
@@ -201,7 +228,12 @@ public boolean isTruncated() {
    */
   @BetaApi
   public ImmutableList<String> getCommonPrefixes() {
-    return commonPrefixes;
+    if (commonPrefixes == null) {
+      return ImmutableList.of();
+    }
+    return commonPrefixes.stream()
+        .map(h -> h.prefix)
+        .collect(ImmutableList.toImmutableList());
   }
 
   @Override
@@ -215,7 +247,7 @@ public boolean equals(Object o) {
     ListMultipartUploadsResponse that = (ListMultipartUploadsResponse) o;
     return isTruncated == that.isTruncated
         && maxUploads == that.maxUploads
-        && Objects.equals(uploads, that.uploads)
+        && Objects.equals(getUploads(), that.getUploads())
         && Objects.equals(bucket, that.bucket)
         && Objects.equals(delimiter, that.delimiter)
         && Objects.equals(encodingType, that.encodingType)
@@ -224,13 +256,13 @@ public boolean equals(Object o) {
         && Objects.equals(nextKeyMarker, that.nextKeyMarker)
         && Objects.equals(nextUploadIdMarker, that.nextUploadIdMarker)
         && Objects.equals(prefix, that.prefix)
-        && Objects.equals(commonPrefixes, that.commonPrefixes);
+        && Objects.equals(getCommonPrefixes(), that.getCommonPrefixes());
   }
 
   @Override
   public int hashCode() {
     return Objects.hash(
-        uploads,
+        getUploads(),
         bucket,
         delimiter,
         encodingType,
@@ -241,13 +273,13 @@ public int hashCode() {
         maxUploads,
         prefix,
         isTruncated,
-        commonPrefixes);
+        getCommonPrefixes());
   }
 
   @Override
   public String toString() {
     return "ListMultipartUploadsResponse{" +
-        "uploads=" + uploads +
+        "uploads=" + getUploads() +
         ", bucket='" + bucket + "'" +
         ", delimiter='" + delimiter + "'" +
         ", encodingType='" + encodingType + "'" +
@@ -258,7 +290,7 @@ public String toString() {
         ", maxUploads=" + maxUploads +
         ", prefix='" + prefix + "'" +
         ", isTruncated=" + isTruncated +
-        ", commonPrefixes=" + commonPrefixes +
+        ", commonPrefixes=" + getCommonPrefixes() +
         '}';
   }
 
@@ -273,11 +305,11 @@ public static Builder builder() {
     return new Builder();
   }
 
-  /**
-   * A builder for {@link ListMultipartUploadsResponse}.
-   *
-   * @since 2.60.0 This new api is in preview and is subject to breaking changes.
-   */
+  public static class CommonPrefixHelper {
+    @JacksonXmlProperty(localName = "Prefix")
+    public String prefix;
+  }
+
   @BetaApi
   public static final class Builder {
     private ImmutableList<MultipartUpload> uploads;

google-cloud-storage/src/main/java/com/google/cloud/storage/multipartupload/model/MultipartUpload.java

@@ -5,7 +5,7 @@
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *       http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -16,6 +16,7 @@
 
 package com.google.cloud.storage.multipartupload.model;
 
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
 import com.google.api.core.BetaApi;
 import com.google.cloud.storage.StorageClass;
 import java.time.OffsetDateTime;
@@ -29,10 +30,19 @@
 @BetaApi
 public final class MultipartUpload {
 
-  private final String key;
-  private final String uploadId;
-  private final StorageClass storageClass;
-  private final OffsetDateTime initiated;
+  @JacksonXmlProperty(localName = "Key")
+  private String key;
+
+  @JacksonXmlProperty(localName = "UploadId")
+  private String uploadId;
+
+  @JacksonXmlProperty(localName = "StorageClass")
+  private StorageClass storageClass;
+
+  @JacksonXmlProperty(localName = "Initiated")
+  private OffsetDateTime initiated;
+
+  private MultipartUpload() {}
 
   private MultipartUpload(
       String key, String uploadId, StorageClass storageClass, OffsetDateTime initiated) {

google-cloud-storage/src/test/java/com/google/cloud/storage/ITMultipartUploadHttpRequestManagerTest.java

@@ -38,8 +38,11 @@
 import com.google.cloud.storage.multipartupload.model.CompletedPart;
 import com.google.cloud.storage.multipartupload.model.CreateMultipartUploadRequest;
 import com.google.cloud.storage.multipartupload.model.CreateMultipartUploadResponse;
+import com.google.cloud.storage.multipartupload.model.ListMultipartUploadsRequest;
+import com.google.cloud.storage.multipartupload.model.ListMultipartUploadsResponse;
 import com.google.cloud.storage.multipartupload.model.ListPartsRequest;
 import com.google.cloud.storage.multipartupload.model.ListPartsResponse;
+import com.google.cloud.storage.multipartupload.model.MultipartUpload;
 import com.google.cloud.storage.multipartupload.model.ObjectLockMode;
 import com.google.cloud.storage.multipartupload.model.Part;
 import com.google.cloud.storage.multipartupload.model.UploadPartRequest;
@@ -840,4 +843,86 @@ public void sendUploadPartRequest_error() throws Exception {
                   endpoint, request, RewindableContent.empty()));
     }
   }
+
+@Test
+public void sendListMultipartUploadsRequest_success() throws Exception {
+  String mockXmlResponse = 
+      "<ListMultipartUploadsResult>" +
+      "  <Bucket>test-bucket</Bucket>" +
+      "  <KeyMarker>key-marker</KeyMarker>" +
+      "  <UploadIdMarker>upload-id-marker</UploadIdMarker>" +
+      "  <NextKeyMarker>next-key-marker</NextKeyMarker>" +
+      "  <NextUploadIdMarker>next-upload-id-marker</NextUploadIdMarker>" +
+      "  <MaxUploads>1</MaxUploads>" +
+      "  <IsTruncated>false</IsTruncated>" +
+      "  <Upload>" +
+      "    <Key>test-key</Key>" +
+      "    <UploadId>test-upload-id</UploadId>" +
+      "    <StorageClass>STANDARD</StorageClass>" +
+      "    <Initiated>2025-11-11T00:00:00Z</Initiated>" +
+      "  </Upload>" +
+      "</ListMultipartUploadsResult>";
+
+  HttpRequestHandler handler =
+      req -> {
+        ByteBuf buf = Unpooled.wrappedBuffer(mockXmlResponse.getBytes(StandardCharsets.UTF_8));
+
+        DefaultFullHttpResponse resp =
+            new DefaultFullHttpResponse(req.protocolVersion(), OK, buf);
+        
+        resp.headers().set("Content-Type", "application/xml; charset=utf-8");
+        resp.headers().set("Content-Length", resp.content().readableBytes());
+        return resp;
+      };
+
+  try (FakeHttpServer fakeHttpServer = FakeHttpServer.of(handler)) {
+    URI endpoint = URI.create(fakeHttpServer.getEndpoint() + "/");
+    
+    ListMultipartUploadsRequest request =
+        ListMultipartUploadsRequest.builder()
+            .bucket("test-bucket")
+            .maxUploads(1)
+            .keyMarker("key-marker")
+            .uploadIdMarker("upload-id-marker")
+            .build();
+
+    ListMultipartUploadsResponse response =
+        multipartUploadHttpRequestManager.sendListMultipartUploadsRequest(endpoint, request);
+
+    assertThat(response).isNotNull();
+    assertThat(response.getBucket()).isEqualTo("test-bucket");
+    assertThat(response.getUploads()).hasSize(1);
+    
+    MultipartUpload upload = response.getUploads().get(0);
+    assertThat(upload.getKey()).isEqualTo("test-key");
+    assertThat(upload.getStorageClass()).isEqualTo(StorageClass.STANDARD);
+    assertThat(upload.getInitiated())
+        .isEqualTo(OffsetDateTime.of(2025, 11, 11, 0, 0, 0, 0, ZoneOffset.UTC));
+  }
+}
+
+ @Test
+ public void sendListMultipartUploadsRequest_error() throws Exception {
+ HttpRequestHandler handler =
+ req -> {
+    FullHttpResponse resp =
+        new DefaultFullHttpResponse(req.protocolVersion(), HttpResponseStatus.BAD_REQUEST);
+    resp.headers().set(CONTENT_TYPE, "text/plain; charset=utf-8");
+    return resp;
+ };
+
+ try (FakeHttpServer fakeHttpServer = FakeHttpServer.of(handler)) {
+    URI endpoint = URI.create(fakeHttpServer.getEndpoint() + "/");
+    ListMultipartUploadsRequest request =
+        ListMultipartUploadsRequest.builder()
+            .bucket("test-bucket")
+            .build();
+
+    assertThrows(
+        HttpResponseException.class,
+        () ->
+            multipartUploadHttpRequestManager.sendListMultipartUploadsRequest(
+                endpoint, request));
+ }
+ }
 }