Refactored testing to add an integration test project for the functions. The intention is to start the local emulator, and call the functions to test actually hitting the Azure infrastructure from the function, using Azure DevTest Labs in the CI/CD process.

NJLangley · NJLangley · commit 756f72eccf9a · 2021-09-16T22:09:35.000+01:00
diff --git a/.github/workflows/test_azure_devtest_labs_integration.yml b/.github/workflows/test_azure_devtest_labs_integration.yml
@@ -52,7 +52,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 }} --output ./output --verbosity normal
+      run: dotnet test --no-build --configuration ${{ env.BUILD_CONFIGURATION }} --filter TestCategory=UnitTest --output ./output --verbosity normal
 
     # - name: Extract 
     #   run: |
diff --git a/.gitignore b/.gitignore
@@ -37,6 +37,7 @@ bld/
 # NUNIT
 *.VisualState.xml
 TestResult.xml
+*.runsettings
 
 # Build Results of an ATL Project
 [Dd]ebugPS/
diff --git a/Azure.DataPipelineTools.sln b/Azure.DataPipelineTools.sln
@@ -12,7 +12,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		LICENSE = LICENSE
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DataPipelineTools.Tests", "DataPipelineTools.Tests\DataPipelineTools.Tests.csproj", "{A2C01394-16F9-4783-9629-2857C400D6E6}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataPipelineTools.Tests", "DataPipelineTools.Tests\DataPipelineTools.Tests.csproj", "{A2C01394-16F9-4783-9629-2857C400D6E6}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DataPipelineTools.Functions.Tests", "DataPipelineTools.Functions.Tests\DataPipelineTools.Functions.Tests.csproj", "{C2448E27-7F4C-4E1E-BAF7-D5344F330073}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DataPipelineTools.Tests.Common", "DataPipelineTools.Tests.Common\DataPipelineTools.Tests.Common.csproj", "{6C304777-0D1A-45A6-A5E0-5849022F319A}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -32,6 +36,14 @@ Global
 		{A2C01394-16F9-4783-9629-2857C400D6E6}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A2C01394-16F9-4783-9629-2857C400D6E6}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{A2C01394-16F9-4783-9629-2857C400D6E6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C2448E27-7F4C-4E1E-BAF7-D5344F330073}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C2448E27-7F4C-4E1E-BAF7-D5344F330073}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C2448E27-7F4C-4E1E-BAF7-D5344F330073}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C2448E27-7F4C-4E1E-BAF7-D5344F330073}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6C304777-0D1A-45A6-A5E0-5849022F319A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6C304777-0D1A-45A6-A5E0-5849022F319A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6C304777-0D1A-45A6-A5E0-5849022F319A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6C304777-0D1A-45A6-A5E0-5849022F319A}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/DataPipelineTools.Functions.Tests/DataLake/DataLakeFunctions/Integration/DataLakeGetItemsIntegrationTests.cs b/DataPipelineTools.Functions.Tests/DataLake/DataLakeFunctions/Integration/DataLakeGetItemsIntegrationTests.cs
