|
| 1 | +// |
| 2 | +// Copyright Amazon.com Inc. or its affiliates. |
| 3 | +// All Rights Reserved. |
| 4 | +// |
| 5 | +// SPDX-License-Identifier: Apache-2.0 |
| 6 | +// |
| 7 | + |
| 8 | +import XCTest |
| 9 | +import AWSCognitoIdentity |
| 10 | +@testable import Amplify |
| 11 | +@testable import AWSCognitoAuthPlugin |
| 12 | +import AWSCognitoIdentityProvider |
| 13 | +import ClientRuntime |
| 14 | + |
| 15 | +class AWSAuthSignInOptionsTestCase: BasePluginTest { |
| 16 | + override var initialState: AuthState { |
| 17 | + AuthState.configured(.signedOut(.init(lastKnownUserName: nil)), .configured) |
| 18 | + } |
| 19 | + |
| 20 | + override func setUp() { |
| 21 | + super.setUp() |
| 22 | + mockIdentityProvider = MockIdentityProvider(mockInitiateAuthResponse: { _ in |
| 23 | + InitiateAuthOutputResponse( |
| 24 | + authenticationResult: .none, |
| 25 | + challengeName: .passwordVerifier, |
| 26 | + challengeParameters: InitiateAuthOutputResponse.validChalengeParams, |
| 27 | + session: "someSession") |
| 28 | + }, mockRespondToAuthChallengeResponse: { _ in |
| 29 | + RespondToAuthChallengeOutputResponse( |
| 30 | + authenticationResult: .init( |
| 31 | + accessToken: Defaults.validAccessToken, |
| 32 | + expiresIn: 300, |
| 33 | + idToken: "idToken", |
| 34 | + newDeviceMetadata: nil, |
| 35 | + refreshToken: "refreshToken", |
| 36 | + tokenType: ""), |
| 37 | + challengeName: .none, |
| 38 | + challengeParameters: [:], |
| 39 | + session: "session") |
| 40 | + }) |
| 41 | + } |
| 42 | + |
| 43 | + /// - Given: A sign in task |
| 44 | + /// - When: `metadata` is included in the `AWSAuthSignInOptions` |
| 45 | + /// - Then: That `metadata` should be included in the event's `clientMetadata` |
| 46 | + func test_clientMetadata_noValidationData() async throws { |
| 47 | + let signInOptions = AWSAuthSignInOptions( |
| 48 | + metadata: ["someKey": "metadataValue"] |
| 49 | + ) |
| 50 | + let options = AuthSignInRequest.Options(pluginOptions: signInOptions) |
| 51 | + let request = AuthSignInRequest(username: "username", password: "password", options: options) |
| 52 | + |
| 53 | + let stateMachine = try XCTUnwrap(plugin.authStateMachine) |
| 54 | + let signInTask = AWSAuthSignInTask( |
| 55 | + request, |
| 56 | + authStateMachine: stateMachine, |
| 57 | + configuration: plugin.authConfiguration |
| 58 | + ) |
| 59 | + |
| 60 | + let states = await stateMachine.listen() |
| 61 | + _ = try await signInTask.execute() |
| 62 | + |
| 63 | + let clientMetadata = await states |
| 64 | + .compactMap(\.authenticationState) |
| 65 | + .compactMap(\.signInEvent) |
| 66 | + .first(where: { _ in true })? |
| 67 | + .clientMetadata |
| 68 | + |
| 69 | + XCTAssertEqual(clientMetadata, ["someKey": "metadataValue"]) |
| 70 | + } |
| 71 | + |
| 72 | + /// - Given: A sign in task |
| 73 | + /// - When: Deprecated `validationData` is included in the `AWSAuthSignInOptions` |
| 74 | + /// - Then: That `validationData` should be included in the event's `clientMetadata` |
| 75 | + @available(*, deprecated) |
| 76 | + func test_clientMetadata_noMetadata() async throws { |
| 77 | + let signInOptions = AWSAuthSignInOptions( |
| 78 | + validationData: ["someKey": "validationValue"] |
| 79 | + ) |
| 80 | + let options = AuthSignInRequest.Options(pluginOptions: signInOptions) |
| 81 | + let request = AuthSignInRequest(username: "username", password: "password", options: options) |
| 82 | + |
| 83 | + let stateMachine = try XCTUnwrap(plugin.authStateMachine) |
| 84 | + let signInTask = AWSAuthSignInTask( |
| 85 | + request, |
| 86 | + authStateMachine: stateMachine, |
| 87 | + configuration: plugin.authConfiguration |
| 88 | + ) |
| 89 | + |
| 90 | + let states = await stateMachine.listen() |
| 91 | + _ = try await signInTask.execute() |
| 92 | + |
| 93 | + let clientMetadata = await states |
| 94 | + .compactMap(\.authenticationState) |
| 95 | + .compactMap(\.signInEvent) |
| 96 | + .first(where: { _ in true })? |
| 97 | + .clientMetadata |
| 98 | + |
| 99 | + XCTAssertEqual(clientMetadata, ["someKey": "validationValue"]) |
| 100 | + } |
| 101 | + |
| 102 | + /// - Given: A sign in task |
| 103 | + /// - When: `metadata` and deprecated `validationData` is included in the `AWSAuthSignInOptions` |
| 104 | + /// with the same key. |
| 105 | + /// - Then: The value from `metadata` should be included in the event's `validationData` |
| 106 | + /// |
| 107 | + /// - Note:`validationData` overriding `metadata` seems a bit counterintuintive because |
| 108 | + /// `validationData` is now deprecated. However this is necessary to ensure we don't break the implicit |
| 109 | + /// contract consumers may be (knowlingly or unknowlingly) depending on. |
| 110 | + @available(*, deprecated) |
| 111 | + func test_clientMetadata_sameKey() async throws { |
| 112 | + let signInOptions = AWSAuthSignInOptions( |
| 113 | + validationData: ["someKey": "validationValue"], |
| 114 | + metadata: ["someKey": "metadataValue"] |
| 115 | + ) |
| 116 | + let options = AuthSignInRequest.Options(pluginOptions: signInOptions) |
| 117 | + let request = AuthSignInRequest(username: "username", password: "password", options: options) |
| 118 | + |
| 119 | + let stateMachine = try XCTUnwrap(plugin.authStateMachine) |
| 120 | + let signInTask = AWSAuthSignInTask( |
| 121 | + request, |
| 122 | + authStateMachine: stateMachine, |
| 123 | + configuration: plugin.authConfiguration |
| 124 | + ) |
| 125 | + |
| 126 | + let states = await stateMachine.listen() |
| 127 | + _ = try await signInTask.execute() |
| 128 | + |
| 129 | + let clientMetadata = await states |
| 130 | + .compactMap(\.authenticationState) |
| 131 | + .compactMap(\.signInEvent) |
| 132 | + .first(where: { _ in true })? |
| 133 | + .clientMetadata |
| 134 | + |
| 135 | + XCTAssertEqual(clientMetadata, ["someKey": "validationValue"]) |
| 136 | + } |
| 137 | + |
| 138 | + /// - Given: A sign in task |
| 139 | + /// - When: `metadata` and deprecated `validationData` is included in the `AWSAuthSignInOptions` |
| 140 | + /// with the different keys. |
| 141 | + /// - Then: The values from `metadata` and the deprecated `validationData` should be included in the event's `clientMetadata` |
| 142 | + @available(*, deprecated) |
| 143 | + func test_clientMetadata_differentKeys() async throws { |
| 144 | + let signInOptions = AWSAuthSignInOptions( |
| 145 | + validationData: ["validationKey": "validationValue"], |
| 146 | + metadata: ["metadataKey": "metadataValue"] |
| 147 | + ) |
| 148 | + let options = AuthSignInRequest.Options(pluginOptions: signInOptions) |
| 149 | + let request = AuthSignInRequest(username: "username", password: "password", options: options) |
| 150 | + |
| 151 | + let stateMachine = try XCTUnwrap(plugin.authStateMachine) |
| 152 | + let signInTask = AWSAuthSignInTask( |
| 153 | + request, |
| 154 | + authStateMachine: stateMachine, |
| 155 | + configuration: plugin.authConfiguration |
| 156 | + ) |
| 157 | + |
| 158 | + let states = await stateMachine.listen() |
| 159 | + _ = try await signInTask.execute() |
| 160 | + |
| 161 | + let clientMetadata = await states |
| 162 | + .compactMap(\.authenticationState) |
| 163 | + .compactMap(\.signInEvent) |
| 164 | + .first(where: { _ in true })? |
| 165 | + .clientMetadata |
| 166 | + |
| 167 | + XCTAssertEqual( |
| 168 | + clientMetadata, |
| 169 | + [ |
| 170 | + "validationKey": "validationValue", |
| 171 | + "metadataKey": "metadataValue" |
| 172 | + ] |
| 173 | + ) |
| 174 | + } |
| 175 | +} |
| 176 | + |
| 177 | +fileprivate extension AuthState { |
| 178 | + var authenticationState: AuthenticationState? { |
| 179 | + if case .configured(let authenticationState, _) = self { |
| 180 | + return authenticationState |
| 181 | + } |
| 182 | + return nil |
| 183 | + } |
| 184 | +} |
| 185 | + |
| 186 | +fileprivate extension AuthenticationState { |
| 187 | + var signInEvent: SignInEventData? { |
| 188 | + if case .signingIn(.signingInWithSRP(_, let eventData)) = self { |
| 189 | + return eventData |
| 190 | + } |
| 191 | + return nil |
| 192 | + } |
| 193 | +} |
0 commit comments