Include the root causes in the exception message of getCredentials to…

… ease troubleshooting.
aws · Mar 13, 2018 · 05d9bcf · 05d9bcf
1 parent 2d1d720
commit 05d9bcf
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 4 deletions.
diff --git a/aws-java-sdk-core/src/main/java/com/amazonaws/auth/AWSCredentialsProviderChain.java b/aws-java-sdk-core/src/main/java/com/amazonaws/auth/AWSCredentialsProviderChain.java
@@ -105,11 +105,13 @@ public void setReuseLastProvider(boolean b) {
         this.reuseLastProvider = b;
     }
 
+    @Override
     public AWSCredentials getCredentials() {
         if (reuseLastProvider && lastUsedProvider != null) {
             return lastUsedProvider.getCredentials();
         }
 
+        List<String> exceptionMessages = new LinkedList<String>();
         for (AWSCredentialsProvider provider : credentialsProviders) {
             try {
                 AWSCredentials credentials = provider.getCredentials();
@@ -123,14 +125,17 @@ public AWSCredentials getCredentials() {
                 }
             } catch (Exception e) {
                 // Ignore any exceptions and move onto the next provider
-                log.debug("Unable to load credentials from " + provider.toString() +
-                          ": " + e.getMessage());
+                String message = provider + ": " + e.getMessage();
+                log.debug("Unable to load credentials from " + message);
+                exceptionMessages.add(message);
             }
         }
 
-        throw new SdkClientException("Unable to load AWS credentials from any provider in the chain");
+        throw new SdkClientException("Unable to load AWS credentials from any provider in the chain: "
+                + exceptionMessages);
     }
 
+    @Override
     public void refresh() {
         for (AWSCredentialsProvider provider : credentialsProviders) {
             provider.refresh();

diff --git a/aws-java-sdk-core/src/test/java/com/amazonaws/auth/AWSCredentialsProviderChainTest.java b/aws-java-sdk-core/src/test/java/com/amazonaws/auth/AWSCredentialsProviderChainTest.java
@@ -22,12 +22,18 @@
 
 import java.util.Arrays;
 
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.rules.ExpectedException;
 
+import com.amazonaws.SdkClientException;
 import com.amazonaws.internal.StaticCredentialsProvider;
 
 public class AWSCredentialsProviderChainTest {
 
+    @Rule
+    public ExpectedException thrown = ExpectedException.none();
+
     /**
      * Tests that, by default, the chain remembers which provider was able to
      * provide credentials, and only calls that provider for any additional
@@ -81,20 +87,43 @@ public void testDisableReusingLastProvider() throws Exception {
         assertEquals(2, provider2.getCredentialsCallCount);
     }
 
+    /**
+     * Tests that getCredentials throws an thrown if all providers in the
+     * chain fail to provide credentials.
+     */
+    @Test
+    public void testGetCredentialsException() {
+        MockCredentialsProvider provider1 = new MockCredentialsProvider("Failed!");
+        MockCredentialsProvider provider2 = new MockCredentialsProvider("Bad!");
+        AWSCredentialsProviderChain chain = new AWSCredentialsProviderChain(provider1, provider2);
+
+        thrown.expect(SdkClientException.class);
+        thrown.expectMessage(provider1.exceptionMessage);
+        thrown.expectMessage(provider2.exceptionMessage);
+
+        chain.getCredentials();
+    }
 
     private static final class MockCredentialsProvider extends StaticCredentialsProvider {
         public int getCredentialsCallCount = 0;
         public boolean throwException = false;
+        public String exceptionMessage = "No credentials";
 
         public MockCredentialsProvider() {
             super(new BasicAWSCredentials("accessKey", "secretKey"));
         }
 
+        public MockCredentialsProvider(String exceptionMessage) {
+            this();
+            this.exceptionMessage = exceptionMessage;
+            this.throwException = true;
+        }
+
         @Override
         public AWSCredentials getCredentials() {
             getCredentialsCallCount++;
 
-            if (throwException) throw new RuntimeException("No credentials");
+            if (throwException) throw new RuntimeException(exceptionMessage);
             else return super.getCredentials();
         }
     }