Skip to content

HDDS-12916. Support ETag in listObjects response #8356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adoroszlai merged 4 commits into from
May 3, 2025
Merged

HDDS-12916. Support ETag in listObjects response #8356

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82e2ad4
HDDS-12916. Support ETag in listObjects response
ivandika3 Apr 29, 2025
c62da7d
Extract listObjects test
ivandika3 May 3, 2025
4061bb8
Add tests for SDK V2
ivandika3 May 3, 2025
251fbfb
Use Cluster#newClient and fix null in bucket and key names suffix
ivandika3 May 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/rpc/RpcClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_CLIENT_REQUIRED_OM_VERSION_MIN_KEY;
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_CLIENT_SERVER_DEFAULTS_VALIDITY_PERIOD_MS;
import static org.apache.hadoop.ozone.OzoneConfigKeys.OZONE_CLIENT_SERVER_DEFAULTS_VALIDITY_PERIOD_MS_DEFAULT;
import static org.apache.hadoop.ozone.OzoneConsts.ETAG;
import static org.apache.hadoop.ozone.OzoneConsts.MAXIMUM_NUMBER_OF_PARTS_PER_UPLOAD;
import static org.apache.hadoop.ozone.OzoneConsts.OLD_QUOTA_DEFAULT;
import static org.apache.hadoop.ozone.OzoneConsts.OZONE_MAXIMUM_ACCESS_ID_LENGTH;
Expand Down Expand Up @@ -1722,8 +1723,10 @@ public List<OzoneKey> listKeys(String volumeName, String bucketName,
key.getCreationTime(),
key.getModificationTime(),
key.getReplicationConfig(),
Collections.singletonMap(ETAG, key.getETag()),
key.isFile(),
key.getOwnerName()))
key.getOwnerName(),
Collections.emptyMap()))
.collect(Collectors.toList());
} else {
List<OmKeyInfo> keys = ozoneManagerClient.listKeys(
Expand All @@ -1735,8 +1738,10 @@ public List<OzoneKey> listKeys(String volumeName, String bucketName,
key.getCreationTime(),
key.getModificationTime(),
key.getReplicationConfig(),
key.getMetadata(),
key.isFile(),
key.getOwnerName()))
key.getOwnerName(),
key.getTags()))
.collect(Collectors.toList());
}
}
Expand Down
143 changes: 85 additions & 58 deletions ...tion-test-s3/src/test/java/org/apache/hadoop/ozone/s3/awssdk/v1/AbstractS3SDKV1Tests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,81 +532,108 @@ public void testGetObjectWithoutETag() throws Exception {
}

