feat: test-suite

Sources/ClientRuntime/Networking/Http/Middlewares/AuthSchemeMiddleware.swift

@@ -100,8 +100,7 @@ public struct AuthSchemeMiddleware<OperationStackOutput: HttpResponseBinding,
         }
 
         // Set the selected auth scheme in context for subsequent middleware access, then pass to next middleware in chain
-        return try await next.handle(
-            context: context.toBuilder().withSelectedAuthScheme(value: selectedAuthScheme).build(), input: input
-        )
+        context.attributes.set(key: AttributeKeys.selectedAuthScheme, value: selectedAuthScheme)
+        return try await next.handle(context: context, input: input)
     }
 }

Sources/SmithyTestUtil/RequestTestUtil/AuthTestUtil/MockAuthSchemeResolver.swift

@@ -0,0 +1,56 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Foundation
+import ClientRuntime
+
+public struct MockAuthSchemeResolverParameters: ClientRuntime.AuthSchemeResolverParameters {
+    public let operation: String
+}
+
+public protocol MockAuthSchemeResolver: ClientRuntime.AuthSchemeResolver {
+    // Intentionally empty.
+    // This is the parent protocol that all auth scheme resolver implementations of
+    // the service Mock must conform to.
+}
+
+public struct DefaultMockAuthSchemeResolver: MockAuthSchemeResolver {
+    public init () {}
+
+    public func resolveAuthScheme(params: ClientRuntime.AuthSchemeResolverParameters) throws -> [AuthOption] {
+        var validAuthOptions = Array<AuthOption>()
+        guard let serviceParams = params as? MockAuthSchemeResolverParameters else {
+            throw ClientError.authError("Service specific auth scheme parameters type must be passed to auth scheme resolver.")
+        }
+        switch serviceParams.operation {
+            case "authA":
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeA"))
+            case "authAB":
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeA"))
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeB"))
+            case "authABC":
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeA"))
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeB"))
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeC"))
+            case "authABCNoAuth":
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeA"))
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeB"))
+                validAuthOptions.append(AuthOption(schemeID: "MockAuthSchemeC"))
+                validAuthOptions.append(AuthOption(schemeID: "smithy.api#noAuth"))
+            default:
+                validAuthOptions.append(AuthOption(schemeID: "fillerAuth"))
+        }
+        return validAuthOptions
+    }
+
+    public func constructParameters(context: HttpContext) throws -> ClientRuntime.AuthSchemeResolverParameters {
+        guard let opName = context.getOperation() else {
+            throw ClientError.dataNotFound("Operation name not configured in middleware context for auth scheme resolver params construction.")
+        }
+        return MockAuthSchemeResolverParameters(operation: opName)
+    }
+}

Sources/SmithyTestUtil/RequestTestUtil/AuthTestUtil/MockAuthSchemes.swift

@@ -0,0 +1,56 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import ClientRuntime
+
+public struct MockAuthSchemeA: ClientRuntime.AuthScheme {
+    public let schemeID: String = "MockAuthSchemeA"
+    public let signer: ClientRuntime.Signer = MockSigner()
+    public let idKind: ClientRuntime.IdentityKind = .aws
+
+    public init() {}
+
+    public func customizeSigningProperties(signingProperties: ClientRuntime.Attributes, context: ClientRuntime.HttpContext) -> ClientRuntime.Attributes {
+        return signingProperties
+    }
+}
+
+public struct MockAuthSchemeB: ClientRuntime.AuthScheme {
+    public let schemeID: String = "MockAuthSchemeB"
+    public let signer: ClientRuntime.Signer = MockSigner()
+    public let idKind: ClientRuntime.IdentityKind = .aws
+
+    public init() {}
+
+    public func customizeSigningProperties(signingProperties: ClientRuntime.Attributes, context: ClientRuntime.HttpContext) -> ClientRuntime.Attributes {
+        return signingProperties
+    }
+}
+
+public struct MockAuthSchemeC: ClientRuntime.AuthScheme {
+    public let schemeID: String = "MockAuthSchemeC"
+    public let signer: ClientRuntime.Signer = MockSigner()
+    public let idKind: ClientRuntime.IdentityKind = .aws
+
+    public init() {}
+
+    public func customizeSigningProperties(signingProperties: ClientRuntime.Attributes, context: ClientRuntime.HttpContext) -> ClientRuntime.Attributes {
+        return signingProperties
+    }
+}
+
+public struct MockNoAuth: ClientRuntime.AuthScheme {
+    public let schemeID: String = "smithy.api#noAuth"
+    public let signer: ClientRuntime.Signer = MockSigner()
+    public let idKind: ClientRuntime.IdentityKind = .aws
+
+    public init() {}
+
+    public func customizeSigningProperties(signingProperties: ClientRuntime.Attributes, context: ClientRuntime.HttpContext) -> ClientRuntime.Attributes {
+        return signingProperties
+    }
+}

