From 9ac26098a1e56a6d1b8ef75c155eb5a832013760 Mon Sep 17 00:00:00 2001 From: Brian Chen Date: Fri, 21 Jun 2019 17:20:23 -0700 Subject: [PATCH 1/3] update documentation to reflect emulator --- firebase-firestore/README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/firebase-firestore/README.md b/firebase-firestore/README.md index afe9ab9dc34..e5d59743642 100644 --- a/firebase-firestore/README.md +++ b/firebase-firestore/README.md @@ -41,7 +41,34 @@ the source root. Make sure you have created a Firestore instance for your project, before you proceed. -### Run on Local Emulator +By default, integration tests run against the Firestore emulator. + +### Setting up the Firestore Emulator + +The integration tests require that the Firestore emulator is running on port +8080, which is default when running it via CLI. + + * Ensure that `gogole-services.json` is properly configured. + * [Install the Firebase CLI](https://firebase.google.com/docs/cli/). + ``` + npm install -g firebase-tools + ``` + * [Install the Firestore + emulator](https://firebase.google.com/docs/firestore/security/test-rules-emulator#install_the_emulator). + ``` + firebase setup:emulators:firestore + ``` + * Run the emulator + ``` + firebase serve --only firestore + ``` + * Select the `Firestore Integration Tests (Firestore Emulator)` run + configuration to run all integration tests. + +To run the integration tests against prod, select `FirestoreProdIntegrationTest` +run configuration. + +### Run on Local Android Emulator Then simply run: ```bash From 4cfd73beaa47cc742083c46e256a38fcf8b54778 Mon Sep 17 00:00:00 2001 From: Brian Chen Date: Sat, 22 Jun 2019 18:37:33 -0700 Subject: [PATCH 2/3] typo fix --- firebase-firestore/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/firebase-firestore/README.md b/firebase-firestore/README.md index e5d59743642..b8dde4b5420 100644 --- a/firebase-firestore/README.md +++ b/firebase-firestore/README.md @@ -48,7 +48,7 @@ By default, integration tests run against the Firestore emulator. The integration tests require that the Firestore emulator is running on port 8080, which is default when running it via CLI. - * Ensure that `gogole-services.json` is properly configured. + * Ensure that `google-services.json` is properly configured. * [Install the Firebase CLI](https://firebase.google.com/docs/cli/). ``` npm install -g firebase-tools From 108138e242ce5b4d7d7e2259050c4096f858f496 Mon Sep 17 00:00:00 2001 From: Brian Chen Date: Mon, 24 Jun 2019 10:35:57 -0700 Subject: [PATCH 3/3] remove google-services.json readme line --- firebase-firestore/README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/firebase-firestore/README.md b/firebase-firestore/README.md index b8dde4b5420..997ab2c3524 100644 --- a/firebase-firestore/README.md +++ b/firebase-firestore/README.md @@ -48,7 +48,6 @@ By default, integration tests run against the Firestore emulator. The integration tests require that the Firestore emulator is running on port 8080, which is default when running it via CLI. - * Ensure that `google-services.json` is properly configured. * [Install the Firebase CLI](https://firebase.google.com/docs/cli/). ``` npm install -g firebase-tools