Skip to content

Commit 1fb4ba1

Browse files
committed
update integration tests and CONTRIBUTING.md
1 parent 450f079 commit 1fb4ba1

File tree

2 files changed

+217
-131
lines changed

2 files changed

+217
-131
lines changed

CONTRIBUTING.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,50 @@ to ensure that exported user records contain the password hashes of the user acc
245245
3. Click **ADD ANOTHER ROLE** and choose **Firebase Authentication Admin**.
246246
4. Click **SAVE**.
247247

248+
9. Setup your project for Firebase Data Connect integration tests:
249+
1. Set up Data Connect in the Firebase Console:
250+
1. Go to the Firebase Console, and select **Data Connect** from the **Build** menu.
251+
2. Click on **Get Started**. You can skip any Gemini generation of your schema
252+
or operations - you must create these manually.
253+
3. Select **Create a new Cloud SQL instance**.
254+
4. Set your **Location** to `us-west2`
255+
5. Set your **Cloud SQL instance ID** to `my-instance`
256+
6. Set your **Database name** to `my-database`
257+
7. Set your **Service ID** to `my-service`
258+
8. Click **Submit**. This operation may take up to 10 minutes to complete.
259+
2. Set up your Data Connect schema locally (currently there is no way to
260+
create/edit your schema from the Console):
261+
1. Run the following commands from the command line to setup your data connect app:
262+
```bash
263+
$ mkdir fdc-integration-test
264+
$ cd fdc-integration-test
265+
$ firebase init dataconnect --project <PROJECT_ID>
266+
```
267+
2. The setup script should say **"Your project already has existing services."**
268+
Select the service you just created, `us-west2/my-service`.
269+
3. When asked to use an app template, select `no`.
270+
4. The set up should complete, and should have created a file `fdc-integration-test/dataconnect/schema/schema.gql`.
271+
5. Paste the following lines into `schema.gql`:
272+
```gql
273+
type User @table(key: ["id"]) {
274+
id: String!
275+
name: String!
276+
address: String!
277+
}
278+
279+
type Email @table {
280+
id: String!
281+
subject: String!
282+
date: Date!
283+
text: String!
284+
from: User!
285+
}
286+
```
287+
6. Run the following commands from `fdc-integration-test/` to setup your data connect app:
288+
```bash
289+
$ firebase deploy --only dataconnect
290+
```
291+
7. When asked if you'd like to execute changes, select `Execute all`.
248292
249293
Finally, to run the integration test suite:
250294

0 commit comments

Comments
 (0)