@@ -0,0 +1,27 @@
+using DataPipelineTools.Tests.Common;
+using Microsoft.Extensions.Logging;
+using NUnit.Framework;
+
+namespace DataPipelineTools.Functions.Tests.DataLake.DataLakeFunctions.Integration
+{
+    [TestFixture]
+    [Category(nameof(TestType.IntegrationTest))]
+    public class DataLakeGetItemsIntegrationTests: IntegrationTestBase
+    {
+        [SetUp]
+        public void Setup()
+        {
+            
+        }
+
+        [Test]
+        public void Test1()
+        {
+            Logger.LogInformation($"Running tests in { (IsRunningOnCIServer ? "CI": "local") } environment");
+
+
+            Logger.LogError("Integration tests not implemented yet.");
+            Assert.Fail();
+        }
+    }
+}
diff --git a/DataPipelineTools.Functions.Tests/DataLake/DataLakeFunctions/Unit/DataLakeGetItemsTests.cs b/DataPipelineTools.Functions.Tests/DataLake/DataLakeFunctions/Unit/DataLakeGetItemsTests.cs
@@ -0,0 +1,27 @@
+using DataPipelineTools.Tests.Common;
+using Microsoft.Extensions.Logging;
+using NUnit.Framework;
+
+namespace DataPipelineTools.Functions.Tests.DataLake.DataLakeFunctions.Unit
+{
+    [TestFixture]
+    [Category(nameof(TestType.IntegrationTest))]
+    public class DataLakeGetItemsTests: IntegrationTestBase
+    {
+        [SetUp]
+        public void Setup()
+        {
+            
+        }
+
+        [Test]
+        public void Test1()
+        {
+            Logger.LogInformation($"Running tests in { (IsRunningOnCIServer ? "CI": "local") } environment");
+
+
+            Logger.LogError("Integration tests not implemented yet.");
+            Assert.Fail();
+        }
+    }
+}
diff --git a/DataPipelineTools.Functions.Tests/DataPipelineTools.Functions.Tests.csproj b/DataPipelineTools.Functions.Tests/DataPipelineTools.Functions.Tests.csproj
@@ -0,0 +1,27 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+
+    <IsPackable>false</IsPackable>
+
+    <RootNamespace>DataPipelineTools.Functions.Tests</RootNamespace>
+
+    <AssemblyName>DataPipelineTools.Functions.Tests</AssemblyName>
+
+    <PackageId>DataPipelineTools.Functions.Tests</PackageId>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.4" />
+    <PackageReference Include="NUnit" Version="3.13.1" />
+    <PackageReference Include="NUnit3TestAdapter" Version="3.17.0" />
+    <PackageReference Include="coverlet.collector" Version="3.0.2" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\DataPipelineTools.Functions\DataPipelineTools.Functions.csproj" />
+    <ProjectReference Include="..\DataPipelineTools.Tests.Common\DataPipelineTools.Tests.Common.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/DataPipelineTools.Functions.Tests/IntegrationTestBase.cs b/DataPipelineTools.Functions.Tests/IntegrationTestBase.cs
@@ -0,0 +1,35 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+using DataPipelineTools.Tests.Common;
+
+namespace DataPipelineTools.Functions.Tests
+{
+    /// <summary>
+    /// Base class for functions tests. Exposes the 
+    /// </summary>
+    public abstract class IntegrationTestBase : TestBase
+    {
+        protected bool IsRunningOnCIServer
+        {
+            get
+            {
+                // Github Actions
+                if (Environment.GetEnvironmentVariable("CI") != null)
+                    return true;
+
+                //Azure Devops
+                if (Environment.GetEnvironmentVariable("TF_BUILD") != null)
+                    return true;
+
+                return false;
+            }
+        }
+
+        protected void StartLocalFunctionsInstance()
+        {
+            throw new NotImplementedException();
+        }
+
+    }
+}
diff --git a/DataPipelineTools.Functions.Tests/example.runsettings b/DataPipelineTools.Functions.Tests/example.runsettings
@@ -0,0 +1,65 @@
+﻿<?xml version="1.0" encoding="utf-8"?>
+<RunSettings>
+  <!-- Parameters used by tests at run time -->
+  <TestRunParameters>
+    <!-- 
+    **********************************************************************************************************************************************
+    **** Integration Test Params                                                         
+    ****
+    **** The integration tests can't use the Azure Storage emulator as is does not support hierarchical storage accounts (ie ADLS). This means
+    **** to run the integration tests you need a storage account/container with the test file structure added to it, and a Azure Key Vault to
+    **** hold keys for testing connectivity.
+    **** 
+    **** The following credentials are required:
+    ****    - Functions App Service Principal with access to the ADLS container and an Azure Key Vault to retrieve secrets
+    ****    - Service Principal and its secret (both directly and via Key Vault) with access to the ADLS container
+    ****    - SAS token (both directly and via Key Vault) for the ADLS container
+    ****    - Storage Account Access Key (both directly and via Key Vault) for the ADLS container
+    ****
+    **** Note: Secrets in this file are examples from the Azure portal that have been reset since.
+    ****
+    **********************************************************************************************************************************************
+    -->
+    
+    <!-- Set whether to use the local function emulator or not -->
+    <Parameter name="UseFunctionsEmulator" value="true" />
+    
+    <!-- The URL for the functions app. Only required if the emulator flag (UseFunctionsEmulator) above is false. -->
+    <Parameter name="FunctionsAppUrl" value="functionsapp.azurewebsites.net" />
+    <!--Parameter name="FunctionsUrl" value="http://localhost:7071/api/HttpTrigger" /-->
+
+    <!-- The key to authorise calls to the functions app. Only required if the emulator flag (UseFunctionsEmulator) above is false. -->
+    <Parameter name="FunctionsAppKey" value="" />
+
+    <!-- The name of the storage account -->
+    <Parameter name="StorageAccountName" value="testadlsaccount" />
+
+    <!-- The name of the storage container -->
+    <Parameter name="StorageContainerName" value="test" />
+
+    <!-- The name of the key vault -->
+    <Parameter name="KeyVaultName" value="test_key_vault" />
+
+    <!-- The name of the Service Principal -->
+    <Parameter name="ServicePrincipalName" value="testSpn" />
+
+    <!-- The secret/password for the Service Principal -->
+    <Parameter name="ServicePrincipalSecret" value="" />
+
+    <!-- The name of the Azure Key Vault secret holding the secret/password for the Service Principal -->
+    <Parameter name="ServicePrincipalNameKeyName" value="" />
+
+    <!-- The SAS token. This needs to be escaped for XML when you copy it from the Azure portal (it should only be the & sign that is an issue) -->
+    <Parameter name="SasToken" value="sp=r&amp;st=2021-07-01T13:16:28Z&amp;se=2021-07-01T21:16:28Z&amp;spr=https&amp;sv=2020-08-04&amp;sr=c&amp;sig=lUXpUl0u6kV1hrnIyQtIztOWIGfvmO56Nred4qP5dK8%3D" />
+
+    <!-- The name of the Azure Key Vault secret holding the SAS token -->
+    <Parameter name="SasTokenKeyName" value="testSasToken" />
+
+    <!-- The Storage Account Access Key -->
+    <Parameter name="AccessKey" value="nc8LtiyiKbeJawBW1pAJtOi4p6Id6rUqx1LqiY6zUZAplFEu9cuuT9YRlv+McTTqZJKI6RRhJDNTdPJykKk5wA==" />
+
+    <!-- The name of the Azure Key Vault secret holding the Storage Account Access Key -->
+    <Parameter name="AccessKeyKeyName" value="testAccessKey" />
+
+  </TestRunParameters>
+</RunSettings>
diff --git a/DataPipelineTools.Tests.Common/DataPipelineTools.Tests.Common.csproj b/DataPipelineTools.Tests.Common/DataPipelineTools.Tests.Common.csproj
@@ -0,0 +1,26 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="3.1.13" />
+    <PackageReference Include="Moq" Version="4.16.1" />
+    <PackageReference Include="NUnit" Version="3.12.0" />
+    <PackageReference Include="NUnit3TestAdapter" Version="3.16.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
+      <_Parameter1>DataPipelineTools.Tests</_Parameter1>
+    </AssemblyAttribute>
+    <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
+      <_Parameter1>DataPipelineTools.Functions.Tests</_Parameter1>
+    </AssemblyAttribute>
+  </ItemGroup>
+
+</Project>
diff --git a/DataPipelineTools.Tests.Common/MockILoggerExtensions.cs b/DataPipelineTools.Tests.Common/MockILoggerExtensions.cs
@@ -2,7 +2,7 @@
 using Microsoft.Extensions.Logging;
 using Moq;
 
