feat(fdc): Add raw HTTP setup and cleanup fixtures to integration test suite

- Type Annotations: Added from __future__ import annotations to dataconnect.py for clean return type hints.
- Integration Test Fixtures: Added setup_and_cleanup_database fixture in integration/test_data_connect.py using raw HTTP bash scripts (seed.sh and cleanup.sh) before/after every test without relying on the SDK under test.
- Emulator Cleanup: Added integration/emulators/cleanup.sh script executing raw HTTP POST deleteMany mutations via curl.
- Test Naming & CI: Updated TestImpersonation test method names to start with test_impersonation_ and removed unnecessary credentials flag from ci.yml.

Author: mk2023

.github/workflows/ci.yml

@@ -55,7 +55,7 @@ jobs:
     - 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'
     - name: Run Data Connect emulator tests
-      run: firebase emulators:exec --config integration/emulators/firebase.json --only dataconnect --project fake-project-id './integration/emulators/seed.sh && DATA_CONNECT_EMULATOR_HOST=localhost:9399 pytest integration/test_data_connect.py --cert=tests/data/service_account.json'
+      run: firebase emulators:exec --config integration/emulators/firebase.json --only dataconnect --project fake-project-id 'DATA_CONNECT_EMULATOR_HOST=localhost:9399 pytest integration/test_data_connect.py'
 
 
   lint:

firebase_admin/dataconnect.py

@@ -18,6 +18,8 @@
 Firebase apps.
 """
 
+from __future__ import annotations
+
 from collections.abc import Mapping
 from dataclasses import dataclass, asdict, is_dataclass
 import typing
@@ -134,12 +136,12 @@ def __init__(
             super().__init__(auth_claims=auth_claims)
 
     @staticmethod
-    def unauthenticated() -> 'Impersonation':
+    def unauthenticated() -> Impersonation:
         """Returns impersonation configuration for unauthenticated requests."""
         return Impersonation(unauthenticated=True)
 
     @staticmethod
-    def authenticated(auth_claims: Dict[str, Any]) -> 'Impersonation':
+    def authenticated(auth_claims: Dict[str, Any]) -> Impersonation:
         """Returns impersonation configuration for authenticated requests.
 
         # TODO: More strongly type auth_claims later.
@@ -166,8 +168,6 @@ class ExecuteGraphqlResponse(Generic[_Data]):
 
 
 class DataConnect:
-
-
     """Represents a Firebase Data Connect client instance. 
     
        This client provides access to the Firebase Data Connect service 
@@ -257,7 +257,6 @@ def execute_graphql_read(
         )
 
 
-
 class _DataConnectService:
     """Service that maintains a collection of DataConnect clients."""
 
@@ -357,8 +356,6 @@ def _validate_variables_type(
                     type_name = getattr(expected_type, '__name__', str(expected_type))
                     raise ValueError(f"variables must be of type {type_name}")
 
-
-
     def _validate_impersonation_options(self, impersonate: Any) -> None:
         """Validates impersonation dictionary options."""
         if impersonate is not None:
@@ -531,7 +528,6 @@ def _parse_graphql_response(
         # TODO(b/406281627): Add support for partial errors.
         return ExecuteGraphqlResponse(data=resp_dict.get("data"))
 
-
     def _execute_graphql_helper(
         self,
         query: str,
@@ -555,7 +551,6 @@ def _execute_graphql_helper(
         resp_dict = self._make_gql_request(url=url, headers=headers, payload=payload)
         return self._parse_graphql_response(resp_dict)
 
-
     def execute_graphql(
         self,
         query: str,

integration/emulators/cleanup.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+# Shell script to clear all test data from the Firebase Data Connect emulator.
+set -e
+
+EMULATOR_HOST="${DATA_CONNECT_EMULATOR_HOST:-127.0.0.1:9399}"
+ENDPOINT="http://${EMULATOR_HOST}/v1/projects/test-project/locations/us-west2/services/my-service:executeGraphql"
+
+send_gql_mutation() {
+  local payload="$1"
+  local response
+  response=$(curl -s -X POST "${ENDPOINT}" \
+    -H "Authorization: Bearer owner" \
+    -H "Content-Type: application/json" \
+    -d "${payload}")
+
+  if [ -z "${response}" ]; then
+    echo "Failed to receive response from Data Connect emulator at ${ENDPOINT}" >&2
+    exit 1
+  fi
+}
+
+send_gql_mutation '{"query": "mutation { email_deleteMany(all: true) user_deleteMany(all: true) }"}'

integration/test_data_connect.py

@@ -14,9 +14,27 @@
 
 """Integration tests for firebase_admin.dataconnect module (execute_graphql)."""
 
+import os
+import subprocess
 import pytest
 
-from firebase_admin import dataconnect, exceptions
+import firebase_admin
+from firebase_admin import _utils, dataconnect, exceptions
+from integration import conftest
+
+def integration_conf(request):
+    host_override = os.environ.get('DATA_CONNECT_EMULATOR_HOST')
+    if host_override:
+        return _utils.EmulatorAdminCredentials(), 'fake-project-id'
+
+    return conftest.integration_conf(request)
+
+@pytest.fixture(scope='module', autouse=True)
+def default_app(request):
+    cred, project_id = integration_conf(request)
+    return firebase_admin.initialize_app(
+        cred, options={'projectId': project_id})
+
 
 CONNECTOR_CONFIG = dataconnect.ConnectorConfig(
     location='us-west2',
@@ -122,6 +140,17 @@
       user_deleteMany(all: true)
     }"""
 
