Refactor resolveRegion method name to getRegion for consistency.

awslabs · Jan 9, 2024 · c981525 · c981525
1 parent ed21c50
commit c981525
Show file tree

Hide file tree

Showing 9 changed files with 14 additions and 14 deletions.
diff --git a/Sources/Core/AWSClientRuntime/AWSClientConfiguration.swift b/Sources/Core/AWSClientRuntime/AWSClientConfiguration.swift
@@ -182,7 +182,7 @@ extension AWSClientConfiguration {
         if let region = region {
             resolvedRegion = region
         } else {
-            resolvedRegion = await resolvedRegionResolver.resolveRegion()
+            resolvedRegion = await resolvedRegionResolver.getRegion()
         }
         let resolvedCredentialsProvider: AWSClientRuntime.CredentialsProviding
         if let credentialsProvider = credentialsProvider {

diff --git a/Sources/Core/AWSClientRuntime/Regions/DefaultRegionResolver.swift b/Sources/Core/AWSClientRuntime/Regions/DefaultRegionResolver.swift
@@ -21,11 +21,11 @@ public struct DefaultRegionResolver: RegionResolver {
         self.logger = SwiftLogger(label: "DefaultRegionProvider")
     }
 
-    public func resolveRegion() async -> String? {
+    public func getRegion() async -> String? {
         for provider in providers {
             logger.debug("Attempting to resolve region with: \(String(describing: type(of: provider)))")
             do {
-                if let region = try await provider.resolveRegion() {
+                if let region = try await provider.getRegion() {
                     logger.debug("Resolved region with: \(String(describing: type(of: provider)))")
                     return region
                 }
@@ -49,7 +49,7 @@ public struct StaticRegionResolver: RegionResolver {
         self.region = region
     }
 
-    public func resolveRegion() async -> String? {
+    public func getRegion() async -> String? {
         return region
     }
 }
diff --git a/Sources/Core/AWSClientRuntime/Regions/EnvironmentRegionProvider.swift b/Sources/Core/AWSClientRuntime/Regions/EnvironmentRegionProvider.swift
@@ -14,7 +14,7 @@ public struct EnvironmentRegionProvider: RegionProvider {
         self.env = env
     }
 
-    public func resolveRegion() async throws -> String? {
+    public func getRegion() async throws -> String? {
         return env.environmentVariable(key: AWS_ENVIRON_REGION)
     }
 }

diff --git a/Sources/Core/AWSClientRuntime/Regions/IMDSRegionProvider.swift b/Sources/Core/AWSClientRuntime/Regions/IMDSRegionProvider.swift
@@ -14,7 +14,7 @@ public struct IMDSRegionProvider: RegionProvider {
         self.imdsClient = try IMDSClient()
     }
 
-    public func resolveRegion() async throws -> String? {
+    public func getRegion() async throws -> String? {
         return try await imdsClient.get(path: REGION_PATH)
     }
 }
diff --git a/Sources/Core/AWSClientRuntime/Regions/ProfileRegionProvider.swift b/Sources/Core/AWSClientRuntime/Regions/ProfileRegionProvider.swift
@@ -26,7 +26,7 @@ struct ProfileRegionProvider: RegionProvider {
         self.credentialsFilePath = credentialsFilePath
     }
 
-    func resolveRegion() async throws -> String? {
+    func getRegion() async throws -> String? {
         guard let configuration = try await fileBasedConfigurationProvider(
             configFilePath,
             credentialsFilePath

diff --git a/Sources/Core/AWSClientRuntime/Regions/RegionProvider.swift b/Sources/Core/AWSClientRuntime/Regions/RegionProvider.swift
@@ -7,5 +7,5 @@
 import AwsCommonRuntimeKit
 
 public protocol RegionProvider {
-    func resolveRegion() async throws -> String?
+    func getRegion() async throws -> String?
 }
diff --git a/Sources/Core/AWSClientRuntime/Regions/RegionResolver.swift b/Sources/Core/AWSClientRuntime/Regions/RegionResolver.swift
@@ -7,5 +7,5 @@
 
 public protocol RegionResolver {
     var providers: [RegionProvider] {get}
-    func resolveRegion() async -> String?
+    func getRegion() async -> String?
 }
diff --git a/Tests/Core/AWSClientRuntimeTests/Regions/DefaultRegionResolverTests.swift b/Tests/Core/AWSClientRuntimeTests/Regions/DefaultRegionResolverTests.swift
@@ -28,7 +28,7 @@ class DefaultRegionResolverTests: XCTestCase {
             let resolver = try DefaultRegionResolver(
                 fileBasedConfigurationProvider: fileBasedConfigProvider
             )
-            let region = await resolver.resolveRegion()
+            let region = await resolver.getRegion()
             XCTAssertEqual(region, "us-west-1")
         } catch {
             XCTFail("Failed to resolve region")
@@ -47,7 +47,7 @@ class DefaultRegionResolverTests: XCTestCase {
             let resolver = try DefaultRegionResolver(
                 fileBasedConfigurationProvider: fileBasedConfigProvider
             )
-            let region = await resolver.resolveRegion()
+            let region = await resolver.getRegion()
             XCTAssertEqual(region, "us-east-2")
         } catch {
             XCTFail("Failed to resolve region")

diff --git a/Tests/Core/AWSClientRuntimeTests/Regions/ProfileRegionProviderTests.swift b/Tests/Core/AWSClientRuntimeTests/Regions/ProfileRegionProviderTests.swift
@@ -23,7 +23,7 @@ class ProfileRegionProviderTests: XCTestCase {
             fileBasedConfigurationProvider: fileBasedConfigProvider,
             configFilePath: configPath
         )
-        let region = try! await provider.resolveRegion()
+        let region = try! await provider.getRegion()
         XCTAssertEqual(region, "us-east-2")
     }
 
@@ -33,7 +33,7 @@ class ProfileRegionProviderTests: XCTestCase {
             profileName: "west",
             configFilePath: configPath
         )
-        let region = try! await provider.resolveRegion()
+        let region = try! await provider.getRegion()
         XCTAssertEqual(region, "us-west-2")
     }
 
@@ -44,7 +44,7 @@ class ProfileRegionProviderTests: XCTestCase {
             },
             credentialsFilePath: configPath
         )
-        let region = try! await provider.resolveRegion()
+        let region = try! await provider.getRegion()
         XCTAssertEqual(region, "us-east-2")
     }
 }