Add SQL Bindings end to end test (#1026)

* add sql bindings e2e test

* update test

* add sql bindings e2e test

* update test

* fix sql binding test

* add python310 sql connection string

* fix unit tests

* fix sql end to end test

Co-authored-by: gavin-aguiar <[email protected]>

Author: lucyzhang929

.ci/e2e_integration_test/pipeline.yml

@@ -42,6 +42,7 @@ steps:
     AzureWebJobsCosmosDBConnectionString: $(AzureWebJobsCosmosDBConnectionString)
     AzureWebJobsEventHubConnectionString: $(AzureWebJobsEventHubConnectionString)
     AzureWebJobsServiceBusConnectionString: $(AzureWebJobsServiceBusConnectionString)
+    AzureWebJobsSqlConnectionString: $(AzureWebJobsSqlConnectionString)
     AzureWebJobsEventGridTopicUri: $(AzureWebJobsEventGridTopicUri)
     AzureWebJobsEventGridConnectionKey: $(AzureWebJobsEventGridConnectionKey)
     PythonVersion: $(PYTHON_VERSION)

.ci/linux_devops_e2e_tests.sh

@@ -5,6 +5,7 @@ export AzureWebJobsStorage=$LINUXSTORAGECONNECTIONSTRING
 export AzureWebJobsCosmosDBConnectionString=$LINUXCOSMOSDBCONNECTIONSTRING
 export AzureWebJobsEventHubConnectionString=$LINUXEVENTHUBCONNECTIONSTRING
 export AzureWebJobsServiceBusConnectionString=$LINUXSERVICEBUSCONNECTIONSTRING
+export AzureWebJobsSqlConnectionString=$LINUXSQLCONNECTIONSTRING
 export AzureWebJobsEventGridTopicUri=$LINUXEVENTGRIDTOPICURI
 export AzureWebJobsEventGridConnectionKey=$LINUXEVENTGRIDTOPICCONNECTIONKEY
 

.github/workflows/ci_e2e_workflow.yml

@@ -76,6 +76,7 @@ jobs:
           AzureWebJobsCosmosDBConnectionString: ${{ secrets.LinuxCosmosDBConnectionString36 }}
           AzureWebJobsEventHubConnectionString: ${{ secrets.LinuxEventHubConnectionString36 }}
           AzureWebJobsServiceBusConnectionString: ${{ secrets.LinuxServiceBusConnectionString36 }}
+          AzureWebJobsSqlConnectionString: ${{ secrets.LinuxSqlConnectionString36 }}
           AzureWebJobsEventGridTopicUri: ${{ secrets.LinuxEventGridTopicUriString36 }}
           AzureWebJobsEventGridConnectionKey: ${{ secrets.LinuxEventGridConnectionKeyString36 }}
         run: |
@@ -87,6 +88,7 @@ jobs:
           AzureWebJobsCosmosDBConnectionString: ${{ secrets.LinuxCosmosDBConnectionString37 }}
           AzureWebJobsEventHubConnectionString: ${{ secrets.LinuxEventHubConnectionString37 }}
           AzureWebJobsServiceBusConnectionString: ${{ secrets.LinuxServiceBusConnectionString37 }}
+          AzureWebJobsSqlConnectionString: ${{ secrets.LinuxSqlConnectionString37 }}
           AzureWebJobsEventGridTopicUri: ${{ secrets.LinuxEventGridTopicUriString37 }}
           AzureWebJobsEventGridConnectionKey: ${{ secrets.LinuxEventGridConnectionKeyString37 }}
         run: |
@@ -98,6 +100,7 @@ jobs:
           AzureWebJobsCosmosDBConnectionString: ${{ secrets.LinuxCosmosDBConnectionString38 }}
           AzureWebJobsEventHubConnectionString: ${{ secrets.LinuxEventHubConnectionString38 }}
           AzureWebJobsServiceBusConnectionString: ${{ secrets.LinuxServiceBusConnectionString38 }}
+          AzureWebJobsSqlConnectionString: ${{ secrets.LinuxSqlConnectionString38 }}
           AzureWebJobsEventGridTopicUri: ${{ secrets.LinuxEventGridTopicUriString38 }}
           AzureWebJobsEventGridConnectionKey: ${{ secrets.LinuxEventGridConnectionKeyString38 }}
         run: |
@@ -109,6 +112,7 @@ jobs:
           AzureWebJobsCosmosDBConnectionString: ${{ secrets.LinuxCosmosDBConnectionString39 }}
           AzureWebJobsEventHubConnectionString: ${{ secrets.LinuxEventHubConnectionString39 }}
           AzureWebJobsServiceBusConnectionString: ${{ secrets.LinuxServiceBusConnectionString39 }}
+          AzureWebJobsSqlConnectionString: ${{ secrets.LinuxSqlConnectionString39 }}
           AzureWebJobsEventGridTopicUri: ${{ secrets.LinuxEventGridTopicUriString39 }}
           AzureWebJobsEventGridConnectionKey: ${{ secrets.LinuxEventGridConnectionKeyString39 }}
         run: |
@@ -120,6 +124,7 @@ jobs:
           AzureWebJobsCosmosDBConnectionString: ${{ secrets.LinuxCosmosDBConnectionString310 }}
           AzureWebJobsEventHubConnectionString: ${{ secrets.LinuxEventHubConnectionString310 }}
           AzureWebJobsServiceBusConnectionString: ${{ secrets.LinuxServiceBusConnectionString310 }}
+          AzureWebJobsSqlConnectionString: ${{ secrets.LinuxSqlConnectionString310 }}
           AzureWebJobsEventGridTopicUri: ${{ secrets.LinuxEventGridTopicUriString310 }}
           AzureWebJobsEventGridConnectionKey: ${{ secrets.LinuxEventGridConnectionKeyString310 }}
         run: |

azure_functions_worker/testutils.py

@@ -878,6 +878,10 @@ def popen_webhost(*, stdout, stderr, script_root=FUNCS_PATH, port=None):
         if servicebus:
             extra_env['AzureWebJobsServiceBusConnectionString'] = servicebus
 
+        sql = testconfig['azure'].get('sql_key')
+        if sql:
+            extra_env['AzureWebJobsSqlConnectionString'] = sql
+
         eventgrid_topic_uri = testconfig['azure'].get('eventgrid_topic_uri')
         if eventgrid_topic_uri:
             extra_env['AzureWebJobsEventGridTopicUri'] = eventgrid_topic_uri

setup.py

@@ -50,6 +50,8 @@
         Version="4.0.5" />
       <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.ServiceBus"
         Version="4.2.1" />
+      <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.Sql"
+        Version="0.1.346-preview" />
       <PackageReference
         Include="Microsoft.Azure.WebJobs.Script.ExtensionsMetadataGenerator"
         Version="1.1.3" />

tests/endtoend/sql_functions/sql_input/__init__.py

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import json
+import azure.functions as func
+
+
+def main(req: func.HttpRequest, products: func.SqlRowList) -> func.HttpResponse:
+    rows = list(map(lambda r: json.loads(r.to_json()), products))
+
+    return func.HttpResponse(
+        json.dumps(rows),
+        status_code=200,
+        mimetype="application/json"
+    )

tests/endtoend/sql_functions/sql_input/function.json

@@ -0,0 +1,27 @@
+{
+  "scriptFile": "__init__.py",
+  "bindings": [
+    {
+      "authLevel": "function",
+      "name": "req",
+      "type": "httpTrigger",
+      "direction": "in",
+      "methods": [
+        "get"
+      ]
+    },
+    {
+      "name": "$return",
+      "type": "http",
+      "direction": "out"
+    },
+    {
+      "name": "products",
+      "type": "sql",
+      "direction": "in",
+      "commandText": "SELECT * FROM Products",
+      "commandType": "Text",
+      "connectionStringSetting": "AzureWebJobsSqlConnectionString"
+    }
+  ]
+}

tests/endtoend/sql_functions/sql_output/__init__.py

@@ -0,0 +1,17 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import json
+import azure.functions as func
+
+
+def main(req: func.HttpRequest, r: func.Out[func.SqlRow]) -> func.HttpResponse:
+    body = json.loads(req.get_body())
+    row = func.SqlRow.from_dict(body)
+    r.set(row)
+
+    return func.HttpResponse(
+        body=req.get_body(),
+        status_code=201,
+        mimetype="application/json"
+    )

tests/endtoend/sql_functions/sql_output/function.json

@@ -0,0 +1,26 @@
+{
+  "scriptFile": "__init__.py",
+  "bindings": [
+    {
+      "authLevel": "function",
+      "name": "req",
+      "type": "httpTrigger",
+      "direction": "in",
+      "methods": [
+        "post"
+      ]
+    },
+    {
+      "name": "$return",
+      "type": "http",
+      "direction": "out"
+    },
+    {
+      "name": "r",
+      "type": "sql",
+      "direction": "out",
+      "commandText": "[dbo].[Products]",
+      "connectionStringSetting": "AzureWebJobsSqlConnectionString"
+    }
+  ]
+}

tests/endtoend/test_sql_functions.py

@@ -0,0 +1,24 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+import json
+
+from azure_functions_worker import testutils
+
+
+class TestSqlFunctions(testutils.WebHostTestCase):
+
+    @classmethod
+    def get_script_dir(cls):
+        return testutils.E2E_TESTS_FOLDER / 'sql_functions'
+
+    @testutils.retryable_test(3, 5)
+    def test_sql_output_and_input(self):
+        row = {"ProductId": 0, "Name": "test", "Cost": 100}
+        r = self.webhost.request('POST', 'sql_output',
+                                 data=json.dumps(row))
+        self.assertEqual(r.status_code, 201)
+
+        r = self.webhost.request('GET', 'sql_input')
+        self.assertEqual(r.status_code, 200)
+        expectedText = "[{\"ProductId\": 0, \"Name\": \"test\", \"Cost\": 100}]"
+        self.assertEqual(r.text, expectedText)