Skip to content

feat: Support AbortIncompleteMultipartUpload LifecycleAction #1347

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
merged 7 commits into from
Jun 7, 2022
Merged

feat: Support AbortIncompleteMultipartUpload LifecycleAction #1347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
eb6f253
Support AbortIncompleteMultipartUpload LifecycleAction
sydney-munro Apr 7, 2022
c38411e
Fixing up tests
sydney-munro Apr 7, 2022
ba1c5f5
Fixing incorrect type value
sydney-munro Apr 8, 2022
17f3897
Adding serialVersionUID and fixing up some weird naming
sydney-munro Apr 8, 2022
21542a7
Adding docs link to comment
sydney-munro Apr 13, 2022
8276600
Adding AbortMPU unit tests plus adding from Pb checks to existing lif…
sydney-munro Apr 14, 2022
84b9ccf
Linter changes
sydney-munro Apr 14, 2022
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
21 changes: 21 additions & 0 deletions google-cloud-storage/src/main/java/com/google/cloud/storage/BucketInfo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,9 @@ static LifecycleRule fromPb(Rule rule) {
LifecycleAction.newSetStorageClassAction(
StorageClass.valueOf(action.getStorageClass()));
break;
case AbortIncompleteMPUAction.TYPE:
lifecycleAction = LifecycleAction.newAbortIncompleteMPUploadAction();
break;
default:
log.warning(
"The lifecycle action "
Expand Down Expand Up @@ -845,6 +848,15 @@ public static SetStorageClassLifecycleAction newSetStorageClassAction(
return new SetStorageClassLifecycleAction(storageClass);
}

/**
* Create a new {@code AbortIncompleteMPUAction}. An incomplete multipart upload will be
* aborted when the multipart upload meets the specified condition. Age is the only condition
* supported for this action. See: https://cloud.google.com/storage/docs/lifecycle##abort-mpu
*/
public static LifecycleAction newAbortIncompleteMPUploadAction() {
return new AbortIncompleteMPUAction();
}

/**
* Creates a new {@code LifecycleAction , with no specific supported action associated with it. This
* is only intended as a "backup" for when the library doesn't recognize the type, and should
Expand Down Expand Up @@ -888,6 +900,15 @@ public StorageClass getStorageClass() {
return storageClass;
}
}

public static class AbortIncompleteMPUAction extends LifecycleAction {
public static final String TYPE = "AbortIncompleteMultipartUpload";
private static final long serialVersionUID = -1072182310389348060L;

private AbortIncompleteMPUAction() {
super(TYPE);
}
}
}

/**
Expand Down
21 changes: 21 additions & 0 deletions google-cloud-storage/src/test/java/com/google/cloud/storage/BucketInfoTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@
import com.google.cloud.storage.BucketInfo.IamConfiguration;
import com.google.cloud.storage.BucketInfo.IsLiveDeleteRule;
import com.google.cloud.storage.BucketInfo.LifecycleRule;
import com.google.cloud.storage.BucketInfo.LifecycleRule.AbortIncompleteMPUAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.DeleteLifecycleAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.LifecycleAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.LifecycleCondition;
import com.google.cloud.storage.BucketInfo.LifecycleRule.SetStorageClassLifecycleAction;
import com.google.cloud.storage.BucketInfo.NumNewerVersionsDeleteRule;
import com.google.cloud.storage.BucketInfo.PublicAccessPrevention;
import com.google.cloud.storage.BucketInfo.RawDeleteRule;
Expand Down Expand Up @@ -331,6 +334,8 @@ public void testLifecycleRules() {
assertEquals(
LifecycleRule.DeleteLifecycleAction.TYPE, deleteLifecycleRule.getAction().getType());
assertEquals(10, deleteLifecycleRule.getCondition().getAge().intValue());
assertTrue(
LifecycleRule.fromPb(deleteLifecycleRule).getAction() instanceof DeleteLifecycleAction);

Rule setStorageClassLifecycleRule =
new LifecycleRule(
Expand All @@ -346,6 +351,9 @@ public void testLifecycleRules() {
setStorageClassLifecycleRule.getAction().getStorageClass());
assertTrue(setStorageClassLifecycleRule.getCondition().getIsLive());
assertEquals(10, setStorageClassLifecycleRule.getCondition().getNumNewerVersions().intValue());
assertTrue(
Copy link
Contributor Author

@sydney-munro sydney-munro Apr 14, 2022

Choose a reason for hiding this comment

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

just added these in since I didn't see us testing all the cases of the fromPb switch statement.

LifecycleRule.fromPb(setStorageClassLifecycleRule).getAction()
instanceof SetStorageClassLifecycleAction);

Rule lifecycleRule =
new LifecycleRule(
Expand All @@ -367,6 +375,19 @@ public void testLifecycleRules() {
assertEquals(StorageClass.COLDLINE.toString(), lifecycleRule.getAction().getStorageClass());
assertEquals(30, lifecycleRule.getCondition().getDaysSinceCustomTime().intValue());
assertNotNull(lifecycleRule.getCondition().getCustomTimeBefore());
assertTrue(
LifecycleRule.fromPb(lifecycleRule).getAction() instanceof SetStorageClassLifecycleAction);

Rule abortMpuLifecycleRule =
new LifecycleRule(
LifecycleAction.newAbortIncompleteMPUploadAction(),
LifecycleCondition.newBuilder().setAge(10).build())
.toPb();
assertEquals(AbortIncompleteMPUAction.TYPE, abortMpuLifecycleRule.getAction().getType());
assertEquals(10, abortMpuLifecycleRule.getCondition().getAge().intValue());
assertTrue(
LifecycleRule.fromPb(abortMpuLifecycleRule).getAction()
instanceof AbortIncompleteMPUAction);

Rule unsupportedRule =
new LifecycleRule(
Expand Down
24 changes: 24 additions & 0 deletions google-cloud-storage/src/test/java/com/google/cloud/storage/it/ITStorageTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
import com.google.cloud.storage.Bucket;
import com.google.cloud.storage.BucketInfo;
import com.google.cloud.storage.BucketInfo.LifecycleRule;
import com.google.cloud.storage.BucketInfo.LifecycleRule.AbortIncompleteMPUAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.LifecycleAction;
import com.google.cloud.storage.BucketInfo.LifecycleRule.LifecycleCondition;
import com.google.cloud.storage.CopyWriter;
Expand Down Expand Up @@ -547,6 +548,29 @@ public void testGetBucketLifecycleRules() {
}
}

@Test
public void testGetBucketAbortMPULifecycle() {
String lifecycleTestBucketName = RemoteStorageHelper.generateBucketName();
storage.create(
BucketInfo.newBuilder(lifecycleTestBucketName)
.setLocation("us")
.setLifecycleRules(
ImmutableList.of(
new LifecycleRule(
LifecycleAction.newAbortIncompleteMPUploadAction(),
LifecycleCondition.newBuilder().setAge(1).build())))
.build());
Bucket remoteBucket =
storage.get(lifecycleTestBucketName, Storage.BucketGetOption.fields(BucketField.LIFECYCLE));
LifecycleRule lifecycleRule = remoteBucket.getLifecycleRules().get(0);
try {
assertEquals(AbortIncompleteMPUAction.TYPE, lifecycleRule.getAction().getActionType());
assertEquals(1, lifecycleRule.getCondition().getAge().intValue());
} finally {
Copy link
Contributor

@frankyn frankyn Apr 13, 2022

Choose a reason for hiding this comment

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

ah interesting; didn't think of wrapping asserts with a try {} so you can do clean up afterwards, clever.

storage.delete(lifecycleTestBucketName);
}
}

@Test
public void testClearBucketDefaultKmsKeyName() throws ExecutionException, InterruptedException {
String bucketName = RemoteStorageHelper.generateBucketName();
Expand Down