Update Akka.Hosting extension methods to support DefaultAzureCredenti…

…al (#237) * Update Akka.Hosting extension methods to support DefaultAzureCredential (cherry picked from commit b37c9db) * Make setup classes sealed * Fix missing HOCON settings * Revert const back to public Co-authored-by: Aaron Stannard <[email protected]>
petabridge · Aug 29, 2022 · cdf3a41 · cdf3a41
1 parent 27e7121
commit cdf3a41
Show file tree

Hide file tree

Showing 7 changed files with 423 additions and 86 deletions.
diff --git a/src/Akka.Persistence.Azure.Hosting/AzurePersistenceExtensions.cs b/src/Akka.Persistence.Azure.Hosting/AzurePersistenceExtensions.cs
diff --git a/src/Akka.Persistence.Azure.Tests/Hosting/AzurePersistenceHostingSanityCheck.cs b/src/Akka.Persistence.Azure.Tests/Hosting/AzurePersistenceHostingSanityCheck.cs
@@ -5,6 +5,7 @@
 using Akka.Event;
 using Akka.Hosting;
 using Akka.Persistence.Azure.Hosting;
+using Akka.Persistence.Azure.Tests.Helper;
 using Akka.TestKit.Xunit2.Internals;
 using FluentAssertions;
 using Microsoft.Extensions.DependencyInjection;
@@ -20,6 +21,7 @@ public class AzurePersistenceHostingSanityCheck
         public static async Task<IHost> StartHost(Action<AkkaConfigurationBuilder> testSetup)
         {
             var conn = Environment.GetEnvironmentVariable("AZURE_CONNECTION_STR") ?? "UseDevelopmentStorage=true";
+            await DbUtils.CleanupCloudTable(conn);
             var host = new HostBuilder()
                 .ConfigureServices(collection =>
                 {

diff --git a/src/Akka.Persistence.Azure/Journal/AzureTableStorageJournalSettings.cs b/src/Akka.Persistence.Azure/Journal/AzureTableStorageJournalSettings.cs
@@ -116,19 +116,19 @@ public AzureTableStorageJournalSettings(
         public bool AutoInitialize { get; }
 
         /// <summary>
-        /// A <see cref="Uri"/> referencing the blob service.
-        /// This is likely to be similar to "https://{account_name}.table.core.windows.net".
+        ///     A <see cref="Uri"/> referencing the Azure Table Storage service.
+        ///     This is likely to be similar to "https://{account_name}.table.core.windows.net".
         /// </summary>
         public Uri ServiceUri { get; }
 
         /// <summary>
-        /// The <see cref="DefaultAzureCredential"/> used to sign API requests.
+        ///     The <see cref="DefaultAzureCredential"/> used to sign API requests.
         /// </summary>
         public DefaultAzureCredential DefaultAzureCredential { get; }
 
         /// <summary>
-        /// Optional client options that define the transport pipeline policies for authentication,
-        /// retries, etc., that are applied to every request.
+        ///     Optional client options that define the transport pipeline policies for authentication,
+        ///     retries, etc., that are applied to every request.
         /// </summary>
         public TableClientOptions TableClientOptions { get; }
 

diff --git a/src/Akka.Persistence.Azure/Journal/AzureTableStorageJournalSetup.cs b/src/Akka.Persistence.Azure/Journal/AzureTableStorageJournalSetup.cs
@@ -11,7 +11,7 @@
 
 namespace Akka.Persistence.Azure.Journal
 {
-    public class AzureTableStorageJournalSetup : Setup
+    public sealed class AzureTableStorageJournalSetup : Setup
     {
         /// <summary>
         ///     The connection string for connecting to Windows Azure table storage.
@@ -51,19 +51,19 @@ public class AzureTableStorageJournalSetup : Setup
         public bool? AutoInitialize { get; set; }
 
         /// <summary>
-        /// A <see cref="Uri"/> referencing the blob service.
-        /// This is likely to be similar to "https://{account_name}.table.core.windows.net".
+        ///     A <see cref="Uri"/> referencing the Azure Storage Table service.
+        ///     This is likely to be similar to "https://{account_name}.table.core.windows.net".
         /// </summary>
         public Uri ServiceUri { get; set; }
 
         /// <summary>
-        /// The <see cref="DefaultAzureCredential"/> used to sign API requests.
+        ///     The <see cref="DefaultAzureCredential"/> used to sign API requests.
         /// </summary>
         public DefaultAzureCredential DefaultAzureCredential { get; set; }
 
         /// <summary>
-        /// Optional client options that define the transport pipeline policies for authentication,
-        /// retries, etc., that are applied to every request.
+        ///     Optional client options that define the transport pipeline policies for authentication,
+        ///     retries, etc., that are applied to every request.
         /// </summary>
         public TableClientOptions TableClientOptions { get; set; }
 

diff --git a/src/Akka.Persistence.Azure/Query/AzureTableStorageReadJournalSetup.cs b/src/Akka.Persistence.Azure/Query/AzureTableStorageReadJournalSetup.cs
@@ -9,7 +9,7 @@
 
 namespace Akka.Persistence.Azure.Query
 {
-    public class AzureTableStorageReadJournalSetup: Setup
+    public sealed class AzureTableStorageReadJournalSetup: Setup
     {
         /// <summary>
         /// How many events to fetch in one query (replay) and keep buffered until they

diff --git a/src/Akka.Persistence.Azure/Snapshot/AzureBlobSnapshotSetup.cs b/src/Akka.Persistence.Azure/Snapshot/AzureBlobSnapshotSetup.cs
@@ -13,24 +13,24 @@
 namespace Akka.Persistence.Azure.Snapshot
 {
     /// <summary>
-    /// Setup class for <see cref="AzureBlobSnapshotStore"/>.
-    /// Any populated properties will override its respective HOCON setting.
+    ///     Setup class for <see cref="AzureBlobSnapshotStore"/>.
+    ///     Any populated properties will override its respective HOCON setting.
     /// </summary>
-    public class AzureBlobSnapshotSetup : Setup
+    public sealed class AzureBlobSnapshotSetup : Setup
     {
         /// <summary>
-        /// Create a new <see cref="AzureBlobSnapshotSetup"/>
+        ///     Create a new <see cref="AzureBlobSnapshotSetup"/>
         /// </summary>
         /// <param name="serviceUri">
-        /// A <see cref="Uri"/> referencing the blob service.
-        /// This is likely to be similar to "https://{account_name}.blob.core.windows.net".
+        ///     A <see cref="Uri"/> referencing the blob service.
+        ///     This is likely to be similar to "https://{account_name}.blob.core.windows.net".
         /// </param>
         /// <param name="defaultAzureCredential">
-        /// The <see cref="DefaultAzureCredential"/> used to sign requests.
+        ///     The <see cref="DefaultAzureCredential"/> used to sign requests.
         /// </param>
         /// <param name="blobClientOptions">
-        /// Optional client options that define the transport pipeline policies for authentication,
-        /// retries, etc., that are applied to every request.
+        ///     Optional client options that define the transport pipeline policies for authentication,
+        ///     retries, etc., that are applied to every request.
         /// </param>
         /// <returns>A new <see cref="AzureBlobSnapshotSetup"/> instance</returns>
         public static AzureBlobSnapshotSetup Create(
@@ -87,19 +87,19 @@ public static AzureBlobSnapshotSetup Create(
         public PublicAccessType? ContainerPublicAccessType { get; set; }
 
         /// <summary>
-        /// A <see cref="Uri"/> referencing the blob service.
-        /// This is likely to be similar to "https://{account_name}.blob.core.windows.net".
+        ///     A <see cref="Uri"/> referencing the blob service.
+        ///     This is likely to be similar to "https://{account_name}.blob.core.windows.net".
         /// </summary>
         public Uri ServiceUri { get; set; }
 
         /// <summary>
-        /// The <see cref="DefaultAzureCredential"/> used to sign API requests.
+        ///     The <see cref="DefaultAzureCredential"/> used to sign API requests.
         /// </summary>
         public DefaultAzureCredential DefaultAzureCredential { get; set; }
 
         /// <summary>
-        /// Optional client options that define the transport pipeline policies for authentication,
-        /// retries, etc., that are applied to every request.
+        ///     Optional client options that define the transport pipeline policies for authentication,
+        ///     retries, etc., that are applied to every request.
         /// </summary>
         public BlobClientOptions BlobClientOptions { get; set; }
 

diff --git a/src/Akka.Persistence.Azure/Snapshot/AzureBlobSnapshotStoreSettings.cs b/src/Akka.Persistence.Azure/Snapshot/AzureBlobSnapshotStoreSettings.cs
@@ -129,19 +129,19 @@ public AzureBlobSnapshotStoreSettings(
         public PublicAccessType ContainerPublicAccessType { get; }
 
         /// <summary>
-        /// A <see cref="Uri"/> referencing the blob service.
-        /// This is likely to be similar to "https://{account_name}.blob.core.windows.net".
+        ///     A <see cref="Uri"/> referencing the blob service.
+        ///     This is likely to be similar to "https://{account_name}.blob.core.windows.net".
         /// </summary>
         public Uri ServiceUri { get; }
 
         /// <summary>
-        /// The <see cref="DefaultAzureCredential"/> used to sign API requests.
+        ///     The <see cref="DefaultAzureCredential"/> used to sign API requests.
         /// </summary>
         public DefaultAzureCredential DefaultAzureCredential { get; }
 
         /// <summary>
-        /// Optional client options that define the transport pipeline policies for authentication,
-        /// retries, etc., that are applied to every request.
+        ///     Optional client options that define the transport pipeline policies for authentication,
+        ///     retries, etc., that are applied to every request.
         /// </summary>
         public BlobClientOptions BlobClientOptions { get; }