Skip to content

HDDS-10325. Make BucketArgs immutable #6205

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 1 commit into from
Feb 12, 2024
Merged

HDDS-10325. Make BucketArgs immutable #6205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
94 changes: 40 additions & 54 deletions hadoop-ozone/client/src/main/java/org/apache/hadoop/ozone/client/BucketArgs.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,15 @@

package org.apache.hadoop.ozone.client;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import org.apache.hadoop.hdds.client.DefaultReplicationConfig;
import org.apache.hadoop.hdds.protocol.StorageType;
import org.apache.hadoop.ozone.OzoneAcl;
import org.apache.hadoop.ozone.OzoneConsts;
import org.apache.hadoop.ozone.om.helpers.BucketLayout;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
Expand All @@ -37,80 +40,60 @@ public final class BucketArgs {
/**
* ACL Information.
*/
private List<OzoneAcl> acls;
private final ImmutableList<OzoneAcl> acls;
/**
* Bucket Version flag.
*/
private Boolean versioning;
private final boolean versioning;
/**
* Type of storage to be used for this bucket.
* [RAM_DISK, SSD, DISK, ARCHIVE]
*/
private StorageType storageType;
private final StorageType storageType;

/**
* Custom key/value metadata.
*/
private Map<String, String> metadata;
private final Map<String, String> metadata;

/**
* Bucket encryption key name.
*/
private String bucketEncryptionKey;
private DefaultReplicationConfig defaultReplicationConfig;
private final String bucketEncryptionKey;
private final DefaultReplicationConfig defaultReplicationConfig;
private final String sourceVolume;
private final String sourceBucket;

private long quotaInBytes;
private long quotaInNamespace;
private final long quotaInBytes;
private final long quotaInNamespace;

private String owner;
private final String owner;

/**
* Bucket Layout.
*/
private BucketLayout bucketLayout = BucketLayout.DEFAULT;

/**
* Private constructor, constructed via builder.
* @param versioning Bucket version flag.
* @param storageType Storage type to be used.
* @param acls list of ACLs.
* @param metadata map of bucket metadata
* @param bucketEncryptionKey bucket encryption key name
* @param sourceVolume
* @param sourceBucket
* @param quotaInBytes Bucket quota in bytes.
* @param quotaInNamespace Bucket quota in counts.
* @param bucketLayout bucket layout.
* @param owner owner of the bucket.
* @param defaultReplicationConfig default replication config.
*/
@SuppressWarnings("parameternumber")
private BucketArgs(Boolean versioning, StorageType storageType,
List<OzoneAcl> acls, Map<String, String> metadata,
String bucketEncryptionKey, String sourceVolume, String sourceBucket,
long quotaInBytes, long quotaInNamespace, BucketLayout bucketLayout,
String owner, DefaultReplicationConfig defaultReplicationConfig) {
this.acls = acls;
this.versioning = versioning;
this.storageType = storageType;
this.metadata = metadata;
this.bucketEncryptionKey = bucketEncryptionKey;
this.sourceVolume = sourceVolume;
this.sourceBucket = sourceBucket;
this.quotaInBytes = quotaInBytes;
this.quotaInNamespace = quotaInNamespace;
this.bucketLayout = bucketLayout;
this.owner = owner;
this.defaultReplicationConfig = defaultReplicationConfig;
private final BucketLayout bucketLayout;

private BucketArgs(Builder b) {
acls = b.acls == null ? ImmutableList.of() : ImmutableList.copyOf(b.acls);
versioning = b.versioning;
storageType = b.storageType;
metadata = b.metadata == null ? ImmutableMap.of() : ImmutableMap.copyOf(b.metadata);
bucketEncryptionKey = b.bucketEncryptionKey;
sourceVolume = b.sourceVolume;
sourceBucket = b.sourceBucket;
quotaInBytes = b.quotaInBytes;
quotaInNamespace = b.quotaInNamespace;
bucketLayout = b.bucketLayout;
owner = b.owner;
defaultReplicationConfig = b.defaultReplicationConfig;
}

/**
* Returns true if bucket version is enabled, else false.
* @return isVersionEnabled
*/
public Boolean getVersioning() {
public boolean getVersioning() {
return versioning;
}

Expand Down Expand Up @@ -206,7 +189,7 @@ public String getOwner() {
* Builder for OmBucketInfo.
*/
public static class Builder {
private Boolean versioning;
private boolean versioning;
private StorageType storageType;
private List<OzoneAcl> acls;
private Map<String, String> metadata;
Expand All @@ -220,12 +203,11 @@ public static class Builder {
private DefaultReplicationConfig defaultReplicationConfig;

public Builder() {
metadata = new HashMap<>();
quotaInBytes = OzoneConsts.QUOTA_RESET;
quotaInNamespace = OzoneConsts.QUOTA_RESET;
}

public BucketArgs.Builder setVersioning(Boolean versionFlag) {
public BucketArgs.Builder setVersioning(boolean versionFlag) {
this.versioning = versionFlag;
return this;
}
Expand All @@ -235,13 +217,19 @@ public BucketArgs.Builder setStorageType(StorageType storage) {
return this;
}

public BucketArgs.Builder setAcls(List<OzoneAcl> listOfAcls) {
this.acls = listOfAcls;
public BucketArgs.Builder addAcl(OzoneAcl acl) {
if (acls == null) {
acls = new ArrayList<>();
}
acls.add(acl);
return this;
}

public BucketArgs.Builder addMetadata(String key, String value) {
this.metadata.put(key, value);
if (metadata == null) {
metadata = new HashMap<>();
}
metadata.put(key, value);
return this;
}

Expand Down Expand Up @@ -291,9 +279,7 @@ public BucketArgs.Builder setDefaultReplicationConfig(
* @return instance of BucketArgs.
*/
public BucketArgs build() {
return new BucketArgs(versioning, storageType, acls, metadata,
bucketEncryptionKey, sourceVolume, sourceBucket, quotaInBytes,
quotaInNamespace, bucketLayout, owner, defaultReplicationConfig);
return new BucketArgs(this);
}
}
}
3 changes: 1 addition & 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 @@ -627,8 +627,7 @@ public void createBucket(
ugi.getShortUserName() : bucketArgs.getOwner();
}

Boolean isVersionEnabled = bucketArgs.getVersioning() == null ?
Boolean.FALSE : bucketArgs.getVersioning();
boolean isVersionEnabled = bucketArgs.getVersioning();
StorageType storageType = bucketArgs.getStorageType() == null ?
StorageType.DEFAULT : bucketArgs.getStorageType();
BucketLayout bucketLayout = bucketArgs.getBucketLayout();
Expand Down
16 changes: 15 additions & 1 deletion hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/OzoneAcl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,23 @@ public OzoneAcl(ACLIdentityType type, String name, ACLType acl,
*
* @param type - Type
* @param name - Name of user
* @param acls - Rights
* @param scope - AclScope
* @param acls - Rights
*/
public OzoneAcl(ACLIdentityType type, String name, AclScope scope, ACLType... acls) {
this(type, name, bitSetOf(acls), scope);
}

private static BitSet bitSetOf(ACLType... acls) {
BitSet bits = new BitSet();
if (acls != null && acls.length > 0) {

@kerneltime kerneltime Feb 9, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (acls != null && acls.length > 0) {
if (acls != null) {

@adoroszlai adoroszlai Feb 10, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the problem with acls.length > 0?

@sodonnel sodonnel Feb 12, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The length > 0 is handled implicitly by the for loop, so its not really needed. I guess this is a nit - change it if there are other comments, otherwise it will do no harm.

@adoroszlai adoroszlai Feb 12, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that it's not strictly necessary. I have two problems:

  1. Don't know the runtime cost of creating an iterator for the empty array in the for loop behind the scene. Maybe the compiler optimizes it away.
  2. Running full CI again for such a cosmetic change does not seem worth the effort. Especially when the reviewer cannot spend the extra 10 seconds to write "nit:" or something like that.

for (ACLType acl : acls) {
bits.set(acl.ordinal());
}
}
return bits;
}

public OzoneAcl(ACLIdentityType type, String name, BitSet acls,
AclScope scope) {
Objects.requireNonNull(type);
Expand Down
15 changes: 2 additions & 13 deletions ...tion-test/src/test/java/org/apache/hadoop/fs/ozone/AbstractRootedOzoneFileSystemTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@
import java.util.Arrays;
import java.util.BitSet;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
Expand Down Expand Up @@ -122,7 +121,6 @@
import static org.apache.hadoop.ozone.om.exceptions.OMException.ResultCodes.VOLUME_NOT_FOUND;
import static org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLType.READ;
import static org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLType.WRITE;
import static org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLType.DELETE;
import static org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLType.LIST;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
Expand Down Expand Up @@ -1223,20 +1221,11 @@ void testSharedTmpDir() throws IOException {
}

// set acls for shared tmp mount under the tmp volume
List<OzoneAcl> objectAcls = new ArrayList<>();
objectAcls.add(new OzoneAcl(ACLIdentityType.USER, "admin", userRights,
ACCESS));
aclRights.clear(DELETE.ordinal());
aclRights.set(LIST.ordinal());
objectAcls.add(new OzoneAcl(ACLIdentityType.WORLD, "",
aclRights, ACCESS));
objectAcls.add(new OzoneAcl(ACLIdentityType.USER, "admin", userRights,
ACCESS));
// bucket acls have all access to admin and read+write+list access to world

BucketArgs bucketArgs = new BucketArgs.Builder()
.setOwner("admin")
.setAcls(Collections.unmodifiableList(objectAcls))
.addAcl(new OzoneAcl(ACLIdentityType.WORLD, "", ACCESS, READ, WRITE, LIST))
.addAcl(new OzoneAcl(ACLIdentityType.USER, "admin", userRights, ACCESS))
.setQuotaInNamespace(1000)
.setQuotaInBytes(Long.MAX_VALUE).build();

Expand Down
43 changes: 16 additions & 27 deletions ...ion-test/src/test/java/org/apache/hadoop/ozone/client/rpc/TestOzoneRpcClientAbstract.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -661,12 +661,10 @@ public void testCreateBucketWithAcls()
String bucketName = UUID.randomUUID().toString();
OzoneAcl userAcl = new OzoneAcl(USER, "test",
READ, ACCESS);
List<OzoneAcl> acls = new ArrayList<>();
acls.add(userAcl);
store.createVolume(volumeName);
OzoneVolume volume = store.getVolume(volumeName);
BucketArgs.Builder builder = BucketArgs.newBuilder();
builder.setAcls(acls);
BucketArgs.Builder builder = BucketArgs.newBuilder()
.addAcl(userAcl);
volume.createBucket(bucketName, builder.build());
OzoneBucket bucket = volume.getBucket(bucketName);
assertEquals(bucketName, bucket.getName());
Expand Down Expand Up @@ -697,15 +695,13 @@ public void testCreateBucketWithAllArgument()
String bucketName = UUID.randomUUID().toString();
OzoneAcl userAcl = new OzoneAcl(USER, "test",
ACLType.ALL, ACCESS);
List<OzoneAcl> acls = new ArrayList<>();
acls.add(userAcl);
ReplicationConfig repConfig = new ECReplicationConfig(3, 2);
store.createVolume(volumeName);
OzoneVolume volume = store.getVolume(volumeName);
BucketArgs.Builder builder = BucketArgs.newBuilder();
builder.setVersioning(true)
.setStorageType(StorageType.SSD)
.setAcls(acls)
.addAcl(userAcl)
.setDefaultReplicationConfig(new DefaultReplicationConfig(repConfig));
volume.createBucket(bucketName, builder.build());
OzoneBucket bucket = volume.getBucket(bucketName);
Expand Down Expand Up @@ -754,20 +750,16 @@ public void testRemoveBucketAcl()
String bucketName = UUID.randomUUID().toString();
OzoneAcl userAcl = new OzoneAcl(USER, "test",
ACLType.ALL, ACCESS);
List<OzoneAcl> acls = new ArrayList<>();
acls.add(userAcl);
store.createVolume(volumeName);
OzoneVolume volume = store.getVolume(volumeName);
BucketArgs.Builder builder = BucketArgs.newBuilder();
builder.setAcls(acls);
BucketArgs.Builder builder = BucketArgs.newBuilder()
.addAcl(userAcl);
volume.createBucket(bucketName, builder.build());
OzoneBucket bucket = volume.getBucket(bucketName);
for (OzoneAcl acl : acls) {
assertTrue(bucket.removeAcl(acl));
}
assertTrue(bucket.removeAcl(userAcl));
OzoneBucket newBucket = volume.getBucket(bucketName);
assertEquals(bucketName, newBucket.getName());
assertThat(bucket.getAcls()).doesNotContain(acls.get(0));
assertThat(newBucket.getAcls()).doesNotContain(userAcl);
}

@Test
Expand All @@ -777,14 +769,13 @@ public void testRemoveBucketAclUsingRpcClientRemoveAcl()
String bucketName = UUID.randomUUID().toString();
OzoneAcl userAcl = new OzoneAcl(USER, "test",
ACLType.ALL, ACCESS);
List<OzoneAcl> acls = new ArrayList<>();
acls.add(userAcl);
acls.add(new OzoneAcl(USER, "test1",
ACLType.ALL, ACCESS));
OzoneAcl acl2 = new OzoneAcl(USER, "test1",
ACLType.ALL, ACCESS);
store.createVolume(volumeName);
OzoneVolume volume = store.getVolume(volumeName);
BucketArgs.Builder builder = BucketArgs.newBuilder();
builder.setAcls(acls);
BucketArgs.Builder builder = BucketArgs.newBuilder()
.addAcl(userAcl)
.addAcl(acl2);
volume.createBucket(bucketName, builder.build());
OzoneObj ozoneObj = OzoneObjInfo.Builder.newBuilder()
.setBucketName(bucketName)
Expand All @@ -793,13 +784,11 @@ public void testRemoveBucketAclUsingRpcClientRemoveAcl()
.setResType(OzoneObj.ResourceType.BUCKET).build();

// Remove the 2nd acl added to the list.
boolean remove = store.removeAcl(ozoneObj, acls.get(1));
assertTrue(remove);
assertThat(store.getAcl(ozoneObj)).doesNotContain(acls.get(1));
assertTrue(store.removeAcl(ozoneObj, acl2));
assertThat(store.getAcl(ozoneObj)).doesNotContain(acl2);

remove = store.removeAcl(ozoneObj, acls.get(0));
assertTrue(remove);
assertThat(store.getAcl(ozoneObj)).doesNotContain(acls.get(0));
assertTrue(store.removeAcl(ozoneObj, userAcl));
assertThat(store.getAcl(ozoneObj)).doesNotContain(userAcl);
}

@Test
Expand Down