Merge pull request #7 from tpiperatgod/issue-6

add new ut cases

Author: benjaminhuo

setup.py

@@ -58,7 +58,7 @@
         "dapr>=1.10.0",
         "aiohttp==3.8.4",
         "dapr-ext-grpc>=1.10.0",
-        "dapr-ext-fastapi>=1.10.0"
+        "dapr-ext-fastapi>=1.10.0",
     ],
     entry_points={
         "console_scripts": [

src/functions_framework/_cli.py

@@ -26,7 +26,7 @@
 @click.option("--dry-run", envvar="DRY_RUN", is_flag=True)
 def _cli(target, source, host, port, debug, dry_run):
     # fetch the context
-    context = _function_registry.get_openfunction_context('')
+    context = _function_registry.get_openfunction_context("")
 
     runner = Runner(context, target, source, host, port, debug, dry_run)
     runner.run()
@@ -35,4 +35,4 @@ def _cli(target, source, host, port, debug, dry_run):
 def run_dry(target, host, port):
     click.echo("Function: {}".format(target))
     click.echo("URL: http://{}:{}/".format(host, port))
-    click.echo("Dry run successful, shutting down.")
+    click.echo("Dry run successful, shutting down.")

src/functions_framework/_function_registry.py

@@ -71,8 +71,11 @@ def get_user_function(source, source_module, target):
         raise InvalidFunctionSignatureException(
             "The function defined in file {source} as {target} needs to be of "
             "function signature {signature}, but got {target_signature}".format(
-                source=source, target=target, signature=FUNCTION_SIGNATURE_RULE,
-                target_signature=inspect.signature(function))
+                source=source,
+                target=target,
+                signature=FUNCTION_SIGNATURE_RULE,
+                target_signature=inspect.signature(function),
+            )
         )
 
     return function
@@ -142,13 +145,10 @@ def get_func_signature_type(func_name: str, signature_type: str) -> str:
 
 def get_openfunction_context(func_context: str) -> FunctionContext:
     """Get openfunction context"""
-    context_str = (
-        func_context
-        or os.environ.get(FUNC_CONTEXT)
-    )
+    context_str = func_context or os.environ.get(FUNC_CONTEXT)
 
     if context_str:
         context = FunctionContext.from_json(json.loads(context_str))
         return context
-   
+
     return None

src/functions_framework/context/function_context.py

@@ -17,9 +17,20 @@
 class FunctionContext(object):
     """OpenFunction's serving context."""
 
-    def __init__(self, name="", version="", dapr_triggers=None, http_trigger=None,
-                 inputs=None, outputs=None, states=None,
-                 pre_hooks=None, post_hooks=None, tracing=None, port=0):
+    def __init__(
+        self,
+        name="",
+        version="",
+        dapr_triggers=None,
+        http_trigger=None,
+        inputs=None,
+        outputs=None,
+        states=None,
+        pre_hooks=None,
+        post_hooks=None,
+        tracing=None,
+        port=0,
+    ):
         self.name = name
         self.version = version
         self.dapr_triggers = dapr_triggers
@@ -34,17 +45,17 @@ def __init__(self, name="", version="", dapr_triggers=None, http_trigger=None,
 
     @staticmethod
     def from_json(json_dct):
-        name = json_dct.get('name')
-        version = json_dct.get('version')
-        inputs_map = json_dct.get('inputs')
-        outputs_map = json_dct.get('outputs')
-        _dapr_triggers = json_dct.get('triggers', {}).get('dapr', [])
-        http_trigger = json_dct.get('triggers', {}).get('http', None)
-        states = json_dct.get('states', {})
-        pre_hooks = json_dct.get('pre_hooks', [])
-        post_hooks = json_dct.get('post_hooks', [])
-        tracing = json_dct.get('tracing', {})
-        port = json_dct.get('port', 0)
+        name = json_dct.get("name")
+        version = json_dct.get("version")
+        inputs_map = json_dct.get("inputs")
+        outputs_map = json_dct.get("outputs")
+        _dapr_triggers = json_dct.get("triggers", {}).get("dapr", [])
+        http_trigger = json_dct.get("triggers", {}).get("http", None)
+        states = json_dct.get("states", {})
+        pre_hooks = json_dct.get("pre_hooks", [])
+        post_hooks = json_dct.get("post_hooks", [])
+        tracing = json_dct.get("tracing", {})
+        port = json_dct.get("port", 0)
 
         inputs = None
         if inputs_map:
@@ -67,14 +78,32 @@ def from_json(json_dct):
         if http_trigger:
             http_trigger = HTTPRoute.from_json(http_trigger)
 
-        return FunctionContext(name, version, dapr_triggers, http_trigger,
-                               inputs, outputs, states, pre_hooks, post_hooks, tracing, port)
+        return FunctionContext(
+            name,
+            version,
+            dapr_triggers,
+            http_trigger,
+            inputs,
+            outputs,
+            states,
+            pre_hooks,
+            post_hooks,
+            tracing,
+            port,
+        )
 
 
 class Component(object):
     """Components for inputs and outputs."""
 
-    def __init__(self, component_name="", component_type="", topic="", metadata=None, operation=""):
+    def __init__(
+        self,
+        component_name="",
+        component_type="",
+        topic="",
+        metadata=None,
+        operation="",
+    ):
         self.topic = topic
         self.component_name = component_name
         self.component_type = component_type
@@ -91,21 +120,24 @@ def get_type(self):
         return ""
 
     def __str__(self):
-        return "{component_name: %s, component_type: %s, topic: %s, metadata: %s, operation: %s}" % (
-            self.component_name,
-            self.component_type,
-            self.topic,
-            self.metadata,
-            self.operation
+        return (
+            "{component_name: %s, component_type: %s, topic: %s, metadata: %s, operation: %s}"
+            % (
+                self.component_name,
+                self.component_type,
+                self.topic,
+                self.metadata,
+                self.operation,
+            )
         )
 
     @staticmethod
     def from_json(json_dct):
-        topic = json_dct.get('topic', '')
-        component_name = json_dct.get('componentName', '')
-        metadata = json_dct.get('metadata')
-        component_type = json_dct.get('componentType', '')
-        operation = json_dct.get('operation', '')
+        topic = json_dct.get("topic", "")
+        component_name = json_dct.get("componentName", "")
+        metadata = json_dct.get("metadata")
+        component_type = json_dct.get("componentType", "")
+        operation = json_dct.get("operation", "")
         return Component(component_name, component_type, topic, metadata, operation)
 
 
@@ -116,18 +148,15 @@ def __init__(self, port=""):
         self.port = port
 
     def __str__(self):
-        return "{port: %s}" % (
-            self.port
-        )
+        return "{port: %s}" % (self.port)
 
     @staticmethod
     def from_json(json_dct):
-        port = json_dct.get('port', '')
+        port = json_dct.get("port", "")
         return HTTPRoute(port)
 
 
 class DaprTrigger(object):
-
     def __init__(self, name, component_type, topic):
         self.name = name
         self.component_type = component_type
@@ -137,12 +166,12 @@ def __str__(self):
         return "{name: %s, component_type: %s, topic: %s}" % (
             self.name,
             self.component_type,
-            self.topic
+            self.topic,
         )
 
     @staticmethod
     def from_json(json_dct):
-        name = json_dct.get('name', '')
-        component_type = json_dct.get('type', '')
-        topic = json_dct.get('topic')
+        name = json_dct.get("name", "")
+        component_type = json_dct.get("type", "")
+        topic = json_dct.get("topic")
         return DaprTrigger(name, component_type, topic)

src/functions_framework/context/user_context.py

@@ -25,8 +25,14 @@
 class UserContext(object):
     """Context for user."""
 
-    def __init__(self, runtime_context: RuntimeContext = None,
-                 binding_request=None, topic_event=None, http_request=None, logger=None):
+    def __init__(
+        self,
+        runtime_context: RuntimeContext = None,
+        binding_request=None,
+        topic_event=None,
+        http_request=None,
+        logger=None,
+    ):
         self.runtime_context = runtime_context
         self.logger = logger
         self.out = FunctionOut(0, None, "", {})
@@ -73,11 +79,17 @@ def send(self, output_name, data):
 
         target = outputs[output_name]
         if target.component_type.startswith(constants.DAPR_BINDING_TYPE):
-            resp = self.dapr_client.invoke_binding(target.component_name, target.operation, data, target.metadata)
+            resp = self.dapr_client.invoke_binding(
+                target.component_name, target.operation, data, target.metadata
+            )
         elif target.component_type.startswith(constants.DAPR_PUBSUB_TYPE):
             data = json.dumps(data)
             resp = self.dapr_client.publish_event(
-                target.component_name, target.topic, data,
-                data_content_type=constants.DEFAULT_DATA_CONTENT_TYPE, publish_metadata=target.metadata)
+                target.component_name,
+                target.topic,
+                data,
+                data_content_type=constants.DEFAULT_DATA_CONTENT_TYPE,
+                publish_metadata=target.metadata,
+            )
 
         return resp

src/functions_framework/log.py

@@ -31,7 +31,9 @@ def initialize_logger(name=None, level=logging.DEBUG):
     console_handler.setLevel(level)
 
     # create formatter
-    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+    formatter = logging.Formatter(
+        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
 
     # add formatter to handlers
     file_handler.setFormatter(formatter)

src/functions_framework/runner.py

@@ -25,8 +25,16 @@
 
 
 class Runner:
-    def __init__(self, context: FunctionContext, target=None, source=None,
-                 host=None, port=None, debug=None, dry_run=None):
+    def __init__(
+        self,
+        context: FunctionContext,
+        target=None,
+        source=None,
+        host=None,
+        port=None,
+        debug=None,
+        dry_run=None,
+    ):
         self.target = target
         self.source = source
         self.context = context
@@ -54,7 +62,9 @@ def load_user_function(self):
         source_module, spec = _function_registry.load_function_module(_source)
         spec.loader.exec_module(source_module)
 
-        self.user_function = _function_registry.get_user_function(_source, source_module, _target)
+        self.user_function = _function_registry.get_user_function(
+            _source, source_module, _target
+        )
 
     def init_logger(self):
         level = logging.INFO
@@ -68,10 +78,18 @@ def run(self):
 
         _trigger = runtime_context.get_http_trigger()
         if _trigger:
-            http_trigger = HTTPTriggerHandler(self.context.port, _trigger, self.source, self.target, self.user_function)
+            http_trigger = HTTPTriggerHandler(
+                self.context.port,
+                _trigger,
+                self.source,
+                self.target,
+                self.user_function,
+            )
             http_trigger.start(runtime_context, logger=self.logger)
 
         _triggers = runtime_context.get_dapr_triggers()
         if _triggers:
-            dapr_trigger = DaprTriggerHandler(self.context.port, _triggers, self.user_function)
+            dapr_trigger = DaprTriggerHandler(
+                self.context.port, _triggers, self.user_function
+            )
             dapr_trigger.start(runtime_context, logger=self.logger)

src/functions_framework/triggers/dapr_trigger/dapr.py

@@ -25,6 +25,7 @@
 
 class DaprTriggerHandler(TriggerHandler):
     """Handle dapr trigger."""
+
     def __init__(self, port, triggers: [DaprTrigger] = None, user_function=None):
         self.port = port
         self.triggers = triggers
@@ -39,17 +40,23 @@ def start(self, context: RuntimeContext, logger=None):
 
         for trigger in self.triggers:
             if trigger.component_type.startswith("bindings"):
+
                 @self.app.binding(trigger.name)
                 def binding_handler(request: BindingRequest):
                     rt_ctx = deepcopy(context)
-                    user_ctx = UserContext(runtime_context=rt_ctx, binding_request=request, logger=logger)
+                    user_ctx = UserContext(
+                        runtime_context=rt_ctx, binding_request=request, logger=logger
+                    )
                     self.user_function(user_ctx)
 
             if trigger.component_type.startswith("pubsub"):
+
                 @self.app.subscribe(pubsub_name=trigger.name, topic=trigger.topic)
                 def topic_handler(event: v1.Event):
                     rt_ctx = deepcopy(context)
-                    user_ctx = UserContext(runtime_context=rt_ctx, topic_event=event, logger=logger)
+                    user_ctx = UserContext(
+                        runtime_context=rt_ctx, topic_event=event, logger=logger
+                    )
                     self.user_function(user_ctx)
 
         self.app.run(self.port)

src/functions_framework/triggers/http_trigger/__init__.py

@@ -89,7 +89,9 @@ def _http_view_func_wrapper(function, runtime_context: RuntimeContext, request,
     @functools.wraps(function)
     def view_func(path):
         rt_ctx = deepcopy(runtime_context)
-        user_ctx = UserContext(runtime_context=rt_ctx, http_request=request, logger=logger)
+        user_ctx = UserContext(
+            runtime_context=rt_ctx, http_request=request, logger=logger
+        )
         return function(user_ctx)
 
     return view_func
@@ -102,7 +104,9 @@ def _configure_app(wsgi_app, runtime_context: RuntimeContext, function, logger):
     wsgi_app.url_map.add(werkzeug.routing.Rule("/robots.txt", endpoint="error"))
     wsgi_app.url_map.add(werkzeug.routing.Rule("/favicon.ico", endpoint="error"))
     wsgi_app.url_map.add(werkzeug.routing.Rule("/<path:path>", endpoint="run"))
-    wsgi_app.view_functions["run"] = _http_view_func_wrapper(function, runtime_context, flask.request, logger)
+    wsgi_app.view_functions["run"] = _http_view_func_wrapper(
+        function, runtime_context, flask.request, logger
+    )
     wsgi_app.view_functions["error"] = lambda: flask.abort(404, description="Not Found")
     wsgi_app.after_request(read_request)
 
@@ -127,7 +131,9 @@ def crash_handler(e):
     return str(e), 500, {_FUNCTION_STATUS_HEADER_FIELD: _CRASH}
 
 
-def create_app(runtime_context: RuntimeContext = None, target=None, source=None, logger=None):
+def create_app(
+    runtime_context: RuntimeContext = None, target=None, source=None, logger=None
+):
     _target = _function_registry.get_function_target(target)
     _source = _function_registry.get_function_source(source)
 

src/functions_framework/triggers/http_trigger/_http/__init__.py

@@ -40,4 +40,4 @@ def run(self, host, port):
 
 
 def create_server(wsgi_app, debug, **options):
-    return HTTPServer(wsgi_app, debug, **options)
+    return HTTPServer(wsgi_app, debug, **options)

src/functions_framework/triggers/http_trigger/_http/flask.py

@@ -22,4 +22,4 @@ def __init__(self, app, host, port, debug, **options):
         self.options = options
 
     def run(self):
-        self.app.run(self.host, self.port, debug=self.debug, **self.options)
+        self.app.run(self.host, self.port, debug=self.debug, **self.options)