packages/google_sign_in/google_sign_in/lib/testing.dart

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'dart:async';
import 'package:flutter/services.dart' show MethodCall;

/// A fake backend that can be used to test components that require a valid
/// [GoogleSignInAccount].
///
/// Example usage:
///
/// ```
/// GoogleSignIn googleSignIn;
/// FakeSignInBackend fakeSignInBackend;
///
/// setUp(() {
///   googleSignIn = GoogleSignIn();
///   fakeSignInBackend = FakeSignInBackend();
///   fakeSignInBackend.user = FakeUser(
///     id: 123,
///     email: 'jdoe@example.org',
///   );
///   googleSignIn.channel.setMockMethodCallHandler(
///       fakeSignInBackend.handleMethodCall);
/// });
/// ```
///
class FakeSignInBackend {
  /// A [FakeUser] object.
  ///
  /// This does not represent the signed-in user, but rather an object that will
  /// be returned when [GoogleSignIn.signIn] or [GoogleSignIn.signInSilently] is
  /// called.
  late FakeUser user;

  /// Handles method calls that would normally be sent to the native backend.
  /// Returns with the expected values based on the current [user].
  Future<dynamic> handleMethodCall(MethodCall methodCall) async {
    switch (methodCall.method) {
      case 'init':
        // do nothing
        return null;
      case 'getTokens':
        return <String, String?>{
          'idToken': user.idToken,
          'accessToken': user.accessToken,
        };
      case 'signIn':
        return user._asMap;
      case 'signInSilently':
        return user._asMap;
      case 'signOut':
        return <String, String>{};
      case 'disconnect':
        return <String, String>{};
    }
  }
}

/// Represents a fake user that can be used with the [FakeSignInBackend] to
/// obtain a [GoogleSignInAccount] and simulate authentication.
class FakeUser {
  /// Any of the given parameters can be null.
  const FakeUser({
    this.id,
    this.email,
    this.displayName,
    this.photoUrl,
    this.serverAuthCode,
    this.idToken,
    this.accessToken,
  });

  /// Will be converted into [GoogleSignInUserData.id].
  final String? id;

  /// Will be converted into [GoogleSignInUserData.email].
  final String? email;

  /// Will be converted into [GoogleSignInUserData.displayName].
  final String? displayName;

  /// Will be converted into [GoogleSignInUserData.photoUrl].
  final String? photoUrl;

  /// Will be converted into [GoogleSignInUserData.serverAuthCode].
  final String? serverAuthCode;

  /// Will be converted into [GoogleSignInTokenData.idToken].
  final String? idToken;

  /// Will be converted into [GoogleSignInTokenData.accessToken].
  final String? accessToken;

  Map<String, String?> get _asMap => <String, String?>{
        'id': id,
        'email': email,
        'displayName': displayName,
        'photoUrl': photoUrl,
        'serverAuthCode': serverAuthCode,
        'idToken': idToken,
      };
}