Sources/SmithyTestUtil/RequestTestUtil/AuthTestUtil/MockIdentity.swift

@@ -0,0 +1,21 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import ClientRuntime
+
+public struct MockIdentity: Identity {
+    public init() {}
+    public var expiration: ClientRuntime.Date? = nil
+}
+
+public struct MockIdentityResolver: IdentityResolver {
+    public typealias IdentityT = MockIdentity
+    public init() {}
+    public func getIdentity(identityProperties: ClientRuntime.Attributes?) async throws -> MockIdentity {
+        return MockIdentity()
+    }
+}

Sources/SmithyTestUtil/RequestTestUtil/AuthTestUtil/MockSigner.swift

@@ -0,0 +1,30 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import ClientRuntime
+import Foundation
+
+public struct MockSigner: ClientRuntime.Signer {
+    public init() {}
+
+    public func signRequest<IdentityT: Identity>(
+        requestBuilder: ClientRuntime.SdkHttpRequestBuilder,
+        identity: IdentityT,
+        signingProperties: ClientRuntime.Attributes
+    ) async throws -> ClientRuntime.SdkHttpRequestBuilder {
+        requestBuilder.withHeader(name: "Mock-Authorization", value: "Mock-Signed")
+        return requestBuilder
+    }
+
+    public func signEvent(
+        payload: Data,
+        previousSignature: String,
+        signingProperties: Attributes
+    ) async throws -> SigningResult<EventStream.Message> {
+        return SigningResult(output: EventStream.Message(), signature: "")
+    }
+}

Tests/ClientRuntimeTests/ClientRuntimeTests/NetworkingTests/Http/MiddlewareTests/AuthSchemeMiddlewareTests.swift

