fix: enable missed return types for generic (#1485)

* tests, support for dict & httpresp * support for returning list * added support for int, double * bool support, unit tests --------- Co-authored-by: Victoria Hall <[email protected]>
Azure · May 29, 2024 · 8214d0c · 8214d0c
1 parent b0bacf0
commit 8214d0c
Show file tree

Hide file tree

Showing 31 changed files with 624 additions and 17 deletions.
diff --git a/azure_functions_worker/bindings/datumdef.py b/azure_functions_worker/bindings/datumdef.py
@@ -201,6 +201,19 @@ def datum_as_proto(datum: Datum) -> protos.TypedData:
         ))
     elif datum.type is None:
         return None
+    elif datum.type == 'dict':
+        # TypedData doesn't support dict, so we return it as json
+        return protos.TypedData(json=json.dumps(datum.value))
+    elif datum.type == 'list':
+        # TypedData doesn't support list, so we return it as json
+        return protos.TypedData(json=json.dumps(datum.value))
+    elif datum.type == 'int':
+        return protos.TypedData(int=datum.value)
+    elif datum.type == 'double':
+        return protos.TypedData(double=datum.value)
+    elif datum.type == 'bool':
+        # TypedData doesn't support bool, so we return it as an int
+        return protos.TypedData(int=int(datum.value))
     else:
         raise NotImplementedError(
             'unexpected Datum type: {!r}'.format(datum.type)

diff --git a/azure_functions_worker/bindings/generic.py b/azure_functions_worker/bindings/generic.py
@@ -30,6 +30,16 @@ def encode(cls, obj: Any, *,
             return datumdef.Datum(type='bytes', value=bytes(obj))
         elif obj is None:
             return datumdef.Datum(type=None, value=obj)
+        elif isinstance(obj, dict):
+            return datumdef.Datum(type='dict', value=obj)
+        elif isinstance(obj, list):
+            return datumdef.Datum(type='list', value=obj)
+        elif isinstance(obj, int):
+            return datumdef.Datum(type='int', value=obj)
+        elif isinstance(obj, float):
+            return datumdef.Datum(type='double', value=obj)
+        elif isinstance(obj, bool):
+            return datumdef.Datum(type='bool', value=obj)
         else:
             raise NotImplementedError
 

diff --git a/tests/endtoend/generic_functions/generic_functions_stein/function_app.py b/tests/endtoend/generic_functions/generic_functions_stein/function_app.py
@@ -1,6 +1,7 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License.
 import azure.functions as func
+
 import logging
 
 app = func.FunctionApp(http_auth_level=func.AuthLevel.ANONYMOUS)
@@ -45,7 +46,91 @@ def mytimer(mytimer: func.TimerRequest, testEntity) -> None:
     logging.info("This timer trigger function executed successfully")
 
 
-@app.function_name(name="mytimer2")
+@app.function_name(name="return_string")
+@app.schedule(schedule="*/1 * * * * *", arg_name="mytimer",
+              run_on_startup=False,
+              use_monitor=False)
+@app.generic_input_binding(
+    arg_name="testEntity",
+    type="table",
+    connection="AzureWebJobsStorage",
+    table_name="EventHubBatchTest")
+def return_string(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return string")
+    return "hi!"
+
+
+@app.function_name(name="return_bytes")
+@app.schedule(schedule="*/1 * * * * *", arg_name="mytimer",
+              run_on_startup=False,
+              use_monitor=False)
+@app.generic_input_binding(
+    arg_name="testEntity",
+    type="table",
+    connection="AzureWebJobsStorage",
+    table_name="EventHubBatchTest")
+def return_bytes(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return bytes")
+    return "test-dată"
+
+
+@app.function_name(name="return_dict")
+@app.schedule(schedule="*/1 * * * * *", arg_name="mytimer",
+              run_on_startup=False,
+              use_monitor=False)
+@app.generic_input_binding(
+    arg_name="testEntity",
+    type="table",
+    connection="AzureWebJobsStorage",
+    table_name="EventHubBatchTest")
+def return_dict(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return dict")
+    return {"hello": "world"}
+
+
+@app.function_name(name="return_list")
+@app.schedule(schedule="*/1 * * * * *", arg_name="mytimer",
+              run_on_startup=False,
+              use_monitor=False)
+@app.generic_input_binding(
+    arg_name="testEntity",
+    type="table",
+    connection="AzureWebJobsStorage",
+    table_name="EventHubBatchTest")
+def return_list(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return list")
+    return [1, 2, 3]
+
+
+@app.function_name(name="return_int")
+@app.schedule(schedule="*/1 * * * * *", arg_name="mytimer",
+              run_on_startup=False,
+              use_monitor=False)
+@app.generic_input_binding(
+    arg_name="testEntity",
+    type="table",
+    connection="AzureWebJobsStorage",
+    table_name="EventHubBatchTest")
+def return_int(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return int")
+    return 12
+
+
+@app.function_name(name="return_double")
+@app.schedule(schedule="*/1 * * * * *", arg_name="mytimer",
+              run_on_startup=False,
+              use_monitor=False)
+@app.generic_input_binding(
+    arg_name="testEntity",
+    type="table",
+    connection="AzureWebJobsStorage",
+    table_name="EventHubBatchTest")
+def return_double(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return double")
+    return 12.34
+
+
+@app.function_name(name="return_bool")
 @app.schedule(schedule="*/1 * * * * *", arg_name="mytimer",
               run_on_startup=False,
               use_monitor=False)
@@ -54,5 +139,6 @@ def mytimer(mytimer: func.TimerRequest, testEntity) -> None:
     type="table",
     connection="AzureWebJobsStorage",
     table_name="EventHubBatchTest")
-def mytimer2(mytimer: func.TimerRequest, testEntity):
-    logging.info("Timer trigger with none return and no type hint")
+def return_bool(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return bool")
+    return True
diff --git a/tests/endtoend/generic_functions/return_bool/function.json b/tests/endtoend/generic_functions/return_bool/function.json
@@ -0,0 +1,21 @@
+{
+  "scriptFile": "main.py",
+  "bindings": [
+    {
+      "name": "mytimer",
+      "type": "timerTrigger",
+      "direction": "in",
+      "schedule": "*/1 * * * * *",
+      "runOnStartup": false
+    },
+    {
+      "direction": "in",
+      "type": "table",
+      "name": "testEntity",
+      "partitionKey": "test",
+      "rowKey": "WillBePopulatedWithGuid",
+      "tableName": "BindingTestTable",
+      "connection": "AzureWebJobsStorage"
+    }
+  ]
+}
diff --git a/tests/endtoend/generic_functions/return_bool/main.py b/tests/endtoend/generic_functions/return_bool/main.py
@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+
+import azure.functions as func
+
+
+def main(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return bool")
+    return True
diff --git a/tests/endtoend/generic_functions/return_bytes/function.json b/tests/endtoend/generic_functions/return_bytes/function.json
@@ -0,0 +1,21 @@
+{
+  "scriptFile": "main.py",
+  "bindings": [
+    {
+      "name": "mytimer",
+      "type": "timerTrigger",
+      "direction": "in",
+      "schedule": "*/1 * * * * *",
+      "runOnStartup": false
+    },
+    {
+      "direction": "in",
+      "type": "table",
+      "name": "testEntity",
+      "partitionKey": "test",
+      "rowKey": "WillBePopulatedWithGuid",
+      "tableName": "BindingTestTable",
+      "connection": "AzureWebJobsStorage"
+    }
+  ]
+}
diff --git a/tests/endtoend/generic_functions/return_bytes/main.py b/tests/endtoend/generic_functions/return_bytes/main.py
@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+
+import azure.functions as func
+
+
+def main(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return bytes")
+    return "test-dată"
diff --git a/tests/endtoend/generic_functions/return_dict/function.json b/tests/endtoend/generic_functions/return_dict/function.json
@@ -0,0 +1,21 @@
+{
+  "scriptFile": "main.py",
+  "bindings": [
+    {
+      "name": "mytimer",
+      "type": "timerTrigger",
+      "direction": "in",
+      "schedule": "*/1 * * * * *",
+      "runOnStartup": false
+    },
+    {
+      "direction": "in",
+      "type": "table",
+      "name": "testEntity",
+      "partitionKey": "test",
+      "rowKey": "WillBePopulatedWithGuid",
+      "tableName": "BindingTestTable",
+      "connection": "AzureWebJobsStorage"
+    }
+  ]
+}
diff --git a/tests/endtoend/generic_functions/return_dict/main.py b/tests/endtoend/generic_functions/return_dict/main.py
@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+
+import azure.functions as func
+
+
+def main(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return dict")
+    return {"hello": "world"}
diff --git a/tests/endtoend/generic_functions/return_double/function.json b/tests/endtoend/generic_functions/return_double/function.json
@@ -0,0 +1,21 @@
+{
+  "scriptFile": "main.py",
+  "bindings": [
+    {
+      "name": "mytimer",
+      "type": "timerTrigger",
+      "direction": "in",
+      "schedule": "*/1 * * * * *",
+      "runOnStartup": false
+    },
+    {
+      "direction": "in",
+      "type": "table",
+      "name": "testEntity",
+      "partitionKey": "test",
+      "rowKey": "WillBePopulatedWithGuid",
+      "tableName": "BindingTestTable",
+      "connection": "AzureWebJobsStorage"
+    }
+  ]
+}
diff --git a/tests/endtoend/generic_functions/return_double/main.py b/tests/endtoend/generic_functions/return_double/main.py
@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+
+import azure.functions as func
+
+
+def main(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return double")
+    return 12.34
diff --git a/tests/endtoend/generic_functions/return_int/function.json b/tests/endtoend/generic_functions/return_int/function.json
@@ -0,0 +1,21 @@
+{
+  "scriptFile": "main.py",
+  "bindings": [
+    {
+      "name": "mytimer",
+      "type": "timerTrigger",
+      "direction": "in",
+      "schedule": "*/1 * * * * *",
+      "runOnStartup": false
+    },
+    {
+      "direction": "in",
+      "type": "table",
+      "name": "testEntity",
+      "partitionKey": "test",
+      "rowKey": "WillBePopulatedWithGuid",
+      "tableName": "BindingTestTable",
+      "connection": "AzureWebJobsStorage"
+    }
+  ]
+}
diff --git a/tests/endtoend/generic_functions/return_int/main.py b/tests/endtoend/generic_functions/return_int/main.py
@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+
+import azure.functions as func
+
+
+def main(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return int")
+    return 12
diff --git a/tests/endtoend/generic_functions/return_list/function.json b/tests/endtoend/generic_functions/return_list/function.json
@@ -0,0 +1,21 @@
+{
+  "scriptFile": "main.py",
+  "bindings": [
+    {
+      "name": "mytimer",
+      "type": "timerTrigger",
+      "direction": "in",
+      "schedule": "*/1 * * * * *",
+      "runOnStartup": false
+    },
+    {
+      "direction": "in",
+      "type": "table",
+      "name": "testEntity",
+      "partitionKey": "test",
+      "rowKey": "WillBePopulatedWithGuid",
+      "tableName": "BindingTestTable",
+      "connection": "AzureWebJobsStorage"
+    }
+  ]
+}
diff --git a/tests/endtoend/generic_functions/return_list/main.py b/tests/endtoend/generic_functions/return_list/main.py
@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+
+import azure.functions as func
+
+
+def main(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return list")
+    return [1, 2, 3]
diff --git a/tests/endtoend/generic_functions/return_string/function.json b/tests/endtoend/generic_functions/return_string/function.json
@@ -0,0 +1,21 @@
+{
+  "scriptFile": "main.py",
+  "bindings": [
+    {
+      "name": "mytimer",
+      "type": "timerTrigger",
+      "direction": "in",
+      "schedule": "*/1 * * * * *",
+      "runOnStartup": false
+    },
+    {
+      "direction": "in",
+      "type": "table",
+      "name": "testEntity",
+      "partitionKey": "test",
+      "rowKey": "WillBePopulatedWithGuid",
+      "tableName": "BindingTestTable",
+      "connection": "AzureWebJobsStorage"
+    }
+  ]
+}
diff --git a/tests/endtoend/generic_functions/return_string/main.py b/tests/endtoend/generic_functions/return_string/main.py
@@ -0,0 +1,11 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+
+import azure.functions as func
+
+
+def main(mytimer: func.TimerRequest, testEntity):
+    logging.info("Return string")
+    return "hi!"