+@pytest.fixture(autouse=True)
+def setup_and_cleanup_database():
+    """Initializes database via seed.sh before each test and wipes it via cleanup.sh afterwards."""
+    script_dir = os.path.dirname(__file__)
+    seed_script = os.path.join(script_dir, 'emulators', 'seed.sh')
+    cleanup_script = os.path.join(script_dir, 'emulators', 'cleanup.sh')
+
+    subprocess.run(['bash', seed_script], check=True)
+    yield
+    subprocess.run(['bash', cleanup_script], check=True)
+
 # Impersonation Options
 OPTS_UNAUTHORIZED_CLAIMS = dataconnect.GraphqlOptions(
     impersonate=dataconnect.Impersonation.unauthenticated()
@@ -140,7 +169,6 @@
     })
 )
 
-
 class TestExecuteGraphql:
     """Integration tests for execute_graphql method."""
 
@@ -192,7 +220,6 @@ def test_execute_graphql_mutation(self):
             QUERY_GET_EMAIL, options=get_email_options
         )
         assert query_email_resp.data['email'] == UPDATED_FRED_EMAIL
-        dc_client.execute_graphql(UPSERT_FRED_EMAIL)
 
 
 class TestExecuteGraphqlRead:
@@ -265,7 +292,6 @@ def test_execute_graphql_impersonated_mutation_authenticated(self):
             query_options = dataconnect.GraphqlOptions(variables={'id': {'id': user_id}})
             query_resp = dc_client.execute_graphql(QUERY_GET_USER_BY_ID, options=query_options)
             assert query_resp.data['user'] == FREDRICK_USER
-            dc_client.execute_graphql(UPSERT_FRED_USER)
 
         def test_execute_graphql_impersonated_mutation_unauthenticated_fails(self):
             """Tests mutation with unauthenticated impersonation fails."""

tests/test_data_connect.py

@@ -830,48 +830,48 @@ def test_parse_graphql_response_non_dict_error(self):
 
 class TestImpersonation:
 
-    def test_unauthenticated_factory(self):
+    def test_impersonation_unauthenticated_factory(self):
         """Tests factory method for unauthenticated impersonation."""
         imp = dataconnect.Impersonation.unauthenticated()
         assert imp == {"unauthenticated": True}
 
-    def test_authenticated_factory(self):
+    def test_impersonation_authenticated_factory(self):
         """Tests factory method for authenticated impersonation."""
         imp = dataconnect.Impersonation.authenticated(TEST_AUTH_CLAIMS)
         assert imp == {"auth_claims": TEST_AUTH_CLAIMS}
 
-    def test_constructor_unauthenticated(self):
+    def test_impersonation_constructor_unauthenticated(self):
         """Tests direct constructor with unauthenticated=True."""
         imp = dataconnect.Impersonation(unauthenticated=True)
         assert imp == {"unauthenticated": True}
 
-    def test_constructor_auth_claims(self):
+    def test_impersonation_constructor_auth_claims(self):
         """Tests direct constructor with auth_claims dict."""
         imp = dataconnect.Impersonation(auth_claims=TEST_AUTH_CLAIMS)
         assert imp == {"auth_claims": TEST_AUTH_CLAIMS}
 
-    def test_constructor_neither_unauth_nor_claims_fails(self):
+    def test_impersonation_constructor_neither_unauth_nor_claims_fails(self):
         """Tests specifying neither unauthenticated nor claims raises ValueError."""
         with pytest.raises(
             ValueError,
             match="Impersonation requires either 'unauthenticated=True' or 'auth_claims'."
         ):
             dataconnect.Impersonation()
 
-    def test_constructor_both_unauth_and_claims_fails(self):
+    def test_impersonation_constructor_both_unauth_and_claims_fails(self):
         """Tests specifying both unauthenticated and claims raises ValueError."""
         with pytest.raises(
             ValueError,
             match="Cannot specify both 'unauthenticated' and 'auth_claims'."
         ):
             dataconnect.Impersonation(unauthenticated=True, auth_claims={"sub": "123"})
 
-    def test_constructor_invalid_unauthenticated_type(self):
+    def test_impersonation_constructor_invalid_unauthenticated_type(self):
         """Tests non-boolean unauthenticated raises ValueError."""
         with pytest.raises(ValueError, match="'unauthenticated' must be a boolean."):
             dataconnect.Impersonation(unauthenticated="not-a-bool")
 
-    def test_constructor_invalid_auth_claims_type(self):
+    def test_impersonation_constructor_invalid_auth_claims_type(self):
         """Tests non-dict auth_claims raises ValueError."""
         with pytest.raises(ValueError, match="'auth_claims' must be a dictionary."):
             dataconnect.Impersonation(auth_claims="not-a-dict")