Flutter模拟Firebase认证插件firebase_auth_mocks的使用

firebase_auth_mocks 是一个用于模拟 Firebase 认证的 Dart 包，可以帮助开发者在不依赖实际 Firebase 服务的情况下进行单元测试。该包通常与 google_sign_in_mocks 一起使用，以模拟 Google 登录。

使用方法

添加依赖

首先，在 pubspec.yaml 文件中添加 firebase_auth_mocks 和 google_sign_in_mocks 到开发依赖项：

dev_dependencies:
  flutter_test:
    sdk: flutter
  firebase_auth_mocks: ^0.14.0
  google_sign_in_mocks: ^0.9.0

然后运行 flutter pub get 来安装这些依赖。

示例代码

以下是一个简单的示例，展示了如何使用 firebase_auth_mocks 模拟 Google 登录和 Firebase 认证：

import 'package:firebase_auth_mocks/firebase_auth_mocks.dart';
import 'package:google_sign_in_mocks/google_sign_in_mocks.dart';
import 'package:firebase_auth/firebase_auth.dart';

void main() async {
  // Mock sign in with Google.
  final googleSignIn = MockGoogleSignIn();
  final signinAccount = await googleSignIn.signIn();
  final googleAuth = await signinAccount.authentication;
  
  // Create a credential from the authentication result.
  final AuthCredential credential = GoogleAuthProvider.credential(
    accessToken: googleAuth.accessToken,
    idToken: googleAuth.idToken,
  );

  // Create a mock user.
  final user = MockUser(
    isAnonymous: false,
    uid: 'someuid',
    email: 'bob@somedomain.com',
    displayName: 'Bob',
  );

  // Initialize the mock Firebase Authentication instance.
  final auth = MockFirebaseAuth(mockUser: user);

  // Sign in with the credential.
  final result = await auth.signInWithCredential(credential);
  final signedInUser = result.user;

  // Print the display name of the signed-in user.
  print(signedInUser.displayName); // Output: Bob
}

更多功能

MockFirebaseAuth 支持多种功能，包括但不限于：

• 初始化为已登录或未登录状态。
• 触发 authStateChanges 和 userChanges 事件。
• 支持多种登录方式，如 signInWithCredential, signInWithEmailAndPassword, signInAnonymously 等。
• 发送密码重置邮件、验证电话号码等操作。

抛出异常

你可以配置 MockFirebaseAuth 在特定条件下抛出异常。例如：

不考虑参数情况

whenCalling(Invocation.method(#signInWithCredential, null))
  .on(auth)
  .thenThrow(FirebaseAuthException(code: 'bla'));

expect(
  () => auth.signInWithCredential(FakeAuthCredential()),
  throwsA(isA<FirebaseAuthException>()),
);

考虑位置参数

final auth = MockFirebaseAuth();
whenCalling(Invocation.method(
        #fetchSignInMethodsForEmail, ['someone@somewhere.com']))
    .on(auth)
    .thenThrow(FirebaseAuthException(code: 'bla'));

expect(() => auth.fetchSignInMethodsForEmail('someone@somewhere.com'),
    throwsA(isA<FirebaseAuthException>()));
expect(() => auth.fetchSignInMethodsForEmail('someoneelse@somewhereelse.com'),
    returnsNormally);

考虑命名参数

whenCalling(Invocation.method(
          #confirmPasswordReset, null, {#code: contains('code')}))
      .on(auth)
      .thenThrow(FirebaseAuthException(code: 'invalid-action-code'));

expect(
  () async => await auth.confirmPasswordReset(
    code: 'code',
    newPassword: 'password',
  ),
  throwsA(isA<FirebaseAuthException>()),
);
expect(
  () => auth.confirmPasswordReset(
    code: '10293',
    newPassword: 'password',
  ),
  returnsNormally);

兼容性表

功能请求和错误报告

如果你需要更多的功能或遇到任何问题，请在 issue tracker 上提交问题或建议。

通过使用 firebase_auth_mocks，你可以更轻松地编写和测试涉及 Firebase 认证的 Flutter 应用程序，而无需依赖真实的 Firebase 服务。