chore: Setup emulator testing for Functions integration tests

Author: jonathanedey

.github/workflows/ci.yml

@@ -12,6 +12,17 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+
+    - name: Set up Python 3.13 for emulator
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.13'
+    - name: Setup functions emulator environment
+      run: |
+        python -m venv integration/emulators/functions/venv
+        source integration/emulators/functions/venv/bin/activate
+        pip install -r integration/emulators/functions/requirements.txt
+        deactivate
     - name: Set up Python ${{ matrix.python }}
       uses: actions/setup-python@v5
       with:
@@ -26,12 +37,12 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: 20
-    - name: Run integration tests against emulator
-      run: |
-        npm install -g firebase-tools
-        firebase emulators:exec --only database --project fake-project-id 'pytest integration/test_db.py'
-
-  lint:
+    - name: Install firebase-tools
+      run: npm install -g firebase-tools
+    - name: Run Database emulator tests
+      run: firebase emulators:exec --only database --project fake-project-id 'pytest integration/test_db.py'
+    - name: Run Functions emulator tests
+      run: firebase emulators:exec --config integration/emulators/firebase.json --only tasks,functions --project fake-project-id 'CLOUD_TASKS_EMULATOR_HOST=localhost:9499 pytest integration/test_functions.py'
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4

integration/emulators/.gitignore

@@ -0,0 +1,69 @@
+# 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
+
+# dataconnect generated files
+.dataconnect

integration/emulators/firebase.json

@@ -0,0 +1,29 @@
+{
+  "emulators": {
+    "tasks": {
+      "port": 9499
+    },
+    "ui": {
+      "enabled": false
+    },
+    "singleProjectMode": true,
+    "functions": {
+      "port": 5001
+    }
+  },
+  "functions": [
+    {
+      "source": "functions",
+      "codebase": "default",
+      "disallowLegacyRuntimeConfig": true,
+      "ignore": [
+        "venv",
+        ".git",
+        "firebase-debug.log",
+        "firebase-debug.*.log",
+        "*.local"
+      ],
+      "runtime": "python313"
+    }
+  ]
+}

integration/emulators/functions/.gitignore

@@ -0,0 +1,6 @@
+# Python bytecode
+__pycache__/
+
+# Python virtual environment
+venv/
+*.local

integration/emulators/functions/main.py

@@ -0,0 +1,7 @@
+from firebase_functions import tasks_fn
+
+@tasks_fn.on_task_dispatched()
+def testTaskQueue(req: tasks_fn.CallableRequest) -> None:
+    """Handles tasks from the task queue."""
+    print(f"Received task with data: {req.data}")
+    return

integration/emulators/functions/requirements.txt

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

integration/test_functions.py

@@ -14,19 +14,35 @@
 
 """Integration tests for firebase_admin.functions module."""
 
+import os
 import pytest
 
 import firebase_admin
 from firebase_admin import functions
+from firebase_admin import _utils
 from integration import conftest
 
 
 _DEFAULT_DATA = {'data': {'city': 'Seattle'}}
+def integration_conf(request):
+    host_override = os.environ.get('CLOUD_TASKS_EMULATOR_HOST')
+    if host_override:
+        return _utils.EmulatorAdminCredentials(), 'fake-project-id'
+
+    return conftest.integration_conf(request)
 
 @pytest.fixture(scope='module')
 def app(request):
-    cred, _ = conftest.integration_conf(request)
-    return firebase_admin.initialize_app(cred, name='integration-functions')
+    cred, project_id = integration_conf(request)
+    return firebase_admin.initialize_app(
+        cred, options={'projectId': project_id}, name='integration-functions')
+
+@pytest.fixture(scope='module', autouse=True)
+def default_app(request):
+    cred, project_id = integration_conf(request)
+    app = firebase_admin.initialize_app(cred, options={'projectId': project_id})
+    yield app
+    firebase_admin.delete_app(app)
 
 
 class TestFunctions:
@@ -56,17 +72,21 @@ def test_task_queue_app(self, task_queue_params, app):
         assert queue is not None
         assert callable(queue.enqueue)
         assert callable(queue.delete)
-    
-    def test_task_enqueue(self, app):
-        queue = functions.task_queue('testTaskQueue', app=app)
+
+    def test_task_enqueue(self):
+        queue = functions.task_queue('testTaskQueue')
         task_id = queue.enqueue(_DEFAULT_DATA)
         assert task_id is not None
-    
-    def test_task_delete(self, app):
+
+    @pytest.mark.skipif(
+        os.environ.get('CLOUD_TASKS_EMULATOR_HOST') is not None,
+        reason="Skipping test_task_delete against emulator due to bug in firebase-tools"
+    )
+    def test_task_delete(self):
         # Skip this test against the emulator since tasks can't be delayed there to verify deletion
         # See: https://github.com/firebase/firebase-tools/issues/8254
         task_options = functions.TaskOptions(schedule_delay_seconds=60)
-        queue = functions.task_queue('testTaskQueue', app=app)
+        queue = functions.task_queue('testTaskQueue')
         task_id = queue.enqueue(_DEFAULT_DATA, task_options)
         assert task_id is not None
         queue.delete(task_id)