Use Marain.TenantManagement v3 (#404)

Author: idg10

.gitignore

@@ -337,4 +337,6 @@ coverage.cobertura.xml
 /.vscode
 
 appsettings.json
-*.feature.cs
+*.feature.cs
+*.ncrunchproject
+*.ncrunchsolution

GitVersion.yml

@@ -20,5 +20,5 @@ branches:
     - feature
     - support
     - hotfix
-next-version: "2.0"
+next-version: "3.0"
 

Solutions/Marain.Operations.Abstractions/Marain.Operations.Abstractions.csproj

@@ -20,7 +20,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Menes.Abstractions" Version="3.1.4" />
+    <PackageReference Include="Menes.Abstractions" Version="4.0.0" />
   </ItemGroup>
 
 </Project>

Solutions/Marain.Operations.Abstractions/packages.lock.json

@@ -45,6 +45,8 @@ public static void PerFeatureContainerSetup(FeatureContext featureContext)
                     services.AddJsonNetDateTimeOffsetToIso8601AndUnixTimeConverter();
                     services.AddSingleton<JsonConverter>(new StringEnumConverter(new CamelCaseNamingStrategy()));
 
+                    services.AddAzureBlobStorageClientSourceFromDynamicConfiguration();
+
                     // Tenancy service client.
                     TenancyClientOptions tenancyConfiguration = config.GetSection("TenancyClient").Get<TenancyClientOptions>();
 
@@ -64,7 +66,7 @@ public static void PerFeatureContainerSetup(FeatureContext featureContext)
                     services.AddMicrosoftRestAdapterForServiceIdentityAccessTokenSource();
 
                     // Marain tenancy management, required to create transient client/service tenants.
-                    services.AddMarainTenantManagement();
+                    services.AddMarainTenantManagementForBlobStorage();
                 });
         }
 

Solutions/Marain.Operations.Api.Specs/Bindings/OperationsContainerBindings.cs

