using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Options;
using NUnit.Framework;
using Serilog;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.Notifications;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Infrastructure.Persistence;
using Umbraco.Cms.Tests.Common.Testing;
using Umbraco.Cms.Tests.Integration.Implementations;
namespace Umbraco.Cms.Tests.Integration.Testing;
///
/// Base class for all UmbracoIntegrationTests
///
[SingleThreaded]
[NonParallelizable]
public abstract class UmbracoIntegrationTestBase
{
private static readonly Lock _dbLocker = new();
private static ITestDatabase? _dbInstance;
private static TestDbMeta _fixtureDbMeta;
protected static int TestCount = 1;
private readonly List _fixtureTeardown = new();
private readonly Queue _testTeardown = new();
private bool _firstTestInFixture = true;
protected Dictionary InMemoryConfiguration { get; } = new();
protected IConfiguration Configuration { get; set; }
protected UmbracoTestAttribute TestOptions => TestOptionAttributeBase.GetTestOptions();
protected TestHelper TestHelper { get; } = new();
protected void AddOnTestTearDown(Action tearDown) => _testTeardown.Enqueue(tearDown);
protected void AddOnFixtureTearDown(Action tearDown) => _fixtureTeardown.Add(tearDown);
[SetUp]
public virtual void SetUp_Logging() =>
TestContext.Out.Write($"Start test {TestCount++}: {TestContext.CurrentContext.Test.Name}");
[TearDown]
public void TearDown_Logging() =>
TestContext.Out.Write($" {TestContext.CurrentContext.Result.Outcome.Status}");
[OneTimeTearDown]
public void FixtureTearDown()
{
foreach (var a in _fixtureTeardown)
{
a();
}
}
[TearDown]
public void TearDown()
{
_firstTestInFixture = false;
while (_testTeardown.TryDequeue(out var a))
{
a();
}
}
protected ILoggerFactory CreateLoggerFactory()
{
try
{
switch (TestOptions.Logger)
{
case UmbracoTestOptions.Logger.Mock:
return NullLoggerFactory.Instance;
case UmbracoTestOptions.Logger.Serilog:
return LoggerFactory.Create(builder =>
{
var path = Path.Combine(TestHelper.WorkingDirectory, "logs", "umbraco_integration_tests_.txt");
Log.Logger = new LoggerConfiguration()
.WriteTo.File(path, rollingInterval: RollingInterval.Day)
.MinimumLevel.Debug()
.ReadFrom.Configuration(Configuration)
.CreateLogger();
builder.AddSerilog(Log.Logger);
});
case UmbracoTestOptions.Logger.Console:
return LoggerFactory.Create(builder =>
{
builder.AddConfiguration(Configuration.GetSection("Logging"))
.AddConsole();
});
}
}
catch
{
// ignored
}
return NullLoggerFactory.Instance;
}
protected void UseTestDatabase(IServiceProvider serviceProvider)
{
if (TestOptions.Database == UmbracoTestOptions.Database.None)
{
return;
}
var state = serviceProvider.GetRequiredService();
var databaseFactory = serviceProvider.GetRequiredService();
var connectionStrings = serviceProvider.GetRequiredService>();
var db = GetOrCreateDatabase(
serviceProvider.GetRequiredService(),
serviceProvider.GetRequiredService());
TestDbMeta meta = TestOptions.Database switch
{
UmbracoTestOptions.Database.NewSchemaPerTest => SetupPerTestDatabase(db, true),
UmbracoTestOptions.Database.NewEmptyPerTest => SetupPerTestDatabase(db, false),
UmbracoTestOptions.Database.NewSchemaPerFixture => SetupPerFixtureDatabase(db, true),
UmbracoTestOptions.Database.NewEmptyPerFixture => SetupPerFixtureDatabase(db, false),
_ => throw new ArgumentOutOfRangeException(),
};
databaseFactory.Configure(meta.ToStronglyTypedConnectionString());
connectionStrings.CurrentValue.ConnectionString = meta.ConnectionString;
connectionStrings.CurrentValue.ProviderName = meta.Provider;
state.DetermineRuntimeLevel();
serviceProvider.GetRequiredService().Publish(new UnattendedInstallNotification());
}
private TestDbMeta SetupPerTestDatabase(ITestDatabase db, bool withSchema)
{
var meta = withSchema ? db.AttachSchema() : db.AttachEmpty();
AddOnTestTearDown(() => db.Detach(meta));
return meta;
}
private TestDbMeta SetupPerFixtureDatabase(ITestDatabase db, bool withSchema)
{
if (_firstTestInFixture)
{
_fixtureDbMeta = withSchema ? db.AttachSchema() : db.AttachEmpty();
AddOnFixtureTearDown(() => db.Detach(_fixtureDbMeta));
}
return _fixtureDbMeta;
}
private ITestDatabase GetOrCreateDatabase(ILoggerFactory loggerFactory, TestUmbracoDatabaseFactoryProvider dbFactory)
{
lock (_dbLocker)
{
if (_dbInstance != null)
{
return _dbInstance;
}
var settings = new TestDatabaseSettings
{
FilesPath = Path.Combine(TestHelper.WorkingDirectory, "databases"),
DatabaseType =
Configuration.GetValue("Tests:Database:DatabaseType"),
PrepareThreadCount = Configuration.GetValue("Tests:Database:PrepareThreadCount"),
EmptyDatabasesCount = Configuration.GetValue("Tests:Database:EmptyDatabasesCount"),
SchemaDatabaseCount = Configuration.GetValue("Tests:Database:SchemaDatabaseCount"),
SQLServerMasterConnectionString = Configuration.GetValue("Tests:Database:SQLServerMasterConnectionString"),
};
Directory.CreateDirectory(settings.FilesPath);
_dbInstance = TestDatabaseFactory.Create(settings, dbFactory, loggerFactory);
return _dbInstance;
}
}
}