firebase-ios-sdk/FirebaseAuth/Tests/Unit/FIRVerifyPhoneNumberResponseTests.m

/*
 * 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 <TargetConditionals.h>
#if TARGET_OS_IOS

#import <XCTest/XCTest.h>

#import "FirebaseAuth/Sources/Public/FirebaseAuth/FIRAuthErrors.h"

#import "FirebaseAuth/Sources/Auth/FIRAuthOperationType.h"
#import "FirebaseAuth/Sources/AuthProvider/Phone/FIRPhoneAuthCredential_Internal.h"
#import "FirebaseAuth/Sources/Backend/FIRAuthBackend.h"
#import "FirebaseAuth/Sources/Backend/RPC/FIRVerifyPhoneNumberRequest.h"
#import "FirebaseAuth/Sources/Backend/RPC/FIRVerifyPhoneNumberResponse.h"
#import "FirebaseAuth/Tests/Unit/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;

  /** @var _requestConfiguration
      @brief This is the request configuration used for testing.
   */
  FIRAuthRequestConfiguration *_requestConfiguration;
}

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

- (void)tearDown {
  _requestConfiguration = nil;
  _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
                                                        operation:FIRAuthOperationTypeSignUpOrSignIn
                                             requestConfiguration:_requestConfiguration];
  __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
                                                        operation:FIRAuthOperationTypeSignUpOrSignIn
                                             requestConfiguration:_requestConfiguration];
  __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
                                                        operation:FIRAuthOperationTypeSignUpOrSignIn
                                             requestConfiguration:_requestConfiguration];
  __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
                                                        operation:FIRAuthOperationTypeSignUpOrSignIn
                                             requestConfiguration:_requestConfiguration];
  __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
                                                        operation:FIRAuthOperationTypeSignUpOrSignIn
                                             requestConfiguration:_requestConfiguration];
  __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[FIRAuthErrorUserInfoUpdatedCredentialKey];
  XCTAssertEqualObjects(credential.temporaryProof, kFakeTemporaryProof);
  XCTAssertEqualObjects(credential.phoneNumber, kFakePhoneNumber);
}

@end

#endif