feat: add tests

Author: exaby73

src/firebase_functions/core.py

@@ -84,8 +84,8 @@ class Change(_typing.Generic[T]):
     """
 
 
-_didInit = False
-_initCallback: _typing.Callable[[], _typing.Any] | None = None
+_did_init = False
+_init_callback: _typing.Callable[[], _typing.Any] | None = None
 
 
 def init(callback: _typing.Callable[[], _typing.Any]) -> None:
@@ -95,31 +95,34 @@ def init(callback: _typing.Callable[[], _typing.Any]) -> None:
      Calling this decorator more than once leads to undefined behavior.
     """
 
-    global _didInit
-    global _initCallback
+    global _did_init
+    global _init_callback
 
-    _initCallback = callback
+    _init_callback = callback
 
-    if _didInit:
-        _logger.warn("Setting init callback more than once. Only the most recent callback will be called")
+    if _did_init:
+        _logger.warn(
+            "Setting init callback more than once. Only the most recent callback will be called"
+        )
 
-    _initCallback = callback
-    _didInit = False
+    _init_callback = callback
+    _did_init = False
 
 
-def _with_init(fn: _typing.Callable[..., _typing.Any]) -> _typing.Callable[..., _typing.Any]:
+def _with_init(
+    fn: _typing.Callable[...,
+                         _typing.Any]) -> _typing.Callable[..., _typing.Any]:
     """
     A decorator that runs the init callback before running the decorated function.
     """
 
     def wrapper(*args, **kwargs):
-        global _didInit
-        global _initCallback
+        global _did_init
 
-        if not _didInit:
-            if _initCallback is not None:
-                _initCallback()
-            _didInit = True
+        if not _did_init:
+            if _init_callback is not None:
+                _init_callback()
+            _did_init = True
 
         return fn(*args, **kwargs)
 

src/firebase_functions/firestore_fn.py

@@ -145,8 +145,7 @@ def _firestore_endpoint_handler(
     app = get_app()
     firestore_client = _firestore_v1.Client(project=app.project_id,
                                             database=event_database)
-    firestore_ref: DocumentReference = firestore_client.document(
-        event_document)
+    firestore_ref: DocumentReference = firestore_client.document(event_document)
     value_snapshot: DocumentSnapshot | None = None
     old_value_snapshot: DocumentSnapshot | None = None
 
@@ -268,7 +267,7 @@ def on_document_written_wrapped(raw: _ce.CloudEvent):
 
 @_util.copy_func_kwargs(FirestoreOptions)
 def on_document_written_with_auth_context(**kwargs
-                                          ) -> _typing.Callable[[_C1], _C1]:
+                                         ) -> _typing.Callable[[_C1], _C1]:
     """
     Event handler that triggers when a document is created, updated, or deleted in Firestore.
     This trigger will also provide the authentication context of the principal who triggered 
@@ -367,7 +366,7 @@ def on_document_updated_wrapped(raw: _ce.CloudEvent):
 
 @_util.copy_func_kwargs(FirestoreOptions)
 def on_document_updated_with_auth_context(**kwargs
-                                          ) -> _typing.Callable[[_C1], _C1]:
+                                         ) -> _typing.Callable[[_C1], _C1]:
     """
     Event handler that triggers when a document is updated in Firestore.
     This trigger will also provide the authentication context of the principal who triggered 
@@ -466,7 +465,7 @@ def on_document_created_wrapped(raw: _ce.CloudEvent):
 
 @_util.copy_func_kwargs(FirestoreOptions)
 def on_document_created_with_auth_context(**kwargs
-                                          ) -> _typing.Callable[[_C2], _C2]:
+                                         ) -> _typing.Callable[[_C2], _C2]:
     """
     Event handler that triggers when a document is created in Firestore.
     This trigger will also provide the authentication context of the principal who triggered 
@@ -565,7 +564,7 @@ def on_document_deleted_wrapped(raw: _ce.CloudEvent):
 
 @_util.copy_func_kwargs(FirestoreOptions)
 def on_document_deleted_with_auth_context(**kwargs
-                                          ) -> _typing.Callable[[_C2], _C2]:
+                                         ) -> _typing.Callable[[_C2], _C2]:
     """
     Event handler that triggers when a document is deleted in Firestore.
     This trigger will also provide the authentication context of the principal who triggered 

