aboutsummaryrefslogtreecommitdiffhomepage
path: root/Example/Auth/Tests/FIRVerifyPhoneNumberResponseTests.m
blob: e3fa1f88de08abdf3400595bd1e9897cec5b56a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/*
 * Copyright 2017 Google
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.
 */
#import <XCTest/XCTest.h>

#import "Phone/FIRPhoneAuthCredential_Internal.h"
#import "FIRAuthBackend.h"
#import "FIRAuthErrors.h"
#import "FIRVerifyPhoneNumberRequest.h"
#import "FIRVerifyPhoneNumberResponse.h"
#import "FIRFakeBackendRPCIssuer.h"

/** @var kTestAPIKey
    @brief Fake API key used for testing.
 */
static NSString *const kTestAPIKey = @"APIKey";

/** @var kVerificationCode
    @brief Fake verification code used for testing.
 */
static NSString *const kVerificationCode = @"12345678";

/** @var kVerificationID
    @brief Fake verification ID for testing.
 */
static NSString *const kVerificationID = @"55432";

/** @var kfakeRefreshToken
    @brief Fake refresh token for testing.
 */
static NSString *const kfakeRefreshToken = @"refreshtoken";

/** @var klocalID
    @brief Fake local ID for testing.
 */
static NSString *const klocalID = @"localID";

/** @var kfakeIDToken
    @brief Fake ID Token for testing.
 */
static NSString *const kfakeIDToken = @"idtoken";

/** @var kTestExpiresIn
    @brief Fake token expiration time.
 */
static NSString *const kTestExpiresIn = @"12345";

/** @var kInvalidVerificationCodeErrorMessage
    @brief This is the error message the server will respond with if an invalid verification code
        provided.
 */
static NSString *const kInvalidVerificationCodeErrorMessage = @"INVALID_CODE";

/** @var kInvalidSessionInfoErrorMessage
    @brief This is the error message the server will respond with if an invalid verification ID
        provided.
 */
static NSString *const kInvalidSessionInfoErrorMessage = @"INVALID_SESSION_INFO";

/** @var kSessionExpiredErrorMessage
    @brief This is the error message the server will respond with if the SMS code has expired before
        it is used.
 */
static NSString *const kSessionExpiredErrorMessage = @"SESSION_EXPIRED";

/** @var kFakePhoneNumber
    @brief The fake user phone number.
 */
static NSString *const kFakePhoneNumber = @"12345658";

/** @var kFakeTemporaryProof
    @brief The fake temporary proof.
 */
static NSString *const kFakeTemporaryProof = @"12345658";

/** @var kAllowedTimeDifference
    @brief Allowed difference when comparing times because of execution time and floating point
        error.
 */
static const double kAllowedTimeDifference = 0.1;

/** @class FIRVerifyPhoneNumberResponseTests
    @brief Tests for @c FIRVerifyPhoneNumberResponse.
 */
@interface FIRVerifyPhoneNumberResponseTests : XCTestCase

@end

@implementation FIRVerifyPhoneNumberResponseTests {
  /** @var _RPCIssuer
      @brief This backend RPC issuer is used to fake network responses for each test in the suite.
          In the @c setUp method we initialize this and set @c FIRAuthBackend's RPC issuer to it.
   */
  FIRFakeBackendRPCIssuer *_RPCIssuer;
}

- (void)setUp {
  FIRFakeBackendRPCIssuer *RPCIssuer = [[FIRFakeBackendRPCIssuer alloc] init];
  [FIRAuthBackend setDefaultBackendImplementationWithRPCIssuer:RPCIssuer];
  _RPCIssuer = RPCIssuer;
}

- (void)tearDown {
  _RPCIssuer = nil;
  [FIRAuthBackend setDefaultBackendImplementationWithRPCIssuer:nil];
  [super tearDown];
}

/** @fn testInvalidVerificationCodeError
    @brief Tests invalid verification code error.
 */
