feat: IntegrationTestConfiguration - supply-default-azure-credentials (…

…#320)
Energinet-DataHub · May 24, 2024 · 6c18eaf · 6c18eaf
1 parent 9ce6557
commit 6c18eaf
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 15 deletions.
diff --git a/source/TestCommon/documents/release-notes/release-notes.md b/source/TestCommon/documents/release-notes/release-notes.md
@@ -1,5 +1,9 @@
 # TestCommon Release notes
 
+## Version 5.2.1
+
+- Extended `IntegrationTestConfiguration` with the option to pass in `DefaultAzureCredential` from the outside.
+
 ## Version 5.2.0
 
 - Changes to `SqlServerDatabaseManager`:

diff --git a/...nctionApp.TestCommon.Tests/Integration/Configuration/IntegrationTestConfigurationTests.cs b/...nctionApp.TestCommon.Tests/Integration/Configuration/IntegrationTestConfigurationTests.cs
@@ -19,14 +19,9 @@
 
 namespace Energinet.DataHub.Core.FunctionApp.TestCommon.Tests.Integration.Configuration;
 
-public class IntegrationTestConfigurationTests : IClassFixture<IntegrationTestConfiguration>
+public class IntegrationTestConfigurationTests
 {
-    public IntegrationTestConfigurationTests(IntegrationTestConfiguration sut)
-    {
-        Sut = sut;
-    }
-
-    public IntegrationTestConfiguration Sut { get; }
+    private IntegrationTestConfiguration Sut { get; } = new();
 
     [Fact]
     public void Given_IdentityHasAccess_When_DatabricksSettings_Then_EachPropertyHasValue()

diff --git a/...TestCommon/source/FunctionApp.TestCommon/Configuration/IConfigurationBuilderExtensions.cs b/...TestCommon/source/FunctionApp.TestCommon/Configuration/IConfigurationBuilderExtensions.cs
@@ -28,14 +28,15 @@ public static class ConfigurationBuilderExtensions
     /// </summary>
     /// <param name="builder">The configuration builder.</param>
     /// <param name="keyVaultUrl">KeyVault URL eg. https://myexamplekeyvault.vault.azure.net/</param>
-    public static IConfigurationBuilder AddAuthenticatedAzureKeyVault(this IConfigurationBuilder builder, string keyVaultUrl)
+    /// <param name="defaultAzureCredential"><see cref="DefaultAzureCredential"/> used for key vault authentication, if not supplied, a new <see cref="DefaultAzureCredential"/> will be created and used</param>
+    public static IConfigurationBuilder AddAuthenticatedAzureKeyVault(this IConfigurationBuilder builder, string keyVaultUrl, DefaultAzureCredential? defaultAzureCredential = null)
     {
         if (string.IsNullOrEmpty(keyVaultUrl))
         {
             throw new ArgumentException("Value cannot be null or empty.", nameof(keyVaultUrl));
         }
 
-        var credential = new DefaultAzureCredential();
+        var credential = defaultAzureCredential ?? new DefaultAzureCredential();
         builder.AddAzureKeyVault(new Uri(keyVaultUrl), credential);
 
         return builder;

diff --git a/...ce/TestCommon/source/FunctionApp.TestCommon/Configuration/IntegrationTestConfiguration.cs b/...ce/TestCommon/source/FunctionApp.TestCommon/Configuration/IntegrationTestConfiguration.cs
@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+using Azure.Identity;
 using Microsoft.Extensions.Configuration;
 
 namespace Energinet.DataHub.Core.FunctionApp.TestCommon.Configuration;
@@ -27,9 +28,9 @@ namespace Energinet.DataHub.Core.FunctionApp.TestCommon.Configuration;
 /// </summary>
 public class IntegrationTestConfiguration
 {
-    public IntegrationTestConfiguration()
+    public IntegrationTestConfiguration(DefaultAzureCredential? defaultAzureCredential = null)
     {
-        Configuration = BuildKeyVaultConfigurationRoot();
+        Configuration = BuildKeyVaultConfigurationRoot(defaultAzureCredential);
 
 #pragma warning disable CS0618 // Type or member is obsolete
         ApplicationInsightsInstrumentationKey = Configuration.GetValue("AZURE-APPINSIGHTS-INSTRUMENTATIONKEY");
@@ -90,7 +91,7 @@ public IntegrationTestConfiguration()
     /// </summary>
     public DatabricksSettings DatabricksSettings { get; }
 
-    private static IConfigurationRoot BuildKeyVaultConfigurationRoot()
+    private static IConfigurationRoot BuildKeyVaultConfigurationRoot(DefaultAzureCredential? defaultAzureCredential)
     {
         var integrationtestConfiguration = new ConfigurationBuilder()
             .AddJsonFile("integrationtest.local.settings.json", optional: true)
@@ -101,7 +102,7 @@ private static IConfigurationRoot BuildKeyVaultConfigurationRoot()
         GuardKeyVaultUrl(keyVaultUrl);
 
         return new ConfigurationBuilder()
-            .AddAuthenticatedAzureKeyVault(keyVaultUrl)
+            .AddAuthenticatedAzureKeyVault(keyVaultUrl, defaultAzureCredential)
             .Build();
     }
 

diff --git a/source/TestCommon/source/FunctionApp.TestCommon/FunctionApp.TestCommon.csproj b/source/TestCommon/source/FunctionApp.TestCommon/FunctionApp.TestCommon.csproj
@@ -31,7 +31,7 @@ limitations under the License.
 
   <PropertyGroup>
     <PackageId>Energinet.DataHub.Core.FunctionApp.TestCommon</PackageId>
-    <PackageVersion>5.2.0$(VersionSuffix)</PackageVersion>
+    <PackageVersion>5.2.1$(VersionSuffix)</PackageVersion>
     <Title>FunctionApp TestCommon library</Title>
     <Company>Energinet-DataHub</Company>
     <Authors>Energinet-DataHub</Authors>

diff --git a/source/TestCommon/source/TestCommon/TestCommon.csproj b/source/TestCommon/source/TestCommon/TestCommon.csproj
@@ -31,7 +31,7 @@ limitations under the License.
 
   <PropertyGroup>
     <PackageId>Energinet.DataHub.Core.TestCommon</PackageId>
-    <PackageVersion>5.2.0$(VersionSuffix)</PackageVersion>
+    <PackageVersion>5.2.1$(VersionSuffix)</PackageVersion>
     <Title>TestCommon library</Title>
     <Company>Energinet-DataHub</Company>
     <Authors>Energinet-DataHub</Authors>