feat(rt): detect region from active AWS profile (#344)

Author: aajtodd

aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChain.kt

@@ -6,6 +6,8 @@
 package aws.sdk.kotlin.runtime.region
 
 import aws.smithy.kotlin.runtime.io.Closeable
+import aws.smithy.kotlin.runtime.util.Platform
+import aws.smithy.kotlin.runtime.util.PlatformProvider
 
 /**
  * [RegionProvider] that looks for region in this order:
@@ -14,4 +16,6 @@ import aws.smithy.kotlin.runtime.io.Closeable
  *  3. Check the AWS config files/profile for region information
  *  4. If running on EC2, check the EC2 metadata service for region
  */
-public expect class DefaultRegionProviderChain public constructor() : RegionProvider, Closeable
+public expect class DefaultRegionProviderChain public constructor(
+    platformProvider: PlatformProvider = Platform
+) : RegionProvider, Closeable

aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/EnvironmentRegionProvider.kt

@@ -13,10 +13,8 @@ import aws.smithy.kotlin.runtime.util.Platform
  * [RegionProvider] that checks `AWS_REGION` region environment variable
  * @param environ the environment mapping to lookup keys in (defaults to the system environment)
  */
-public class EnvironmentRegionProvider(
-    private val environ: EnvironmentProvider
+internal class EnvironmentRegionProvider(
+    private val environ: EnvironmentProvider = Platform
 ) : RegionProvider {
-    public constructor() : this(Platform)
-
     override suspend fun getRegion(): String? = environ.getenv(AwsSdkSetting.AwsRegion.environmentVariable)
 }

aws-runtime/aws-config/common/src/aws/sdk/kotlin/runtime/region/ProfileRegionProvider.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+package aws.sdk.kotlin.runtime.region
+
+import aws.sdk.kotlin.runtime.config.profile.loadActiveAwsProfile
+import aws.sdk.kotlin.runtime.config.profile.region
+import aws.smithy.kotlin.runtime.util.Platform
+import aws.smithy.kotlin.runtime.util.PlatformProvider
+import aws.smithy.kotlin.runtime.util.asyncLazy
+
+/**
+ * [RegionProvider] that sources region information from the active profile
+ */
+internal class ProfileRegionProvider(
+    private val platformProvider: PlatformProvider = Platform
+) : RegionProvider {
+    private val profile = asyncLazy { loadActiveAwsProfile(platformProvider) }
+
+    override suspend fun getRegion(): String? = profile.get().region
+}

aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainTest.kt

@@ -0,0 +1,129 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+package aws.sdk.kotlin.runtime.region
+
+import aws.sdk.kotlin.runtime.testing.TestPlatformProvider
+import aws.sdk.kotlin.runtime.testing.runSuspendTest
+import kotlinx.serialization.json.*
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class DefaultRegionProviderChainTest {
+    private data class RegionProviderChainTest(
+        val name: String,
+        val platformProvider: TestPlatformProvider,
+        val region: String?,
+        val targets: List<String> = emptyList()
+    )
+
+    @Test
+    fun testSuite(): Unit = runSuspendTest {
+        val tests = Json.parseToJsonElement(regionProviderChainTestSuite).jsonArray
+            .map { it.jsonObject }
+            .map {
+                val name = it["name"]!!.jsonPrimitive.content
+                val platform = TestPlatformProvider.fromJsonNode(it["platform"]!!.jsonObject)
+                val region = it["region"]!!.jsonPrimitive.contentOrNull
+                RegionProviderChainTest(name, platform, region)
+            }
+
+        tests.forEach { test ->
+            val provider = DefaultRegionProviderChain(test.platformProvider)
+            val actual = provider.getRegion()
+            assertEquals(test.region, actual, test.name)
+        }
+    }
+}
+
+/**
+ * Construct a [TestPlatformProvider] from a JSON node like:
+ *
+ * ```json
+ * {
+ *     "env": {
+ *         "ENV_VAR": "value"
+ *     },
+ *     "props": {
+ *         "aws.property": "value"
+ *     },
+ *     "fs": {
+ *         "filename": "contents"
+ *     }
+ * }
+ * ```
+ */
+fun TestPlatformProvider.Companion.fromJsonNode(obj: JsonObject): TestPlatformProvider {
+    val env = obj["env"]?.jsonObject?.mapValues { it.value.jsonPrimitive.content } ?: emptyMap()
+    val props = obj["props"]?.jsonObject?.mapValues { it.value.jsonPrimitive.content } ?: emptyMap()
+    val fs = obj["fs"]?.jsonObject?.mapValues { it.value.jsonPrimitive.content } ?: emptyMap()
+    return TestPlatformProvider(env, props, fs)
+}
+
+// language=JSON
+private const val regionProviderChainTestSuite = """
+[
+    {
+        "name": "no region configured",
+        "platform": {
+            "env": {},
+            "props": {},
+            "fs": {}
+        },
+        "region": null
+    },
+    {
+        "name": "environment configured",
+        "platform": {
+            "env": {
+                "AWS_REGION": "us-east-2"
+            },
+            "props": {},
+            "fs": {}
+        },
+        "region": "us-east-2"
+    },
+    {
+        "name": "jvm property is favored",
+        "platform": {
+            "env": {
+                "AWS_REGION": "us-east-2"
+            },
+            "props": {
+                "aws.region": "us-west-1"
+            },
+            "fs": {}
+        },
+        "region": "us-west-1"
+    },
+    {
+        "name": "default profile",
+        "platform": {
+            "env": {
+              "AWS_CONFIG_FILE": "config"
+            },
+            "props": {},
+            "fs": {
+              "config": "[default]\nregion = us-east-2"
+            }
+        },
+        "region": "us-east-2"
+    },
+    {
+        "name": "explicit profile",
+        "platform": {
+            "env": {
+              "AWS_CONFIG_FILE": "config",
+              "AWS_PROFILE": "test-profile"
+            },
+            "props": {},
+            "fs": {
+              "config": "[default]\nregion = us-east-2\n[profile test-profile]\nregion = us-west-1"
+            }
+        },
+        "region": "us-west-1"
+    }
+]
+"""

aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/region/ProfileRegionProviderTest.kt

@@ -0,0 +1,59 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+package aws.sdk.kotlin.runtime.region
+
+import aws.sdk.kotlin.runtime.testing.TestPlatformProvider
+import aws.sdk.kotlin.runtime.testing.runSuspendTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class ProfileRegionProviderTest {
+    @Test
+    fun testSuccessDefaultProfile(): Unit = runSuspendTest {
+        val platform = TestPlatformProvider(
+            env = mapOf(
+                "AWS_CONFIG_FILE" to "config"
+            ),
+            fs = mapOf(
+                "config" to "[default]\nregion = us-east-2"
+            )
+        )
+
+        val provider = ProfileRegionProvider(platform)
+        assertEquals("us-east-2", provider.getRegion())
+    }
+
+    @Test
+    fun testSuccessProfileOverride(): Unit = runSuspendTest {
+        val platform = TestPlatformProvider(
+            env = mapOf(
+                "AWS_CONFIG_FILE" to "config",
+                "AWS_PROFILE" to "test-profile"
+            ),
+            fs = mapOf(
+                "config" to "[default]\nregion = us-east-2\n[profile test-profile]\nregion = us-west-2"
+            )
+        )
+
+        val provider = ProfileRegionProvider(platform)
+        assertEquals("us-west-2", provider.getRegion())
+    }
+
+    @Test
+    fun testNoRegion(): Unit = runSuspendTest {
+        val platform = TestPlatformProvider(
+            env = mapOf(
+                "AWS_CONFIG_FILE" to "config",
+            ),
+            fs = mapOf(
+                "config" to "[default]\naccess_key_id=AKID"
+            )
+        )
+
+        val provider = ProfileRegionProvider(platform)
+        assertEquals(null, provider.getRegion())
+    }
+}

aws-runtime/aws-config/common/test/aws/sdk/kotlin/runtime/region/ResolveRegionTest.kt

@@ -14,16 +14,17 @@ import kotlin.test.assertEquals
 class ResolveRegionTest {
 
     @Test
-    fun `it resolves region for operation`() = runSuspendTest {
+    fun testResolutionOrder() = runSuspendTest {
         // from context
         val config = object : RegionConfig {
             override val region: String = "us-west-2"
         }
 
+        // context has highest priority
         val actual = resolveRegionForOperation(ctx = ExecutionContext().apply { set(AwsClientOption.Region, "us-east-1") }, config)
         assertEquals("us-east-1", actual)
 
-        // from config
+        // from config is next
         val actual2 = resolveRegionForOperation(ExecutionContext(), config)
         assertEquals("us-west-2", actual2)
     }

aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/DefaultRegionProviderChainJVM.kt

@@ -6,16 +6,19 @@
 package aws.sdk.kotlin.runtime.region
 
 import aws.smithy.kotlin.runtime.io.Closeable
+import aws.smithy.kotlin.runtime.util.PlatformProvider
 
-public actual class DefaultRegionProviderChain public actual constructor() :
-    RegionProvider,
+public actual class DefaultRegionProviderChain public actual constructor(
+    platformProvider: PlatformProvider
+) : RegionProvider,
     Closeable,
     RegionProviderChain(
-        JvmSystemPropRegionProvider(),
-        EnvironmentRegionProvider(),
-        // TODO - profile
-        ImdsRegionProvider()
+        JvmSystemPropRegionProvider(platformProvider),
+        EnvironmentRegionProvider(platformProvider),
+        ProfileRegionProvider(platformProvider),
+        ImdsRegionProvider(platformProvider = platformProvider)
     ) {
+
     override fun close() {
         providers.forEach { provider ->
             if (provider is Closeable) provider.close()

aws-runtime/aws-config/jvm/src/aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProvider.kt

@@ -6,10 +6,13 @@
 package aws.sdk.kotlin.runtime.region
 
 import aws.sdk.kotlin.runtime.config.AwsSdkSetting
+import aws.smithy.kotlin.runtime.util.PropertyProvider
 
 /**
  * [RegionProvider] that checks `aws.region` system property
  */
-internal class JvmSystemPropRegionProvider : RegionProvider {
-    override suspend fun getRegion(): String? = System.getProperty(AwsSdkSetting.AwsRegion.jvmProperty, null)
+internal class JvmSystemPropRegionProvider(
+    private val propertyProvider: PropertyProvider
+) : RegionProvider {
+    override suspend fun getRegion(): String? = propertyProvider.getProperty(AwsSdkSetting.AwsRegion.jvmProperty)
 }

aws-runtime/aws-config/jvm/test/aws/sdk/kotlin/runtime/region/JvmSystemPropRegionProviderTest.kt

@@ -5,7 +5,7 @@
 
 package aws.sdk.kotlin.runtime.region
 
-import aws.sdk.kotlin.runtime.config.AwsSdkSetting
+import aws.sdk.kotlin.runtime.testing.TestPlatformProvider
 import aws.sdk.kotlin.runtime.testing.runSuspendTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -15,11 +15,15 @@ class JvmSystemPropRegionProviderTest {
 
     @Test
     fun testGetRegion() = runSuspendTest {
-        val provider = JvmSystemPropRegionProvider()
+        val provider = JvmSystemPropRegionProvider(TestPlatformProvider())
 
         assertNull(provider.getRegion())
 
-        System.setProperty(AwsSdkSetting.AwsRegion.jvmProperty, "us-east-1")
-        assertEquals("us-east-1", provider.getRegion())
+        val provider2 = JvmSystemPropRegionProvider(
+            TestPlatformProvider(
+                props = mapOf("aws.region" to "us-east-1")
+            )
+        )
+        assertEquals("us-east-1", provider2.getRegion())
     }
 }

aws-runtime/testing/common/src/aws/sdk/kotlin/runtime/testing/TestPlatformProvider.kt

@@ -23,6 +23,9 @@ public class TestPlatformProvider(
     private val fs: Map<String, String> = emptyMap(),
     private val os: OperatingSystem = OperatingSystem(OsFamily.Linux, "test")
 ) : PlatformProvider, Filesystem by Filesystem.fromMap(fs.mapValues { it.value.encodeToByteArray() }) {
+
+    public companion object;
+
     // ensure HOME directory is set for path normalization. this is mostly for AWS config loader behavior
     private val env = if (env.containsKey("HOME")) env else env.toMutableMap().apply { put("HOME", "/users/test") }
     override val filePathSeparator: String