More refactoring and added integration tests for different auth types

Author: NJLangley

.github/workflows/test_azure_devtest_labs_integration.yml

@@ -18,6 +18,7 @@ on:
 jobs:
   # This workflow contains a single job called "build"
   build-and-integration-test:
+    name: Build and run tests on Azure DevTest Labs
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
@@ -53,7 +54,7 @@ jobs:
     #     ls -ltAR ./${{ env.FUNCTIONS_PROJECT_NAME }}/bin/${{ env.BUILD_CONFIGURATION }}
 
     - name: Run Unit Tests
-      run: dotnet test --no-build --configuration ${{ env.BUILD_CONFIGURATION }} --filter TestCategory=UnitTest --output ./output --verbosity normal
+      run: dotnet test --no-build --configuration ${{ env.BUILD_CONFIGURATION }} --filter TestCategory=UnitTest --output ./output --results-directory ./test-results --verbosity normal --logger "trx;LogFileName=unit-test-results.trx"
 
 
     # Login to Azure
@@ -134,8 +135,16 @@ jobs:
 
 
     - name: Run Integration Tests
-      run: dotnet test --no-build --configuration ${{ env.BUILD_CONFIGURATION }} --filter TestCategory=IntegrationTest --output ./output --verbosity normal --settings ${{ env.RUN_SETTINGS_FILENAME }}
+      run: dotnet test --no-build --configuration ${{ env.BUILD_CONFIGURATION }} --filter TestCategory=IntegrationTest --output ./output --results-directory ./test-results --verbosity normal --logger "trx;LogFileName=integration-test-results.trx" --settings ${{ env.RUN_SETTINGS_FILENAME }}
 
 
 
+    - name: Publish Test Report
+      uses: dorny/test-reporter@v1
+      if: success() || failure()    # run this step even if previous step failed
+      with:
+        name: Tests                 # Name of the check run which will be created
+        path: ./test-results/*.trx                 # Path to test results
+        reporter: dotnet-trx        # Format of test results
+
 

DataPipelineTools.Functions.Tests/DataLake/DataLakeFunctions/Integration/DataLakeGetItemsIntegrationTests.cs

@@ -1,16 +1,18 @@
-using System;
-using System.Net;
-using System.Net.Http;
-using System.Threading.Tasks;
-using System.Web;
 using DataPipelineTools.Tests.Common;
 using Microsoft.Extensions.Logging;
 using NUnit.Framework;
+using SqlCollaborative.Azure.DataPipelineTools.Functions.DataLake;
+using System;
+using System.Collections.Generic;
+using System.Net;
+using System.Threading.Tasks;
+using SqlCollaborative.Azure.DataPipelineTools.DataLake.Model;
 
 namespace DataPipelineTools.Functions.Tests.DataLake.DataLakeFunctions.Integration
 {
     [TestFixture]
     [Category(nameof(TestType.IntegrationTest))]
+    [Parallelizable(ParallelScope.Children)]
     public class DataLakeGetItemsIntegrationTests: IntegrationTestBase
     {
         protected override string FunctionUri => $"{FunctionsAppUrl}/api/DataLakeGetItems";
@@ -25,33 +27,60 @@ public void Setup()
         }
 
         [Test]
-        public async Task Test_FunctionIsRunnable()
+        public async Task Test_FunctionIsRunnable_With_FunctionsServicePrincipalAuth()
         {
-            using (var client = new HttpClient())
+            var parameters = new Dictionary<string, string>
             {
-                var queryParams = HttpUtility.ParseQueryString(string.Empty);
-                queryParams["account"] = this.StorageAccountName;
-                queryParams["container"] = this.StorageContainerName;
+                {DataLakeConfigFactory.AccountParam, StorageAccountName},
+                {DataLakeConfigFactory.ContainerParam, StorageContainerName}
+            };
+            var response = await RunQueryFromParameters(parameters);
+            LogContent(response);
+            Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
 
-                if (!IsEmulatorRunning)
-                    queryParams["code"] = this.FunctionsAppKey;
+            // Check response details. Its important to cast the actual or we test against JToken from the dynamic results
+            dynamic results = GetResultsObject(response);
+            Assert.AreEqual(AuthType.FunctionsServicePrincipal, (AuthType)results.authType);
+        }
 
-                var urlBuilder = new UriBuilder(FunctionUri)
-                {
-                    Query = queryParams.ToString() ?? string.Empty
-                };
-                var queryUrl = urlBuilder.ToString();
+        [Test]
+        public async Task Test_FunctionIsRunnable_With_UserServicePrincipalAuthAndPlainTextKey()
+        {
+            var parameters = new Dictionary<string, string>
+            {
+                {DataLakeConfigFactory.AccountParam, StorageAccountName},
+                {DataLakeConfigFactory.ContainerParam, StorageContainerName},
+                {DataLakeConfigFactory.ServicePrincipalClientIdParam, ServicePrincipalName},
+                {DataLakeConfigFactory.ServicePrincipalClientSecretParam, ServicePrincipalSecretKey},
+            };
+            var response = await RunQueryFromParameters(parameters);
+            LogContent(response);
+            Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
 
-                if (!IsRunningOnCIServer)
-                    Logger.LogInformation($"Query URL: {queryUrl}");
-                
-                var result = await client.GetAsync(queryUrl);
-                var content = result.Content.ReadAsStringAsync().Result;
+            // Check response details. Its important to cast the actual or we test against JToken from the dynamic results
+            dynamic results = GetResultsObject(response);
+            Assert.AreEqual(AuthType.UserServicePrincipal, (AuthType)results.authType);
+        }
 
-                Logger.LogInformation($"Content: {content}");
+        [Test]
+        public async Task Test_FunctionIsRunnable_With_UserServicePrincipalAuthAndKeyVaultKeyName()
+        {
+            var parameters = new Dictionary<string, string>
+            {
+                {DataLakeConfigFactory.AccountParam, StorageAccountName},
+                {DataLakeConfigFactory.ContainerParam, StorageContainerName},
+                {DataLakeConfigFactory.ServicePrincipalClientIdParam, ServicePrincipalName},
+                {DataLakeConfigFactory.ServicePrincipalClientSecretParam, ServicePrincipalSecretKeyName},
+                {DataLakeConfigFactory.KeyVaultParam, KeyVaultName}
+            };
+            var response = await RunQueryFromParameters(parameters);
+            LogContent(response);
+            Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);
 
-                Assert.AreEqual(HttpStatusCode.OK, result.StatusCode);
-            }
+            // Check response details. Its important to cast the actual or we test against JToken from the dynamic results
+            dynamic results = GetResultsObject(response);
+            Assert.AreEqual(AuthType.UserServicePrincipal, (AuthType)results.authType);
         }
+
     }
 }

DataPipelineTools.Functions.Tests/DataPipelineTools.Functions.Tests.csproj

@@ -13,8 +13,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Security.KeyVault.Secrets" Version="4.2.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.4" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <PackageReference Include="NUnit" Version="3.13.1" />
     <PackageReference Include="NUnit3TestAdapter" Version="3.17.0" />
     <PackageReference Include="coverlet.collector" Version="3.0.2" />