mock_cloud_firestore 0.0.11

Mock Cloud Firestore

The best way i found to test cloud_firestore is to use Firestore.channel.setMockMethodCallHandler. But this requires knowledge of firebase protocol. This implementation tries to provide easier way.

First define the firestore data as json #

  String source = r"""
{
  "goals": {
    "1": {
      "$": "Goal",
      "id": "1",
      "taskId": "1",
      "projectId": "1",
      "profileId": "1",
      "state": "ASSIGNED"
    }
  },
  "projects": {
    "1": {
      "id": "1",
      "$": "Project",
      "title": "test title",
      "description": "description",
      "contributors": [
        "2"
      ],
      "creatorProfileId": "3",
      "state": "INCOMPLETE"
    },
    "__where__": {
      "id == 1": {
        "1": {
          "id": "1",
          "$": "Project",
          "title": "test title",
          "description": "description",
          "contributors": [
            "2"
          ],
          "creatorProfileId": "3",
          "state": "INCOMPLETE"
        }
      }
    }
  },
  "tasks": {
    "1": {
      "id": "1",
      "$": "Task",
      "projectId": "123",
      "description": "test desc",
      "closeReason": "",
      "closeReasonDescription": "",
      "creatorProfileId": "123",
      "assigneeProfileId": "123",
      "state": "INCOMPLETE"
    }
  }
}
""";

create the mock #

  MockCloudFirestore mcf = MockCloudFirestore(source);

now you can #

main() {
  test("get a document", () async {
      MockCollectionReference col = mcf.collection("projects");
      MockDocumentReference docSnapshot = col.document("1");
      MockDocumentSnapshot docSnapshot = await doc.get();
      expect(docSnapshot.data["id"], "1");
      expect(docSnapshot.data["title"], "test project 1");
  });
}
main() {
  test("get snapshots", () async {
      MockCollectionReference col = mcf.collection("projects");
      Stream<QuerySnapshot> snapshots = col.snapshots();
      QuerySnapshot first = await snaphosts.first;
      expect(first, isNotNull);
      MockDocumentSnapshot docSnap = first.documents[0];
      expect(docSnap.data["id"], "1");
  });
}

To test widgets

create a backend to wrap firestore api #

class BackendApi {
  CollectionGet collectionGet;

  BackendApi(this.collectionGet);

  Future<Map<String, dynamic>> project() async {
    DocumentReference docRef = collectionGet("projects").document("1");
    DocumentSnapshot docSnap = await docRef.get();
    return docSnap.data;
  }
}

remove firestore dependency from widget #

class FirebaseDepWidget extends StatelessWidget {
  BackendApi backend;

  FirebaseDepWidget(this.backend);

  @override
  Widget build(BuildContext context) {
    return FutureBuilder(
      future: backend.project(),
      builder: (BuildContext context, AsyncSnapshot snapshot) {
        if (!snapshot.hasData) {
          return Text("Loading...");
        }
        return Text("${snapshot.data["title"]}");
      },
    );
  }
}

now you can mock out firestore #

void main() {
  MockCloudFirestore mcf = getMockCloudFirestore();

  //BackendApi realBackend = BackendApi(Firestore.instance.collection);
  BackendApi mockBackend = BackendApi(mcf.collection);

  testWidgets('check task info ', (WidgetTester tester) async {
    await tester.pumpWidget(
      MaterialApp(
        home: Container(
          child: FirebaseDepWidget(mockBackend),
        ),
      ),
    );
    await tester.pump(Duration.zero); // Duration.zero is required or you get a timer exception
    expect(find.text("test project 1"), findsOneWidget);
  });
}

using where on collection

add expected results to collection node with __where__ key.See example on projects collection.

condition format #

field name operator expected value

condition operators (in order) #

  • isEqualTo: ==
  • isLessThen: <
  • isLessThanOrEqualTo: =<
  • isGreaterThen: >
  • isGreaterThanOrEqualTo: =>
  • arrayContains: 'array-contains'
  • isNull: null

about condition order #

dart does't give order guarantee to named arguments, so order is hard coded with in code. See operators for the order. Don't expect logical conditions like id > 1 & id < 5 this is not valid because of ordering, it must be like id < 5 & id > 1