src/firebase_functions/private/_identity_fn.py

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Cloud functions to handle Eventarc events."""
-
 # pylint: disable=protected-access
 import typing as _typing
 import datetime as _dt
@@ -353,8 +352,8 @@ def before_operation_handler(
         jwt_token = request.json["data"]["jwt"]
         decoded_token = _token_verifier.verify_auth_blocking_token(jwt_token)
         event = _auth_blocking_event_from_token_data(decoded_token)
-        auth_response: BeforeCreateResponse | BeforeSignInResponse | None = _with_init(func)(
-            event)
+        auth_response: BeforeCreateResponse | BeforeSignInResponse | None = _with_init(
+            func)(event)
         if not auth_response:
             return _jsonify({})
         auth_response_dict = _validate_auth_response(event_type, auth_response)
@@ -364,7 +363,7 @@ def before_operation_handler(
     # pylint: disable=broad-except
     except Exception as exception:
         if not isinstance(exception, HttpsError):
-            _logging.error("Unhandled error", exception)
+            _logging.error("Unhandled error %s", exception)
             exception = HttpsError(FunctionsErrorCode.INTERNAL, "INTERNAL")
         status = exception._http_error_code.status
         return _make_response(_jsonify(error=exception._as_dict()), status)

tests/test_db.py

@@ -0,0 +1,43 @@
+"""
+Tests for the db module.
+"""
+
+import unittest
+from unittest import mock
+from cloudevents.http import CloudEvent
+from firebase_functions import core, db_fn
+
+
+class TestDb(unittest.TestCase):
+    """
+    Tests for the db module.
+    """
+
+    def test_calls_init_function(self):
+        hello = None
+
+        @core.init
+        def init():
+            nonlocal hello
+            hello = "world"
+
+        func = mock.Mock(__name__="example_func")
+        decorated_func = db_fn.on_value_created(reference="path")(func)
+
+        event = CloudEvent(attributes={
+            "specversion": "1.0",
+            "id": "id",
+            "source": "source",
+            "subject": "subject",
+            "type": "type",
+            "time": "2024-04-10T12:00:00.000Z",
+            "instance": "instance",
+            "ref": "ref",
+            "firebasedatabasehost": "firebasedatabasehost",
+            "location": "location",
+        },
+                           data={"delta": "delta"})
+
+        decorated_func(event)
+
+        self.assertEqual(hello, "world")

tests/test_eventarc_fn.py

@@ -14,7 +14,10 @@
 """Eventarc trigger function tests."""
 import unittest
 from unittest.mock import Mock
+
 from cloudevents.http import CloudEvent as _CloudEvent
+
+from firebase_functions import core
 from firebase_functions.core import CloudEvent
 from firebase_functions.eventarc_fn import on_custom_event_published
 
@@ -83,3 +86,34 @@ def test_on_custom_event_published_wrapped(self):
             event_arg.type,
             "firebase.extensions.storage-resize-images.v1.complete",
         )
+
+    def test_calls_init_function(self):
+        hello = None
+
+        @core.init
+        def init():
+            nonlocal hello
+            hello = "world"
+
+        func = Mock(__name__="example_func")
+        raw_event = _CloudEvent(
+            attributes={
+                "specversion": "1.0",
+                "type": "firebase.extensions.storage-resize-images.v1.complete",
+                "source": "https://example.com/testevent",
+                "id": "1234567890",
+                "subject": "test_subject",
+                "time": "2023-03-11T13:25:37.403Z",
+            },
+            data={
+                "some_key": "some_value",
+            },
+        )
+
+        decorated_func = on_custom_event_published(
+            event_type="firebase.extensions.storage-resize-images.v1.complete",
+        )(func)
+
+        decorated_func(raw_event)
+
+        self.assertEqual(hello, "world")

tests/test_firestore_fn.py

@@ -70,3 +70,54 @@ def test_firestore_endpoint_handler_calls_function_with_correct_args(self):
             self.assertIsInstance(event, AuthEvent)
             self.assertEqual(event.auth_type, "unauthenticated")
             self.assertEqual(event.auth_id, "foo")
+
+    def test_calls_init_function(self):
+        with patch.dict("sys.modules", mocked_modules):
+            from firebase_functions import firestore_fn, core
+            from cloudevents.http import CloudEvent
+
+            func = Mock(__name__="example_func")
+
+            hello = None
+
+            @core.init
+            def init():
+                nonlocal hello
+                hello = "world"
+
+            attributes = {
+                "specversion":
+                    "1.0",
+                # pylint: disable=protected-access
+                "type":
+                    firestore_fn._event_type_created,
+                "source":
+                    "https://example.com/testevent",
+                "time":
+                    "2023-03-11T13:25:37.403Z",
+                "subject":
+                    "test_subject",
+                "datacontenttype":
+                    "application/json",
+                "location":
+                    "projects/project-id/databases/(default)/documents/foo/{bar}",
+                "project":
+                    "project-id",
+                "namespace":
+                    "(default)",
+                "document":
+                    "foo/{bar}",
+                "database":
+                    "projects/project-id/databases/(default)",
+                "authtype":
+                    "unauthenticated",
+                "authid":
+                    "foo"
+            }
+            raw_event = CloudEvent(attributes=attributes, data=json.dumps({}))
+            decorated_func = firestore_fn.on_document_created(
+                document="/foo/{bar}")(func)
+
+            decorated_func(raw_event)
+
+            self.assertEqual(hello, "world")

tests/test_https_fn.py

@@ -0,0 +1,72 @@
+"""
+Tests for the https module.
+"""
+
+import unittest
+from unittest.mock import Mock
+from flask import Flask, Request
+from werkzeug.test import EnvironBuilder
+
+from firebase_functions import core, https_fn
+
+
+class TestHttps(unittest.TestCase):
+    """
+    Tests for the http module.
+    """
+
+    def test_on_request_calls_init_function(self):
+        app = Flask(__name__)
+
+        hello = None
+
+        @core.init
+        def init():
+            nonlocal hello
+            hello = "world"
+
+        func = Mock(__name__="example_func")
+
+        with app.test_request_context("/"):
+            environ = EnvironBuilder(
+                method="POST",
+                json={
+                    "data": {
+                        "test": "value"
+                    },
+                },
+            ).get_environ()
+            request = Request(environ)
+            decorated_func = https_fn.on_request()(func)
+
+            decorated_func(request)
+
+        self.assertEqual(hello, "world")
+
+    def test_on_call_calls_init_function(self):
+        app = Flask(__name__)
+
+        hello = None
+
+        @core.init
+        def init():
+            nonlocal hello
+            hello = "world"
+
+        func = Mock(__name__="example_func")
+
+        with app.test_request_context("/"):
+            environ = EnvironBuilder(
+                method="POST",
+                json={
+                    "data": {
+                        "test": "value"
+                    },
+                },
+            ).get_environ()
+            request = Request(environ)
+            decorated_func = https_fn.on_call()(func)
+
+            decorated_func(request)
+
+        self.assertEqual("world", hello)