@@ -4,27 +4,19 @@
 
 namespace Marain.Operations.Api.Specs.Bindings
 {
-    using System;
     using System.Threading.Tasks;
 
-    using Azure.Storage.Blobs;
+    using BoDi;
 
-    using Corvus.Azure.Cosmos.Tenancy;
-    using Corvus.Azure.Storage.Tenancy;
-    using Corvus.Storage.Azure.BlobStorage.Tenancy;
+    using Corvus.Storage.Azure.BlobStorage;
     using Corvus.Tenancy;
     using Corvus.Testing.AzureFunctions;
     using Corvus.Testing.AzureFunctions.SpecFlow;
     using Corvus.Testing.SpecFlow;
 
-    using Marain.Operations.Storage.Blob;
-    using Marain.TenantManagement.EnrollmentConfiguration;
+    using Marain.Operations.Specs;
     using Marain.TenantManagement.Testing;
 
-    using Microsoft.Extensions.Configuration;
-    using Microsoft.Extensions.DependencyInjection;
-    using Microsoft.Extensions.Logging;
-
     using TechTalk.SpecFlow;
 
     /// <summary>
@@ -36,85 +28,36 @@ public static class TransientTenantBindings
         public const string TransientServiceTenantIdFeatureContextKey = "TransientServiceTenantId";
 
         /// <summary>
-        /// Creates a new <see cref="ITenant"/> for the current feature, adding a test <see cref="CosmosConfiguration"/>
+        /// Creates a new <see cref="ITenant"/> for the current feature, adding a test <see cref="BlobContainerConfiguration"/>
         /// to the tenant data.
         /// </summary>
         /// <param name="featureContext">The current <see cref="FeatureContext"/>.</param>
+        /// <param name="objectContainer">The SpecFlow DI container.</param>
         /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
         /// <remarks>
-        /// The newly created tenant is added to the <see cref="FeatureContext"/>. Access it via the helper methods
-        /// <see cref="GetTransientTenant(FeatureContext)"/> or <see cref="GetTransientTenantId(FeatureContext)"/>.
+        /// The newly created client and service tenants are available to tests via DI through the
+        /// <see cref="OperationsServiceTestTenants"/> type.
         /// </remarks>
         [BeforeFeature(Order = BindingSequence.TransientTenantSetup)]
-        public static async Task SetupTransientTenant(FeatureContext featureContext)
+        public static async Task SetupTransientTenant(FeatureContext featureContext, IObjectContainer objectContainer)
         {
-            ITenantProvider tenantProvider = ContainerBindings.GetServiceProvider(featureContext).GetRequiredService<ITenantProvider>();
-            var transientTenantManager = TransientTenantManager.GetInstance(featureContext);
-            await transientTenantManager.EnsureInitialised().ConfigureAwait(false);
-
-            // Create a transient service tenant for testing purposes.
-            ITenant transientServiceTenant = await transientTenantManager.CreateTransientServiceTenantFromEmbeddedResourceAsync(
-                typeof(TransientTenantBindings).Assembly,
-                "Marain.Operations.Api.Specs.ServiceManifests.OperationsServiceManifest.jsonc").ConfigureAwait(false);
+            OperationsServiceTestTenants transientTenants = await OperationsTestTenantSetup.CreateTestTenantAndEnrollInClaimsAsync(featureContext);
 
             // Now update the service Id in our configuration and in the function configuration
-            UpdateServiceConfigurationWithTransientTenantId(featureContext, transientServiceTenant);
-
-            // Now we need to construct a transient client tenant for the test, and enroll it in the new
-            // transient service.
-            ITenant transientClientTenant = await transientTenantManager.CreateTransientClientTenantAsync().ConfigureAwait(false);
+            UpdateServiceConfigurationWithTransientTenantId(featureContext, transientTenants.TransientServiceTenant);
 
-            await transientTenantManager.AddEnrollmentAsync(
-                transientClientTenant.Id,
-                transientServiceTenant.Id,
-                GetOperationsConfig(featureContext)).ConfigureAwait(false);
-
-            // TODO: Temporary hack to work around the fact that the transient tenant manager no longer holds the latest
-            // version of the tenants it's tracking; see https://github.com/marain-dotnet/Marain.TenantManagement/issues/28
-            transientTenantManager.PrimaryTransientClient = await tenantProvider.GetTenantAsync(transientClientTenant.Id).ConfigureAwait(false);
+            objectContainer.RegisterInstanceAs(transientTenants);
         }
 
         [AfterFeature]
         public static async Task TearDownTenants(FeatureContext featureContext)
         {
-            var tenantManager = TransientTenantManager.GetInstance(featureContext);
-
-            await featureContext.RunAndStoreExceptionsAsync(async () =>
-            {
-                IBlobContainerSourceWithTenantLegacyTransition cloudBlobContainerFactory = ContainerBindings.GetServiceProvider(featureContext).GetRequiredService<IBlobContainerSourceWithTenantLegacyTransition>();
-                BlobContainerClient testContainer = await cloudBlobContainerFactory.GetBlobContainerClientFromTenantAsync(
-                    tenantManager.PrimaryTransientClient,
-                    OperationsRepository.OperationsV2ConfigKey,
-                    OperationsRepository.OperationsV3ConfigKey).ConfigureAwait(false);
-                await testContainer.DeleteIfExistsAsync().ConfigureAwait(false);
-            }).ConfigureAwait(false);
+            await OperationsTestStorageSetup.TearDownBlobContainersAsync(featureContext);
 
+            var tenantManager = TransientTenantManager.GetInstance(featureContext);
             await featureContext.RunAndStoreExceptionsAsync(() => tenantManager.CleanupAsync()).ConfigureAwait(false);
         }
 
-        /// <summary>
-        /// Retrieves the transient tenant created for the current feature from the supplied <see cref="FeatureContext"/>,
-        /// or null if there is none.
-        /// </summary>
-        /// <param name="context">The current <see cref="FeatureContext"/>.</param>
-        /// <returns>The <see cref="ITenant"/>.</returns>
-        public static ITenant GetTransientTenant(this FeatureContext context)
-        {
-            return TransientTenantManager.GetInstance(context).PrimaryTransientClient;
-        }
-
-        /// <summary>
-        /// Retrieves the Id of the transient tenant created for the current feature from the supplied feature context.
-        /// <see cref="FeatureContext"/>.
-        /// </summary>
-        /// <param name="context">The current <see cref="FeatureContext"/>.</param>
-        /// <returns>The Id of the <see cref="ITenant"/>.</returns>
-        /// <exception cref="ArgumentNullException">There is no current tenant.</exception>
-        public static string GetTransientTenantId(this FeatureContext context)
-        {
-            return context.GetTransientTenant().Id;
-        }
-
         private static void UpdateServiceConfigurationWithTransientTenantId(
             FeatureContext featureContext,
             ITenant transientServiceTenant)
@@ -129,36 +72,5 @@ private static void UpdateServiceConfigurationWithTransientTenantId(
                 "MarainServiceConfiguration:ServiceDisplayName",
                 transientServiceTenant.Name);
         }
-
-        private static EnrollmentConfigurationItem[] GetOperationsConfig(FeatureContext featureContext)
-        {
-            IConfiguration configuration = ContainerBindings
-                .GetServiceProvider(featureContext)
-                .GetRequiredService<IConfiguration>();
-
-            // Can't create a logger using the generic type of this class because it's static, so we'll do it using
-            // the feature context instead.
-            ILogger<FeatureContext> logger = ContainerBindings
-                .GetServiceProvider(featureContext)
-                .GetRequiredService<ILogger<FeatureContext>>();
-
-            BlobStorageConfiguration blobStorageConfiguration =
-                configuration.GetSection("TestBlobStorageConfiguration").Get<BlobStorageConfiguration>()
-                ?? new BlobStorageConfiguration();
-
-            if (string.IsNullOrEmpty(blobStorageConfiguration.AccountName))
-            {
-                logger.LogDebug("No configuration value 'TestBlobStorageConfiguration:AccountName' provided; using local storage emulator.");
-            }
-
-            return new EnrollmentConfigurationItem[]
-            {
-                new EnrollmentBlobStorageConfigurationItem
-                {
-                    Key = "operationsStore",
-                    Configuration = blobStorageConfiguration,
-                },
-            };
-        }
     }
 }

