Use [ordered] in PowerShell identity tests (#581)

* test ordered on the PS samples

* update case sensitive samples

* add readme known issue

Author: VasuBhog

.vscode/launch.json

@@ -18,7 +18,10 @@
             "name": "Attach to Function Host",
             "type": "coreclr",
             "request": "attach",
-            "processName": "func.exe"
+            "Windows": {
+                "processName": "func.exe"
+            },
+            "processName": "func"
         }
     ]
 }

README.md

@@ -50,6 +50,7 @@ Databases on SQL Server, Azure SQL Database, or Azure SQL Managed Instance which
     * Have multiple functions, with dependent functions being triggered by the initial functions (through a trigger binding or other such method)
     * Use [dynamic (imperative)](https://learn.microsoft.com/azure/azure-functions/functions-bindings-expressions-patterns#binding-at-runtime) bindings (.NET only)
     * Use [IAsyncCollector](https://learn.microsoft.com/azure/azure-functions/functions-dotnet-class-library?tabs=v2%2Ccmd#writing-multiple-output-values) and call `FlushAsync` in the order desired (.NET only)
+- For PowerShell Functions that use hashtables must use the `[ordered]@` for the request query or request body assertion in order to upsert the data to the SQL table properly. An example can be found [here](https://github.com/Azure/azure-functions-sql-extension/blob/main/samples/samples-powershell/AddProductsWithIdentityColumnArray/run.ps1).
 
 ### Input Bindings
 - Input bindings against tables with columns of data types 'DATETIME', 'DATETIME2', or 'SMALLDATETIME' will assume that the values are in UTC format.

samples/samples-powershell/AddProductWithIdentityColumn/run.ps1

@@ -7,7 +7,7 @@ param($Request, $TriggerMetadata)
 Write-Host "PowerShell function with SQL Output Binding processed a request."
 
 # Update req_query with the query of the request
-$req_query = @{
+$req_query = [ordered]@{
     Name=$Request.QUERY.name;
     Cost=$Request.QUERY.cost;
 };

samples/samples-powershell/AddProductWithIdentityColumnIncluded/run.ps1

@@ -7,7 +7,7 @@ param($Request, $TriggerMetadata)
 Write-Host "PowerShell function with SQL Output Binding processed a request."
 
 # Update req_query with the body of the request
-$req_query = @{
+$req_query = [ordered]@{
     ProductId= if($Request.QUERY.productId) { [int]$Request.QUERY.productId } else { $null };
     Name=$Request.QUERY.name;
     Cost=[int]$Request.QUERY.cost;

samples/samples-powershell/AddProductWithMultiplePrimaryColumnsAndIdentity/run.ps1

@@ -7,10 +7,10 @@ param($Request, $TriggerMetadata)
 Write-Host "PowerShell function with SQL Output Binding processed a request."
 
 # Update req_query with the body of the request
-$req_query = @{
-    externalId=$Request.QUERY.externalId;
-    name=$Request.QUERY.name;
-    cost=$Request.QUERY.cost;
+$req_query = [ordered]@{
+    ExternalId=$Request.QUERY.externalId;
+    Name=$Request.QUERY.name;
+    Cost=$Request.QUERY.cost;
 };
 
 # Assign the value we want to pass to the SQL Output binding. 

samples/samples-powershell/AddProductsWithIdentityColumnArray/run.ps1

@@ -9,12 +9,12 @@ Write-Host "PowerShell function with SQL Output Binding processed a request."
 # Update req_body with the body of the request
 # Note that this expects the body to be a JSON object or array of objects 
 # which have a property matching each of the columns in the table to upsert to.
-$req_body = @(@{
-    name="Cup";
-    cost=2;
-}, @{
-    name="Glasses";
-    cost=12;
+$req_body = @([ordered]@{
+    Name="Cup";
+    Cost=2;
+}, [ordered]@{
+    Name="Glasses";
+    Cost=12;
 });
 
 # Assign the value we want to pass to the SQL Output binding. 

test/Integration/SqlOutputBindingIntegrationTests.cs

@@ -220,9 +220,6 @@ public void AddProductNoPartialUpsertTest(SupportedLanguages lang)
         /// </summary>
         [Theory]
         [SqlInlineData()]
-        // Currently PowerShell gives an error due to the deserialization of the object
-        // Issue link: https://github.com/Azure/azure-functions-sql-extension/issues/448
-        [UnsupportedLanguages(SupportedLanguages.PowerShell)]
         public void AddProductWithIdentity(SupportedLanguages lang)
         {
             this.StartFunctionHost(nameof(AddProductWithIdentityColumn), lang);
@@ -243,9 +240,6 @@ public void AddProductWithIdentity(SupportedLanguages lang)
         /// </summary>
         [Theory]
         [SqlInlineData()]
-        // Currently PowerShell gives an error due to the deserialization of the object
-        // Issue link: https://github.com/Azure/azure-functions-sql-extension/issues/448
-        [UnsupportedLanguages(SupportedLanguages.PowerShell)]
         public void AddProductsWithIdentityColumnArray(SupportedLanguages lang)
         {
             this.StartFunctionHost(nameof(AddProductsWithIdentityColumnArray), lang);
@@ -261,9 +255,6 @@ public void AddProductsWithIdentityColumnArray(SupportedLanguages lang)
         /// </summary>
         [Theory]
         [SqlInlineData()]
-        // Currently PowerShell gives an error due to the deserialization of the object
-        // Issue link: https://github.com/Azure/azure-functions-sql-extension/issues/448
-        [UnsupportedLanguages(SupportedLanguages.PowerShell)]
         public void AddProductWithIdentity_MultiplePrimaryColumns(SupportedLanguages lang)
         {
             this.StartFunctionHost(nameof(AddProductWithMultiplePrimaryColumnsAndIdentity), lang);
@@ -343,9 +334,6 @@ public void AddProductWithIdentity_NoIdentityColumn(SupportedLanguages lang)
         /// </summary>
         [Theory]
         [SqlInlineData()]
-        // Currently PowerShell gives an error due to the deserialization of the object
-        // Issue link: https://github.com/Azure/azure-functions-sql-extension/issues/448
-        [UnsupportedLanguages(SupportedLanguages.PowerShell)]
         public void AddProductWithIdentity_MissingPrimaryColumn(SupportedLanguages lang)
         {
             this.StartFunctionHost(nameof(AddProductWithMultiplePrimaryColumnsAndIdentity), lang);

test/README.md

@@ -118,9 +118,9 @@ To debug either any core extension code (anything under the `src` folder) OR fun
 To do this and be able to set breakpoints before the test runs you will need to follow these steps :
 
 1. Go to [IntegrationTestBase.cs](./Integration/IntegrationTestBase.cs) and in `StartFunctionHost` add a `return;` on the first line - this is to skip having the test start up the function host itself (since you'll be doing it manually)
-2. `cd` to the directory containing the functions to run - this will be in the `test/bin/Debug/net6/SqlExtensionSamples/<LANG>` folder (e.g. `test/bin/Debug/net6/SqlExtensionSamples/samples-csharp`)
+2. `cd` to the directory containing the functions to run - this will be in the `test/bin/Debug/net6/SqlExtensionSamples/<LANG>` folder (e.g. `test/bin/Debug/net6/SqlExtensionSamples/CSharp`)
 3. Run `func host start --functions <FUNCTION_NAME>` - replacing `<FUNCTION_NAME>` with the name of the function you want to debug (e.g. `func host start --functions AddProduct`)
-4. Attach to the func.exe process
+4. Attach to the Function Host process
    * Visual Studio : Use `Attach to Process...`.
    * VS Code you can use `Attach to Function Host` debug target (at the root level of the project)