Tests | Move fixtures to common project (#3402)

Author: edwardneal

src/Microsoft.Data.SqlClient/tests/Common/Common.csproj

@@ -51,4 +51,10 @@
     </ContentWithTargetPath>
   </ItemGroup>
 
+  <!-- Fixture-specific References -->
+  <ItemGroup>
+    <PackageReference Include="Azure.Identity" />
+    <PackageReference Include="Azure.Security.KeyVault.Keys" />
+  </ItemGroup>
+
 </Project>

src/Microsoft.Data.SqlClient/tests/Common/Fixtures/AzureKeyVaultKeyFixtureBase.cs

@@ -0,0 +1,70 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.using System;
+
+using System;
+using System.Collections.Generic;
+using Azure.Core;
+using Azure.Security.KeyVault.Keys;
+
+namespace Microsoft.Data.SqlClient.Tests.Common.Fixtures;
+
+/// <summary>
+/// Provides a base class for managing Azure Key Vault keys in test fixtures.
+/// </summary>
+/// <remarks>
+/// This class simplifies the creation and cleanup of RSA keys in an Azure Key Vault during testing
+/// scenarios. It ensures that any keys created during the fixture's lifetime are properly deleted when the fixture is
+/// disposed.
+/// </remarks>
+public abstract class AzureKeyVaultKeyFixtureBase : IDisposable
+{
+    private readonly KeyClient _keyClient;
+    private readonly Random _randomGenerator;
+
+    private readonly List<KeyVaultKey> _createdKeys = new List<KeyVaultKey>();
+
+    protected AzureKeyVaultKeyFixtureBase(Uri keyVaultUri, TokenCredential keyVaultToken)
+    {
+        _keyClient = new KeyClient(keyVaultUri, keyVaultToken);
+        _randomGenerator = new Random();
+    }
+
+    protected Uri CreateKey(string name, int keySize)
+    {
+        CreateRsaKeyOptions createOptions = new CreateRsaKeyOptions(GenerateUniqueName(name)) { KeySize = keySize };
+        KeyVaultKey created = _keyClient.CreateRsaKey(createOptions);
+
+        _createdKeys.Add(created);
+        return created.Id;
+    }
+
+    private string GenerateUniqueName(string name)
+    {
+        byte[] rndBytes = new byte[16];
+
+        _randomGenerator.NextBytes(rndBytes);
+        return name + "-" + BitConverter.ToString(rndBytes);
+    }
+
+    public void Dispose()
+    {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
+
+    protected virtual void Dispose(bool disposing)
+    {
+        foreach (KeyVaultKey key in _createdKeys)
+        {
+            try
+            {
+                _keyClient.StartDeleteKey(key.Name).WaitForCompletion();
+            }
+            catch (Exception)
+            {
+                continue;
+            }
+        }
+    }
+}