examples #

  • id == 1
  • id < 5 & id > 1multiple conditions concat with &, spaces are required
  • id array-contains ["1", "2"] value should be json encoded

[0.0.11]

  • chore run flutter format

[0.0.10]

  • impl docRef.snapshots() support

[0.0.9]

  • add where support

[0.0.8]

[0.0.7]

  • Version bump

[0.0.6]

[0.0.5]

  • implemented getDocuments

[0.0.4]

  • new simulateModifyFromServer to simulate modifying a document from server
  • new simulateRemoveFromServer to simulate removing a document from server

[0.0.3]

  • chore

[0.0.2]

  • implemented add
  • added documentation and examples
  • new simulateAddFromServer to simulate adding a document from server

[0.0.1]

  • initial release.

example/example.dart

import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:mock_cloud_firestore/mock_cloud_firestore.dart';

import 'test_data.dart';

typedef CollectionReference CollectionGet(String path);

class BackendApi {
  CollectionGet collectionGet;

  BackendApi(this.collectionGet);

  Future<Map<String, dynamic>> project() async {
    DocumentReference docRef = collectionGet("projects").document("1");
    DocumentSnapshot docSnap = await docRef.get();
    return docSnap.data;
  }
}

class FirebaseDepWidget extends StatelessWidget {
  BackendApi backend;

  FirebaseDepWidget(this.backend);

  @override
  Widget build(BuildContext context) {
    return FutureBuilder(
      future: backend.project(),
      builder: (BuildContext context, AsyncSnapshot snapshot) {
        if (!snapshot.hasData) {
          return Text("Loading...");
        }
        return Text("${snapshot.data["title"]}");
      },
    );
  }
}

MockCloudFirestore getMockCloudFirestore() {
  return MockCloudFirestore(getTestData());
}

void main() {
  MockCloudFirestore mcf = getMockCloudFirestore();

  //BackendApi realBackend = BackendApi(Firestore.instance.collection);
  BackendApi mockBackend = BackendApi(mcf.collection);

  testWidgets('check task info ', (WidgetTester tester) async {
    await tester.pumpWidget(
      MaterialApp(
        home: Container(
          child: FirebaseDepWidget(mockBackend),
        ),
      ),
    );
    await tester.pump(Duration
        .zero); // Duration.zero is required or you get a timer exception
    expect(find.text("test project 1"), findsOneWidget);
  });
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  mock_cloud_firestore: ^0.0.11

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:mock_cloud_firestore/mock_cloud_firestore.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
46
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
71
Learn more about scoring.

We analyzed this package on Jul 17, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.3

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-0.39 points)

47 out of 48 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
cloud_firestore ^0.12.5+2 0.12.7
flutter 0.0.0
mockito ^4.0.0 4.1.0
test ^1.5.3 1.6.5
Transitive dependencies
analyzer 0.37.0
args 1.5.2
async 2.3.0
boolean_selector 1.0.5
charcode 1.1.2
collection 1.14.11
convert 2.1.1
crypto 2.0.6
csslib 0.16.1
firebase_core 0.4.0+6
front_end 0.1.20
glob 1.1.7
html 0.14.0+2
http 0.12.0+2
http_multi_server 2.1.0
http_parser 3.1.3
io 0.3.3
js 0.6.1+1
kernel 0.3.20
matcher 0.12.5
meta 1.1.6 1.1.7
mime 0.9.6+3
multi_server_socket 1.0.2
node_preamble 1.4.4
package_config 1.0.5
package_resolver 1.0.10
path 1.6.2
pedantic 1.8.0+1
pool 1.4.0
pub_semver 1.4.2
shelf 0.7.5
shelf_packages_handler 1.0.4
shelf_static 0.2.8
shelf_web_socket 0.2.3
sky_engine 0.0.99
source_map_stack_trace 1.1.5
source_maps 0.10.8
source_span 1.5.5
stack_trace 1.9.3
stream_channel 2.0.0
stream_transform 0.0.19
string_scanner 1.0.4
term_glyph 1.1.0
test_api 0.2.6
test_core 0.2.7
typed_data 1.1.6
vector_math 2.0.8
vm_service_lib 3.22.2
watcher 0.9.7+12
web_socket_channel 1.0.14
yaml 2.1.16
Dev dependencies
flutter_test

Admin