@@ -0,0 +1,136 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import XCTest
+import SmithyTestUtil
+@testable import ClientRuntime
+
+class AuthSchemeMiddlewareTests: XCTestCase {
+    private var contextBuilder: HttpContextBuilder!
+    private var operationStack: OperationStack<MockInput, MockOutput>!
+
+    override func setUp() async throws {
+        try await super.setUp()
+        contextBuilder = HttpContextBuilder()
+            .withAuthSchemeResolver(value: DefaultMockAuthSchemeResolver())
+            .withAuthScheme(value: MockNoAuth())
+            .withIdentityResolver(value: MockIdentityResolver(), type: .aws)
+        operationStack = OperationStack<MockInput, MockOutput>(id: "auth scheme middleware test stack")
+    }
+
+    // Test exception cases
+    func testNoAuthSchemeResolverConfigured() async throws {
+        contextBuilder.attributes.remove(key: AttributeKeys.authSchemeResolver)
+        contextBuilder.withOperation(value: "fillerOp")
+        do {
+            try await AssertSelectedAuthSchemeMatches(builtContext: contextBuilder.build(), expectedAuthScheme: "")
+        } catch ClientError.authError(let message) {
+            XCTAssertEqual(message, "No auth scheme resolver has been configured on the service.")
+        } catch {
+            XCTFail("Expected exception was not thrown.")
+        }
+    }
+
+    func testNoIdentityResolverConfigured() async throws {
+        contextBuilder.attributes.remove(key: AttributeKeys.identityResolvers)
+        contextBuilder.withOperation(value: "fillerOp")
+        do {
+            try await AssertSelectedAuthSchemeMatches(builtContext: contextBuilder.build(), expectedAuthScheme: "")
+        } catch ClientError.authError(let message) {
+            XCTAssertEqual(message, "No identity resolver has been configured on the service.")
+        } catch let error {
+            print(error)
+            XCTFail("Expected exception was not thrown.")
+        }
+    }
+
+    func testNoAuthSchemeCouldBeLoaded() async throws {
+        contextBuilder.withOperation(value: "fillerOp")
+        do {
+            try await AssertSelectedAuthSchemeMatches(builtContext: contextBuilder.build(), expectedAuthScheme: "")
+        } catch ClientError.authError(let message) {
+            XCTAssertEqual(message, "Could not resolve auth scheme for the operation call. Log: Auth scheme fillerAuth was not enabled for this request.")
+        } catch {
+            XCTFail("Expected exception was not thrown.")
+        }
+    }
+
+    // Test success cases
+    func testOnlyAuthSchemeA() async throws {
+        let context = contextBuilder
+            .withOperation(value: "authA")
+            .withAuthScheme(value: MockAuthSchemeA())
+            .build()
+        try await AssertSelectedAuthSchemeMatches(builtContext: context, expectedAuthScheme: "MockAuthSchemeA")
+    }
+
+    func testAuthOrderABSelectA() async throws {
+        let context = contextBuilder
+            .withOperation(value: "authAB")
+            .withAuthScheme(value: MockAuthSchemeA())
+            .withAuthScheme(value: MockAuthSchemeB())
+            .build()
+        try await AssertSelectedAuthSchemeMatches(builtContext: context, expectedAuthScheme: "MockAuthSchemeA")
+    }
+
+    func testAuthOrderABSelectB() async throws {
+        let context = contextBuilder
+            .withOperation(value: "authAB")
+            .withAuthScheme(value: MockAuthSchemeB())
+            .build()
+        try await AssertSelectedAuthSchemeMatches(builtContext: context, expectedAuthScheme: "MockAuthSchemeB")
+    }
+
+    func testAuthOrderABCSelectA() async throws {
+        let context = contextBuilder
+            .withOperation(value: "authABC")
+            .withAuthScheme(value: MockAuthSchemeA())
+            .withAuthScheme(value: MockAuthSchemeB())
+            .withAuthScheme(value: MockAuthSchemeC())
+            .build()
+        try await AssertSelectedAuthSchemeMatches(builtContext: context, expectedAuthScheme: "MockAuthSchemeA")
+    }
+
+    func testAuthOrderABCSelectB() async throws {
+        let context = contextBuilder
+            .withOperation(value: "authABC")
+            .withAuthScheme(value: MockAuthSchemeB())
+            .withAuthScheme(value: MockAuthSchemeC())
+            .build()
+        try await AssertSelectedAuthSchemeMatches(builtContext: context, expectedAuthScheme: "MockAuthSchemeB")
+    }
+
+    func testAuthOrderABCSelectC() async throws {
+        let context = contextBuilder
+            .withOperation(value: "authABC")
+            .withAuthScheme(value: MockAuthSchemeC())
+            .build()
+        try await AssertSelectedAuthSchemeMatches(builtContext: context, expectedAuthScheme: "MockAuthSchemeC")
+    }
+
+    func testAuthOderABCNoAuthSelectNoAuth() async throws {
+        let context = contextBuilder
+            .withOperation(value: "authABCNoAuth")
+            .build()
+        try await AssertSelectedAuthSchemeMatches(builtContext: context, expectedAuthScheme: "smithy.api#noAuth")
+    }
+
+    private func AssertSelectedAuthSchemeMatches(builtContext: HttpContext, expectedAuthScheme: String) async throws {
+        operationStack.buildStep.intercept(position: .before, middleware: AuthSchemeMiddleware<MockOutput, MockMiddlewareError>())
+
+        let mockHandler = MockHandler(handleCallback: { (context, input) in
+            let selectedAuthScheme = context.getSelectedAuthScheme()
+            XCTAssertEqual(expectedAuthScheme, selectedAuthScheme?.schemeID)
+            let httpResponse = HttpResponse(body: .noStream, statusCode: HttpStatusCode.ok)
+            let mockOutput = try! MockOutput(httpResponse: httpResponse, decoder: nil)
+            let output = OperationOutput<MockOutput>(httpResponse: httpResponse, output: mockOutput)
+            return output
+        })
+
+        _ = try await operationStack.handleMiddleware(context: builtContext, input: MockInput(), next: mockHandler)
+    }
+}