@Test
public void testListObjectsMany() {
final String bucketName = getBucketName();
s3Client.createBucket(bucketName);
final List<String> keyNames = Arrays.asList(
getKeyName("1"),
getKeyName("2"),
getKeyName("3")
);

for (String keyName: keyNames) {
s3Client.putObject(bucketName, keyName, RandomStringUtils.secure().nextAlphanumeric(5));
}

ListObjectsRequest listObjectsRequest = new ListObjectsRequest()
.withBucketName(bucketName)
.withMaxKeys(2);
ObjectListing listObjectsResponse = s3Client.listObjects(listObjectsRequest);
assertThat(listObjectsResponse.getObjectSummaries()).hasSize(2);
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertEquals(listObjectsResponse.getObjectSummaries().stream()
.map(S3ObjectSummary::getKey).collect(Collectors.toList()),
keyNames.subList(0, 2));
assertTrue(listObjectsResponse.isTruncated());


listObjectsRequest = new ListObjectsRequest()
.withBucketName(bucketName)
.withMaxKeys(2)
.withMarker(listObjectsResponse.getNextMarker());
listObjectsResponse = s3Client.listObjects(listObjectsRequest);
assertThat(listObjectsResponse.getObjectSummaries()).hasSize(1);
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertEquals(listObjectsResponse.getObjectSummaries().stream()
.map(S3ObjectSummary::getKey).collect(Collectors.toList()),
keyNames.subList(2, keyNames.size()));
assertFalse(listObjectsResponse.isTruncated());
public void testListObjectsMany() throws Exception {
testListObjectsMany(false);
}

@Test
public void testListObjectsManyV2() {
public void testListObjectsManyV2() throws Exception {
testListObjectsMany(true);
}

private void testListObjectsMany(boolean isListV2) throws Exception {
final String bucketName = getBucketName();
s3Client.createBucket(bucketName);
final List<String> keyNames = Arrays.asList(
getKeyName("1"),
getKeyName("2"),
getKeyName("3")
);
final List<String> keyNamesWithoutETag = Arrays.asList(
getKeyName("4"),
getKeyName("5")
);

final Map<String, String> keyToEtag = new HashMap<>();
for (String keyName: keyNames) {
s3Client.putObject(bucketName, keyName, RandomStringUtils.secure().nextAlphanumeric(5));
PutObjectResult putObjectResult = s3Client.putObject(bucketName, keyName,
RandomStringUtils.secure().nextAlphanumeric(5));
keyToEtag.put(keyName, putObjectResult.getETag());
}
try (OzoneClient ozoneClient = OzoneClientFactory.getRpcClient(cluster.getConf())) {
ObjectStore store = ozoneClient.getObjectStore();

ListObjectsV2Request listObjectsRequest = new ListObjectsV2Request()
.withBucketName(bucketName)
.withMaxKeys(2);
ListObjectsV2Result listObjectsResponse = s3Client.listObjectsV2(listObjectsRequest);
assertThat(listObjectsResponse.getObjectSummaries()).hasSize(2);
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertEquals(listObjectsResponse.getObjectSummaries().stream()
OzoneVolume volume = store.getS3Volume();
OzoneBucket bucket = volume.getBucket(bucketName);

for (String keyNameWithoutETag : keyNamesWithoutETag) {
byte[] valueBytes = RandomStringUtils.secure().nextAlphanumeric(5).getBytes(StandardCharsets.UTF_8);
try (OzoneOutputStream out = bucket.createKey(keyNameWithoutETag,
valueBytes.length,
ReplicationConfig.fromTypeAndFactor(ReplicationType.RATIS, ReplicationFactor.ONE),
Collections.emptyMap())) {
out.write(valueBytes);
}
}
}

List<S3ObjectSummary> objectSummaries;
String continuationToken;
if (isListV2) {
ListObjectsV2Request listObjectsRequest = new ListObjectsV2Request()
.withBucketName(bucketName)
.withMaxKeys(2);
ListObjectsV2Result listObjectsResponse = s3Client.listObjectsV2(listObjectsRequest);
objectSummaries = listObjectsResponse.getObjectSummaries();
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertTrue(listObjectsResponse.isTruncated());
continuationToken = listObjectsResponse.getNextContinuationToken();
} else {
ListObjectsRequest listObjectsRequest = new ListObjectsRequest()
.withBucketName(bucketName)
.withMaxKeys(2);
ObjectListing listObjectsResponse = s3Client.listObjects(listObjectsRequest);
objectSummaries = listObjectsResponse.getObjectSummaries();
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertTrue(listObjectsResponse.isTruncated());
continuationToken = listObjectsResponse.getNextMarker();
}
assertThat(objectSummaries).hasSize(2);
assertEquals(objectSummaries.stream()
.map(S3ObjectSummary::getKey).collect(Collectors.toList()),
keyNames.subList(0, 2));
assertTrue(listObjectsResponse.isTruncated());
for (S3ObjectSummary objectSummary : objectSummaries) {
assertEquals(keyToEtag.get(objectSummary.getKey()), objectSummary.getETag());
}

// Include both keys with and without ETag
if (isListV2) {
ListObjectsV2Request listObjectsRequest = new ListObjectsV2Request()
.withBucketName(bucketName)
.withMaxKeys(5)
.withContinuationToken(continuationToken);
ListObjectsV2Result listObjectsResponse = s3Client.listObjectsV2(listObjectsRequest);
objectSummaries = listObjectsResponse.getObjectSummaries();
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertFalse(listObjectsResponse.isTruncated());
} else {
ListObjectsRequest listObjectsRequest = new ListObjectsRequest()
.withBucketName(bucketName)
.withMaxKeys(5)
.withMarker(continuationToken);
ObjectListing listObjectsResponse = s3Client.listObjects(listObjectsRequest);
objectSummaries = listObjectsResponse.getObjectSummaries();
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertFalse(listObjectsResponse.isTruncated());
}

listObjectsRequest = new ListObjectsV2Request()
.withBucketName(bucketName)
.withMaxKeys(2)
.withContinuationToken(listObjectsResponse.getNextContinuationToken());
listObjectsResponse = s3Client.listObjectsV2(listObjectsRequest);
assertThat(listObjectsResponse.getObjectSummaries()).hasSize(1);
assertEquals(bucketName, listObjectsResponse.getBucketName());
assertEquals(listObjectsResponse.getObjectSummaries().stream()
.map(S3ObjectSummary::getKey).collect(Collectors.toList()),
keyNames.subList(2, keyNames.size()));
assertFalse(listObjectsResponse.isTruncated());
assertThat(objectSummaries).hasSize(3);
assertEquals(keyNames.get(2), objectSummaries.get(0).getKey());
assertEquals(keyNamesWithoutETag.get(0), objectSummaries.get(1).getKey());
assertEquals(keyNamesWithoutETag.get(1), objectSummaries.get(2).getKey());
for (S3ObjectSummary objectSummary : objectSummaries) {
assertEquals(keyToEtag.get(objectSummary.getKey()), objectSummary.getETag());
}
}

@Test
Expand Down Expand Up @@ -961,7 +988,7 @@ private boolean isBucketEmpty(Bucket bucket) {
}

private String getBucketName() {
return getBucketName(null);
return getBucketName("");
}

private String getBucketName(String suffix) {
Expand Down
130 changes: 130 additions & 0 deletions ...tion-test-s3/src/test/java/org/apache/hadoop/ozone/s3/awssdk/v2/AbstractS3SDKV2Tests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,40 @@
import static org.apache.hadoop.ozone.OzoneConsts.MB;
import static org.apache.hadoop.ozone.s3.awssdk.S3SDKTestUtils.calculateDigest;
import static org.apache.hadoop.ozone.s3.awssdk.S3SDKTestUtils.createFile;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.RandomAccessFile;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.stream.Collectors;
import javax.xml.bind.DatatypeConverter;
import org.apache.commons.lang3.RandomStringUtils;
import org.apache.hadoop.hdds.client.ReplicationConfig;
import org.apache.hadoop.hdds.client.ReplicationFactor;
import org.apache.hadoop.hdds.client.ReplicationType;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.ozone.MiniOzoneCluster;
import org.apache.hadoop.ozone.client.ObjectStore;
import org.apache.hadoop.ozone.client.OzoneBucket;
import org.apache.hadoop.ozone.client.OzoneClient;
import org.apache.hadoop.ozone.client.OzoneClientFactory;
import org.apache.hadoop.ozone.client.OzoneVolume;
import org.apache.hadoop.ozone.client.io.OzoneOutputStream;
import org.apache.hadoop.ozone.s3.S3ClientFactory;
import org.apache.hadoop.ozone.s3.S3GatewayService;
import org.apache.ozone.test.OzoneTestBase;
Expand All @@ -57,7 +72,12 @@
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.GetObjectResponse;
import software.amazon.awssdk.services.s3.model.HeadObjectResponse;
import software.amazon.awssdk.services.s3.model.ListObjectsRequest;
import software.amazon.awssdk.services.s3.model.ListObjectsResponse;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Response;
import software.amazon.awssdk.services.s3.model.PutObjectResponse;
import software.amazon.awssdk.services.s3.model.S3Object;
import software.amazon.awssdk.services.s3.model.Tag;
import software.amazon.awssdk.services.s3.model.Tagging;
import software.amazon.awssdk.services.s3.model.UploadPartRequest;
Expand Down Expand Up @@ -133,6 +153,116 @@ public void testPutObject() {
assertEquals("\"37b51d194a7513e45b56f6524f2d51f2\"", getObjectResponse.eTag());
}

@Test
public void testListObjectsMany() throws Exception {
testListObjectsMany(false);
}

@Test
public void testListObjectsManyV2() throws Exception {
testListObjectsMany(true);
}

private void testListObjectsMany(boolean isListV2) throws Exception {
final String bucketName = getBucketName();
s3Client.createBucket(b -> b.bucket(bucketName));
final List<String> keyNames = Arrays.asList(
getKeyName("1"),
getKeyName("2"),
getKeyName("3")
);
final List<String> keyNamesWithoutETag = Arrays.asList(
getKeyName("4"),
getKeyName("5")
);
final Map<String, String> keyToEtag = new HashMap<>();
for (String keyName: keyNames) {
PutObjectResponse putObjectResponse = s3Client.putObject(b -> b
.bucket(bucketName)
.key(keyName),
RequestBody.fromString(RandomStringUtils.secure().nextAlphanumeric(5)));
keyToEtag.put(keyName, putObjectResponse.eTag());
}
try (OzoneClient ozoneClient = OzoneClientFactory.getRpcClient(cluster.getConf())) {
ObjectStore store = ozoneClient.getObjectStore();

OzoneVolume volume = store.getS3Volume();
OzoneBucket bucket = volume.getBucket(bucketName);

for (String keyNameWithoutETag : keyNamesWithoutETag) {
byte[] valueBytes = RandomStringUtils.secure().nextAlphanumeric(5).getBytes(StandardCharsets.UTF_8);
try (OzoneOutputStream out = bucket.createKey(keyNameWithoutETag,
valueBytes.length,
ReplicationConfig.fromTypeAndFactor(ReplicationType.RATIS, ReplicationFactor.ONE),
Collections.emptyMap())) {
out.write(valueBytes);
}
}
}

List<S3Object> s3Objects;
String continuationToken;
if (isListV2) {
ListObjectsV2Request listObjectsRequest = ListObjectsV2Request.builder()
.bucket(bucketName)
.maxKeys(2)
.build();
ListObjectsV2Response listObjectsResponse = s3Client.listObjectsV2(listObjectsRequest);
s3Objects = listObjectsResponse.contents();
assertEquals(bucketName, listObjectsResponse.name());
assertTrue(listObjectsResponse.isTruncated());
continuationToken = listObjectsResponse.nextContinuationToken();
} else {
ListObjectsRequest listObjectsRequest = ListObjectsRequest.builder()
.bucket(bucketName)
.maxKeys(2)
.build();
ListObjectsResponse listObjectsResponse = s3Client.listObjects(listObjectsRequest);
s3Objects = listObjectsResponse.contents();
assertEquals(bucketName, listObjectsResponse.name());
assertTrue(listObjectsResponse.isTruncated());
continuationToken = listObjectsResponse.nextMarker();
}
assertThat(s3Objects).hasSize(2);
assertEquals(s3Objects.stream()
.map(S3Object::key).collect(Collectors.toList()),
keyNames.subList(0, 2));
for (S3Object s3Object : s3Objects) {
assertEquals(keyToEtag.get(s3Object.key()), s3Object.eTag());
}

// Include both keys with and without ETag
if (isListV2) {
ListObjectsV2Request listObjectsRequest = ListObjectsV2Request.builder()
.bucket(bucketName)
.maxKeys(5)
.continuationToken(continuationToken)
.build();
ListObjectsV2Response listObjectsResponse = s3Client.listObjectsV2(listObjectsRequest);
s3Objects = listObjectsResponse.contents();
assertEquals(bucketName, listObjectsResponse.name());
assertFalse(listObjectsResponse.isTruncated());
} else {
ListObjectsRequest listObjectsRequest = ListObjectsRequest.builder()
.bucket(bucketName)
.maxKeys(5)
.marker(continuationToken)
.build();
ListObjectsResponse listObjectsResponse = s3Client.listObjects(listObjectsRequest);
s3Objects = listObjectsResponse.contents();
assertEquals(bucketName, listObjectsResponse.name());
assertFalse(listObjectsResponse.isTruncated());
}

assertThat(s3Objects).hasSize(3);
assertEquals(keyNames.get(2), s3Objects.get(0).key());
assertEquals(keyNamesWithoutETag.get(0), s3Objects.get(1).key());
assertEquals(keyNamesWithoutETag.get(1), s3Objects.get(2).key());
for (S3Object s3Object : s3Objects) {
assertEquals(keyToEtag.get(s3Object.key()), s3Object.eTag());
}
}

@Test
public void testCopyObject() {
final String sourceBucketName = getBucketName("source");
Expand Down