-namespace DataPipelineTools.Tests
+namespace DataPipelineTools.Tests.Common
 {
     // Based once code / ideas here: https://adamstorr.azurewebsites.net/blog/mocking-ilogger-with-moq
     public static class MockILoggerExtensions
diff --git a/DataPipelineTools.Tests.Common/TestBase.cs b/DataPipelineTools.Tests.Common/TestBase.cs
@@ -1,52 +1,59 @@
-﻿using Moq;
-using System;
+﻿using System;
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
 using System.Reflection;
 using Microsoft.Extensions.Logging;
-using SqlCollaborative.Azure.DataPipelineTools.DataLake;
+using Moq;
 
-namespace DataPipelineTools.Tests
+//using SqlCollaborative.Azure.DataPipelineTools.DataLake;
+
+namespace DataPipelineTools.Tests.Common
 {
+    /// <summary>
+    /// Base class for unit tests. Provides a strongly typed mock ILogger<T> instance for use with an IoC container,  and methods for generically loading test data from a CSV file matching the format
+    /// '{TestClass}_Data_{DataType}', where data type is a simple object that represents the CSV row.
+    /// </summary>
+    /// <typeparam name="T">The type of the </typeparam>
     public abstract class TestBase<T>: TestBase
     {
-        protected ILogger<T> Logger => MockLogger.Object;
-        protected readonly Mock<ILogger<T>> MockLogger;
+        protected new ILogger<T> Logger => MockLogger.Object;
+        protected new readonly Mock<ILogger<T>> MockLogger;
 
         internal TestBase()
         {
             // Mock the logger to test where it is called
             MockLogger = new Mock<ILogger<T>>();
+            SetupConsoleLogging(MockLogger);
         }
 
-        protected void SetupConsoleLogging()
+        /// <summary>
+        /// Setup the logger to write to the console, which will also write to the standard output when running unit tests. This needs to be called if the logger is reset.
+        /// </summary>
+        protected new void SetupConsoleLogging()
         {
-            MockLogger.Setup(
-                    l => l.Log(
-                        It.IsAny<LogLevel>(),
-                        It.IsAny<EventId>(),
-                        It.IsAny<It.IsAnyType>(),
-                        It.IsAny<Exception>(),
-                        (Func<It.IsAnyType, Exception, string>)It.IsAny<object>()))
-                .Callback((IInvocation invocation) =>
-                {
-                    var logLevel = (LogLevel)invocation.Arguments[0];
-                    var eventId = (EventId)invocation.Arguments[1];
-                    var state = (IReadOnlyCollection<KeyValuePair<string, object>>)invocation.Arguments[2];
-                    var exception = invocation.Arguments[3] as Exception;
-                    var formatter = invocation.Arguments[4] as Delegate;
-                    var formatterStr = formatter.DynamicInvoke(state, exception);
-                    Console.WriteLine($"{logLevel} - {eventId.Id} - Testing - {formatterStr}");
-                }).Verifiable();
+            SetupConsoleLogging(MockLogger);
         }
     }
 
+    /// <summary>
+    /// Base class for unit tests. Provides a mock ILogger instance and methods for generically loading test data from a CSV file matching the format '{TestClass}_Data_{DataType}', where data type is a simple
+    /// object that represents the CSV row.
+    /// </summary>
     public abstract class TestBase
     {
+        protected ILogger Logger => MockLogger.Object;
+        protected readonly Mock<ILogger> MockLogger;
+
+        internal TestBase()
+        {
+            // Mock the logger to test where it is called
+            MockLogger = new Mock<ILogger>();
+            SetupConsoleLogging(MockLogger);
+        }
+
         protected IEnumerable<T> GetTestData<T>(string delimiter, Func<Dictionary<string, string>, T> conversionFunc)
         {
-            var thisAssembly = Assembly.GetExecutingAssembly();
+            var thisAssembly = this.GetType().Assembly;
             var assemblyPath = thisAssembly.Location;
             var assemblyName = thisAssembly.GetName().Name;
             var nameSpace = GetType().Namespace;
@@ -76,5 +83,34 @@ protected IEnumerable<T> GetTestData<T>(string delimiter, Func<Dictionary<string
                 }
             }
         }
+
+        /// <summary>
+        /// Setup the logger to write to the console, which will also write to the standard output when running unit tests. This needs to be called if the logger is reset.
+        /// </summary>
+        protected void SetupConsoleLogging()
+        {
+            SetupConsoleLogging<ILogger>(MockLogger);
+        }
+
+        protected void SetupConsoleLogging<T>(Mock<T> logger) where T : class, ILogger
+        {
+            logger.Setup(
+                    l => l.Log(
+                        It.IsAny<LogLevel>(),
+                        It.IsAny<EventId>(),
+                        It.IsAny<It.IsAnyType>(),
+                        It.IsAny<Exception>(),
+                        (Func<It.IsAnyType, Exception, string>)It.IsAny<object>()))
+                .Callback((IInvocation invocation) =>
+                {
+                    var logLevel = (LogLevel)invocation.Arguments[0];
+                    var eventId = (EventId)invocation.Arguments[1];
+                    var state = (IReadOnlyCollection<KeyValuePair<string, object>>)invocation.Arguments[2];
+                    var exception = invocation.Arguments[3] as Exception;
+                    var formatter = invocation.Arguments[4] as Delegate;
+                    var formatterStr = formatter.DynamicInvoke(state, exception);
+                    Console.WriteLine($"{logLevel} - {eventId.Id} - Testing - {formatterStr}");
+                }).Verifiable();
+        }
     }
 }
