Skip to content
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

Feature: Check if bucket exists with S3Template #915

Merged
merged 2 commits into from
Nov 1, 2023
Merged

Feature: Check if bucket exists with S3Template #915

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbcafbb
feat: check if bucket exists with S3Template
straurob Oct 20, 2023
6472a13
rename method to bucketExists
straurob Oct 28, 2023
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
8 changes: 8 additions & 0 deletions ...ud-aws-s3-parent/spring-cloud-aws-s3/src/main/java/io/awspring/cloud/s3/S3Operations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ public interface S3Operations {
*/
void deleteBucket(String bucketName);

/**
* Checks if an S3 bucket exists.
*
* @param bucketName - the bucket name
* @return true if bucket exists; false otherwise
*/
boolean existsBucket(String bucketName);
straurob marked this conversation as resolved.
Show resolved Hide resolved

/**
* Deletes an object from S3 bucket.
*
Expand Down
12 changes: 12 additions & 0 deletions ...loud-aws-s3-parent/spring-cloud-aws-s3/src/main/java/io/awspring/cloud/s3/S3Template.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import software.amazon.awssdk.services.s3.model.ListObjectsV2Request;
import software.amazon.awssdk.services.s3.model.ListObjectsV2Response;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.services.s3.model.NoSuchBucketException;
import software.amazon.awssdk.services.s3.presigner.S3Presigner;
import software.amazon.awssdk.services.s3.presigner.model.GetObjectPresignRequest;
import software.amazon.awssdk.services.s3.presigner.model.PresignedGetObjectRequest;
Expand Down Expand Up @@ -74,6 +75,17 @@ public void deleteBucket(String bucketName) {
s3Client.deleteBucket(request -> request.bucket(bucketName));
}

@Override
public boolean existsBucket(String bucketName) {
Assert.notNull(bucketName, "bucketName is required");
try {
s3Client.headBucket(request -> request.bucket(bucketName));
} catch (NoSuchBucketException e) {
return false;
}
return true;
}

@Override
public void deleteObject(String bucketName, String key) {
Assert.notNull(bucketName, "bucketName is required");
Expand Down
17 changes: 17 additions & 0 deletions ...nt/spring-cloud-aws-s3/src/test/java/io/awspring/cloud/s3/S3TemplateIntegrationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,23 @@ void deletesBucket() {
assertThat(client.listBuckets()).satisfies(r -> this.bucketDoesNotExist(r, BUCKET_NAME));
}

@Test
void whenBucketExistsShouldReturnTrue() {
final boolean existsBucket = s3Template.existsBucket(BUCKET_NAME);

assertThat(existsBucket).isTrue();
assertThat(client.listBuckets()).satisfies(r -> this.bucketExists(r, BUCKET_NAME));
}

@Test
void whenBucketNotExistsShouldReturnFalse() {
destroyBuckets();

final boolean existsBucket = s3Template.existsBucket(BUCKET_NAME);

assertThat(existsBucket).isFalse();
}

@Test
void deletesObject() {
client.createBucket(r -> r.bucket(BUCKET_NAME));
Expand Down
Loading