support inject S3Client instance to test method parameter. (#84)

Author: Robothy

README.md

@@ -135,8 +135,14 @@ LocalS3 for Junit5 provides a Java annotation `@LocalS3` helps you easily launch
 </dependency>
 ```
 
-When you annotate it on test classes or test methods, the LocalS3 extension automatically inject instances
-for AmazonS3 parameters of test methods.
+When you annotate it on test classes or test methods, the LocalS3 extension automatically inject instances with 
+the following parameter types of test methods.
+
++ `AmazonS3`
++ `S3Client`
++ `LocalS3Endpoint`
+
+Example 1: Inject a `AmazonS3` object to the test method parameter.
 
 ```java
 @LocalS3
@@ -146,6 +152,19 @@ class AppTest {
     s3.createBucket("my-bucket");
   }
 }
+
+```
+
+Example 2: Inject a `S3Client` object to the test method parameter
+
+```java
+class AppTest {
+  @Test
+  @LocalS3
+  void test(S3Client client) {
+    client.createBucket(b -> b.bucket("my-bucket"));
+  }
+}
 ```
 
 #### Difference between `@LocalS3` on test classes and test methods

local-s3-jupiter/build.gradle

@@ -5,12 +5,14 @@ plugins {
 
 dependencies {
     implementation project(":local-s3-rest")
-    implementation "software.amazon.awssdk:s3:${libVersion['software.amazon.awssdk.s3']}"
-    implementation "com.amazonaws:aws-java-sdk:${libVersion['com.amazonaws.aws-java-sdk']}"
+    compileOnly "software.amazon.awssdk:s3:${libVersion['software.amazon.awssdk.s3']}"
+    compileOnly "com.amazonaws:aws-java-sdk:${libVersion['com.amazonaws.aws-java-sdk']}"
     implementation "commons-io:commons-io:${libVersion['commons-io.commons-io']}"
     implementation "org.apache.commons:commons-lang3:${libVersion['org.apache.commons.commons-lang3']}"
     implementation "com.fasterxml.jackson.dataformat:jackson-dataformat-xml:${libVersion['com.fasterxml.jackson.dataformat.jackson-dataformat-xml']}"
     implementation "org.junit.jupiter:junit-jupiter:${libVersion['org.junit.jupiter.junit-jupiter']}"
     testRuntimeOnly "ch.qos.logback:logback-classic:${libVersion['ch.qos.logback.logback-classic']}"
+    testImplementation "software.amazon.awssdk:s3:${libVersion['software.amazon.awssdk.s3']}"
+    testImplementation "com.amazonaws:aws-java-sdk:${libVersion['com.amazonaws.aws-java-sdk']}"
 }
 

local-s3-jupiter/src/main/java/com/robothy/s3/jupiter/LocalS3.java

@@ -4,18 +4,26 @@
 import com.robothy.s3.jupiter.extensions.AmazonS3Resolver;
 import com.robothy.s3.jupiter.extensions.LocalS3EndpointResolver;
 import com.robothy.s3.jupiter.extensions.LocalS3Extension;
+import com.robothy.s3.jupiter.extensions.S3ClientResolver;
 import com.robothy.s3.jupiter.supplier.DataPathSupplier;
 import com.robothy.s3.rest.bootstrap.LocalS3Mode;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 import org.junit.jupiter.api.extension.ExtendWith;
+import software.amazon.awssdk.services.s3.S3Client;
 
 /**
  * {@code @LocalS3} is a Junit5/Jupiter extension that runs a mocked AmazonS3 service
  * for annotated test classes or test methods. To hit the mocked service, you can add
- * {@linkplain AmazonS3} or {@linkplain LocalS3Endpoint} parameters in test methods.
+ * the following parameter types in test methods.
+ *
+ * <ul>
+ *   <li>{@linkplain AmazonS3}</li>
+ *   <li>{@linkplain S3Client}</li>
+ *   <li>{@linkplain LocalS3Endpoint}</li>
+ * </ul>
  *
  * <p>Below example injects an {@code AmazonS3} instance to the parameter:
  *
@@ -55,6 +63,7 @@
 @Retention(RetentionPolicy.RUNTIME)
 @ExtendWith(LocalS3Extension.class)
 @ExtendWith(AmazonS3Resolver.class)
+@ExtendWith(S3ClientResolver.class)
 @ExtendWith(LocalS3EndpointResolver.class)
 public @interface LocalS3 {
 

local-s3-jupiter/src/main/java/com/robothy/s3/jupiter/extensions/AbstractLocalS3ParameterResolver.java

@@ -5,12 +5,14 @@
 import org.junit.jupiter.api.extension.ParameterResolutionException;
 import org.junit.jupiter.api.extension.ParameterResolver;
 
-public abstract class AbstractLocalS3ParameterResolver<T> implements ParameterResolver {
+import java.util.Objects;
+
+public abstract class AbstractLocalS3ParameterResolver implements ParameterResolver {
 
   @Override
   public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext)
       throws ParameterResolutionException {
-    return type() == parameterContext.getParameter().getType();
+    return Objects.equals(className(), parameterContext.getParameter().getType().getName());
   }
 
   @Override
@@ -29,8 +31,8 @@ public Object resolveParameter(ParameterContext parameterContext, ExtensionConte
     return resolve(port);
   }
 
-  protected abstract Class<T> type();
+  protected abstract String className();
 
-  protected abstract T resolve(int port);
+  protected abstract Object resolve(int port);
 
 }

local-s3-jupiter/src/main/java/com/robothy/s3/jupiter/extensions/AmazonS3Resolver.java

@@ -2,22 +2,14 @@
 
 import com.amazonaws.ClientConfiguration;
 import com.amazonaws.client.builder.AwsClientBuilder;
-import com.amazonaws.retry.RetryMode;
-import com.amazonaws.retry.RetryPolicy;
 import com.amazonaws.services.s3.AmazonS3;
 import com.amazonaws.services.s3.AmazonS3Client;
 import com.amazonaws.services.s3.AmazonS3ClientBuilder;
-import org.junit.jupiter.api.extension.ExtensionContext;
-import org.junit.jupiter.api.extension.ParameterContext;
-import org.junit.jupiter.api.extension.ParameterResolutionException;
-import org.junit.jupiter.api.extension.ParameterResolver;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * Inject an AmazonS3 instance to a test parameter.
  */
-public class AmazonS3Resolver extends AbstractLocalS3ParameterResolver<AmazonS3> {
+public class AmazonS3Resolver extends AbstractLocalS3ParameterResolver {
 
   private final AmazonS3ClientBuilder s3Builder = AmazonS3Client.builder()
       .enablePathStyleAccess()
@@ -26,8 +18,8 @@ public class AmazonS3Resolver extends AbstractLocalS3ParameterResolver<AmazonS3>
           .withSocketTimeout(1000));
 
   @Override
-  protected Class<AmazonS3> type() {
-    return AmazonS3.class;
+  protected String className() {
+    return "com.amazonaws.services.s3.AmazonS3";
   }
 
   @Override

local-s3-jupiter/src/main/java/com/robothy/s3/jupiter/extensions/LocalS3EndpointResolver.java

@@ -1,16 +1,12 @@
 package com.robothy.s3.jupiter.extensions;
 
 import com.robothy.s3.jupiter.LocalS3Endpoint;
-import org.junit.jupiter.api.extension.ExtensionContext;
-import org.junit.jupiter.api.extension.ParameterContext;
-import org.junit.jupiter.api.extension.ParameterResolutionException;
-import org.junit.jupiter.api.extension.ParameterResolver;
 
-public class LocalS3EndpointResolver extends AbstractLocalS3ParameterResolver<LocalS3Endpoint> {
+public class LocalS3EndpointResolver extends AbstractLocalS3ParameterResolver {
 
   @Override
-  protected Class<LocalS3Endpoint> type() {
-    return LocalS3Endpoint.class;
+  protected String className() {
+    return LocalS3Endpoint.class.getName();
   }
 
   @Override

local-s3-jupiter/src/main/java/com/robothy/s3/jupiter/extensions/S3ClientResolver.java

@@ -0,0 +1,33 @@
+package com.robothy.s3.jupiter.extensions;
+
+import lombok.SneakyThrows;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.s3.S3Client;
+
+import java.net.URI;
+
+public class S3ClientResolver extends AbstractLocalS3ParameterResolver {
+
+  @Override
+  protected String className() {
+    return "software.amazon.awssdk.services.s3.S3Client";
+  }
+
+  @SneakyThrows
+  @Override
+  protected Object resolve(int port) {
+    String endpoint = "http://localhost:" + port;
+
+    return S3Client.builder()
+      .forcePathStyle(true)
+      .endpointOverride(new URI(endpoint))
+      .region(Region.of("local"))
+      .credentialsProvider(StaticCredentialsProvider.create(
+        AwsBasicCredentials.create("local-s3-access-key", "local-s3-secret-key")))
+      .build();
+  }
+
+}

local-s3-jupiter/src/test/java/com/robothy/s3/jupiter/extensions/S3ClientResolverTest.java

@@ -0,0 +1,26 @@
+package com.robothy.s3.jupiter.extensions;
+
+import com.robothy.s3.jupiter.LocalS3;
+import org.junit.jupiter.api.Test;
+import software.amazon.awssdk.core.sync.RequestBody;
+import software.amazon.awssdk.services.s3.S3Client;
+import software.amazon.awssdk.services.s3.model.CreateBucketResponse;
+import software.amazon.awssdk.services.s3.model.PutObjectRequest;
+import software.amazon.awssdk.services.s3.model.PutObjectResponse;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+@LocalS3
+public class S3ClientResolverTest {
+
+  @Test
+  void test(S3Client client){
+    assertNotNull(client);
+    CreateBucketResponse createBucketResponse = client.createBucket(b -> b.bucket("my-bucket"));
+    assertNotNull(createBucketResponse);
+    PutObjectResponse putObjectResponse = client.putObject(PutObjectRequest.builder()
+      .bucket("my-bucket").key("a.txt").build(), RequestBody.empty());
+    assertNotNull(putObjectResponse);
+  }
+
+}