How to mock the FirebaseApp in flutter
Solution 1
I had the same problem. Using this answer I found the solution.
-
Copy the contents of: https://github.com/FirebaseExtended/flutterfire/blob/master/packages/firebase_auth/firebase_auth/test/mock.dart into a file, that you can import into your tests, where you need to initialize a Firebase app.
-
Call
setupFirebaseAuthMocks();
at the top of yourmain
function for all your tests. -
In your
setUpAll
function, callawait Firebase.initializeApp();
(You can also put this in yourmain
function undersetupFirebaseAuthMocks();
will still work).
Now you should have a mocked Firebase app.
Here is a full example:
import 'package:flutter/material.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:flutter_test/flutter_test.dart';
import '../lib/authentication/your_auth_using_firebase.dart';
import './mock.dart'; // from: https://github.com/FirebaseExtended/flutterfire/blob/master/packages/firebase_auth/firebase_auth/test/mock.dart
void main() {
// TestWidgetsFlutterBinding.ensureInitialized(); Gets called in setupFirebaseAuthMocks()
setupFirebaseAuthMocks();
setUpAll(() async {
await Firebase.initializeApp();
});
testWidgets('Your Test', (WidgetTester tester) async {
final YourFirebaseAuthClass authService = YourFirebaseAuthClass();
// Tests to write
});
}
Solution 2
Maybe the cloud_firestore_mocks package is useful for you:
Fakes to write unit tests for Cloud Firestore. Instantiate a MockFirestoreInstance, then pass it around your project as if it were a FirestoreInstance. This fake acts like Firestore except it will only keep the state in memory. To help debug, you can use MockFirestoreInstance.dump() to see what's in the fake database. This is useful to set up the state of your database, then check that your UI behaves the way you expect.
Example from the docs:
import 'package:cloud_firestore_mocks/cloud_firestore_mocks.dart';
void main() {
final instance = MockFirestoreInstance();
await instance.collection('users').add({
'username': 'Bob',
});
final snapshot = await instance.collection('users').get();
print(snapshot.documents.length); // 1
print(snapshot.documents.first['username']); // 'Bob'
print(instance.dump());
}
Edson Dias
Updated on December 18, 2022Comments
-
Edson Dias over 1 year
I am trying to test a method that uses FirebaseFirestore but I am not able to mock the FirebaseFirestore.instance property.
I am following these examples:
- Initializing the core: https://firebase.flutter.dev/docs/overview#initializing-flutterfire
- Using the firestore plugin: https://firebase.flutter.dev/docs/firestore/usage
I am using the code below for my class and it is working well, which means the firestoreInstance is loaded correctly
import 'package:cloud_firestore/cloud_firestore.dart'; import 'package:firebase_core/firebase_core.dart'; import 'package:flutter/material.dart'; void main() { WidgetsFlutterBinding.ensureInitialized(); runApp( Main(firebaseApp: Firebase.initializeApp()), ); } class Main extends StatelessWidget { final Future<FirebaseApp> firebaseApp; const Main({this.firebaseApp}); @override Widget build(BuildContext context) { return FutureBuilder( future: firebaseApp, builder: (context, snapshot) { if (snapshot.connectionState == ConnectionState.done) { final firestoreInstance = FirebaseFirestore.instanceFor( app: snapshot.data, ); return MyWidget(); } return CircularProgressIndicator(); }, ); } }
But when I run the test below I got the message:
"The following FirebaseException was thrown building Builder(dirty): [core/no-app] No Firebase App '[DEFAULT]' has been created - call Firebase.initializeApp()"
import 'package:firebase_core/firebase_core.dart'; import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; class MockFirebaseApp extends Mock implements FirebaseApp {} void main() { FirebaseApp firebaseApp; setUp(() async { TestWidgetsFlutterBinding.ensureInitialized(); firebaseApp = MockFirebaseApp(); }); group('Main', () { testWidgets('Loads my widget', (WidgetTester tester) async { await tester.runAsync(() async { await tester.pumpWidget( Main(firebaseApp: Future.value(firebaseApp)), ); expect(find.byType(CircularProgressIndicator), findsOneWidget); }); }); }); }
-
Edson Dias over 3 yearsI can do this, but the problem will be the same, my problem is trying to mock the return of the Firebase.initializeApp() method, which means, I need to mock a FirebaseApp object that works in FirebaseFirestore.instanceFor( app: MY_MOCKED_OBJECT, )
-
William Terrill over 3 yearsThis worked well for me. Thank you Gareth!
-
Adrien Arcuri about 3 yearsThank you. Not the cleaner way to test it but it works for me too.
-
nAndroid about 3 yearsGareth - great callout but doesn't seem to work with firebase crashlytics in the app, or at least i'm getting assertion errors there
-
martinseal1987 over 2 yearsthanks this does give me a good start but also firebase messaging throws MissingPluginException(No implementation found for method Messaging#startBackgroundIsolate on channel plugins.flutter.io/firebase_messaging)
-
masus04 about 2 yearsGreat Start, thank you. Is there any way to cleanly import the mocks?