diff --git a/DataPipelineTools.Tests.Common/TestType.cs b/DataPipelineTools.Tests.Common/TestType.cs
@@ -1,4 +1,4 @@
-﻿namespace DataPipelineTools.Tests
+﻿namespace DataPipelineTools.Tests.Common
 {
     public enum TestType
     {
diff --git a/DataPipelineTools.Tests/DataLake/DataLakeServiceTests/CheckPathAsyncTests.cs b/DataPipelineTools.Tests/DataLake/DataLakeServiceTests/CheckPathAsyncTests.cs
diff --git a/DataPipelineTools.Tests/DataLake/DataLakeServiceTests/GetItemsAsyncTests.cs b/DataPipelineTools.Tests/DataLake/DataLakeServiceTests/GetItemsAsyncTests.cs
diff --git a/DataPipelineTools.Tests/DataLake/DataLakeTestBase.cs b/DataPipelineTools.Tests/DataLake/DataLakeTestBase.cs
diff --git a/DataPipelineTools.Tests/DataLake/Model/DataLakeConfigTests.cs b/DataPipelineTools.Tests/DataLake/Model/DataLakeConfigTests.cs
diff --git a/DataPipelineTools.Tests/DataPipelineTools.Tests.csproj b/DataPipelineTools.Tests/DataPipelineTools.Tests.csproj

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`using Microsoft.Extensions.Logging;`
`3`	`3`	`using Moq;`
`4`	`4`
`5`		`-namespace DataPipelineTools.Tests`
	`5`	`+namespace DataPipelineTools.Tests.Common`
`6`	`6`	`{`
`7`	`7`	`// Based once code / ideas here: https://adamstorr.azurewebsites.net/blog/mocking-ilogger-with-moq`
`8`	`8`	`public static class MockILoggerExtensions`