mock_cloud_firestore 0.0.2

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 70

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"
		}
	},
	"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();
    expect(find.text("test project 1"), findsOneWidget);
  });
}

[0.0.2]

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

[0.0.1]

  • initial release.

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.2

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages 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';
  
Version Uploaded Documentation Archive
0.0.5 Dec 24, 2018 Go to the documentation of mock_cloud_firestore 0.0.5 Download mock_cloud_firestore 0.0.5 archive
0.0.4 Oct 22, 2018 Go to the documentation of mock_cloud_firestore 0.0.4 Download mock_cloud_firestore 0.0.4 archive
0.0.3 Oct 22, 2018 Go to the documentation of mock_cloud_firestore 0.0.3 Download mock_cloud_firestore 0.0.3 archive
0.0.2 Oct 22, 2018 Go to the documentation of mock_cloud_firestore 0.0.2 Download mock_cloud_firestore 0.0.2 archive
0.0.1 Oct 19, 2018 Go to the documentation of mock_cloud_firestore 0.0.1 Download mock_cloud_firestore 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
52
Health:
Code health derived from static analysis. [more]
98
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
70
Learn more about scoring.

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

  • Dart: 2.1.0
  • pana: 0.12.13
  • Flutter: 1.2.0

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

33 out of 33 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.

Fix lib/factories.dart. (-0.50 points)

Analysis of lib/factories.dart reported 1 hint:

line 28 col 35: The class 'Future' was not exported from 'dart:core' until version 2.1, but this code is required to be able to run on earlier versions.

Fix lib/mock_types.dart. (-0.50 points)

Analysis of lib/mock_types.dart reported 1 hint:

line 16 col 27: Don't type annotate initializing formals.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

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.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and mock_cloud_firestore.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
cloud_firestore ^0.8.2+1 0.8.2+3 0.9.0+1
flutter 0.0.0
mockito ^3.0.0 3.0.2 4.0.0
test ^1.3.0 1.5.3
Transitive dependencies
analyzer 0.35.1
args 1.5.1
async 2.0.8
boolean_selector 1.0.4
charcode 1.1.2
collection 1.14.11
convert 2.1.1
crypto 2.0.6
csslib 0.14.6
firebase_core 0.2.5+1 0.3.0+1
front_end 0.1.11
glob 1.1.7
html 0.13.3+3
http 0.12.0+1
http_multi_server 2.0.5
http_parser 3.1.3
io 0.3.3
js 0.6.1+1
json_rpc_2 2.0.9
kernel 0.3.11
logging 0.11.3+2
matcher 0.12.3+1 0.12.4
meta 1.1.6 1.1.7
mime 0.9.6+2
multi_server_socket 1.0.2
node_preamble 1.4.4
package_config 1.0.5
package_resolver 1.0.6
path 1.6.2
pedantic 1.4.0
plugin 0.2.0+3
pool 1.4.0
pub_semver 1.4.2
shelf 0.7.4
shelf_packages_handler 1.0.4
shelf_static 0.2.8
shelf_web_socket 0.2.2+4
sky_engine 0.0.99
source_map_stack_trace 1.1.5
source_maps 0.10.8
source_span 1.5.4
stack_trace 1.9.3
stream_channel 1.6.8
string_scanner 1.0.4
term_glyph 1.1.0
test_api 0.2.2
test_core 0.2.1+1
typed_data 1.1.6
utf 0.9.0+5
vector_math 2.0.8
vm_service_client 0.2.6
watcher 0.9.7+10
web_socket_channel 1.0.9
yaml 2.1.15
Dev dependencies
flutter_test