Add Auth Integration tests for new APIs (#709)

* Add Auth Integration tests for new APIs
* Update Functions and Firestore tests which uses Auth APIs
* Change `FirebaseUser.IsValid()` from a property to a method, to be aligned with `Credential.IsValid()`

Author: chkuang-g

auth/testapp/Assets/Firebase/Sample/Auth/UIHandler.cs

@@ -183,6 +183,33 @@ protected void DisplaySignInResult(Firebase.Auth.SignInResult result, int indent
       }
     }
 
+    // Display user information reported
+    protected void DisplayAuthResult(Firebase.Auth.AuthResult result, int indentLevel) {
+      string indent = new String(' ', indentLevel * 2);
+      DisplayDetailedUserInfo(result.User, indentLevel);
+      var metadata = result.User != null ? result.User.Metadata : null;
+      if (metadata != null) {
+        DebugLog(String.Format("{0}Created: {1}", indent, metadata.CreationTimestamp));
+        DebugLog(String.Format("{0}Last Sign-in: {1}", indent, metadata.LastSignInTimestamp));
+      }
+      var info = result.AdditionalUserInfo;
+      if (info != null) {
+        DebugLog(String.Format("{0}Additional User Info:", indent));
+        DebugLog(String.Format("{0}  User Name: {1}", indent, info.UserName));
+        DebugLog(String.Format("{0}  Provider ID: {1}", indent, info.ProviderId));
+        DisplayProfile<string>(info.Profile, indentLevel + 1);
+      }
+      var credential = result.Credential;
+      if (credential != null) {
+        DebugLog(String.Format("{0}Credential:", indent));
+        DebugLog(String.Format("{0}  Is Valid?: {1}", indent, credential.IsValid()));
+        DebugLog(String.Format("{0}  Class Type: {1}", indent, credential.GetType()));
+        if (credential.IsValid()) {
+            DebugLog(String.Format("{0}  Provider: {1}", indent, credential.Provider));
+        }
+      }
+    }
+
     // Display user information.
     protected void DisplayUserInfo(Firebase.Auth.IUserInfo userInfo, int indentLevel) {
       string indent = new String(' ', indentLevel * 2);
@@ -291,6 +318,27 @@ public Task CreateUserWithEmailAsync_DEPRECATED() {
         }).Unwrap();
     }
 
