wip

Author: exaby73

.gitignore

@@ -139,3 +139,4 @@ doc/dist
 .idea
 .vscode/*
 !.vscode/settings.json
+integration_tests/serviceAccount.json

integration_tests/.env.example

@@ -0,0 +1,12 @@
+REGION=us-central1
+PROJECT_ID=
+DATABASE_URL=
+STORAGE_BUCKET=
+NODE_VERSION=18
+FIREBASE_ADMIN=^10.0.0
+FIREBASE_APP_ID=
+FIREBASE_MEASUREMENT_ID=
+FIREBASE_AUTH_DOMAIN=
+FIREBASE_API_KEY=
+GOOGLE_APPLICATION_CREDENTIALS=./serviceAccount.json
+GOOGLE_ANALYTICS_API_SECRET=

integration_tests/.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "ff-test-74aeb"
+  }
+}

integration_tests/.gitignore

@@ -0,0 +1,66 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

integration_tests/README.md

@@ -0,0 +1,40 @@
+# Integration Test Suite
+
+## How to use
+
+### Prerequisites
+
+Tests use locally installed firebase to invoke commands for deploying functions.
+The tests also require that you have gcloud CLI installed and authenticated
+(`gcloud auth login`).
+
+Tests are deployed with a unique identifier, which enables the teardown of its own resources, without affecting other test runs.
+
+1. Add a service account at root serviceAccount.json
+2. Add a .env `cp .env.example .env`
+3. Ensure service account has required roles for each cloud service
+4. Ensure any resources such as eventarc channel ("firebase" is used as default) are configured
+
+### Running setup and tests
+
+This will deploy functions with unique names, set up environment for running the jest files, and run the jest test suite.
+
+```bash
+yarn start
+```
+
+## TODO
+
+[x] Deploy functions with unique name
+[x] Update existing tests to use jest (v1 and v2)
+[x] Add missing coverage for v1 and v2 (WIP)
+[x] Ensure proper teardown of resources (only those for current test run)
+[] Analytics: since you cannot directly trigger onLog events from Firebase Analytics in a CI environment, the primary strategy is to isolate and test the logic within the Cloud Functions by mocking Firebase services and the Analytics event data. This is done elsewhere via unit tests, so no additional coverage added.
+[] Alerts: same as analytics, couldn't find way to trigger.
+[] Auth blocking functions can only be deployed one at a time, half-way solution is to deploy v1 functions, run v1 tests, teardown, and repeat for v2. However, this still won't allow for multiple runs to happen in parallel. Solution needed before re-enabling auth/identity tests. You can run the suite with either v1 or v2 commented out to check test runs.
+[] Https tests were commented out previously, comments remain as before
+[] Python runtime support
+
+## Troubleshooting
+
+- Sometimes I ran into this reported [issue](https://github.com/firebase/firebase-tools/issues/793), I had to give it some period of time and attempt deploy again. Probably an upstream issue but may affect our approach here. Seems to struggle with deploying the large amount of trigger functions...? Falls over on Firebase Storage functions (if you comment these out everything else deploys as expected).

integration_tests/database.rules.json

@@ -0,0 +1,13 @@
+{
+  "rules": {
+    "dbTests": {
+      "$testId": {
+        "adminOnly": {
+          ".validate": false
+        }
+      }
+    },
+    ".read": "auth != null",
+    ".write": true
+  }
+}

integration_tests/firebase.json

@@ -0,0 +1,22 @@
+{
+  "database": {
+    "rules": "database.rules.json"
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
+  },
+  "functions": [
+    {
+      "source": "functions",
+      "codebase": "default",
+      "ignore": [
+        "venv",
+        ".git",
+        "firebase-debug.log",
+        "firebase-debug.*.log",
+        "*.local"
+      ]
+    }
+  ]
+}

integration_tests/firestore.indexes.json

@@ -0,0 +1,3 @@
+{
+  "indexes": []
+}

integration_tests/firestore.rules

@@ -0,0 +1,9 @@
+rules_version = "2";
+
+service cloud.firestore {
+  match /databases/{database}/documents {
+    match /{document=**} {
+      allow read, write: if request.auth != null;
+    }
+  }
+}

integration_tests/functions/.gitignore

@@ -0,0 +1,2 @@
+*.local
+venv

integration_tests/functions/main.py

@@ -0,0 +1,12 @@
+# Welcome to Cloud Functions for Firebase for Python!
+# To get started, simply uncomment the below code or create your own.
+# Deploy with `firebase deploy`
+
+from firebase_functions import https_fn
+from firebase_admin import initialize_app
+
+initialize_app()
+
+@https_fn.on_call()
+def hello(_: https_fn.CallableRequest) -> str:
+    return 'Hello from Firebase!'

integration_tests/functions/requirements.txt

@@ -0,0 +1 @@
+firebase_functions~=0.1.0

integration_tests/global.d.ts

@@ -0,0 +1,3 @@
+declare module "firebase-tools";
+declare module "firebase-tools/lib/deploy/functions/runtimes/index.js";
+declare module "firebase-tools/lib/deploy/functions/runtimes/discovery/index.js";

integration_tests/jest.config.js

@@ -0,0 +1,9 @@
+export default {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: ["**/tests/**/*.test.ts"],
+  testTimeout: 30000,
+  transform: {
+    "^.+\\.(t|j)s$": ["ts-jest", { tsconfig: "tsconfig.test.json" }],
+  },
+};