Skip to content

Commit 087dc8d

Browse files
committed
docs(integration_test): updated readme
1 parent db8d468 commit 087dc8d

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

integration_test/README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
This directory contains end-to-end integration tests for the Firebase Functions SDK. These tests deploy real Cloud Functions to a Firebase project and verify their behavior by triggering events and validating responses.
44

5+
## Prerequisites
6+
7+
- Node.js 18+ installed
8+
- Firebase CLI installed and authenticated (`npm install -g firebase-tools`)
9+
- Access to a Firebase test project
10+
11+
## Usage
12+
13+
```bash
14+
npm i
15+
npm run test
16+
```
17+
518
## Overview
619

720
The integration test suite:
@@ -28,7 +41,7 @@ Using `npm run test`. This will:
2841

2942
### Updating multiple versions functions for storage causes a pre-condition error
3043

31-
For this test suite V1 and v2 storage functions have been seperated to mitigate against function deployment errors. When deploying all functions simultaneously, the following error may occur:
44+
For this test suite v1 and v2 storage functions have been separated to mitigate against function deployment errors. When deploying all functions simultaneously, the following error may occur:
3245

3346
```js
3447
{
@@ -43,7 +56,7 @@ For this test suite V1 and v2 storage functions have been seperated to mitigate
4356
}
4457
```
4558

46-
To mitigate this, the test suite included a delay between deploying v1 and v2 storage functions.
59+
To mitigate this, the test suite includes a delay between deploying v1 and v2 storage functions.
4760

4861
### Storage onObjectDeleted
4962

@@ -71,21 +84,21 @@ Configuration Appears Set: The API response shows the triggers are configured wi
7184

7285
[API source](https://identitytoolkit.googleapis.com/$discovery/rest?version=v2)
7386

74-
### Mutliple storage function deployments
87+
### Multiple storage function deployments
7588

76-
An intermittent error occurs when deploying functions related to storage, causing deployments to fail. A delay has been added to the test frameowkr to allow functions to propogate before deploying addiitonal functions and running the tets suite.
89+
An intermittent error occurs when deploying functions related to storage, causing deployments to fail. A delay has been added to the test framework to allow functions to propagate before deploying additional functions and running the test suite.
7790

7891
### Service identity via Function deployment
7992

80-
There is an intermittent issue on deploying functions. Runnign the test suite will occasionally resulting in one the following errors:
93+
There is an intermittent issue on deploying functions. Running the test suite will occasionally result in one of the following" errors:
8194

8295
```bash
8396
functions: generating the service identity for pubsub.googleapis.com...
8497
functions: generating the service identity for eventarc.googleapis.com...
8598
```
8699

87-
Retyring the suite will resulting in a successful deployment following a time delay >5 minutes.
100+
Retrying the suite will result in a successful deployment following a time delay >5 minutes.
88101

89-
### Delay on Firestore intitial propgation
102+
### Delay on Firestore initial propogation
90103

91104
Following the deployment of a Firestore function, events do not always fire. A delay is required (30 seconds) to ensure the function has completed installation steps before firing an event.

0 commit comments

Comments
 (0)