[BEEEP] Integration tests (#1945)

* Add api integration tests * Add some stuff * Make program mockable * Work on IntegrationTests for Identity * Formatting * Update packages.lock.json * Update more packages.lock.json * Update all packages.lock.json * Fix InMemory configuration * Actually fix test configuration * Fix tests for CI * Fix event service * Force EF EventRepository * Add client_credentials test * Remove Api.IntegrationTest * Remove Api Program changes * Cleanup * Add more Auth-Email tests * Run formatting * Address some PR feedback * Move integration stuff to it's own common project * Ran linter * Add shared project to test solution * Remove sln changes * Clean usings * Add more coverage * Address PR feedback
2025-06-30 15:42:48 -05:00 · 2022-05-20 15:24:59 -04:00
parent 98546a65ea
commit 719abc7e61
36 changed files with 8706 additions and 161 deletions
--- a/test/IntegrationTestCommon/Factories/WebApplicationFactoryBase.cs
+++ b/test/IntegrationTestCommon/Factories/WebApplicationFactoryBase.cs
@ -0,0 +1,102 @@
+using System.Collections.Generic;
+using System.Linq;
+using AspNetCoreRateLimit;
+using Bit.Core.Repositories;
+using Bit.Core.Services;
+using Bit.Infrastructure.EntityFramework.Repositories;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc.Testing;
+using Microsoft.AspNetCore.TestHost;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Bit.IntegrationTestCommon.Factories
+{
+    public static class FactoryConstants
+    {
+        public const string DefaultDatabaseName = "test_database";
+        public const string WhitelistedIp = "1.1.1.1";
+    }
+
+    public abstract class WebApplicationFactoryBase<T> : WebApplicationFactory<T>
+        where T : class
+    {
+        /// <summary>
+        /// The database name to use for this instance of the factory. By default it will use a shared database name so all instances will connect to the same database during it's lifetime.
+        /// </summary>
+        /// <remarks>
+        /// This will need to be set BEFORE using the <c>Server</c> property
+        /// </remarks>
+        public string DatabaseName { get; set; } = FactoryConstants.DefaultDatabaseName;
+
+        /// <summary>
+        /// Configure the web host to use an EF in memory database
+        /// </summary>
+        protected override void ConfigureWebHost(IWebHostBuilder builder)
+        {
+            builder.ConfigureAppConfiguration(c =>
+            {
+                c.AddInMemoryCollection(new Dictionary<string, string>
+                {
+                    // Manually insert a EF provider so that ConfigureServices will add EF repositories but we will override
+                    // DbContextOptions to use an in memory database
+                    { "globalSettings:databaseProvider", "postgres" },
+                    { "globalSettings:postgreSql:connectionString", "Host=localhost;Username=test;Password=test;Database=test" },
+                });
+            });
+
+            builder.ConfigureTestServices(services =>
+            {
+                var dbContextOptions = services.First(sd => sd.ServiceType == typeof(DbContextOptions<DatabaseContext>));
+                services.Remove(dbContextOptions);
+                services.AddScoped(_ =>
+                {
+                    return new DbContextOptionsBuilder<DatabaseContext>()
+                        .UseInMemoryDatabase(DatabaseName)
+                        .Options;
+                });
+
+                // QUESTION: The normal licensing service should run fine on developer machines but not in CI
+                // should we have a fork here to leave the normal service for developers?
+                // TODO: Eventually add the license file to CI
+                var licensingService = services.First(sd => sd.ServiceType == typeof(ILicensingService));
+                services.Remove(licensingService);
+                services.AddSingleton<ILicensingService, NoopLicensingService>();
+
+                // FUTURE CONSIDERATION: Add way to run this self hosted/cloud, for now it is cloud only
+                var pushRegistrationService = services.First(sd => sd.ServiceType == typeof(IPushRegistrationService));
+                services.Remove(pushRegistrationService);
+                services.AddSingleton<IPushRegistrationService, NoopPushRegistrationService>();
+
+                // Even though we are cloud we currently set this up as cloud, we can use the EF/selfhosted service
+                // instead of using Noop for this service
+                // TODO: Install and use azurite in CI pipeline
+                var eventWriteService = services.First(sd => sd.ServiceType == typeof(IEventWriteService));
+                services.Remove(eventWriteService);
+                services.AddSingleton<IEventWriteService, RepositoryEventWriteService>();
+
+                var eventRepositoryService = services.First(sd => sd.ServiceType == typeof(IEventRepository));
+                services.Remove(eventRepositoryService);
+                services.AddSingleton<IEventRepository, EventRepository>();
+
+                // Our Rate limiter works so well that it begins to fail tests unless we carve out
+                // one whitelisted ip. We should still test the rate limiter though and they should change the Ip 
+                // to something that is NOT whitelisted
+                services.Configure<IpRateLimitOptions>(options =>
+                {
+                    options.IpWhitelist = new List<string>
+                    {
+                        FactoryConstants.WhitelistedIp,
+                    };
+                });
+            });
+        }
+
+        public DatabaseContext GetDatabaseContext()
+        {
+            var scope = Services.CreateScope();
+            return scope.ServiceProvider.GetRequiredService<DatabaseContext>();
+        }
+    }
+}