aboutsummaryrefslogtreecommitdiffhomepage
path: root/Example/Auth/Tests/FIRSendVerificationCodeResponseTests.m
blob: 5a1244b035b3e4528277c72c8e5b78698aa74717 (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
/*
 * 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 "FIRAuthAppCredential.h"
#import "FIRAuthErrors.h"
#import "FIRAuthErrorUtils.h"
#import "FIRAuthBackend.h"
#import "FIRSendVerificationCodeRequest.h"
#import "FIRSendVerificationCodeResponse.h"
#import "FIRFakeBackendRPCIssuer.h"

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

/** @var kTestPhoneNumber
    @brief Fake phone number used for testing.
 */
static NSString *const kTestPhoneNumber = @"12345678";

/** @var kTestInvalidPhoneNumber
    @brief An invalid testing phone number.
 */
static NSString *const kTestInvalidPhoneNumber = @"555+!*55555";

/** @var kVerificationIDKey
    @brief Fake key for the test verification ID.
 */
static NSString *const kVerificationIDKey = @"sessionInfo";

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

/** @var kTestSecret
    @brief Fake secret used for testing.
 */
static NSString *const kTestSecret = @"secret";

/** @var kTestReceipt
    @brief Fake receipt used for testing.
 */
static NSString *const kTestReceipt = @"receipt";

/** @var kInvalidPhoneNumberErrorMessage
    @brief This is the error message the server will respond with if an incorrectly formatted phone
        number is provided.
 */
static NSString *const kInvalidPhoneNumberErrorMessage = @"INVALID_PHONE_NUMBER";

/** @var kQuotaExceededErrorMessage
    @brief This is the error message the server will respond with if the quota for SMS text messages
        has been exceeded for the project.
 */
static NSString *const kQuotaExceededErrorMessage = @"QUOTA_EXCEEDED";

/** @var kAppNotVerifiedErrorMessage
    @brief This is the error message the server will respond with if Firebase could not verify the
        app during a phone authentication flow.
 */
static NSString *const kAppNotVerifiedErrorMessage = @"APP_NOT_VERIFIED";

/** @class FIRSendVerificationCodeResponseTests
    @brief Tests for @c FIRSendVerificationCodeResponseTests.
 */
@interface FIRSendVerificationCodeResponseTests : XCTestCase
@end

@implementation FIRSendVerificationCodeResponseTests {
  /** @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 testSendVerificationCodeResponseInvalidPhoneNumber
    @brief Tests a failed attempt to send a verification code with an invalid phone number.
 */
- (void)testSendVerificationCodeResponseInvalidPhoneNumber {
  FIRAuthAppCredential *credential =
      [[FIRAuthAppCredential alloc]initWithReceipt:kTestReceipt secret:kTestSecret];
  FIRSendVerificationCodeRequest *request =
      [[FIRSendVerificationCodeRequest alloc] initWithPhoneNumber:kTestInvalidPhoneNumber
                                                    appCredential:credential
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRSendVerificationCodeResponse *RPCResponse;
  __block NSError *RPCError;
  [FIRAuthBackend sendVerificationCode:request
                              callback:^(FIRSendVerificationCodeResponse *_Nullable response,
                                         NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithServerErrorMessage:kInvalidPhoneNumberErrorMessage];

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

/** @fn testSendVerificationCodeResponseQuotaExceededError
    @brief Tests a failed attempt to send a verification code due to SMS quota having been exceeded.
 */
- (void)testSendVerificationCodeResponseQuotaExceededError {
  FIRAuthAppCredential *credential =
      [[FIRAuthAppCredential alloc]initWithReceipt:kTestReceipt secret:kTestSecret];
  FIRSendVerificationCodeRequest *request =
      [[FIRSendVerificationCodeRequest alloc] initWithPhoneNumber:kTestPhoneNumber
                                                    appCredential:credential
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRSendVerificationCodeResponse *RPCResponse;
  __block NSError *RPCError;
  [FIRAuthBackend sendVerificationCode:request
                              callback:^(FIRSendVerificationCodeResponse *_Nullable response,
                                         NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithServerErrorMessage:kQuotaExceededErrorMessage];

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

/** @fn testSendVerificationCodeResponseAppNotVerifiedError
    @brief Tests a failed attempt to send a verification code due to Firebase not being able to
        verify the app.
 */
- (void)testSendVerificationCodeResponseAppNotVerifiedError {
  FIRAuthAppCredential *credential =
      [[FIRAuthAppCredential alloc]initWithReceipt:kTestReceipt secret:kTestSecret];
  FIRSendVerificationCodeRequest *request =
      [[FIRSendVerificationCodeRequest alloc] initWithPhoneNumber:kTestPhoneNumber
                                                    appCredential:credential
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRSendVerificationCodeResponse *RPCResponse;
  __block NSError *RPCError;
  [FIRAuthBackend sendVerificationCode:request
                              callback:^(FIRSendVerificationCodeResponse *_Nullable response,
                                         NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithServerErrorMessage:kAppNotVerifiedErrorMessage];

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

/** @fn testSuccessfulSendVerificationCodeResponse
    @brief Tests a succesful to send a verification code.
 */
- (void)testSuccessfulSendVerificationCodeResponse {
   FIRAuthAppCredential *credential =
      [[FIRAuthAppCredential alloc]initWithReceipt:kTestReceipt secret:kTestSecret];
  FIRSendVerificationCodeRequest *request =
      [[FIRSendVerificationCodeRequest alloc] initWithPhoneNumber:kTestPhoneNumber
                                                    appCredential:credential
                                                           APIKey:kTestAPIKey];
  __block BOOL callbackInvoked;
  __block FIRSendVerificationCodeResponse *RPCResponse;
  __block NSError *RPCError;
  [FIRAuthBackend sendVerificationCode:request
                              callback:^(FIRSendVerificationCodeResponse *_Nullable response,
                                         NSError *_Nullable error) {
    RPCResponse = response;
    RPCError = error;
    callbackInvoked = YES;
  }];

  [_RPCIssuer respondWithJSON:@{
    kVerificationIDKey : kFakeVerificationID
  }];

  XCTAssert(callbackInvoked);
  XCTAssertNotNil(RPCResponse);
  XCTAssertEqualObjects(RPCResponse.verificationID, kFakeVerificationID);
}

@end