Solutions/Marain.Operations.Api.Specs/Bindings/TransientTenantBindings.cs

@@ -40,6 +40,7 @@ Scenario: Change an operation state to Running and retrieve it
 	And I use the operations control client to create an operation
 	| IdName         | ResourceLocation       | ExpireAfter | Body                           |
 	| NewOperationId | http://www.google.com/ | 300         | This is some text for the body |
+	And the request succeeds
 	And I use the operations control client to set the status of the operation with Id called 'NewOperationId' to Running
 	And the request succeeds
 	When I use the operations status client to get the operation with the Id called 'NewOperationId'
@@ -52,6 +53,7 @@ Scenario: Update the percentage complete of a Running operation and retrieve it
 	And I use the operations control client to create an operation
 	| IdName         | ResourceLocation       | ExpireAfter | Body                           |
 	| NewOperationId | http://www.google.com/ | 300         | This is some text for the body |
+	And the request succeeds
 	And I use the operations control client to set the status of the operation with Id called 'NewOperationId' to Running
 	And the request succeeds
 	And I use the operations control client to set the status of the operation with Id called 'NewOperationId' to Running and the percentage complete to 45
@@ -66,6 +68,7 @@ Scenario: Change an operation state to Succeeded and retrieve it
 	And I use the operations control client to create an operation
 	| IdName         | ResourceLocation       | ExpireAfter | Body                           |
 	| NewOperationId | http://www.google.com/ | 300         | This is some text for the body |
+	And the request succeeds
 	And I use the operations control client to set the status of the operation with Id called 'NewOperationId' to Succeeded
 	And the request succeeds
 	When I use the operations status client to get the operation with the Id called 'NewOperationId'
@@ -78,6 +81,7 @@ Scenario: Change an operation state to Failed and retrieve it
 	And I use the operations control client to create an operation
 	| IdName         | ResourceLocation       | ExpireAfter | Body                           |
 	| NewOperationId | http://www.google.com/ | 300         | This is some text for the body |
+	And the request succeeds
 	And I use the operations control client to set the status of the operation with Id called 'NewOperationId' to Failed
 	And the request succeeds
 	When I use the operations status client to get the operation with the Id called 'NewOperationId'

Solutions/Marain.Operations.Api.Specs/Features/OperationsUsingClient.feature

@@ -47,19 +47,11 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Marain.Services.Tenancy.Testing" Version="2.3.3" />
-  </ItemGroup>
-  <ItemGroup>
-    <Folder Include="ServiceManifests\" />
-  </ItemGroup>
-  <ItemGroup>
-    <EmbeddedResource Include="..\Marain.Operations.Deployment\ServiceManifests\OperationsServiceManifest.jsonc" Link="ServiceManifests\OperationsServiceManifest.jsonc">
-      <CopyToOutputDirectory>Never</CopyToOutputDirectory>
-    </EmbeddedResource>
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\Marain.Operations.ControlClient\Marain.Operations.ControlClient.csproj" />
     <ProjectReference Include="..\Marain.Operations.ControlHost.Functions\Marain.Operations.ControlHost.Functions.csproj" />
+    <ProjectReference Include="..\Marain.Operations.Specs.Common\Marain.Operations.Specs.Common.csproj" />
     <ProjectReference Include="..\Marain.Operations.StatusClient\Marain.Operations.StatusClient.csproj" />
     <ProjectReference Include="..\Marain.Operations.StatusHost.Functions\Marain.Operations.StatusHost.Functions.csproj" />
   </ItemGroup>

Solutions/Marain.Operations.Api.Specs/Marain.Operations.Api.Specs.csproj

@@ -54,7 +54,7 @@ public static void AssertNoLastException(SpecFlowContext context)
         {
             if (context.TryGetValue(LastExceptionContextKey, out Exception ex))
             {
-                Assert.Fail($"Expected no last exception, but an exception of type '{ex.GetType().Name}' was thrown: '{ex.Message}'");
+                Assert.Fail($"Expected no last exception, but an exception of type '{ex.GetType().Name}' was thrown: '{ex.Message}' - {ex}");
             }
         }
 

Solutions/Marain.Operations.Api.Specs/Steps/Exceptions.cs

@@ -5,6 +5,13 @@
   "APPINSIGHTS_INSTRUMENTATIONKEY": "",
   "AI:DeveloperMode": "true",
 
+  // This uses the emulator:
+  "TestBlobStorageConfiguration:ConnectionStringPlainText": "UseDevelopmentStorage=true",
+  // If using a real blob storage account, provide the details using these settings.
+  //"TestBlobStorageConfiguration:AccountName": ""
+  //"TestBlobStorageConfiguration:AccessKeyInKeyVault:SecretName": "",
+  //"TestBlobStorageConfiguration:AccessKeyInKeyVault:VaultName": ""
+
   // If running with a local tenancy service, point TenancyClient:TenancyServiceBaseUri at the localhost address for that
   // and set the ResourceIdForMsiAuthentication to an empty string.
   "TenancyClient:TenancyServiceBaseUri": "http://localhost:7071/"