Remove sdk-core dependency from profiles module.

millems · millems · commit 587e08047530 · 2018-08-01T14:02:25.000-07:00
diff --git a/.changes/next-release/feature-AWSSDKforJavav2-926e183.json b/.changes/next-release/feature-AWSSDKforJavav2-926e183.json
@@ -0,0 +1,5 @@
+{
+    "category": "AWS SDK for Java v2", 
+    "type": "feature", 
+    "description": "Removed sdk-core dependency from the profiles module. This allows reading from profile files without pulling in the rest of the SDK."
+}
diff --git a/core/auth/src/main/java/software/amazon/awssdk/auth/credentials/ProfileCredentialsProvider.java b/core/auth/src/main/java/software/amazon/awssdk/auth/credentials/ProfileCredentialsProvider.java
@@ -24,6 +24,7 @@
 import software.amazon.awssdk.core.SdkSystemSetting;
 import software.amazon.awssdk.core.exception.SdkClientException;
 import software.amazon.awssdk.profiles.ProfileFile;
+import software.amazon.awssdk.profiles.ProfileFileSystemSetting;
 import software.amazon.awssdk.utils.IoUtils;
 import software.amazon.awssdk.utils.SdkAutoCloseable;
 import software.amazon.awssdk.utils.ToString;
@@ -52,7 +53,7 @@ public final class ProfileCredentialsProvider implements AwsCredentialsProvider,
      */
     private ProfileCredentialsProvider(BuilderImpl builder) {
         this.profileName = builder.profileName != null ? builder.profileName
-                                                       : SdkSystemSetting.AWS_PROFILE.getStringValueOrThrow();
+                                                       : ProfileFileSystemSetting.AWS_PROFILE.getStringValueOrThrow();
 
         // Load the profiles file
         this.profileFile = Optional.ofNullable(builder.profileFile)
diff --git a/core/profiles/pom.xml b/core/profiles/pom.xml
@@ -43,11 +43,6 @@
             <artifactId>annotations</artifactId>
             <version>${awsjavasdk.version}</version>
         </dependency>
-        <dependency>
-            <groupId>software.amazon.awssdk</groupId>
-            <artifactId>sdk-core</artifactId>
-            <version>${awsjavasdk.version}</version>
-        </dependency>
         <dependency>
             <groupId>software.amazon.awssdk</groupId>
             <artifactId>test-utils</artifactId>
diff --git a/core/profiles/src/main/java/software/amazon/awssdk/profiles/ProfileFile.java b/core/profiles/src/main/java/software/amazon/awssdk/profiles/ProfileFile.java
@@ -28,7 +28,6 @@
 import java.util.Objects;
 import java.util.Optional;
 import software.amazon.awssdk.annotations.SdkPublicApi;
-import software.amazon.awssdk.core.SdkSystemSetting;
 import software.amazon.awssdk.profiles.internal.ProfileFileReader;
 import software.amazon.awssdk.utils.FunctionalUtils;
 import software.amazon.awssdk.utils.IoUtils;
@@ -80,8 +79,8 @@ public static Aggregator aggregator() {
     /**
      * Get the default profile file, using the credentials file from "~/.aws/credentials", the config file from "~/.aws/config"
      * and the "default" profile. This default behavior can be customized using the
-     * {@link SdkSystemSetting#AWS_SHARED_CREDENTIALS_FILE}, {@link SdkSystemSetting#AWS_CONFIG_FILE} and
-     * {@link SdkSystemSetting#AWS_PROFILE} settings or by specifying a different profile file and profile name
+     * {@link ProfileFileSystemSetting#AWS_SHARED_CREDENTIALS_FILE}, {@link ProfileFileSystemSetting#AWS_CONFIG_FILE} and
+     * {@link ProfileFileSystemSetting#AWS_PROFILE} settings or by specifying a different profile file and profile name
      */
     public static ProfileFile defaultProfileFile() {
         return ProfileFile.aggregator()
diff --git a/core/profiles/src/main/java/software/amazon/awssdk/profiles/ProfileFileLocation.java b/core/profiles/src/main/java/software/amazon/awssdk/profiles/ProfileFileLocation.java
@@ -23,7 +23,6 @@
 import java.util.regex.Pattern;
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.annotations.SdkPublicApi;
-import software.amazon.awssdk.core.SdkSystemSetting;
 import software.amazon.awssdk.utils.JavaSystemSetting;
 import software.amazon.awssdk.utils.StringUtils;
 
@@ -44,9 +43,9 @@ private ProfileFileLocation() {
      */
     public static Optional<Path> configurationFileLocation() {
         return resolveProfileFilePath(
-            SdkSystemSetting.AWS_CONFIG_FILE.getStringValue()
-                                            .orElse(Paths.get(ProfileFileLocation.userHomeDirectory(),
-                                                              ".aws", "config").toString()));
+                ProfileFileSystemSetting.AWS_CONFIG_FILE.getStringValue()
+                                                        .orElse(Paths.get(ProfileFileLocation.userHomeDirectory(),
+                                                                          ".aws", "config").toString()));
     }
 
     /**
@@ -55,9 +54,9 @@ public static Optional<Path> configurationFileLocation() {
      */
     public static Optional<Path> credentialsFileLocation() {
         return resolveProfileFilePath(
-            SdkSystemSetting.AWS_SHARED_CREDENTIALS_FILE.getStringValue()
-                                                        .orElse(Paths.get(userHomeDirectory(),
-                                                                          ".aws", "credentials").toString()));
+                ProfileFileSystemSetting.AWS_SHARED_CREDENTIALS_FILE.getStringValue()
+                                                                    .orElse(Paths.get(userHomeDirectory(),
+                                                                                      ".aws", "credentials").toString()));
     }
 
     /**
diff --git a/core/profiles/src/main/java/software/amazon/awssdk/profiles/ProfileFileSystemSetting.java b/core/profiles/src/main/java/software/amazon/awssdk/profiles/ProfileFileSystemSetting.java
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.profiles;
+
+import software.amazon.awssdk.annotations.SdkProtectedApi;
+import software.amazon.awssdk.utils.SystemSetting;
+
+/**
+ * System settings for loading configuration from profile files.
+ */
+@SdkProtectedApi
+public enum ProfileFileSystemSetting implements SystemSetting {
+    /**
+     * Configure the default configuration file used in the ProfileFile. When not explicitly
+     * overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an
+     * AWS client is created.
+     *
+     * See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the
+     * SDK via a configuration file.
+     */
+    AWS_CONFIG_FILE("aws.configFile", null),
+
+    /**
+     * Configure the default credentials file used in the ProfileFile. When not explicitly
+     * overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an
+     * AWS client is created.
+     *
+     * See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the
+     * SDK via a credentials file.
+     */
+    AWS_SHARED_CREDENTIALS_FILE("aws.sharedCredentialsFile", null),
+
+    /**
+     * Configure the default profile that should be loaded from the {@link #AWS_CONFIG_FILE}
+     *
+     * @see #AWS_CONFIG_FILE
+     */
+    AWS_PROFILE("aws.profile", "default");
+
+    private final String systemProperty;
+    private final String defaultValue;
+
+    ProfileFileSystemSetting(String systemProperty, String defaultValue) {
+        this.systemProperty = systemProperty;
+        this.defaultValue = defaultValue;
+    }
+
+    @Override
+    public String property() {
+        return systemProperty;
+    }
+
+    @Override
+    public String environmentVariable() {
+        return name();
+    }
+
+    @Override
+    public String defaultValue() {
+        return defaultValue;
+    }
+}
diff --git a/core/regions/src/main/java/software/amazon/awssdk/regions/providers/AwsProfileRegionProvider.java b/core/regions/src/main/java/software/amazon/awssdk/regions/providers/AwsProfileRegionProvider.java
@@ -16,9 +16,9 @@
 package software.amazon.awssdk.regions.providers;
 
 import software.amazon.awssdk.annotations.SdkProtectedApi;
-import software.amazon.awssdk.core.SdkSystemSetting;
 import software.amazon.awssdk.core.exception.SdkClientException;
 import software.amazon.awssdk.profiles.ProfileFile;
+import software.amazon.awssdk.profiles.ProfileFileSystemSetting;
 import software.amazon.awssdk.profiles.ProfileProperty;
 import software.amazon.awssdk.regions.Region;
 
@@ -28,7 +28,7 @@
 @SdkProtectedApi
 public final class AwsProfileRegionProvider implements AwsRegionProvider {
 
-    private final String profileName = SdkSystemSetting.AWS_PROFILE.getStringValueOrThrow();
+    private final String profileName = ProfileFileSystemSetting.AWS_PROFILE.getStringValueOrThrow();
 
     @Override
     public Region getRegion() {
diff --git a/core/regions/src/test/java/software/amazon/awssdk/regions/providers/AwsProfileRegionProviderTest.java b/core/regions/src/test/java/software/amazon/awssdk/regions/providers/AwsProfileRegionProviderTest.java
@@ -22,8 +22,8 @@
 import java.nio.file.Paths;
 import org.junit.Rule;
 import org.junit.Test;
-import software.amazon.awssdk.core.SdkSystemSetting;
 import software.amazon.awssdk.core.exception.SdkClientException;
+import software.amazon.awssdk.profiles.ProfileFileSystemSetting;
 import software.amazon.awssdk.regions.Region;
 import software.amazon.awssdk.testutils.EnvironmentVariableHelper;
 
@@ -34,8 +34,8 @@ public class AwsProfileRegionProviderTest {
 
     @Test
     public void nonExistentDefaultConfigFile_ThrowsException() {
-        settingsHelper.set(SdkSystemSetting.AWS_CONFIG_FILE, "/var/tmp/this/is/invalid.txt");
-        settingsHelper.set(SdkSystemSetting.AWS_SHARED_CREDENTIALS_FILE, "/var/tmp/this/is/also.invalid.txt");
+        settingsHelper.set(ProfileFileSystemSetting.AWS_CONFIG_FILE, "/var/tmp/this/is/invalid.txt");
+        settingsHelper.set(ProfileFileSystemSetting.AWS_SHARED_CREDENTIALS_FILE, "/var/tmp/this/is/also.invalid.txt");
         assertThatThrownBy(() -> new AwsProfileRegionProvider().getRegion())
             .isInstanceOf(SdkClientException.class)
             .hasMessageContaining("No region provided in profile: default");
@@ -45,8 +45,8 @@ public void nonExistentDefaultConfigFile_ThrowsException() {
     public void profilePresentAndRegionIsSet_ProvidesCorrectRegion() throws URISyntaxException {
         String testFile = "/profileconfig/test-profiles.tst";
 
-        settingsHelper.set(SdkSystemSetting.AWS_PROFILE, "test");
-        settingsHelper.set(SdkSystemSetting.AWS_CONFIG_FILE, Paths.get(getClass().getResource(testFile).toURI()).toString());
+        settingsHelper.set(ProfileFileSystemSetting.AWS_PROFILE, "test");
+        settingsHelper.set(ProfileFileSystemSetting.AWS_CONFIG_FILE, Paths.get(getClass().getResource(testFile).toURI()).toString());
         assertThat(new AwsProfileRegionProvider().getRegion()).isEqualTo(Region.of("saa"));
     }
 }
diff --git a/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkSystemSetting.java b/core/sdk-core/src/main/java/software/amazon/awssdk/core/SdkSystemSetting.java
@@ -23,34 +23,6 @@
  */
 @SdkProtectedApi
 public enum SdkSystemSetting implements SystemSetting {
-
-    /**
-     * Configure the default configuration file used in the ProfileFile. When not explicitly
-     * overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an
-     * AWS client is created.
-     *
-     * See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the
-     * SDK via a configuration file.
-     */
-    AWS_CONFIG_FILE("aws.configFile", null),
-
-    /**
-     * Configure the default profile that should be loaded from the {@link #AWS_CONFIG_FILE}
-     *
-     * @see #AWS_CONFIG_FILE
-     */
-    AWS_PROFILE("aws.profile", "default"),
-
-    /**
-     * Configure the default credentials file used in the ProfileFile. When not explicitly
-     * overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an
-     * AWS client is created.
-     *
-     * See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the
-     * SDK via a credentials file.
-     */
-    AWS_SHARED_CREDENTIALS_FILE("aws.sharedCredentialsFile", null),
-
     /**
      * Configure the AWS access key ID.
      *
