| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457 |
- // Copyright 2023 Google LLC
- //
- // 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 Foundation
- import XCTest
- @testable import FirebaseAuth
- import FirebaseAuthInterop
- import FirebaseCore
- @available(iOS 13, tvOS 13, macOS 10.15, macCatalyst 13, watchOS 7, *)
- class AuthTests: RPCBaseTests {
- static let kAccessToken = "TEST_ACCESS_TOKEN"
- static let kNewAccessToken = "NEW_ACCESS_TOKEN"
- static let kFakeAPIKey = "FAKE_API_KEY"
- static let kFakeRecaptchaResponse = "RecaptchaResponse"
- static let kFakeRecaptchaVersion = "RecaptchaVersion"
- var auth: Auth!
- static var testNum = 0
- var authDispatcherCallback: (() -> Void)?
- override func setUp() {
- super.setUp()
- let options = FirebaseOptions(googleAppID: "0:0000000000000:ios:0000000000000000",
- gcmSenderID: "00000000000000000-00000000000-000000000")
- options.apiKey = AuthTests.kFakeAPIKey
- options.projectID = "myProjectID"
- let name = "test-AuthTests\(AuthTests.testNum)"
- AuthTests.testNum = AuthTests.testNum + 1
- FirebaseApp.configure(name: name, options: options)
- #if (os(macOS) && !FIREBASE_AUTH_TESTING_USE_MACOS_KEYCHAIN) || SWIFT_PACKAGE
- let keychainStorageProvider = FakeAuthKeychainStorage()
- #else
- let keychainStorageProvider = AuthKeychainStorageReal.shared
- #endif // (os(macOS) && !FIREBASE_AUTH_TESTING_USE_MACOS_KEYCHAIN) || SWIFT_PACKAGE
- // Stub the implementation to save the token refresh task for later execution.
- let authDispatcher = AuthDispatcher { delay, queue, task in
- XCTAssertNotNil(task)
- XCTAssertGreaterThan(delay, 0)
- XCTAssertEqual(kAuthGlobalWorkQueue, queue)
- self.authDispatcherCallback = task
- }
- auth = Auth(
- app: FirebaseApp.app(name: name)!,
- keychainStorageProvider: keychainStorageProvider,
- backend: authBackend,
- authDispatcher: authDispatcher
- )
- // Wait until Auth initialization completes
- waitForAuthGlobalWorkQueueDrain()
- }
- private func waitForAuthGlobalWorkQueueDrain() {
- let workerSemaphore = DispatchSemaphore(value: 0)
- kAuthGlobalWorkQueue.async {
- workerSemaphore.signal()
- }
- _ = workerSemaphore.wait(timeout: DispatchTime.distantFuture)
- }
- /** @fn testFetchSignInMethodsForEmailSuccess
- @brief Tests the flow of a successful @c fetchSignInMethodsForEmail:completion: call.
- */
- func testFetchSignInMethodsForEmailSuccess() throws {
- let allSignInMethods = ["emailLink", "facebook.com"]
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- let request = try XCTUnwrap(self.rpcIssuer.request as? CreateAuthURIRequest)
- XCTAssertEqual(request.identifier, self.kEmail)
- XCTAssertEqual(request.endpoint, "createAuthUri")
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- return try self.rpcIssuer.respond(withJSON: ["signinMethods": allSignInMethods])
- }
- auth?.fetchSignInMethods(forEmail: kEmail) { signInMethods, error in
- // 4. After the response triggers the callback, verify the returned signInMethods.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertEqual(signInMethods, allSignInMethods)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testFetchSignInMethodsForEmailFailure
- @brief Tests the flow of a failed @c fetchSignInMethodsForEmail:completion: call.
- */
- func testFetchSignInMethodsForEmailFailure() throws {
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- let message = "TOO_MANY_ATTEMPTS_TRY_LATER"
- return try self.rpcIssuer.respond(serverErrorMessage: message)
- }
- auth?.fetchSignInMethods(forEmail: kEmail) { signInMethods, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(signInMethods)
- let rpcError = (error as? NSError)!
- XCTAssertEqual(rpcError.code, AuthErrorCode.tooManyRequests.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- #if os(iOS)
- /** @fn testPhoneAuthSuccess
- @brief Tests the flow of a successful @c signInWithCredential:completion for phone auth.
- */
- func testPhoneAuthSuccess() throws {
- let kVerificationID = "55432"
- let kVerificationCode = "12345678"
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyPhoneNumberRequest)
- XCTAssertEqual(request.verificationCode, kVerificationCode)
- XCTAssertEqual(request.verificationID, kVerificationID)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- let credential = PhoneAuthProvider.provider(auth: auth)
- .credential(withVerificationID: kVerificationID,
- verificationCode: kVerificationCode)
- auth?.signIn(with: credential) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- guard let user = authResult?.user,
- let additionalUserInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.user or additionalUserInfo is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, self.kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertTrue(additionalUserInfo.isNewUser)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- /** @fn testPhoneAuthMissingVerificationCode
- @brief Tests the flow of an unsuccessful @c signInWithCredential:completion for phone auth due
- to an empty verification code
- */
- func testPhoneAuthMissingVerificationCode() throws {
- let kVerificationID = "55432"
- let kVerificationCode = ""
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- try auth?.signOut()
- let credential = PhoneAuthProvider.provider(auth: auth)
- .credential(withVerificationID: kVerificationID,
- verificationCode: kVerificationCode)
- auth?.signIn(with: credential) { authResult, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.missingVerificationCode.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testPhoneAuthMissingVerificationID
- @brief Tests the flow of an unsuccessful @c signInWithCredential:completion for phone auth due
- to an empty verification ID.
- */
- func testPhoneAuthMissingVerificationID() throws {
- let kVerificationID = ""
- let kVerificationCode = "123"
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- try auth?.signOut()
- let credential = PhoneAuthProvider.provider(auth: auth)
- .credential(withVerificationID: kVerificationID,
- verificationCode: kVerificationCode)
- auth?.signIn(with: credential) { authResult, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.missingVerificationID.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- #endif
- /** @fn testSignInWithEmailLinkSuccess
- @brief Tests the flow of a successful @c signInWithEmail:link:completion: call.
- */
- func testSignInWithEmailLinkSuccess() throws {
- try signInWithEmailLinkSuccessWithLinkOrDeeplink(link: kFakeEmailSignInLink)
- }
- /** @fn testSignInWithEmailLinkSuccessDeeplink
- @brief Tests the flow of a successful @c signInWithEmail:link: call using a deep link.
- */
- func testSignInWithEmailLinkSuccessDeeplink() throws {
- try signInWithEmailLinkSuccessWithLinkOrDeeplink(link: kFakeEmailSignInDeeplink)
- }
- private func signInWithEmailLinkSuccessWithLinkOrDeeplink(link: String) throws {
- let fakeCode = "testoobcode"
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? EmailLinkSignInRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.oobCode, fakeCode)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- auth?.signIn(withEmail: kEmail, link: link) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- guard let user = authResult?.user else {
- XCTFail("authResult.user is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, self.kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.email, self.kEmail)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- /** @fn testSignInWithEmailLinkFailure
- @brief Tests the flow of a failed @c signInWithEmail:link:completion: call.
- */
- func testSignInWithEmailLinkFailure() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "INVALID_OOB_CODE")
- }
- try auth?.signOut()
- auth?.signIn(withEmail: kEmail, link: kFakeEmailSignInLink) { authResult, error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.invalidActionCode.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- #if os(iOS)
- /** @fn testSignInWithEmailPasswordWithRecaptchaSuccess
- @brief Tests the flow of a successful @c signInWithEmail:password:completion: call.
- */
- func testSignInWithEmailPasswordWithRecaptchaSuccess() throws {
- let kRefreshToken = "fakeRefreshToken"
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyPasswordRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertTrue(request.returnSecureToken)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": kRefreshToken])
- }
- try auth?.signOut()
- auth?.signIn(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- guard let user = authResult?.user else {
- XCTFail("authResult.user is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.email, self.kEmail)
- guard let additionalUserInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertFalse(additionalUserInfo.isNewUser)
- XCTAssertEqual(additionalUserInfo.providerID, EmailAuthProvider.id)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- /** @fn testSignInWithEmailPasswordWithRecaptchaFallbackSuccess
- @brief Tests the flow of a successful @c signInWithEmail:password:completion: call.
- */
- func testSignInWithEmailPasswordWithRecaptchaFallbackSuccess() throws {
- let kRefreshToken = "fakeRefreshToken"
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- let kTestRecaptchaKey = "projects/123/keys/456"
- rpcIssuer.recaptchaSiteKey = kTestRecaptchaKey
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyPasswordRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertTrue(request.returnSecureToken)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(serverErrorMessage: "MISSING_RECAPTCHA_TOKEN")
- }
- rpcIssuer.nextRespondBlock = {
- // 4. Validate again the created Request instance after the recaptcha retry.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyPasswordRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertTrue(request.returnSecureToken)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 5. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": kRefreshToken])
- }
- try auth?.signOut()
- auth?.signIn(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 6. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- guard let user = authResult?.user else {
- XCTFail("authResult.user is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.email, self.kEmail)
- guard let additionalUserInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertFalse(additionalUserInfo.isNewUser)
- XCTAssertEqual(additionalUserInfo.providerID, EmailAuthProvider.id)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- #endif
- /** @fn testSignInAndRetrieveDataWithEmailPasswordSuccess
- @brief Tests the flow of a successful @c signInAndRetrieveDataWithEmail:password:completion:
- call. Superset of historical testSignInWithEmailPasswordSuccess.
- */
- func testSignInAndRetrieveDataWithEmailPasswordSuccess() throws {
- let kRefreshToken = "fakeRefreshToken"
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyPasswordRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": kRefreshToken])
- }
- try auth?.signOut()
- auth?.signIn(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- guard let user = authResult?.user else {
- XCTFail("authResult.user is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.email, self.kEmail)
- guard let additionalUserInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertFalse(additionalUserInfo.isNewUser)
- XCTAssertEqual(additionalUserInfo.providerID, EmailAuthProvider.id)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- /** @fn testSignInWithEmailPasswordFailure
- @brief Tests the flow of a failed @c signInWithEmail:password:completion: call.
- */
- func testSignInWithEmailPasswordFailure() throws {
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "INVALID_PASSWORD")
- }
- try auth?.signOut()
- auth?.signIn(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.wrongPassword.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testResetPasswordSuccess
- @brief Tests the flow of a successful @c confirmPasswordResetWithCode:newPassword:completion:
- call.
- */
- func testResetPasswordSuccess() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? ResetPasswordRequest)
- XCTAssertEqual(request.oobCode, self.kFakeOobCode)
- XCTAssertEqual(request.updatedPassword, self.kFakePassword)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- try auth?.signOut()
- auth?
- .confirmPasswordReset(withCode: kFakeOobCode, newPassword: kFakePassword) { error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testResetPasswordFailure
- @brief Tests the flow of a failed @c confirmPasswordResetWithCode:newPassword:completion:
- call.
- */
- func testResetPasswordFailure() throws {
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "INVALID_OOB_CODE")
- }
- try auth?.signOut()
- auth?
- .confirmPasswordReset(withCode: kFakeOobCode, newPassword: kFakePassword) { error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.invalidActionCode.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testCheckActionCodeSuccess
- @brief Tests the flow of a successful @c checkActionCode:completion call.
- */
- func testCheckActionCodeSuccess() throws {
- let kNewEmail = "newEmail@example.com"
- let verifyEmailRequestType = "verifyEmail"
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? ResetPasswordRequest)
- XCTAssertEqual(request.oobCode, self.kFakeOobCode)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["email": self.kEmail,
- "requestType": verifyEmailRequestType,
- "newEmail": kNewEmail])
- }
- try auth?.signOut()
- auth?.checkActionCode(kFakeOobCode) { info, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- XCTAssertEqual(info?.email, kNewEmail)
- XCTAssertEqual(info?.operation, ActionCodeOperation.verifyEmail)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testCheckActionCodeFailure
- @brief Tests the flow of a failed @c checkActionCode:completion call.
- */
- func testCheckActionCodeFailure() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "EXPIRED_OOB_CODE")
- }
- try auth?.signOut()
- auth?.checkActionCode(kFakeOobCode) { info, error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.expiredActionCode.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testApplyActionCodeSuccess
- @brief Tests the flow of a successful @c applyActionCode:completion call.
- */
- func testApplyActionCodeSuccess() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? SetAccountInfoRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- try auth?.signOut()
- auth?.applyActionCode(kFakeOobCode) { error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testApplyActionCodeFailure
- @brief Tests the flow of a failed @c checkActionCode:completion call.
- */
- func testApplyActionCodeFailure() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "INVALID_OOB_CODE")
- }
- try auth?.signOut()
- auth?.applyActionCode(kFakeOobCode) { error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.invalidActionCode.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testVerifyPasswordResetCodeSuccess
- @brief Tests the flow of a successful @c verifyPasswordResetCode:completion call.
- */
- func testVerifyPasswordResetCodeSuccess() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? ResetPasswordRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.oobCode, self.kFakeOobCode)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["email": self.kEmail])
- }
- try auth?.signOut()
- auth?.verifyPasswordResetCode(kFakeOobCode) { email, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertEqual(email, self.kEmail)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testVerifyPasswordResetCodeFailure
- @brief Tests the flow of a failed @c verifyPasswordResetCode:completion call.
- */
- func testVerifyPasswordResetCodeFailure() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "INVALID_OOB_CODE")
- }
- try auth?.signOut()
- auth?.verifyPasswordResetCode(kFakeOobCode) { email, error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(email)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.invalidActionCode.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testSignInWithEmailLinkCredentialSuccess
- @brief Tests the flow of a successfully @c signInWithCredential:completion: call with an
- email sign-in link credential using FIREmailAuthProvider.
- */
- func testSignInWithEmailLinkCredentialSuccess() throws {
- let expectation = self.expectation(description: #function)
- let fakeCode = "testoobcode"
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? EmailLinkSignInRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.oobCode, fakeCode)
- XCTAssertEqual(request.email, self.kEmail)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- let emailCredential = EmailAuthProvider.credential(
- withEmail: kEmail,
- link: kFakeEmailSignInLink
- )
- auth?.signIn(with: emailCredential) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- guard let user = authResult?.user else {
- XCTFail("authResult.user or additionalUserInfo is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, self.kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.email, self.kEmail)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSignInWithEmailLinkCredentialFailure
- @brief Tests the flow of a failed @c signInWithCredential:completion: call with an
- email-email sign-in link credential using FIREmailAuthProvider.
- */
- func testSignInWithEmailLinkCredentialFailure() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "USER_DISABLED")
- }
- try auth?.signOut()
- let emailCredential = EmailAuthProvider.credential(
- withEmail: kEmail,
- link: kFakeEmailSignInLink
- )
- auth?.signIn(with: emailCredential) { authResult, error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.userDisabled.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testSignInWithEmailCredentialSuccess
- @brief Tests the flow of a successfully @c signInWithCredential:completion: call with an
- email-password credential.
- */
- func testSignInWithEmailCredentialSuccess() throws {
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyPasswordRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertEqual(request.email, self.kEmail)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- let emailCredential = EmailAuthProvider.credential(withEmail: kEmail, password: kFakePassword)
- auth?.signIn(with: emailCredential) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- guard let user = authResult?.user else {
- XCTFail("authResult.user or additionalUserInfo is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, self.kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.email, self.kEmail)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSignInWithEmailCredentialFailure
- @brief Tests the flow of a failed @c signInWithCredential:completion: call with an
- email-password credential.
- */
- func testSignInWithEmailCredentialFailure() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Send the response from the fake backend.
- try self.rpcIssuer.respond(serverErrorMessage: "USER_DISABLED")
- }
- try auth?.signOut()
- let emailCredential = EmailAuthProvider.credential(withEmail: kEmail, password: kFakePassword)
- auth?.signIn(with: emailCredential) { authResult, error in
- // 3. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.userDisabled.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testSignInWithEmailCredentialEmptyPassword
- @brief Tests the flow of a failed @c signInWithCredential:completion: call with an
- email-password credential using an empty password. This error occurs on the client side,
- so there is no need to fake an RPC response.
- */
- func testSignInWithEmailCredentialEmptyPassword() throws {
- let expectation = self.expectation(description: #function)
- let emailCredential = EmailAuthProvider.credential(withEmail: kEmail, password: "")
- auth?.signIn(with: emailCredential) { authResult, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.wrongPassword.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- #if os(iOS)
- class FakeProvider: NSObject, FederatedAuthProvider {
- @available(iOS 13, tvOS 13, macOS 10.15, watchOS 8, *)
- func credential(with UIDelegate: FirebaseAuth.AuthUIDelegate?) async throws ->
- FirebaseAuth.AuthCredential {
- let credential = OAuthCredential(withProviderID: GoogleAuthProvider.id,
- sessionID: kOAuthSessionID,
- OAuthResponseURLString: kOAuthRequestURI)
- XCTAssertEqual(credential.OAuthResponseURLString, kOAuthRequestURI)
- XCTAssertEqual(credential.sessionID, kOAuthSessionID)
- return credential
- }
- }
- /** @fn testSignInWithProviderSuccess
- @brief Tests a successful @c signInWithProvider:UIDelegate:completion: call with an OAuth
- provider configured for Google.
- */
- func testSignInWithProviderSuccess() throws {
- let expectation = self.expectation(description: #function)
- setFakeGoogleGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyAssertionRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, GoogleAuthProvider.id)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": RPCBaseTests.kFakeAccessToken,
- "refreshToken": self.kRefreshToken,
- "federatedId": self.kGoogleID,
- "providerId": GoogleAuthProvider.id,
- "localId": self.kLocalID,
- "displayName": self.kDisplayName,
- "rawUserInfo": self.kGoogleProfile,
- "username": self.kUserName])
- }
- try auth.signOut()
- auth.signIn(with: FakeProvider(), uiDelegate: nil) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- do {
- try self.assertUserGoogle(authResult?.user)
- } catch {
- XCTFail("\(error)")
- }
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- try assertUserGoogle(auth.currentUser)
- }
- /** @fn testSignInWithProviderFailure
- @brief Tests a failed @c signInWithProvider:UIDelegate:completion: call with the error code
- FIRAuthErrorCodeWebSignInUserInteractionFailure.
- */
- func testSignInWithProviderFailure() throws {
- let expectation = self.expectation(description: #function)
- setFakeGoogleGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyAssertionRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, GoogleAuthProvider.id)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(serverErrorMessage: "USER_DISABLED")
- }
- try auth.signOut()
- auth.signIn(with: FakeProvider(), uiDelegate: nil) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.userDisabled.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSignInWithGoogleAccountExistsError
- @brief Tests the flow of a failed @c signInWithCredential:completion: with a Google credential
- where the backend returns a needs @needConfirmation equal to true. An
- FIRAuthErrorCodeAccountExistsWithDifferentCredential error should be thrown.
- */
- func testSignInWithGoogleAccountExistsError() throws {
- let expectation = self.expectation(description: #function)
- setFakeGoogleGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyAssertionRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, GoogleAuthProvider.id)
- XCTAssertEqual(request.providerIDToken, self.kGoogleIDToken)
- XCTAssertEqual(request.providerAccessToken, self.kGoogleAccessToken)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": RPCBaseTests.kFakeAccessToken,
- "refreshToken": self.kRefreshToken,
- "federatedId": self.kGoogleID,
- "providerId": GoogleAuthProvider.id,
- "localId": self.kLocalID,
- "displayName": self.kGoogleDisplayName,
- "rawUserInfo": self.kGoogleProfile,
- "username": self.kUserName,
- "needConfirmation": true])
- }
- try auth.signOut()
- let googleCredential = GoogleAuthProvider.credential(withIDToken: kGoogleIDToken,
- accessToken: kGoogleAccessToken)
- auth.signIn(with: googleCredential) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code,
- AuthErrorCode.accountExistsWithDifferentCredential.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSignInWithOAuthCredentialSuccess
- @brief Tests the flow of a successful @c signInWithCredential:completion: call with a generic
- OAuth credential (In this case, configured for the Google IDP).
- */
- func testSignInWithOAuthCredentialSuccess() throws {
- let expectation = self.expectation(description: #function)
- setFakeGoogleGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyAssertionRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, GoogleAuthProvider.id)
- XCTAssertEqual(request.requestURI, AuthTests.kOAuthRequestURI)
- XCTAssertEqual(request.sessionID, AuthTests.kOAuthSessionID)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": RPCBaseTests.kFakeAccessToken,
- "refreshToken": self.kRefreshToken,
- "federatedId": self.kGoogleID,
- "providerId": GoogleAuthProvider.id,
- "localId": self.kLocalID,
- "displayName": self.kGoogleDisplayName,
- "rawUserInfo": self.kGoogleProfile,
- "username": self.kUserName])
- }
- try auth.signOut()
- auth.signIn(with: FakeProvider(), uiDelegate: nil) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- do {
- try self.assertUserGoogle(authResult?.user)
- } catch {
- XCTFail("\(error)")
- }
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- try assertUserGoogle(auth.currentUser)
- }
- #endif
- /** @fn testSignInWithCredentialSuccess
- @brief Tests the flow of a successful @c signInWithCredential:completion: call
- with a Google Sign-In credential.
- Note: also a superset of the former testSignInWithGoogleCredentialSuccess
- */
- func testSignInWithCredentialSuccess() throws {
- let expectation = self.expectation(description: #function)
- setFakeGoogleGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyAssertionRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, GoogleAuthProvider.id)
- XCTAssertEqual(request.providerIDToken, self.kGoogleIDToken)
- XCTAssertEqual(request.providerAccessToken, self.kGoogleAccessToken)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": RPCBaseTests.kFakeAccessToken,
- "refreshToken": self.kRefreshToken,
- "federatedId": self.kGoogleID,
- "providerId": GoogleAuthProvider.id,
- "localId": self.kLocalID,
- "displayName": self.kGoogleDisplayName,
- "rawUserInfo": self.kGoogleProfile,
- "username": self.kGoogleDisplayName])
- }
- try auth.signOut()
- let googleCredential = GoogleAuthProvider.credential(withIDToken: kGoogleIDToken,
- accessToken: kGoogleAccessToken)
- auth.signIn(with: googleCredential) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- do {
- try self.assertUserGoogle(authResult?.user)
- guard let additionalUserInfo = authResult?.additionalUserInfo,
- let profile = additionalUserInfo.profile as? [String: String] else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertEqual(profile, self.kGoogleProfile)
- XCTAssertEqual(additionalUserInfo.username, self.kGoogleDisplayName)
- XCTAssertEqual(additionalUserInfo.providerID, GoogleAuthProvider.id)
- } catch {
- XCTFail("\(error)")
- }
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- try assertUserGoogle(auth.currentUser)
- }
- /** @fn testSignInWithGoogleCredentialFailure
- @brief Tests the flow of a failed @c signInWithCredential:completion: call with an
- Google Sign-In credential.
- */
- func testSignInWithGoogleCredentialFailure() throws {
- let expectation = self.expectation(description: #function)
- setFakeGoogleGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyAssertionRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, GoogleAuthProvider.id)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(serverErrorMessage: "EMAIL_EXISTS")
- }
- try auth.signOut()
- let googleCredential = GoogleAuthProvider.credential(withIDToken: kGoogleIDToken,
- accessToken: kGoogleAccessToken)
- auth.signIn(with: googleCredential) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.emailAlreadyInUse.rawValue)
- XCTAssertEqual((error as? NSError)?.userInfo[NSLocalizedDescriptionKey] as? String,
- "The email address is already in use by another account.")
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSignInWithAppleCredentialFullNameInRequest
- @brief Tests the flow of a successful @c signInWithCredential:completion: call
- with an Apple Sign-In credential with a full name. This test differentiates from
- @c testSignInWithCredentialSuccess only in verifying the full name.
- */
- func testSignInWithAppleCredentialFullNameInRequest() throws {
- let expectation = self.expectation(description: #function)
- let kAppleIDToken = "APPLE_ID_TOKEN"
- let kFirst = "First"
- let kLast = "Last"
- var fullName = PersonNameComponents()
- fullName.givenName = kFirst
- fullName.familyName = kLast
- setFakeGoogleGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyAssertionRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, AuthProviderID.apple.rawValue)
- XCTAssertEqual(request.providerIDToken, kAppleIDToken)
- XCTAssertEqual(request.fullName, fullName)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": RPCBaseTests.kFakeAccessToken,
- "refreshToken": self.kRefreshToken,
- "federatedId": self.kGoogleID,
- "providerId": AuthProviderID.apple.rawValue,
- "localId": self.kLocalID,
- "displayName": self.kGoogleDisplayName,
- "rawUserInfo": self.kGoogleProfile,
- "firstName": kFirst,
- "lastName": kLast,
- "username": self.kGoogleDisplayName])
- }
- try auth.signOut()
- let appleCredential = OAuthProvider.appleCredential(withIDToken: kAppleIDToken,
- rawNonce: nil,
- fullName: fullName)
- auth.signIn(with: appleCredential) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- do {
- try self.assertUserGoogle(authResult?.user)
- guard let additionalUserInfo = authResult?.additionalUserInfo,
- let profile = additionalUserInfo.profile as? [String: String] else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertEqual(profile, self.kGoogleProfile)
- XCTAssertEqual(additionalUserInfo.username, self.kGoogleDisplayName)
- XCTAssertEqual(additionalUserInfo.providerID, AuthProviderID.apple.rawValue)
- } catch {
- XCTFail("\(error)")
- }
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNotNil(auth.currentUser)
- }
- /** @fn testSignInAnonymouslySuccess
- @brief Tests the flow of a successful @c signInAnonymouslyWithCompletion: call.
- */
- func testSignInAnonymouslySuccess() throws {
- let expectation = self.expectation(description: #function)
- setFakeSecureTokenService()
- setFakeGetAccountProviderAnonymous()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? SignUpNewUserRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertNil(request.email)
- XCTAssertNil(request.password)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- auth?.signInAnonymously { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertNil(error)
- XCTAssertTrue(Thread.isMainThread)
- self.assertUserAnonymous(authResult?.user)
- guard let userInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertTrue(userInfo.isNewUser)
- XCTAssertNil(userInfo.username)
- XCTAssertNil(userInfo.profile)
- XCTAssertEqual(userInfo.providerID, "")
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- try assertUserAnonymous(XCTUnwrap(auth?.currentUser))
- }
- /** @fn testSignInAnonymouslyFailure
- @brief Tests the flow of a failed @c signInAnonymouslyWithCompletion: call.
- */
- func testSignInAnonymouslyFailure() throws {
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- try self.rpcIssuer.respond(serverErrorMessage: "OPERATION_NOT_ALLOWED")
- }
- try auth?.signOut()
- auth?.verifyPasswordResetCode(kFakeOobCode) { email, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(email)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.operationNotAllowed.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testSignInWithCustomTokenSuccess
- @brief Tests the flow of a successful @c signInWithCustomToken:completion: call.
- */
- func testSignInWithCustomTokenSuccess() throws {
- let expectation = self.expectation(description: #function)
- setFakeSecureTokenService()
- setFakeGetAccountProvider()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyCustomTokenRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.token, self.kCustomToken)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": false,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- auth?.signIn(withCustomToken: kCustomToken) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- self.assertUser(authResult?.user)
- guard let userInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertFalse(userInfo.isNewUser)
- XCTAssertNil(userInfo.username)
- XCTAssertNil(userInfo.profile)
- XCTAssertEqual(userInfo.providerID, "")
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- /** @fn testSignInWithCustomTokenFailure
- @brief Tests the flow of a failed @c signInWithCustomToken:completion: call.
- */
- func testSignInWithCustomTokenFailure() throws {
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- try self.rpcIssuer.respond(serverErrorMessage: "INVALID_CUSTOM_TOKEN")
- }
- try auth?.signOut()
- auth?.signIn(withCustomToken: kCustomToken) { authResult, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult?.user)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.invalidCustomToken.rawValue)
- XCTAssertNotNil((error as? NSError)?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- #if os(iOS)
- /** @fn testCreateUserWithEmailPasswordWithRecaptchaVerificationSuccess
- @brief Tests the flow of a successful @c createUserWithEmail:password:completion: call.
- */
- func testCreateUserWithEmailPasswordWithRecaptchaVerificationSuccess() throws {
- let expectation = self.expectation(description: #function)
- let kTestRecaptchaKey = "projects/123/keys/456"
- rpcIssuer.recaptchaSiteKey = kTestRecaptchaKey
- setFakeSecureTokenService()
- setFakeGetAccountProvider()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? SignUpNewUserRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertTrue(request.returnSecureToken)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- auth?.createUser(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- self.assertUser(authResult?.user)
- guard let userInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertTrue(userInfo.isNewUser)
- XCTAssertNil(userInfo.username)
- XCTAssertNil(userInfo.profile)
- XCTAssertEqual(userInfo.providerID, EmailAuthProvider.id)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- /** @fn testCreateUserWithEmailPasswordWithRecaptchaVerificationFallbackSuccess
- @brief Tests the flow of a successful @c createUserWithEmail:password:completion: call.
- */
- func testCreateUserWithEmailPasswordWithRecaptchaVerificationFallbackSuccess() throws {
- let expectation = self.expectation(description: #function)
- let kTestRecaptchaKey = "projects/123/keys/456"
- rpcIssuer.recaptchaSiteKey = kTestRecaptchaKey
- setFakeSecureTokenService()
- setFakeGetAccountProvider()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? SignUpNewUserRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertTrue(request.returnSecureToken)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(serverErrorMessage: "MISSING_RECAPTCHA_TOKEN")
- }
- rpcIssuer.nextRespondBlock = {
- // 4. Validate again the created Request instance after the recaptcha retry.
- let request = try XCTUnwrap(self.rpcIssuer.request as? SignUpNewUserRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertTrue(request.returnSecureToken)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 5. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- auth?.createUser(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- self.assertUser(authResult?.user)
- guard let userInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertTrue(userInfo.isNewUser)
- XCTAssertNil(userInfo.username)
- XCTAssertNil(userInfo.profile)
- XCTAssertEqual(userInfo.providerID, EmailAuthProvider.id)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- #endif
- /** @fn testCreateUserWithEmailPasswordSuccess
- @brief Tests the flow of a successful @c createUserWithEmail:password:completion: call.
- */
- func testCreateUserWithEmailPasswordSuccess() throws {
- let expectation = self.expectation(description: #function)
- setFakeSecureTokenService()
- setFakeGetAccountProvider()
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? SignUpNewUserRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- try auth?.signOut()
- auth?.createUser(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- self.assertUser(authResult?.user)
- guard let userInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertTrue(userInfo.isNewUser)
- XCTAssertNil(userInfo.username)
- XCTAssertNil(userInfo.profile)
- XCTAssertEqual(userInfo.providerID, EmailAuthProvider.id)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- /** @fn testCreateUserWithEmailPasswordFailure
- @brief Tests the flow of a failed @c createUserWithEmail:password:completion: call.
- */
- func testCreateUserWithEmailPasswordFailure() throws {
- let expectation = self.expectation(description: #function)
- let reason = "The password must be 6 characters long or more."
- rpcIssuer.respondBlock = {
- try self.rpcIssuer.respond(serverErrorMessage: "WEAK_PASSWORD")
- }
- try auth?.signOut()
- auth?.createUser(withEmail: kEmail, password: kFakePassword) { authResult, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult?.user)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.weakPassword.rawValue)
- XCTAssertEqual((error as? NSError)?.userInfo[NSLocalizedDescriptionKey] as? String, reason)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- XCTAssertNil(auth?.currentUser)
- }
- /** @fn testCreateUserEmptyPasswordFailure
- @brief Tests the flow of a failed @c createUserWithEmail:password:completion: call due to an
- empty password. This error occurs on the client side, so there is no need to fake an RPC
- response.
- */
- func testCreateUserEmptyPasswordFailure() throws {
- let expectation = self.expectation(description: #function)
- try auth?.signOut()
- auth?.createUser(withEmail: kEmail, password: "") { authResult, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult?.user)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.weakPassword.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testCreateUserEmptyEmailFailure
- @brief Tests the flow of a failed @c createUserWithEmail:password:completion: call due to an
- empty email address. This error occurs on the client side, so there is no need to fake an
- RPC response.
- */
- func testCreateUserEmptyEmailFailure() throws {
- let expectation = self.expectation(description: #function)
- try auth?.signOut()
- auth?.createUser(withEmail: "", password: kFakePassword) { authResult, error in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(authResult?.user)
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.missingEmail.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- #if os(iOS)
- /** @fn testSendPasswordResetEmailWithRecaptchaSuccess
- @brief Tests the flow of a successful @c sendPasswordResetWithEmail:completion: call.
- */
- func testSendPasswordResetEmailWithRecaptchaSuccess() throws {
- let expectation = self.expectation(description: #function)
- let kTestRecaptchaKey = "projects/123/keys/456"
- rpcIssuer.recaptchaSiteKey = kTestRecaptchaKey
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- auth?.sendPasswordReset(withEmail: kEmail) { error in
- // 4. After the response triggers the callback, verify success.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSendPasswordResetEmailWithRecaptchaFallbackSuccess
- @brief Tests the flow of a successful @c sendPasswordResetWithEmail:completion: call.
- */
- func testSendPasswordResetEmailWithRecaptchaFallbackSuccess() throws {
- let expectation = self.expectation(description: #function)
- let kTestRecaptchaKey = "projects/123/keys/456"
- rpcIssuer.recaptchaSiteKey = kTestRecaptchaKey
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(serverErrorMessage: "MISSING_RECAPTCHA_TOKEN")
- }
- rpcIssuer.nextRespondBlock = {
- // 4. Validate again the created Request instance after the recaptcha retry.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 5. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- auth?.sendPasswordReset(withEmail: kEmail) { error in
- // 4. After the response triggers the callback, verify success.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- #endif
- /** @fn testSendPasswordResetEmailSuccess
- @brief Tests the flow of a successful @c sendPasswordReset call.
- */
- func testSendPasswordResetEmailSuccess() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- auth?.sendPasswordReset(withEmail: kEmail) { error in
- // 4. After the response triggers the callback, verify success.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSendPasswordResetEmailFailure
- @brief Tests the flow of a failed @c sendPasswordReset call.
- */
- func testSendPasswordResetEmailFailure() throws {
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- try self.rpcIssuer.respond(underlyingErrorMessage: "ipRefererBlocked")
- }
- auth?.sendPasswordReset(withEmail: kEmail) { error in
- XCTAssertTrue(Thread.isMainThread)
- let rpcError = (error as? NSError)!
- XCTAssertEqual(rpcError.code, AuthErrorCode.appNotAuthorized.rawValue)
- XCTAssertNotNil(rpcError.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- #if os(iOS)
- /** @fn testSendSignInLinkToEmailWithRecaptchaSuccess
- @brief Tests the flow of a successful @c sendSignInLinkToEmail:actionCodeSettings: call.
- */
- func testSendSignInLinkToEmailWithRecaptchaSuccess() throws {
- let expectation = self.expectation(description: #function)
- let kTestRecaptchaKey = "projects/123/keys/456"
- rpcIssuer.recaptchaSiteKey = kTestRecaptchaKey
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.continueURL, self.kContinueURL)
- XCTAssertTrue(request.handleCodeInApp)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- auth?.sendSignInLink(toEmail: kEmail,
- actionCodeSettings: fakeActionCodeSettings()) { error in
- // 4. After the response triggers the callback, verify success.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSendSignInLinkToEmailWithRecaptchaFallbackSuccess
- @brief Tests the flow of a successful @c sendSignInLinkToEmail:actionCodeSettings: call.
- */
- func testSendSignInLinkToEmailWithRecaptchaFallbackSuccess() throws {
- let expectation = self.expectation(description: #function)
- let kTestRecaptchaKey = "projects/123/keys/456"
- rpcIssuer.recaptchaSiteKey = kTestRecaptchaKey
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.continueURL, self.kContinueURL)
- XCTAssertTrue(request.handleCodeInApp)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- rpcIssuer.nextRespondBlock = {
- // 4. Validate again the created Request instance after the recaptcha retry.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- request.injectRecaptchaFields(recaptchaResponse: AuthTests.kFakeRecaptchaResponse,
- recaptchaVersion: AuthTests.kFakeRecaptchaVersion)
- // 5. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": AuthTests.kAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "refreshToken": self.kRefreshToken])
- }
- auth?.sendSignInLink(toEmail: kEmail,
- actionCodeSettings: fakeActionCodeSettings()) { error in
- // 4. After the response triggers the callback, verify success.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- #endif
- /** @fn testSendSignInLinkToEmailSuccess
- @brief Tests the flow of a successful @c sendSignInLinkToEmail call.
- */
- func testSendSignInLinkToEmailSuccess() throws {
- let expectation = self.expectation(description: #function)
- // 1. Setup respond block to test and fake send request.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? GetOOBConfirmationCodeRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.continueURL, self.kContinueURL)
- XCTAssertTrue(request.handleCodeInApp)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- auth?.sendSignInLink(toEmail: kEmail,
- actionCodeSettings: fakeActionCodeSettings()) { error in
- // 4. After the response triggers the callback, verify success.
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testSendSignInLinkToEmailFailure
- @brief Tests the flow of a failed @c sendSignInLink call.
- */
- func testSendSignInLinkToEmailFailure() throws {
- let expectation = self.expectation(description: #function)
- rpcIssuer.respondBlock = {
- try self.rpcIssuer.respond(underlyingErrorMessage: "ipRefererBlocked")
- }
- auth?.sendSignInLink(toEmail: kEmail,
- actionCodeSettings: fakeActionCodeSettings()) { error in
- XCTAssertTrue(Thread.isMainThread)
- let rpcError = error as? NSError
- XCTAssertEqual(rpcError?.code, AuthErrorCode.appNotAuthorized.rawValue)
- XCTAssertNotNil(rpcError?.userInfo[NSLocalizedDescriptionKey])
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testUpdateCurrentUserFailure
- @brief Tests the flow of a failed @c updateCurrentUser:completion:
- call.
- */
- func testUpdateCurrentUserFailure() throws {
- try waitForSignInWithAccessToken()
- let expectation = self.expectation(description: #function)
- let kTestAPIKey2 = "fakeAPIKey2"
- let auth = try XCTUnwrap(auth)
- let user2 = auth.currentUser
- user2?.requestConfiguration = AuthRequestConfiguration(apiKey: kTestAPIKey2,
- appID: kTestFirebaseAppID)
- rpcIssuer.respondBlock = {
- try self.rpcIssuer.respond(underlyingErrorMessage: "keyInvalid")
- }
- // Clear fake so we can inject error
- rpcIssuer.fakeGetAccountProviderJSON = nil
- auth.updateCurrentUser(user2) { error in
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.invalidAPIKey.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testUpdateCurrentUserFailureNetworkError
- @brief Tests the flow of a failed @c updateCurrentUser:completion:
- call with a network error.
- */
- func testUpdateCurrentUserFailureNetworkError() throws {
- try waitForSignInWithAccessToken()
- let expectation = self.expectation(description: #function)
- let kTestAPIKey2 = "fakeAPIKey2"
- let auth = try XCTUnwrap(auth)
- let user2 = auth.currentUser
- user2?.requestConfiguration = AuthRequestConfiguration(apiKey: kTestAPIKey2,
- appID: kTestFirebaseAppID)
- rpcIssuer.respondBlock = {
- let kFakeErrorDomain = "fakeDomain"
- let kFakeErrorCode = -1
- let responseError = NSError(domain: kFakeErrorDomain, code: kFakeErrorCode)
- return (nil, responseError)
- }
- // Clear fake so we can inject error
- rpcIssuer.fakeGetAccountProviderJSON = nil
- auth.updateCurrentUser(user2) { error in
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.networkError.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testUpdateCurrentUserFailureNullUser
- @brief Tests the flow of a failed @c updateCurrentUser:completion:
- call with FIRAuthErrorCodeNullUser.
- */
- func testUpdateCurrentUserFailureNullUser() throws {
- try waitForSignInWithAccessToken()
- let expectation = self.expectation(description: #function)
- auth.updateCurrentUser(nil) { error in
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.nullUser.rawValue)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testUpdateCurrentUserFailureTenantIDMismatch
- @brief Tests the flow of a failed @c updateCurrentUser:completion:
- call with FIRAuthErrorCodeTenantIDMismatch.
- */
- func testUpdateCurrentUserFailureTenantIDMismatch() throws {
- // User without tenant id
- try waitForSignInWithAccessToken()
- let auth = try XCTUnwrap(auth)
- let user1 = auth.currentUser
- try auth.signOut()
- // User with tenant id "tenant-id"
- auth.tenantID = "tenant-id-1"
- let kTestAccessToken2 = "fakeAccessToken2"
- try waitForSignInWithAccessToken(fakeAccessToken: kTestAccessToken2)
- let user2 = auth.currentUser
- try auth.signOut()
- auth.tenantID = "tenant-id-2"
- let expectation = self.expectation(description: #function)
- auth.updateCurrentUser(user1) { error in
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.tenantIDMismatch.rawValue)
- expectation.fulfill()
- }
- try auth.signOut()
- auth.tenantID = "tenant-id-2"
- let expectation2 = self.expectation(description: "tenant-id-test2")
- auth.updateCurrentUser(user2) { error in
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.tenantIDMismatch.rawValue)
- expectation2.fulfill()
- }
- try auth.signOut()
- auth.tenantID = nil
- let expectation3 = self.expectation(description: "tenant-id-test3")
- auth.updateCurrentUser(user2) { error in
- XCTAssertEqual((error as? NSError)?.code, AuthErrorCode.tenantIDMismatch.rawValue)
- expectation3.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testUpdateCurrentUserSuccess
- @brief Tests the flow of a successful @c updateCurrentUser:completion:
- call with a network error.
- */
- func testUpdateCurrentUserSuccess() throws {
- // Sign in with the first user.
- try waitForSignInWithAccessToken()
- let auth = try XCTUnwrap(auth)
- let user1 = auth.currentUser
- let kTestAPIKey = "fakeAPIKey"
- user1?.requestConfiguration = AuthRequestConfiguration(apiKey: kTestAPIKey,
- appID: kTestFirebaseAppID)
- try auth.signOut()
- let kTestAccessToken2 = "fakeAccessToken2"
- try waitForSignInWithAccessToken(fakeAccessToken: kTestAccessToken2)
- let user2 = auth.currentUser
- let expectation = self.expectation(description: #function)
- // Current user should now be user2.
- XCTAssertEqual(auth.currentUser, user2)
- auth.updateCurrentUser(user1) { error in
- XCTAssertNil(error)
- // Current user should now be user1.
- XCTAssertEqual(auth.currentUser, user1)
- XCTAssertNotEqual(auth.currentUser, user2)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testRevokeTokenSuccess
- @brief Tests the flow of a successful @c revokeToken:completion.
- */
- func testRevokeTokenSuccess() throws {
- try waitForSignInWithAccessToken()
- let expectation = self.expectation(description: #function)
- let code = "code"
- rpcIssuer.respondBlock = {
- let request = try XCTUnwrap(self.rpcIssuer.request as? RevokeTokenRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, AuthProviderID.apple.rawValue)
- XCTAssertEqual(request.token, code)
- XCTAssertEqual(request.tokenType, .authorizationCode)
- // Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: [:])
- }
- auth?.revokeToken(withAuthorizationCode: code) { error in
- // Verify callback success.
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- /** @fn testRevokeTokenMissingCallback
- @brief Tests the flow of @c revokeToken:completion with a nil callback.
- */
- func testRevokeTokenMissingCallback() throws {
- try waitForSignInWithAccessToken()
- let code = "code"
- let issuer = try XCTUnwrap(rpcIssuer)
- issuer.respondBlock = {
- let request = try XCTUnwrap(issuer.request as? RevokeTokenRequest)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertEqual(request.providerID, AuthProviderID.apple.rawValue)
- XCTAssertEqual(request.token, code)
- XCTAssertEqual(request.tokenType, .authorizationCode)
- // Send the response from the fake backend.
- return try issuer.respond(withJSON: [:])
- }
- auth?.revokeToken(withAuthorizationCode: code)
- }
- /** @fn testSignOut
- @brief Tests the @c signOut: method.
- */
- func testSignOut() throws {
- try waitForSignInWithAccessToken()
- // Verify signing out succeeds and clears the current user.
- let auth = try XCTUnwrap(auth)
- try auth.signOut()
- XCTAssertNil(auth.currentUser)
- }
- /** @fn testIsSignInWithEmailLink
- @brief Tests the @c isSignInWithEmailLink: method.
- */
- func testIsSignInWithEmailLink() throws {
- let auth = try XCTUnwrap(auth)
- let kBadSignInEmailLink = "http://www.facebook.com"
- XCTAssertTrue(auth.isSignIn(withEmailLink: kFakeEmailSignInLink))
- XCTAssertTrue(auth.isSignIn(withEmailLink: kFakeEmailSignInDeeplink))
- XCTAssertFalse(auth.isSignIn(withEmailLink: kBadSignInEmailLink))
- XCTAssertFalse(auth.isSignIn(withEmailLink: ""))
- }
- /** @fn testAuthStateChanges
- @brief Tests @c addAuthStateDidChangeListener: and @c removeAuthStateDidChangeListener: methods.
- */
- func testAuthStateChanges() throws {
- // Set up listener.
- let auth = try XCTUnwrap(auth)
- var shouldHaveUser = false
- var expectation: XCTestExpectation?
- let listener = { listenerAuth, user in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertEqual(auth, listenerAuth)
- XCTAssertEqual(user, auth.currentUser)
- if shouldHaveUser {
- XCTAssertNotNil(user)
- } else {
- XCTAssertNil(user)
- }
- // `expectation` being nil means the listener is not expected to be fired at this moment.
- XCTAssertNotNil(expectation)
- expectation?.fulfill()
- }
- try auth.signOut()
- // Listener should fire immediately when attached.
- expectation = self.expectation(description: "initial")
- shouldHaveUser = false
- let handle = auth.addStateDidChangeListener(listener)
- waitForExpectations(timeout: 5)
- expectation = nil
- // Listener should fire for signing in.
- expectation = self
- .expectation(description: "sign-in") // waited on in waitForSignInWithAccessToken
- shouldHaveUser = true
- try waitForSignInWithAccessToken()
- // Listener should not fire for signing in again.
- expectation = nil
- shouldHaveUser = true
- try waitForSignInWithAccessToken()
- // Listener should fire for signing out.
- expectation = self.expectation(description: "sign-out")
- shouldHaveUser = false
- try auth.signOut()
- waitForExpectations(timeout: 5)
- // Listener should no longer fire once detached.
- expectation = nil
- auth.removeStateDidChangeListener(handle)
- try waitForSignInWithAccessToken()
- }
- /** @fn testIDTokenChanges
- @brief Tests @c addIDTokenDidChangeListener: and @c removeIDTokenDidChangeListener: methods.
- */
- func testIDTokenChanges() throws {
- // Set up listener.
- let auth = try XCTUnwrap(auth)
- var shouldHaveUser = false
- var expectation: XCTestExpectation?
- var fulfilled = false
- let listener = { listenerAuth, user in
- XCTAssertTrue(Thread.isMainThread)
- XCTAssertEqual(auth, listenerAuth)
- XCTAssertEqual(user, auth.currentUser)
- if shouldHaveUser {
- XCTAssertNotNil(user)
- } else {
- XCTAssertNil(user)
- }
- // `expectation` being nil means the listener is not expected to be fired at this moment.
- XCTAssertNotNil(expectation)
- if !fulfilled {
- fulfilled = true
- expectation?.fulfill()
- }
- }
- try auth.signOut()
- // Listener should fire immediately when attached.
- expectation = self.expectation(description: "initial")
- shouldHaveUser = false
- let handle = auth.addIDTokenDidChangeListener(listener)
- waitForExpectations(timeout: 5)
- expectation = nil
- // Listener should fire for signing in. Expectation is waited on in
- // waitForSignInWithAccessToken.
- fulfilled = false
- expectation = self.expectation(description: "sign-in")
- shouldHaveUser = true
- try waitForSignInWithAccessToken()
- // Listener should not fire for signing in again.
- expectation = nil
- shouldHaveUser = true
- try waitForSignInWithAccessToken()
- // Listener should fire for signing in again as the same user with another access token.
- fulfilled = false
- expectation = self.expectation(description: "sign-in")
- shouldHaveUser = true
- try waitForSignInWithAccessToken(fakeAccessToken: AuthTests.kNewAccessToken)
- // Listener should fire for signing out.
- fulfilled = false
- expectation = self.expectation(description: "sign-out")
- shouldHaveUser = false
- try auth.signOut()
- waitForExpectations(timeout: 5)
- // Listener should no longer fire once detached.
- expectation = nil
- auth.removeStateDidChangeListener(handle)
- try waitForSignInWithAccessToken()
- }
- /** @fn testUseEmulator
- @brief Tests the @c useEmulatorWithHost:port: method.
- */
- func testUseEmulator() throws {
- auth.useEmulator(withHost: "host", port: 12345)
- XCTAssertEqual("host:12345", auth.requestConfiguration.emulatorHostAndPort)
- #if os(iOS)
- let settings = try XCTUnwrap(auth.settings)
- XCTAssertTrue(settings.isAppVerificationDisabledForTesting)
- #endif
- }
- /** @fn testUseEmulatorNeverCalled
- @brief Tests that the emulatorHostAndPort stored in @c FIRAuthRequestConfiguration is nil if the
- @c useEmulatorWithHost:port: is not called.
- */
- func testUseEmulatorNeverCalled() throws {
- XCTAssertNil(auth.requestConfiguration.emulatorHostAndPort)
- #if os(iOS)
- let settings = try XCTUnwrap(auth.settings)
- XCTAssertFalse(settings.isAppVerificationDisabledForTesting)
- #endif
- }
- /** @fn testUseEmulatorIPv6Address
- @brief Tests the @c useEmulatorWithHost:port: method with an IPv6 host address.
- */
- func testUseEmulatorIPv6Address() throws {
- auth.useEmulator(withHost: "::1", port: 12345)
- XCTAssertEqual("[::1]:12345", auth.requestConfiguration.emulatorHostAndPort)
- #if os(iOS)
- let settings = try XCTUnwrap(auth.settings)
- XCTAssertTrue(settings.isAppVerificationDisabledForTesting)
- #endif
- }
- // MARK: Automatic Token Refresh Tests.
- /** @fn testAutomaticTokenRefresh
- @brief Tests a successful flow to automatically refresh tokens for a signed in user.
- */
- func testAutomaticTokenRefresh() throws {
- try auth.signOut()
- // Enable auto refresh
- enableAutoTokenRefresh()
- // Sign in a user.
- try waitForSignInWithAccessToken()
- setFakeSecureTokenService(fakeAccessToken: AuthTests.kNewAccessToken)
- // Verify that the current user's access token is the "old" access token before automatic token
- // refresh.
- XCTAssertEqual(AuthTests.kAccessToken, auth.currentUser?.rawAccessToken())
- // Execute saved token refresh task.
- let expectation = self.expectation(description: #function)
- kAuthGlobalWorkQueue.async {
- XCTAssertNotNil(self.authDispatcherCallback)
- self.authDispatcherCallback?()
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- waitForAuthGlobalWorkQueueDrain()
- // Verify that current user's access token is the "new" access token provided in the mock secure
- // token response during automatic token refresh.
- RPCBaseTests.waitSleep()
- XCTAssertEqual(AuthTests.kNewAccessToken, auth.currentUser?.rawAccessToken())
- }
- /** @fn testAutomaticTokenRefreshInvalidTokenFailure
- @brief Tests an unsuccessful flow to auto refresh tokens with an "invalid token" error.
- This error should cause the user to be signed out.
- */
- func testAutomaticTokenRefreshInvalidTokenFailure() throws {
- try auth.signOut()
- // Enable auto refresh
- enableAutoTokenRefresh()
- // Sign in a user.
- try waitForSignInWithAccessToken()
- // Set up expectation for secureToken RPC made by a failed attempt to refresh tokens.
- rpcIssuer.secureTokenErrorString = "INVALID_ID_TOKEN"
- // Verify that the current user's access token is the "old" access token before automatic token
- // refresh.
- XCTAssertEqual(AuthTests.kAccessToken, auth.currentUser?.rawAccessToken())
- // Execute saved token refresh task.
- let expectation = self.expectation(description: #function)
- kAuthGlobalWorkQueue.async {
- XCTAssertNotNil(self.authDispatcherCallback)
- self.authDispatcherCallback?()
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- waitForAuthGlobalWorkQueueDrain()
- // Verify that the user is nil after failed attempt to refresh tokens caused signed out.
- RPCBaseTests.waitSleep()
- XCTAssertNil(auth.currentUser)
- }
- /** @fn testAutomaticTokenRefreshRetry
- @brief Tests that a retry is attempted for a automatic token refresh task (which is not due to
- invalid tokens). The initial attempt to refresh the access token fails, but the second
- attempt is successful.
- */
- func testAutomaticTokenRefreshRetry() throws {
- try auth.signOut()
- // Enable auto refresh
- enableAutoTokenRefresh()
- // Sign in a user.
- try waitForSignInWithAccessToken()
- // Set up expectation for secureToken RPC made by a failed attempt to refresh tokens.
- rpcIssuer.secureTokenNetworkError = NSError(domain: "ERROR", code: -1)
- // Execute saved token refresh task.
- let expectation = self.expectation(description: #function)
- kAuthGlobalWorkQueue.async {
- XCTAssertNotNil(self.authDispatcherCallback)
- self.authDispatcherCallback?()
- self.authDispatcherCallback = nil
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- waitForAuthGlobalWorkQueueDrain()
- rpcIssuer.secureTokenNetworkError = nil
- setFakeSecureTokenService(fakeAccessToken: AuthTests.kNewAccessToken)
- // The old access token should still be the current user's access token and not the new access
- // token (kNewAccessToken).
- XCTAssertEqual(AuthTests.kAccessToken, auth.currentUser?.rawAccessToken())
- // Execute saved token refresh task.
- let expectation2 = self.expectation(description: "dispatchAfterExpectation")
- kAuthGlobalWorkQueue.async {
- RPCBaseTests.waitSleep()
- XCTAssertNotNil(self.authDispatcherCallback)
- self.authDispatcherCallback?()
- expectation2.fulfill()
- }
- waitForExpectations(timeout: 5)
- waitForAuthGlobalWorkQueueDrain()
- // Time for callback to run.
- RPCBaseTests.waitSleep()
- // Verify that current user's access token is the "new" access token provided in the mock secure
- // token response during automatic token refresh.
- XCTAssertEqual(AuthTests.kNewAccessToken, auth.currentUser?.rawAccessToken())
- }
- #if os(iOS)
- /** @fn testAutoRefreshAppForegroundedNotification
- @brief Tests that app foreground notification triggers the scheduling of an automatic token
- refresh task.
- */
- func testAutoRefreshAppForegroundedNotification() throws {
- try auth.signOut()
- // Enable auto refresh
- enableAutoTokenRefresh()
- // Sign in a user.
- try waitForSignInWithAccessToken()
- // Post "UIApplicationDidBecomeActiveNotification" to trigger scheduling token refresh task.
- NotificationCenter.default.post(name: UIApplication.didBecomeActiveNotification, object: nil)
- setFakeSecureTokenService(fakeAccessToken: AuthTests.kNewAccessToken)
- // Verify that the current user's access token is the "old" access token before automatic
- // token refresh.
- XCTAssertEqual(AuthTests.kAccessToken, auth.currentUser?.rawAccessToken())
- // Execute saved token refresh task.
- let expectation = self.expectation(description: #function)
- kAuthGlobalWorkQueue.async {
- XCTAssertNotNil(self.authDispatcherCallback)
- self.authDispatcherCallback?()
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- waitForAuthGlobalWorkQueueDrain()
- // Time for callback to run.
- RPCBaseTests.waitSleep()
- // Verify that current user's access token is the "new" access token provided in the mock
- // secure token response during automatic token refresh.
- XCTAssertEqual(AuthTests.kNewAccessToken, auth.currentUser?.rawAccessToken())
- }
- #endif
- // MARK: Application Delegate tests.
- #if os(iOS)
- func testAppDidRegisterForRemoteNotifications_APNSTokenUpdated() {
- class FakeAuthTokenManager: AuthAPNSTokenManager, @unchecked Sendable {
- override var token: AuthAPNSToken? {
- get {
- return tokenStore
- }
- set(setToken) {
- tokenStore = setToken
- }
- }
- }
- let apnsToken = Data()
- auth.tokenManager = FakeAuthTokenManager(withApplication: UIApplication.shared)
- auth.application(UIApplication.shared,
- didRegisterForRemoteNotificationsWithDeviceToken: apnsToken)
- XCTAssertEqual(auth.tokenManager.token?.data, apnsToken)
- XCTAssertEqual(auth.tokenManager.token?.type, .unknown)
- }
- func testAppDidFailToRegisterForRemoteNotifications_TokenManagerCancels() {
- class FakeAuthTokenManager: AuthAPNSTokenManager, @unchecked Sendable {
- var cancelled = false
- override func cancel(withError error: Error) {
- cancelled = true
- }
- }
- let error = NSError(domain: "AuthTests", code: -1)
- let fakeTokenManager = FakeAuthTokenManager(withApplication: UIApplication.shared)
- auth.tokenManager = fakeTokenManager
- XCTAssertFalse(fakeTokenManager.cancelled)
- auth.application(UIApplication.shared,
- didFailToRegisterForRemoteNotificationsWithError: error)
- XCTAssertTrue(fakeTokenManager.cancelled)
- }
- func testAppDidReceiveRemoteNotificationWithCompletion_NotificationManagerHandleCanNotification() {
- class FakeNotificationManager: AuthNotificationManager {
- var canHandled = false
- override func canHandle(notification: [AnyHashable: Any]) -> Bool {
- canHandled = true
- return true
- }
- }
- let notification = ["test": ""]
- let fakeKeychain = AuthKeychainServices(
- service: "AuthTests",
- storage: FakeAuthKeychainStorage()
- )
- let appCredentialManager = AuthAppCredentialManager(withKeychain: fakeKeychain)
- let fakeNotificationManager = FakeNotificationManager(withApplication: UIApplication.shared,
- appCredentialManager: appCredentialManager)
- auth.notificationManager = fakeNotificationManager
- XCTAssertFalse(fakeNotificationManager.canHandled)
- auth.application(UIApplication.shared,
- didReceiveRemoteNotification: notification) { _ in
- }
- XCTAssertTrue(fakeNotificationManager.canHandled)
- }
- func testAppOpenURL_AuthPresenterCanHandleURL() throws {
- class FakeURLPresenter: AuthURLPresenter {
- var canHandled = false
- override func canHandle(url: URL) -> Bool {
- canHandled = true
- return true
- }
- }
- let url = try XCTUnwrap(URL(string: "https://localhost"))
- let fakeURLPresenter = FakeURLPresenter()
- auth.authURLPresenter = fakeURLPresenter
- XCTAssertFalse(fakeURLPresenter.canHandled)
- XCTAssertTrue(auth.application(UIApplication.shared, open: url, options: [:]))
- XCTAssertTrue(fakeURLPresenter.canHandled)
- }
- #endif // os(iOS)
- // MARK: Interoperability Tests
- func testComponentsRegistered() throws {
- // Verify that the components are registered properly. Check the count, because any time a new
- // component is added it should be added to the test suite as well.
- XCTAssertEqual(AuthComponent.componentsToRegister().count, 1)
- // TODO: Can/should we do something like?
- // XCTAssert(component.protocol == @protocol(FIRAuthInterop));
- }
- // MARK: Helper Functions
- private func enableAutoTokenRefresh() {
- let expectation = self.expectation(description: #function)
- auth.getToken(forcingRefresh: false) { token, error in
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- }
- private func waitForSignInWithAccessToken(fakeAccessToken: String = kAccessToken) throws {
- let kRefreshToken = "fakeRefreshToken"
- let expectation = self.expectation(description: #function)
- setFakeGetAccountProvider()
- setFakeSecureTokenService()
- // 1. Set up respondBlock to test request and send it to generate a fake response.
- rpcIssuer.respondBlock = {
- // 2. Validate the created Request instance.
- let request = try XCTUnwrap(self.rpcIssuer.request as? VerifyPasswordRequest)
- XCTAssertEqual(request.email, self.kEmail)
- XCTAssertEqual(request.password, self.kFakePassword)
- XCTAssertEqual(request.apiKey, AuthTests.kFakeAPIKey)
- XCTAssertTrue(request.returnSecureToken)
- // 3. Send the response from the fake backend.
- return try self.rpcIssuer.respond(withJSON: ["idToken": fakeAccessToken,
- "email": self.kEmail,
- "isNewUser": true,
- "expiresIn": "3600",
- "refreshToken": kRefreshToken])
- }
- auth?.signIn(withEmail: kEmail, password: kFakePassword) { authResult, error in
- // 4. After the response triggers the callback, verify the returned result.
- XCTAssertTrue(Thread.isMainThread)
- guard let user = authResult?.user else {
- XCTFail("authResult.user is missing")
- return
- }
- XCTAssertEqual(user.refreshToken, kRefreshToken)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.email, self.kEmail)
- guard let additionalUserInfo = authResult?.additionalUserInfo else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertFalse(additionalUserInfo.isNewUser)
- XCTAssertEqual(additionalUserInfo.providerID, EmailAuthProvider.id)
- XCTAssertNil(error)
- expectation.fulfill()
- }
- waitForExpectations(timeout: 5)
- assertUser(auth?.currentUser)
- }
- private func assertUser(_ user: User?) {
- guard let user = user else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertEqual(user.uid, kLocalID)
- XCTAssertEqual(user.displayName, kDisplayName)
- XCTAssertEqual(user.email, kEmail)
- XCTAssertFalse(user.isAnonymous)
- XCTAssertEqual(user.providerData.count, 1)
- }
- private func assertUserAnonymous(_ user: User?) {
- guard let user = user else {
- XCTFail("authResult.additionalUserInfo is missing")
- return
- }
- XCTAssertEqual(user.uid, kLocalID)
- XCTAssertNil(user.email)
- XCTAssertNil(user.displayName)
- XCTAssertTrue(user.isAnonymous)
- XCTAssertEqual(user.providerData.count, 0)
- }
- }
|