Українська
База даних для тестів
Крок 1. Життя запуску тестів
Навіщо. Добрі тести незалежні: кожен починає з відомого стану, тож порядок тестів не має значення, а тест, що падає, не ламає наступний. Для бази даних це означає порожню схему перед кожним тестом. Створення нової бази даних для кожного тесту коштувало б секунди на тест; Chatex поєднує три засоби, щоб це було швидко (рис. 6.2):
- Testcontainers запускає контейнер PostgreSQL з коду – один раз на тестовий проєкт – на вільному порту й видаляє його після запуску. Нічого не треба встановлювати чи запускати вручну, а база даних розробки ніколи не зачіпається.
- Справжні міграції створюють схему в цьому контейнері, тож кожен запуск заодно тестує й міграції.
- Respawn очищає всі таблиці перед кожним тестом кількома швидкими операторами
DELETE, зберігаючи схему. Це займає мілісекунди.
Рис. 6.2. Один контейнер на запуск, чиста база даних на тест
Крок 2. Фікстура
Навіщо. У xUnit фікстура (fixture) – це об’єкт, спільний для багатьох тестів: створюється перед першим і знищується після останнього. xUnit v3 додає фікстури збірки (assembly fixtures): один екземпляр для всіх тестів тестового проєкту. Це правильна область для дорогого контейнера.
Що зробити. Створіть фікстуру в Chatex.Testing:
cs
using Chatex.Data;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using Npgsql;
using Respawn;
using Testcontainers.PostgreSql;
using Xunit;
namespace Chatex.Testing;
/// <summary>
/// Starts one PostgreSQL container per test assembly and applies the real migrations to it.
/// Register it with <c>[assembly: AssemblyFixture(typeof(PostgresFixture))]</c>.
/// </summary>
public sealed class PostgresFixture : IAsyncLifetime
{
private readonly PostgreSqlContainer _container = new PostgreSqlBuilder("postgres:18-alpine").Build();
private Respawner _respawner = null!;
public string ConnectionString => _container.GetConnectionString();
public async ValueTask InitializeAsync()
{
await _container.StartAsync();
var services = new ServiceCollection();
services.AddLogging();
services.AddData(ConnectionString, o => o.RootPath = Path.GetTempPath());
await using (var provider = services.BuildServiceProvider())
await using (var scope = provider.CreateAsyncScope())
{
await scope.ServiceProvider.GetRequiredService<ChatexDbContext>().Database.MigrateAsync();
}
await using var connection = new NpgsqlConnection(ConnectionString);
await connection.OpenAsync();
_respawner = await Respawner.CreateAsync(connection, new RespawnerOptions
{
DbAdapter = DbAdapter.Postgres,
SchemasToInclude = ["public"],
TablesToIgnore = ["__EFMigrationsHistory"],
});
}
/// <summary>Deletes all rows, keeping the schema.</summary>
public async Task ResetAsync()
{
await using var connection = new NpgsqlConnection(ConnectionString);
await connection.OpenAsync();
await _respawner.ResetAsync(connection);
}
public async ValueTask DisposeAsync() => await _container.DisposeAsync();
}IAsyncLifetime– інтерфейс xUnit для асинхронного налаштування й завершення:InitializeAsyncвиконується перед першим тестом,DisposeAsync– після останнього. Обидва повертаютьValueTask.new PostgreSqlBuilder("postgres:18-alpine").Build()описує контейнер із тим самим образом, що йcompose.yaml;StartAsyncзапускає його й чекає, доки PostgreSQL почне приймати з’єднання.GetConnectionString()повертає рядок підключення з випадковим портом, який вибрав Testcontainers, тож тести ніколи не конфліктують із базою даних розробки на порту 5432.- Міграції застосовуються через справжню реєстрацію: тимчасова колекція служб викликає
AddData, отримує контекст і викликаєDatabase.MigrateAsync(). Блокиawait using (...)звільняють постачальника й область одразу після завершення міграції. Respawnerодин раз досліджує базу даних і запам’ятовує таблиці та зовнішні ключі між ними, щобResetAsyncміг видаляти в правильному порядку. Він пропускає__EFMigrationsHistory, яка має вціліти.
Крок 3. Базовий клас для тестів бази даних
Навіщо. Кожен тест бази даних потребує тієї самої підготовки: стерти дані, побудувати свіжого постачальника служб (щоб підробка, зареєстрована одним тестом, ніколи не потрапила в наступний), дати тесту спосіб створювати області й отримувати сервіси. Базовий клас робить це один раз.
Що зробити.
cs
using Microsoft.Extensions.DependencyInjection;
using Xunit;
namespace Chatex.Testing;
/// <summary>
/// Base for tests against <see cref="PostgresFixture"/>: wipes the database and builds a fresh service provider
/// (so fakes such as a test clock never leak between tests) before each test.
/// </summary>
public abstract class DatabaseTest(PostgresFixture fixture) : IAsyncLifetime
{
private ServiceProvider _services = null!;
protected static CancellationToken Ct => TestContext.Current.CancellationToken;
/// <summary>A temporary directory for file storage, deleted after the test.</summary>
protected string StorageRoot { get; } = Path.Combine(Path.GetTempPath(), "chatex-tests", Guid.NewGuid().ToString("N"));
protected abstract void ConfigureServices(IServiceCollection services, string connectionString);
public async ValueTask InitializeAsync()
{
await fixture.ResetAsync();
var services = new ServiceCollection();
services.AddLogging();
ConfigureServices(services, fixture.ConnectionString);
_services = services.BuildServiceProvider(validateScopes: true);
}
public async ValueTask DisposeAsync()
{
await _services.DisposeAsync();
if (Directory.Exists(StorageRoot))
{
Directory.Delete(StorageRoot, recursive: true);
}
GC.SuppressFinalize(this);
}
/// <summary>A fresh scope, i.e. a fresh DbContext with nothing tracked.</summary>
protected AsyncServiceScope NewScope() => _services.CreateAsyncScope();
protected static T Get<T>(AsyncServiceScope scope) where T : notnull =>
scope.ServiceProvider.GetRequiredService<T>();
/// <summary>Resolves a singleton (e.g. a fake) from the root provider.</summary>
protected T GetSingleton<T>() where T : notnull => _services.GetRequiredService<T>();
}abstractз абстрактним методомConfigureServices: кожен тестовий проєкт сам вирішує, що реєструвати – тут рівень даних, у темі 7 бізнес-рівень. Це патерн шаблонного методу (template method): базовий клас фіксує порядок кроків, підкласи заповнюють один із них.InitializeAsyncвиконується перед кожним тестом (xUnit створює новий екземпляр тестового класу для кожного тесту): скинути базу даних, потім побудувати постачальника.validateScopes: trueзмушує контейнер викидати виняток, якщо сервіс області, наприклад контекст, отримують із кореневого постачальника, – це помилка, що розділила б один контекст між непов’язаними операціями.NewScope()дає тесту свіжу область, тобто свіжийChatexDbContext, у якому нічого не відстежується. Тести використовують одну область, щоб підготувати дані (arrange), і іншу, щоб виконати дію (act) й перевірити (assert), аби результат справді надходив із бази даних, а не з відстежувача змін контексту, що щойно зберіг дані.Ct– токен скасування поточного тесту (TestContext.Current.CancellationToken); xUnit скасовує його, коли запуск перервано або минув тайм-аут. Аналізатори xUnit v3 нагадують передавати його далі.StorageRoot– тимчасова папка для сховища файлів, яку видаляють після тесту.
Перевірка
powershell
dotnet buildЗбірка знову успішна без жодного попередження: простір імен Chatex.Testing тепер існує. Тестів ще немає.