Skip to content

Commit

Permalink
chore(test): expand StorageInstance vetoing to apply to bucket acl op…
Browse files Browse the repository at this point in the history 
…erations (#1819)

* chore(test): simplify StorageInstance vetoing implementation

Rather than using a runtime proxy to do invocation method argument matching we are now defining a concrete class to override the methods it needs to provide enforcement for.

This is simpler in that it uses standard java language implementation approach which is helped by compiler and IDEs. It is at the expense of needing to define the new ~500 line AbstractStorageDecorator class.

* test: veto attempts to mutate bucket default acls

* test: veto attempts to mutate bucket acls

* test: veto lockRetentionPolicy
  • Loading branch information
@BenWhitehead
BenWhitehead committed Dec 16, 2022
1 parent 96beca2 commit f8cad99
Show file tree
Hide file tree
Showing 3 changed files with 606 additions and 138 deletions.
96 changes: 0 additions & 96 deletions google-cloud-storage/src/test/java/com/google/cloud/storage/it/ITAccessTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
import com.google.cloud.storage.Acl.Role;
import com.google.cloud.storage.Acl.User;
import com.google.cloud.storage.Blob;
import com.google.cloud.storage.BlobId;
import com.google.cloud.storage.BlobInfo;
import com.google.cloud.storage.Bucket;
import com.google.cloud.storage.BucketInfo;
Expand All @@ -45,7 +44,6 @@
import com.google.cloud.storage.Storage.BlobTargetOption;
import com.google.cloud.storage.Storage.BucketField;
import com.google.cloud.storage.Storage.BucketGetOption;
import com.google.cloud.storage.Storage.BucketSourceOption;
import com.google.cloud.storage.Storage.BucketTargetOption;
import com.google.cloud.storage.StorageException;
import com.google.cloud.storage.StorageRoles;
Expand All @@ -63,7 +61,6 @@
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
Expand Down Expand Up @@ -97,37 +94,6 @@ public class ITAccessTest {

@Inject public Generator generator;

@Test
@CrossRun.Ignore(transports = Transport.GRPC)
public void bucketAcl_requesterPays_true() {
String projectId = storage.getOptions().getProjectId();
testBucketAclRequesterPays(requesterPaysBucket, BucketSourceOption.userProject(projectId));
}

@Test
@CrossRun.Ignore(transports = Transport.GRPC)
public void bucketAcl_requesterPays_false() {
testBucketAclRequesterPays(bucket);
}

private void testBucketAclRequesterPays(
BucketInfo bucket, Storage.BucketSourceOption... bucketOptions) {
// TODO: break into individual tests
assertNull(storage.getAcl(bucket.getName(), User.ofAllAuthenticatedUsers(), bucketOptions));
assertFalse(storage.deleteAcl(bucket.getName(), User.ofAllAuthenticatedUsers(), bucketOptions));
Acl acl = Acl.of(User.ofAllAuthenticatedUsers(), Role.READER);
assertNotNull(storage.createAcl(bucket.getName(), acl, bucketOptions));
Acl updatedAcl =
storage.updateAcl(
bucket.getName(), acl.toBuilder().setRole(Role.WRITER).build(), bucketOptions);
assertEquals(Role.WRITER, updatedAcl.getRole());
Set<Acl> acls = new HashSet<>();
acls.addAll(storage.listAcls(bucket.getName(), bucketOptions));
assertTrue(acls.contains(updatedAcl));
assertTrue(storage.deleteAcl(bucket.getName(), User.ofAllAuthenticatedUsers(), bucketOptions));
assertNull(storage.getAcl(bucket.getName(), User.ofAllAuthenticatedUsers(), bucketOptions));
}

@Test
public void bucket_defaultAcl_get() {
String bucketName = bucket.getName();
Expand Down Expand Up @@ -1061,68 +1027,6 @@ public void testEnableAndDisableBucketPolicyOnlyOnExistingBucket() throws Except
}
}

@Test
@CrossRun.Ignore(transports = Transport.GRPC)
public void testBlobAcl() {
// TODO: break this test up into each of the respective scenarios
// 1. get ACL for specific entity
// 2. Create an ACL for specific entity
// 3. Update ACL to change role of a specific entity
// 4. List ACLs for an object
// 5. Delete an ACL for a specific entity
// 6. Attempt to get an acl for an object that doesn't exist
// 7. Attempt to delete an acl for an object that doesn't exist
// 8. Attempt to create an acl for an object that doesn't exist
// 9. Attempt to update an acl for an object that doesn't exist
// 10. Attempt to list acls for an object that doesn't exist
BlobId blobId = BlobId.of(bucket.getName(), "test-blob-acl");
BlobInfo blob = BlobInfo.newBuilder(blobId).build();
storage.create(blob);
assertNull(storage.getAcl(blobId, User.ofAllAuthenticatedUsers()));
Acl acl = Acl.of(User.ofAllAuthenticatedUsers(), Role.READER);
assertNotNull(storage.createAcl(blobId, acl));
Acl updatedAcl = storage.updateAcl(blobId, acl.toBuilder().setRole(Role.OWNER).build());
assertEquals(Role.OWNER, updatedAcl.getRole());
Set<Acl> acls = new HashSet<>(storage.listAcls(blobId));
assertTrue(acls.contains(updatedAcl));
assertTrue(storage.deleteAcl(blobId, User.ofAllAuthenticatedUsers()));
assertNull(storage.getAcl(blobId, User.ofAllAuthenticatedUsers()));
// test non-existing blob
BlobId otherBlobId = BlobId.of(bucket.getName(), "test-blob-acl", -1L);
try {
assertNull(storage.getAcl(otherBlobId, User.ofAllAuthenticatedUsers()));
fail("Expected an 'Invalid argument' exception");
} catch (StorageException e) {
assertThat(e.getMessage()).contains("Invalid argument");
}

try {
assertFalse(storage.deleteAcl(otherBlobId, User.ofAllAuthenticatedUsers()));
fail("Expected an 'Invalid argument' exception");
} catch (StorageException e) {
assertThat(e.getMessage()).contains("Invalid argument");
}

try {
storage.createAcl(otherBlobId, acl);
fail("Expected StorageException");
} catch (StorageException ex) {
// expected
}
try {
storage.updateAcl(otherBlobId, acl);
fail("Expected StorageException");
} catch (StorageException ex) {
// expected
}
try {
storage.listAcls(otherBlobId);
fail("Expected StorageException");
} catch (StorageException ex) {
// expected
}
}

static ImmutableList<Acl> dropEtags(List<Acl> defaultAcls) {
return defaultAcls.stream()
.map(ITAccessTest::dropEtag)
Expand Down

0 comments on commit f8cad99

Please sign in to comment.