- (void)testInvalidVerificationCodeError {
  FIRVerifyPhoneNumberRequest *request =
      [[FIRVerifyPhoneNumberRequest alloc] initWithVerificationID:kVerificationID
                                                 verificationCode:kVerificationCode
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRVerifyPhoneNumberResponse *RPCResponse;
  __block NSError *RPCError;


  [FIRAuthBackend verifyPhoneNumber:request
                           callback:^(FIRVerifyPhoneNumberResponse *_Nullable response,
                                      NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithServerErrorMessage:kInvalidVerificationCodeErrorMessage];

  XCTAssert(callbackInvoked);
  XCTAssertNil(RPCResponse);
  XCTAssertEqual(RPCError.code, FIRAuthErrorCodeInvalidVerificationCode);
}

/** @fn testInvalidVerificationIDError
    @brief Tests invalid verification code error.
 */
- (void)testInvalidVerificationIDError {
  FIRVerifyPhoneNumberRequest *request =
      [[FIRVerifyPhoneNumberRequest alloc] initWithVerificationID:kVerificationID
                                                 verificationCode:kVerificationCode
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRVerifyPhoneNumberResponse *RPCResponse;
  __block NSError *RPCError;

  [FIRAuthBackend verifyPhoneNumber:request
                           callback:^(FIRVerifyPhoneNumberResponse *_Nullable response,
                                      NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithServerErrorMessage:kInvalidSessionInfoErrorMessage];

  XCTAssert(callbackInvoked);
  XCTAssertNil(RPCResponse);
  XCTAssertEqual(RPCError.code, FIRAuthErrorCodeInvalidVerificationID);
}

/** @fn testSessionExpiredError
    @brief Tests session expired error code.
 */
- (void)testSessionExpiredError {
  FIRVerifyPhoneNumberRequest *request =
      [[FIRVerifyPhoneNumberRequest alloc] initWithVerificationID:kVerificationID
                                                 verificationCode:kVerificationCode
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRVerifyPhoneNumberResponse *RPCResponse;
  __block NSError *RPCError;

  [FIRAuthBackend verifyPhoneNumber:request
                           callback:^(FIRVerifyPhoneNumberResponse *_Nullable response,
                                      NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithServerErrorMessage:kSessionExpiredErrorMessage];

  XCTAssert(callbackInvoked);
  XCTAssertNil(RPCResponse);
  XCTAssertEqual(RPCError.code, FIRAuthErrorCodeSessionExpired);
}

/** @fn testSuccessfulVerifyPhoneNumberResponse
    @brief Tests a succesful to verify phone number flow.
 */
- (void)testSuccessfulVerifyPhoneNumberResponse {
  FIRVerifyPhoneNumberRequest *request =
      [[FIRVerifyPhoneNumberRequest alloc] initWithVerificationID:kVerificationID
                                                 verificationCode:kVerificationCode
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRVerifyPhoneNumberResponse *RPCResponse;
  __block NSError *RPCError;

  [FIRAuthBackend verifyPhoneNumber:request
                           callback:^(FIRVerifyPhoneNumberResponse *_Nullable response,
                                      NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithJSON:@{
    @"idToken" : kfakeIDToken,
    @"refreshToken" : kfakeRefreshToken,
    @"localID" : klocalID,
    @"expiresIn" : kTestExpiresIn,
    @"isNewUser" : @YES // Set new user flag to true.
  }];

  XCTAssert(callbackInvoked);
  XCTAssertNotNil(RPCResponse);
  XCTAssertEqualObjects(RPCResponse.IDToken, kfakeIDToken);
  XCTAssertEqualObjects(RPCResponse.refreshToken, kfakeRefreshToken);
  NSTimeInterval expiresIn = [RPCResponse.approximateExpirationDate timeIntervalSinceNow];
  XCTAssertEqualWithAccuracy(expiresIn, [kTestExpiresIn doubleValue], kAllowedTimeDifference);
  XCTAssertTrue(RPCResponse.isNewUser);
}

/** @fn testSuccessfulVerifyPhoneNumberResponseWithTemporaryProof
    @brief Tests a succesful to verify phone number flow with temporary proof response.
 */
- (void)testSuccessfulVerifyPhoneNumberResponseWithTemporaryProof {
  FIRVerifyPhoneNumberRequest *request =
      [[FIRVerifyPhoneNumberRequest alloc] initWithTemporaryProof:kFakeTemporaryProof
                                                      phoneNumber:kFakePhoneNumber
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRVerifyPhoneNumberResponse *RPCResponse;
  __block NSError *RPCError;

  [FIRAuthBackend verifyPhoneNumber:request
                           callback:^(FIRVerifyPhoneNumberResponse *_Nullable response,
                                      NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithJSON:@{
    @"temporaryProof" : kFakeTemporaryProof,
    @"phoneNumber" : kFakePhoneNumber
  }];

  XCTAssert(callbackInvoked);
  XCTAssertNil(RPCResponse);
  FIRPhoneAuthCredential *credential = RPCError.userInfo[FIRAuthUpdatedCredentialKey];
  XCTAssertEqualObjects(credential.temporaryProof, kFakeTemporaryProof);
  XCTAssertEqualObjects(credential.phoneNumber, kFakePhoneNumber);
}

@end