feat: check if bucket exists with S3Template

Closes #901
awspring · Oct 20, 2023 · dbcafbb · dbcafbb
1 parent d6d9dce
commit dbcafbb
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 0 deletions.
diff --git a/...ud-aws-s3-parent/spring-cloud-aws-s3/src/main/java/io/awspring/cloud/s3/S3Operations.java b/...ud-aws-s3-parent/spring-cloud-aws-s3/src/main/java/io/awspring/cloud/s3/S3Operations.java
@@ -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);
+
 	/**
 	 * Deletes an object from S3 bucket.
 	 *

diff --git a/...loud-aws-s3-parent/spring-cloud-aws-s3/src/main/java/io/awspring/cloud/s3/S3Template.java b/...loud-aws-s3-parent/spring-cloud-aws-s3/src/main/java/io/awspring/cloud/s3/S3Template.java
@@ -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;
@@ -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");

diff --git a/...nt/spring-cloud-aws-s3/src/test/java/io/awspring/cloud/s3/S3TemplateIntegrationTests.java b/...nt/spring-cloud-aws-s3/src/test/java/io/awspring/cloud/s3/S3TemplateIntegrationTests.java
@@ -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));