Changing ProfileCredentialProvider to throw an exception when no prof…

…ile file can be found. Fixes #120
aws · Aug 25, 2017 · 57c44ce · 57c44ce
1 parent 01670ab
commit 57c44ce
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 5 deletions.
diff --git a/core/src/main/java/software/amazon/awssdk/auth/ProfileCredentialsProvider.java b/core/src/main/java/software/amazon/awssdk/auth/ProfileCredentialsProvider.java
@@ -17,6 +17,7 @@
 
 import java.io.File;
 import software.amazon.awssdk.AwsSystemSetting;
+import software.amazon.awssdk.SdkClientException;
 import software.amazon.awssdk.annotation.SdkTestInternalApi;
 import software.amazon.awssdk.auth.profile.ProfilesConfigFile;
 import software.amazon.awssdk.profile.path.AwsProfileFileLocationProvider;
@@ -70,7 +71,12 @@ public static Builder builder() {
 
     @Override
     protected AwsCredentials loadCredentials() {
-        return profilesConfigFile == null ? null : profilesConfigFile.getCredentials(profileName);
+        if (profilesConfigFile == null) {
+            throw new SdkClientException("Unable to find profile configuration file. If you are specifying a profile config "
+                                         + "file please verify it exists.");
+        }
+
+        return profilesConfigFile.getCredentials(profileName);
     }
 
     @Override

diff --git a/core/src/main/java/software/amazon/awssdk/client/BaseClientHandler.java b/core/src/main/java/software/amazon/awssdk/client/BaseClientHandler.java
@@ -19,6 +19,7 @@
 import software.amazon.awssdk.RequestConfig;
 import software.amazon.awssdk.SdkResponse;
 import software.amazon.awssdk.ServiceAdvancedConfiguration;
+import software.amazon.awssdk.auth.AwsCredentials;
 import software.amazon.awssdk.auth.AwsCredentialsProvider;
 import software.amazon.awssdk.config.AdvancedClientOption;
 import software.amazon.awssdk.config.ClientConfiguration;
@@ -34,6 +35,7 @@
 import software.amazon.awssdk.metrics.RequestMetricCollector;
 import software.amazon.awssdk.metrics.spi.AwsRequestMetrics;
 import software.amazon.awssdk.util.AwsRequestMetricsFullSupport;
+import software.amazon.awssdk.utils.Validate;
 
 abstract class BaseClientHandler {
     private final ClientConfiguration clientConfiguration;
@@ -54,11 +56,16 @@ ExecutionContext createExecutionContext(RequestConfig requestConfig) {
                 : clientConfiguration.credentialsProvider();
 
         ClientOverrideConfiguration overrideConfiguration = clientConfiguration.overrideConfiguration();
+
+        AwsCredentials credentials = credentialsProvider.getCredentials();
+
+        Validate.validState(credentials != null, "Credential providers must never return null.");
+
         ExecutionAttributes executionAttributes =
                 new ExecutionAttributes().putAttribute(AwsExecutionAttributes.SERVICE_ADVANCED_CONFIG,
                                                        serviceAdvancedConfiguration)
                                          .putAttribute(AwsExecutionAttributes.AWS_CREDENTIALS,
-                                                       credentialsProvider.getCredentials())
+                                                       credentials)
                                          .putAttribute(AwsExecutionAttributes.REQUEST_CONFIG, requestConfig);
 
         return ExecutionContext.builder()

diff --git a/core/src/main/java/software/amazon/awssdk/http/pipeline/stages/SigningStage.java b/core/src/main/java/software/amazon/awssdk/http/pipeline/stages/SigningStage.java
@@ -53,7 +53,7 @@ public SdkHttpFullRequest execute(SdkHttpFullRequest request, RequestExecutionCo
      * Sign the request if the signer if provided and credentials are present.
      */
     private SdkHttpFullRequest signRequest(SdkHttpFullRequest request, RequestExecutionContext context) {
-        final AwsCredentials credentials = context.credentialsProvider().getCredentials();
+        final AwsCredentials credentials = context.executionAttributes().getAttribute(AwsExecutionAttributes.AWS_CREDENTIALS);
         updateInterceptorContext(request, context.executionContext());
         Signer signer = newSigner(request, context);
         if (shouldSign(signer, credentials)) {

diff --git a/core/src/test/java/software/amazon/awssdk/auth/AwsCredentialsProviderChainTest.java b/core/src/test/java/software/amazon/awssdk/auth/AwsCredentialsProviderChainTest.java
@@ -78,6 +78,18 @@ public void testDisableReusingLastProvider() throws Exception {
         assertEquals(2, provider2.getCredentialsCallCount);
     }
 
+    @Test
+    public void testNullProfileFileUsesNextProvider() {
+        ProfileCredentialsProvider provider = ProfileCredentialsProvider.builder().defaultProfilesConfigFileLocator(() -> null).build();
+
+        MockCredentialsProvider provider2 = new MockCredentialsProvider();
+
+        AwsCredentialsProviderChain chain = AwsCredentialsProviderChain.builder().credentialsProviders(provider, provider2).build();
+
+        chain.getCredentials();
+        assertEquals(1, provider2.getCredentialsCallCount);
+    }
+
 
     private static final class MockCredentialsProvider extends StaticCredentialsProvider {
         public int getCredentialsCallCount = 0;

diff --git a/core/src/test/java/software/amazon/awssdk/auth/ProfileCredentialsProviderTest.java b/core/src/test/java/software/amazon/awssdk/auth/ProfileCredentialsProviderTest.java
@@ -22,6 +22,7 @@
 import org.junit.BeforeClass;
 import org.junit.Test;
 import software.amazon.awssdk.AwsSystemSetting;
+import software.amazon.awssdk.SdkClientException;
 import software.amazon.awssdk.auth.profile.ProfileResourceLoader;
 import software.amazon.awssdk.auth.profile.ProfilesConfigFile;
 
@@ -50,11 +51,12 @@ public void testDefault() {
         Assert.assertEquals("defaultAccessKey", credentials.secretAccessKey());
     }
 
-    @Test
+    @Test(expected = SdkClientException.class)
     public void testNoProfileFile() {
         ProfileCredentialsProvider nullProvider =
                 ProfileCredentialsProvider.builder().defaultProfilesConfigFileLocator(() -> null).build();
-        Assert.assertNull(nullProvider.loadCredentials());
+
+        nullProvider.getCredentials();
     }
 
     @Test

diff --git a/core/src/test/java/software/amazon/awssdk/client/SyncClientHandlerImplTest.java b/core/src/test/java/software/amazon/awssdk/client/SyncClientHandlerImplTest.java
@@ -118,6 +118,12 @@ public void failedExecutionCallsErrorResponseHandler() throws Exception {
         verifyNoMoreInteractions(responseHandler); // No response handler calls
     }
 
+    @Test(expected = IllegalStateException.class)
+    public void clientHandlerThrowsExceptionWhenCredentialProviderReturnsNull() {
+        when(credentialsProvider.getCredentials()).thenReturn(null);
+        syncClientHandler.execute(clientExecutionParams());
+    }
+
     private void expectRetrievalFromMocks() {
         when(credentialsProvider.getCredentials()).thenReturn(awsCredentials);
         when(requestConfig.getOriginalRequest()).thenReturn(request);