+    // Create a user with the email and password.
+    public Task CreateUserWithEmailAsync() {
+      DebugLog(String.Format("Attempting to create user {0}...", email));
+      DisableUI();
+
+      // This passes the current displayName through to HandleCreateUserAsync
+      // so that it can be passed to UpdateUserProfile().  displayName will be
+      // reset by AuthStateChanged() when the new user is created and signed in.
+      string newDisplayName = displayName;
+      return auth.CreateUserWithEmailAndPasswordAsync(email, password)
+        .ContinueWithOnMainThread((task) => {
+          EnableUI();
+          if (LogTaskCompletion(task, "User Creation")) {
+            var user = task.Result.User;
+            DisplayDetailedUserInfo(user, 1);
+            return UpdateUserProfileAsync(newDisplayName: newDisplayName);
+          }
+          return task;
+        }).Unwrap();
+    }
+
     // Update the user's display name with the currently selected display name.
     public Task UpdateUserProfileAsync(string newDisplayName = null) {
       if (auth.CurrentUser == null) {
@@ -325,6 +373,20 @@ public Task SigninWithEmailAsync_DEPRECATED() {
       }
     }
 
+    // Sign-in with an email and password.
+    public Task SigninWithEmailAsync() {
+      DebugLog(String.Format("Attempting to sign in as {0}...", email));
+      DisableUI();
+      if (signInAndFetchProfile) {
+        return auth.SignInAndRetrieveDataWithCredentialAsync(
+          Firebase.Auth.EmailAuthProvider.GetCredential(email, password)).ContinueWithOnMainThread(
+            HandleSignInWithAuthResult);
+      } else {
+        return auth.SignInWithEmailAndPasswordAsync(email, password)
+          .ContinueWithOnMainThread(HandleSignInWithAuthResult);
+      }
+    }
+
     // This is functionally equivalent to the Signin() function.  However, it
     // illustrates the use of Credentials, which can be aquired from many
     // different sources of authentication.
@@ -336,7 +398,24 @@ public Task SigninWithEmailCredentialAsync_DEPRECATED() {
           Firebase.Auth.EmailAuthProvider.GetCredential(email, password)).ContinueWithOnMainThread(
             HandleSignInWithSignInResult);
       } else {
-        return auth.SignInWithCredentialAsync_DEPRECATED(
+        return auth.SignInWithCredentialAsync(
+          Firebase.Auth.EmailAuthProvider.GetCredential(email, password)).ContinueWithOnMainThread(
+            HandleSignInWithUser);
+      }
+    }
+
+    // This is functionally equivalent to the Signin() function.  However, it
+    // illustrates the use of Credentials, which can be aquired from many
+    // different sources of authentication.
+    public Task SigninWithEmailCredentialAsync() {
+      DebugLog(String.Format("Attempting to sign in as {0}...", email));
+      DisableUI();
+      if (signInAndFetchProfile) {
+        return auth.SignInAndRetrieveDataWithCredentialAsync(
+          Firebase.Auth.EmailAuthProvider.GetCredential(email, password)).ContinueWithOnMainThread(
+            HandleSignInWithAuthResult);
+      } else {
+        return auth.SignInWithCredentialAsync(
           Firebase.Auth.EmailAuthProvider.GetCredential(email, password)).ContinueWithOnMainThread(
             HandleSignInWithUser);
       }
@@ -349,6 +428,13 @@ public Task SigninAnonymouslyAsync_DEPRECATED() {
       return auth.SignInAnonymouslyAsync_DEPRECATED().ContinueWithOnMainThread(HandleSignInWithUser);
     }
 
+    // Attempt to sign in anonymously.
+    public Task SigninAnonymouslyAsync() {
+      DebugLog("Attempting to sign anonymously...");
+      DisableUI();
+      return auth.SignInAnonymouslyAsync().ContinueWithOnMainThread(HandleSignInWithAuthResult);
+    }
+
     public void AuthenticateToGameCenter() {
       #if (UNITY_IOS || UNITY_TVOS)
         Social.localUser.Authenticate(success => {
@@ -385,6 +471,19 @@ void HandleSignInWithUser(Task<Firebase.Auth.FirebaseUser> task) {
       }
     }
 
+    // Called when a sign-in without fetching profile data completes.
+    void HandleSignInWithAuthResult(Task<Firebase.Auth.AuthResult> task) {
+      EnableUI();
+      if (LogTaskCompletion(task, "Sign-in")) {
+        if(task.Result.User != null && task.Result.User.IsValid()) {
+          DisplayAuthResult(task.Result, 1);
+          DebugLog(String.Format("{0} signed in", task.Result.User.DisplayName));
+        } else {
+          DebugLog("Signed in but User is either null or invalid");
+        }
+      }
+    }
+
     // Called when a sign-in with profile data completes.
     void HandleSignInWithSignInResult(Task<Firebase.Auth.SignInResult> task) {
       EnableUI();
@@ -422,6 +521,24 @@ protected Task LinkWithEmailCredentialAsync_DEPRECATED() {
       }
     }
 
+    // Link the current user with an email / password credential.
+    protected Task LinkWithEmailCredentialAsync() {
+      if (auth.CurrentUser == null) {
+        DebugLog("Not signed in, unable to link credential to user.");
+        var tcs = new TaskCompletionSource<bool>();
+        tcs.SetException(new Exception("Not signed in"));
+        return tcs.Task;
+      }
+      DebugLog("Attempting to link credential to user...");
+      Firebase.Auth.Credential cred =
+        Firebase.Auth.EmailAuthProvider.GetCredential(email, password);
+      return auth.CurrentUser.LinkWithCredentialAsync(cred).ContinueWithOnMainThread(task => {
+        if (LogTaskCompletion(task, "Link Credential")) {
+          DisplayDetailedUserInfo(task.Result.User, 1);
+        }
+      });
+    }
+
     // Reauthenticate the user with the current email / password.
     protected Task ReauthenticateAsync_DEPRECATED() {
       var user = auth.CurrentUser;
@@ -451,6 +568,35 @@ protected Task ReauthenticateAsync_DEPRECATED() {
       }
     }
 
+    // Reauthenticate the user with the current email / password.
+    protected Task ReauthenticateAsync() {
+      var user = auth.CurrentUser;
+      if (user == null) {
+        DebugLog("Not signed in, unable to reauthenticate user.");
+        var tcs = new TaskCompletionSource<bool>();
+        tcs.SetException(new Exception("Not signed in"));
+        return tcs.Task;
+      }
+      DebugLog("Reauthenticating...");
+      DisableUI();
+      Firebase.Auth.Credential cred = Firebase.Auth.EmailAuthProvider.GetCredential(email, password);
+      if (signInAndFetchProfile) {
+        return user.ReauthenticateAndRetrieveDataAsync(cred).ContinueWithOnMainThread(task => {
+          EnableUI();
+          if (LogTaskCompletion(task, "Reauthentication")) {
+            DisplayAuthResult(task.Result, 1);
+          }
+        });
+      } else {
+        return user.ReauthenticateAsync(cred).ContinueWithOnMainThread(task => {
+          EnableUI();
+          if (LogTaskCompletion(task, "Reauthentication")) {
+            DisplayDetailedUserInfo(auth.CurrentUser, 1);
+          }
+        });
+      }
+    }
+
     // Reload the currently logged in user.
     public void ReloadUser() {
       if (auth.CurrentUser == null) {
@@ -509,6 +655,24 @@ protected Task UnlinkEmailAsync_DEPRECATED() {
           });
     }
 
+    // Unlink the email credential from the currently logged in user.
+    protected Task UnlinkEmailAsync() {
+      if (auth.CurrentUser == null) {
+        DebugLog("Not signed in, unable to unlink");
+        var tcs = new TaskCompletionSource<bool>();
+        tcs.SetException(new Exception("Not signed in"));
+        return tcs.Task;
+      }
+      DebugLog("Unlinking email credential");
+      DisableUI();
+      return auth.CurrentUser.UnlinkAsync(
+        Firebase.Auth.EmailAuthProvider.GetCredential(email, password).Provider)
+          .ContinueWithOnMainThread(task => {
+            EnableUI();
+            LogTaskCompletion(task, "Unlinking");
+          });
+    }
+
     // Sign out the current user.
     protected void SignOut() {
       DebugLog("Signing out.");
@@ -671,6 +835,36 @@ protected void VerifyPhoneNumber_DEPRECATED() {
         });
     }
 
+    // Begin authentication with the phone number.
+    protected void VerifyPhoneNumber() {
+      var phoneAuthProvider = Firebase.Auth.PhoneAuthProvider.GetInstance(auth);
+      phoneAuthProvider.VerifyPhoneNumber(
+        new Firebase.Auth.PhoneAuthOptions {
+            PhoneNumber = phoneNumber,
+            TimeoutInMilliseconds = phoneAuthTimeoutMs,
+            ForceResendingToken = null
+        },
+        verificationCompleted: (cred) => {
+          DebugLog("Phone Auth, auto-verification completed");
+          if (signInAndFetchProfile) {
+            auth.SignInAndRetrieveDataWithCredentialAsync(cred).ContinueWithOnMainThread(
+              HandleSignInWithAuthResult);
+          } else {
+            auth.SignInWithCredentialAsync(cred).ContinueWithOnMainThread(HandleSignInWithUser);
+          }
+        },
+        verificationFailed: (error) => {
+          DebugLog("Phone Auth, verification failed: " + error);
+        },
+        codeSent: (id, token) => {
+          phoneAuthVerificationId = id;
+          DebugLog("Phone Auth, code sent");
+        },
+        codeAutoRetrievalTimeOut: (id) => {
+          DebugLog("Phone Auth, auto-verification timed out");
+        });
+    }
+
     // Sign in using phone number authentication using code input by the user.
     protected void VerifyReceivedPhoneCode_DEPRECATED() {
       var phoneAuthProvider = Firebase.Auth.PhoneAuthProvider.GetInstance(auth);
@@ -680,7 +874,20 @@ protected void VerifyReceivedPhoneCode_DEPRECATED() {
         auth.SignInAndRetrieveDataWithCredentialAsync_DEPRECATED(cred).ContinueWithOnMainThread(
           HandleSignInWithSignInResult);
       } else {
-        auth.SignInWithCredentialAsync_DEPRECATED(cred).ContinueWithOnMainThread(HandleSignInWithUser);
+        auth.SignInWithCredentialAsync(cred).ContinueWithOnMainThread(HandleSignInWithUser);
+      }
+    }
+
+    // Sign in using phone number authentication using code input by the user.
+    protected void VerifyReceivedPhoneCode() {
+      var phoneAuthProvider = Firebase.Auth.PhoneAuthProvider.GetInstance(auth);
+      // receivedCode should have been input by the user.
+      var cred = phoneAuthProvider.GetCredential(phoneAuthVerificationId, receivedCode);
+      if (signInAndFetchProfile) {
+        auth.SignInAndRetrieveDataWithCredentialAsync(cred).ContinueWithOnMainThread(
+          HandleSignInWithAuthResult);
+      } else {
+        auth.SignInWithCredentialAsync(cred).ContinueWithOnMainThread(HandleSignInWithUser);
       }
     }
 
@@ -774,22 +981,22 @@ void GUIDisplayControls() {
         GUILayout.Space(20);
 
         if (GUILayout.Button("Create User")) {
-          CreateUserWithEmailAsync_DEPRECATED();
+          CreateUserWithEmailAsync();
         }
         if (GUILayout.Button("Sign In Anonymously")) {
-          SigninAnonymouslyAsync_DEPRECATED();
+          SigninAnonymouslyAsync();
         }
         if (GUILayout.Button("Sign In With Email")) {
-          SigninWithEmailAsync_DEPRECATED();
+          SigninWithEmailAsync();
         }
         if (GUILayout.Button("Sign In With Email Credential")) {
-          SigninWithEmailCredentialAsync_DEPRECATED();
+          SigninWithEmailCredentialAsync();
         }
         if (GUILayout.Button("Link With Email Credential")) {
-          LinkWithEmailCredentialAsync_DEPRECATED();
+          LinkWithEmailCredentialAsync();
         }
         if (GUILayout.Button("Reauthenticate with Email")) {
-          ReauthenticateAsync_DEPRECATED();
+          ReauthenticateAsync();
         }
         GUIDisplayGameCenterControls();
         if (GUILayout.Button("Reload User")) {
@@ -802,7 +1009,7 @@ void GUIDisplayControls() {
           GetUserInfo();
         }
         if (GUILayout.Button("Unlink Email Credential")) {
-          UnlinkEmailAsync_DEPRECATED();
+          UnlinkEmailAsync();
         }
         if (GUILayout.Button("Sign Out")) {
           SignOut();
@@ -817,10 +1024,10 @@ void GUIDisplayControls() {
           SendPasswordResetEmail();
         }
         if (GUILayout.Button("Authenticate Phone Number")) {
-          VerifyPhoneNumber_DEPRECATED();
+          VerifyPhoneNumber();
         }
         if (GUILayout.Button("Verify Received Phone Code")) {
-          VerifyReceivedPhoneCode_DEPRECATED();
+          VerifyReceivedPhoneCode();
         }
         if (GUILayout.Button(String.Format("Fetch Profile on Sign-in {0}",
                                             signInAndFetchProfile ?