Merge pull request #14 from americanexpress/add_option_for_http_headers

Resolves #13 Add support for custom headers

README.md

@@ -49,6 +49,7 @@ The AWS S3 build cache implementation has a few configuration options:
 | `path` | The path under which all cache objects should be stored. | no | |
 | `reducedRedundancy` | Whether or not to use [reduced redundancy](https://aws.amazon.com/s3/reduced-redundancy/). | no | true |
 | `endpoint` | Alternative S3 compatible endpoint | no | |
+| `headers` | A map with HTTP headers to be added to each request (nulls are ignored). e.g. `[ 'x-header-name': 'header-value' ]` | no | |
 | `awsAccessKeyId` | The AWS access key id | no | from DefaultAWSCredentialsProviderChain |
 | `awsSecretKey` | The AWS secret key | no | from DefaultAWSCredentialsProviderChain |
 

src/main/java/ch/myniva/gradle/caching/s3/AwsS3BuildCache.java

@@ -16,6 +16,8 @@
 
 package ch.myniva.gradle.caching.s3;
 
+import java.util.HashMap;
+import java.util.Map;
 import org.gradle.caching.configuration.AbstractBuildCache;
 
 public class AwsS3BuildCache extends AbstractBuildCache {
@@ -24,6 +26,7 @@ public class AwsS3BuildCache extends AbstractBuildCache {
   private String path;
   private boolean reducedRedundancy = true;
   private String endpoint;
+  private Map<String, String> headers;
   private String awsAccessKeyId;
   private String awsSecretKey;
 
@@ -67,6 +70,14 @@ public void setEndpoint(String endpoint) {
     this.endpoint = endpoint;
   }
 
+  public Map<String, String> getHeaders() {
+    return headers;
+  }
+
+  public void setHeaders(final Map<String, String> headers) {
+    this.headers = headers != null ? new HashMap<>(headers) : null;
+  }
+
   public String getAwsAccessKeyId() {
     return awsAccessKeyId;
   }

src/main/java/ch/myniva/gradle/caching/s3/internal/AwsS3BuildCacheServiceFactory.java

@@ -18,13 +18,14 @@
 
 import static com.amazonaws.util.StringUtils.isNullOrEmpty;
 
+import com.amazonaws.ClientConfiguration;
 import com.amazonaws.SdkClientException;
 import com.amazonaws.auth.AWSStaticCredentialsProvider;
 import com.amazonaws.auth.BasicAWSCredentials;
 import com.amazonaws.client.builder.AwsClientBuilder;
 import com.amazonaws.services.s3.AmazonS3;
 import com.amazonaws.services.s3.AmazonS3ClientBuilder;
-
+import java.util.Map;
 import org.gradle.api.GradleException;
 import org.gradle.caching.BuildCacheService;
 import org.gradle.caching.BuildCacheServiceFactory;
@@ -78,6 +79,9 @@ private AmazonS3 createS3Client(AwsS3BuildCache config) {
         s3Builder.withCredentials(new AWSStaticCredentialsProvider(
             new BasicAWSCredentials(config.getAwsAccessKeyId(), config.getAwsSecretKey())));
       }
+
+      addHttpHeaders(s3Builder, config);
+
       if (isNullOrEmpty(config.getEndpoint())) {
         s3Builder.withRegion(config.getRegion());
       } else {
@@ -91,4 +95,17 @@ private AmazonS3 createS3Client(AwsS3BuildCache config) {
     }
     return s3;
   }
+
+  private void addHttpHeaders(final AmazonS3ClientBuilder s3Builder, final AwsS3BuildCache config) {
+    final Map<String, String> headers = config.getHeaders();
+    if (headers != null) {
+      final ClientConfiguration clientConfiguration = new ClientConfiguration();
+      for (Map.Entry<String, String> header : headers.entrySet()) {
+        if(header.getKey() != null && header.getValue() != null) {
+          clientConfiguration.addHeader(header.getKey(), header.getValue());
+        }
+      }
+      s3Builder.setClientConfiguration(clientConfiguration);
+    }
+  }
 }

src/test/java/ch/myniva/gradle/caching/s3/internal/AwsS3BuildCacheServiceFactoryTest.java

@@ -19,6 +19,8 @@
 import static org.junit.Assert.assertNotNull;
 
 import ch.myniva.gradle.caching.s3.AwsS3BuildCache;
+import java.util.HashMap;
+import java.util.Map;
 import org.gradle.caching.BuildCacheService;
 import org.gradle.caching.BuildCacheServiceFactory.Describer;
 import org.junit.Before;
@@ -58,6 +60,49 @@ public void testPath() {
     assertNotNull(service);
   }
 
+  @Test
+  public void testNullHeaders() {
+    AwsS3BuildCache conf = new AwsS3BuildCache();
+    conf.setRegion("us-west-1");
+    conf.setBucket("my-bucket");
+    conf.setHeaders(null);
+
+    BuildCacheService service = subject.createBuildCacheService(conf, buildCacheDescriber);
+
+    assertNotNull(service);
+  }
+
+
+  @Test
+  public void testNullHeaderName() {
+    AwsS3BuildCache conf = new AwsS3BuildCache();
+    conf.setRegion("us-west-1");
+    conf.setBucket("my-bucket");
+    Map<String, String> headers = new HashMap<String, String>(){{
+      put(null, "foo");
+    }};
+    conf.setHeaders(headers);
+
+    BuildCacheService service = subject.createBuildCacheService(conf, buildCacheDescriber);
+
+    assertNotNull(service);
+  }
+
+  @Test
+  public void testNullHeaderValue() {
+    AwsS3BuildCache conf = new AwsS3BuildCache();
+    conf.setRegion("us-west-1");
+    conf.setBucket("my-bucket");
+    Map<String, String> headers = new HashMap<String, String>(){{
+      put("x-foo", null);
+    }};
+    conf.setHeaders(headers);
+
+    BuildCacheService service = subject.createBuildCacheService(conf, buildCacheDescriber);
+
+    assertNotNull(service);
+  }
+
   @Test(expected = IllegalStateException.class)
   public void testIllegalConfigWithoutRegion() throws Exception {
     AwsS3BuildCache conf = new AwsS3BuildCache();

version.properties

@@ -1,5 +1,5 @@
 #Currently building version
-version=0.7.1
+version=0.8.0
 
 #Previous version used to generate release notes delta
 previousVersion=0.7.0