Українська
Тестування бізнес-рівня
Крок 1. Тестовий проєкт
Навіщо. Бізнес-рівень має власний тестовий проєкт. Його тести викликають сервіси через справжній граф впровадження залежностей – AddCore зі справжнім рівнем даних на контейнері PostgreSQL із теми 6, – тож тест перевіряє правило, запит і транзакцію разом. Підміняються лише три речі: годинник, файлове сховище (тема 9) і сповіщувач (тема 10).
Що зробити.
powershell
dotnet new classlib -o Tests/Chatex.Core.Testspowershell
Remove-Item Tests/Chatex.Core.Tests/Class1.cspowershell
dotnet sln add Tests/Chatex.Core.Testspowershell
dotnet add Tests/Chatex.Core.Tests reference Source/Chatex.Corepowershell
dotnet add Tests/Chatex.Core.Tests package Microsoft.Extensions.Configurationpowershell
dotnet add Tests/Chatex.Core.Tests package Microsoft.Extensions.TimeProvider.TestingВидаліть <PropertyGroup>, який записав шаблон. Назва закінчується на .Tests, тож Tests/Directory.Build.props із теми 6 робить із нього тестовий проєкт із xUnit, Shouldly та Chatex.Testing:
xml
<Project Sdk="Microsoft.NET.Sdk">
<ItemGroup>
<ProjectReference Include="..\..\Source\Chatex.Core\Chatex.Core.csproj" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Configuration" />
<PackageReference Include="Microsoft.Extensions.TimeProvider.Testing" />
</ItemGroup>
</Project>Microsoft.Extensions.Configurationбудує конфігурацію зі словника в пам’яті – саме ті налаштування, які читаєAddCore.Microsoft.Extensions.TimeProvider.TestingміститьFakeTimeProvider:TimeProvider, час якого стоїть, доки тест не зрушить його методомAdvance(TimeSpan). Тест «токен оновлення спливає за 30 днів» пересуває годинник на 31 день одним рядком.
Крок 2. Базовий клас
Навіщо. Як і DbTestBase у темі 6, базовий клас виконує повторювану роботу: налаштовує сервіси й пропонує короткі допоміжні методи. Він побудований на двох ідеях:
- Одна область дії на виклик сервісу.
Auth(s => s.LoginAsync(...))створює нову область дії, отримує сервіс, викликає його й знищує область – так само, як один HTTP-запит. Ніщо, що відстежує контекст одного виклику, не може випадково допомогти наступному виклику пройти. - Перевірки, що читаються як правила.
result.ShouldSucceed()повертає значення або падає з помилкою в повідомленні;result.ShouldFail(ErrorKind.Conflict, "user_name_taken")перевіряє вид і код.
Що зробити.
cs
using Chatex.Core.Auth;
using Chatex.Core.Common;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Time.Testing;
// Tests share one database that is wiped before each test; xunit.runner.json turns off parallel runs.
[assembly: AssemblyFixture(typeof(PostgresFixture))]
namespace Chatex.Core.Tests;
public abstract class BusinessTestBase(PostgresFixture fixture) : DatabaseTest(fixture)
{
public const string Password = "Passw0rd!";
public const string Issuer = "chatex-tests";
public const string SigningKey = "test-signing-key-that-is-long-enough-for-hmac";
protected FakeTimeProvider Time { get; } = new(DateTimeOffset.UtcNow);
protected override void ConfigureServices(IServiceCollection services, string connectionString)
{
var configuration = new ConfigurationBuilder()
.AddInMemoryCollection(new Dictionary<string, string?>
{
["ConnectionStrings:Chatex"] = connectionString,
["Storage:RootPath"] = StorageRoot,
["Jwt:Issuer"] = Issuer,
["Jwt:Audience"] = Issuer,
["Jwt:SigningKey"] = SigningKey,
})
.Build();
services.AddSingleton<TimeProvider>(Time);
services.AddCore(configuration);
}
protected Task<T> Auth<T>(Func<IAuthService, Task<T>> call) => Use(call);
/// <summary>Registers <paramref name="userName"/> and returns the signed-in session.</summary>
protected async Task<AuthResult> RegisterAsync(string userName)
{
var result = await Auth(s => s.RegisterAsync(
new RegisterCommand(userName, $"{userName}@example.test", Password, $"{userName} display"), ClientInfo.Unknown, Ct));
return result.ShouldSucceed();
}
protected async Task<Guid> RegisterUserAsync(string userName) => (await RegisterAsync(userName)).User.Id;
private async Task<T> Use<TService, T>(Func<TService, Task<T>> call) where TService : notnull
{
await using var scope = NewScope();
return await call(Get<TService>(scope));
}
}
internal static class ResultAssertions
{
public static T ShouldSucceed<T>(this Result<T> result)
{
result.IsSuccess.ShouldBeTrue($"Expected success but got {result.Error}");
return result.Value;
}
public static void ShouldSucceed(this Result result) =>
result.IsSuccess.ShouldBeTrue($"Expected success but got {result.Error}");
public static Error ShouldFail<T>(this Result<T> result, ErrorKind kind, string code)
{
result.IsSuccess.ShouldBeFalse("Expected a failure but the operation succeeded.");
result.Error.Kind.ShouldBe(kind);
result.Error.Code.ShouldBe(code);
return result.Error;
}
public static Error ShouldFail(this Result result, ErrorKind kind, string code)
{
result.IsSuccess.ShouldBeFalse("Expected a failure but the operation succeeded.");
result.Error.Kind.ShouldBe(kind);
result.Error.Code.ShouldBe(code);
return result.Error;
}
}[assembly: AssemblyFixture(typeof(PostgresFixture))]дає цьому тестовому проєкту власний контейнер PostgreSQL, як і в тестах даних.ConfigureServicesбудує конфігурацію, яку API читатиме зappsettings, – рядок підключення, папку сховища, налаштування JWT – і реєструє підроблений годинник доAddCore.AddDataреєструє справжній годинник черезTryAddSingleton(тема 5), що нічого не робить, колиTimeProviderуже є.Auth<T>і закритийUse<TService, T>реалізують «одну область дії на виклик».Useузагальнений за типом сервісу; кожна функція отримує однорядковий допоміжний метод (Profiles,Chats, … у наступних темах).RegisterAsyncреєструє користувача з фіксованим паролем і повертає сесію;RegisterUserAsyncповертає лише ідентифікатор. Більшість тестів починається з них.ResultAssertions– методи розширення і дляResult, і дляResult<T>. Вони лежать у тому самому файлі й мають модифікаторinternalдля тестового проєкту.
Крок 3. Тести сервісу автентифікації
Що зробити.
cs
using System.Text;
using Chatex.Core.Auth;
using Chatex.Core.Common;
using Microsoft.IdentityModel.JsonWebTokens;
using Microsoft.IdentityModel.Tokens;
namespace Chatex.Core.Tests;
public sealed class AuthServiceTests(PostgresFixture fixture) : BusinessTestBase(fixture)
{
[Fact]
public async Task Register_signs_the_user_in_and_creates_the_profile()
{
var result = await Auth(s => s.RegisterAsync(
new RegisterCommand("Alice_1", "[email protected]", Password, " Alice "), ClientInfo.Unknown, Ct));
var session = result.ShouldSucceed();
session.AccessToken.ShouldNotBeNullOrEmpty();
session.RefreshToken.ShouldNotBeNullOrEmpty();
session.User.UserName.ShouldBe("alice_1");
session.User.DisplayName.ShouldBe("Alice");
session.RefreshTokenExpiresAt.ShouldBe(Time.GetUtcNow() + TimeSpan.FromDays(30));
}
[Fact]
public async Task Register_rejects_a_taken_user_name_in_any_case()
{
await RegisterAsync("alice");
var result = await Auth(s => s.RegisterAsync(
new RegisterCommand("ALICE", "[email protected]", Password, "Other"), ClientInfo.Unknown, Ct));
result.ShouldFail(ErrorKind.Conflict, "user_name_taken");
}
[Fact]
public async Task Register_rejects_a_weak_password_and_an_invalid_user_name()
{
var weak = await Auth(s => s.RegisterAsync(
new RegisterCommand("alice", "[email protected]", "short", "Alice"), ClientInfo.Unknown, Ct));
var badName = await Auth(s => s.RegisterAsync(
new RegisterCommand("1alice!", "[email protected]", Password, "Alice"), ClientInfo.Unknown, Ct));
weak.ShouldFail(ErrorKind.Validation, "validation_failed").Details.ShouldNotBeNull().ShouldContainKey("password");
badName.ShouldFail(ErrorKind.Validation, "validation_failed").Details.ShouldNotBeNull().ShouldContainKey("userName");
}
[Fact]
public async Task Login_works_with_user_name_or_email()
{
var alice = await RegisterUserAsync("alice");
var byName = await Auth(s => s.LoginAsync(new LoginCommand("Alice", Password), ClientInfo.Unknown, Ct));
var byEmail = await Auth(s => s.LoginAsync(new LoginCommand("[email protected]", Password), ClientInfo.Unknown, Ct));
byName.ShouldSucceed().User.Id.ShouldBe(alice);
byEmail.ShouldSucceed().User.Id.ShouldBe(alice);
}
[Fact]
public async Task Login_locks_the_account_after_five_wrong_passwords()
{
await RegisterAsync("alice");
for (var attempt = 1; attempt <= 4; attempt++)
{
(await Auth(s => s.LoginAsync(new LoginCommand("alice", "Wrong1234"), ClientInfo.Unknown, Ct)))
.ShouldFail(ErrorKind.Unauthorized, "invalid_credentials");
}
(await Auth(s => s.LoginAsync(new LoginCommand("alice", "Wrong1234"), ClientInfo.Unknown, Ct)))
.ShouldFail(ErrorKind.Unauthorized, "locked_out");
(await Auth(s => s.LoginAsync(new LoginCommand("alice", Password), ClientInfo.Unknown, Ct)))
.ShouldFail(ErrorKind.Unauthorized, "locked_out");
}
[Fact]
public async Task Login_does_not_reveal_whether_the_user_exists()
{
var result = await Auth(s => s.LoginAsync(new LoginCommand("nobody", Password), ClientInfo.Unknown, Ct));
result.ShouldFail(ErrorKind.Unauthorized, "invalid_credentials");
}
[Fact]
public async Task Refresh_issues_a_new_pair_and_retires_the_old_token()
{
var first = await RegisterAsync("alice");
var second = (await Auth(s => s.RefreshAsync(new RefreshCommand(first.RefreshToken), ClientInfo.Unknown, Ct))).ShouldSucceed();
var third = await Auth(s => s.RefreshAsync(new RefreshCommand(second.RefreshToken), ClientInfo.Unknown, Ct));
second.RefreshToken.ShouldNotBe(first.RefreshToken);
second.User.Id.ShouldBe(first.User.Id);
third.ShouldSucceed();
}
[Fact]
public async Task Reusing_a_refresh_token_signs_the_user_out_everywhere()
{
var first = await RegisterAsync("alice");
var second = (await Auth(s => s.RefreshAsync(new RefreshCommand(first.RefreshToken), ClientInfo.Unknown, Ct))).ShouldSucceed();
var replay = await Auth(s => s.RefreshAsync(new RefreshCommand(first.RefreshToken), ClientInfo.Unknown, Ct));
var afterReplay = await Auth(s => s.RefreshAsync(new RefreshCommand(second.RefreshToken), ClientInfo.Unknown, Ct));
replay.ShouldFail(ErrorKind.Unauthorized, "invalid_refresh_token");
afterReplay.ShouldFail(ErrorKind.Unauthorized, "invalid_refresh_token");
}
[Fact]
public async Task Refresh_fails_once_the_token_expired()
{
var session = await RegisterAsync("alice");
Time.Advance(TimeSpan.FromDays(31));
var result = await Auth(s => s.RefreshAsync(new RefreshCommand(session.RefreshToken), ClientInfo.Unknown, Ct));
result.ShouldFail(ErrorKind.Unauthorized, "invalid_refresh_token");
}
[Fact]
public async Task Stale_refresh_tokens_are_deleted_only_after_a_full_lifetime()
{
var first = await RegisterAsync("alice");
var second = (await Auth(s => s.RefreshAsync(new RefreshCommand(first.RefreshToken), ClientInfo.Unknown, Ct))).ShouldSucceed();
// The retired token is kept, so replaying it is still caught as theft.
(await Auth(s => s.DeleteStaleRefreshTokensAsync(Ct))).ShouldBe(0);
Time.Advance(TimeSpan.FromDays(61));
(await Auth(s => s.DeleteStaleRefreshTokensAsync(Ct))).ShouldBe(2);
var result = await Auth(s => s.RefreshAsync(new RefreshCommand(second.RefreshToken), ClientInfo.Unknown, Ct));
result.ShouldFail(ErrorKind.Unauthorized, "invalid_refresh_token");
}
[Fact]
public async Task Logout_ends_the_session()
{
var session = await RegisterAsync("alice");
(await Auth(s => s.LogoutAsync(new RefreshCommand(session.RefreshToken), Ct))).ShouldSucceed();
var result = await Auth(s => s.RefreshAsync(new RefreshCommand(session.RefreshToken), ClientInfo.Unknown, Ct));
result.ShouldFail(ErrorKind.Unauthorized, "invalid_refresh_token");
}
[Fact]
public async Task Access_token_is_signed_and_identifies_the_user()
{
var session = await RegisterAsync("alice");
var validation = await new JsonWebTokenHandler().ValidateTokenAsync(session.AccessToken, new TokenValidationParameters
{
ValidIssuer = Issuer,
ValidAudience = Issuer,
IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(SigningKey)),
});
validation.IsValid.ShouldBeTrue(validation.Exception?.Message);
validation.Claims[JwtRegisteredClaimNames.Sub].ShouldBe(session.User.Id.ToString());
validation.Claims[JwtRegisteredClaimNames.UniqueName].ShouldBe("alice");
}
}Що доводять дванадцять тестів:
- Реєстрація переводить ім’я користувача в нижній регістр, обрізає пробіли у відображуваному імені, виконує вхід користувача, а токен оновлення спливає рівно через 30 днів після підробленого «зараз». Зайняте ім’я відхиляється в будь-якому регістрі літер; слабкий пароль і недійсне ім’я повідомляються під їхніми полями.
- Вхід працює з іменем (в іншому регістрі) і з електронною адресою. П’ять хибних паролів блокують обліковий запис: чотири відповіді
invalid_credentials, п’ята –locked_out– і далі навіть правильний пароль відхиляється. Невідомий користувач отримує точно таку саму помилку, як і хибний пароль. - Оновлення повертає новий токен оновлення, що знову працює один раз. Повторне використання першого токена не вдається, і після цього навіть найновіший токен мертвий: користувача розлогінено всюди.
- Закінчення строку й очищення використовують підроблений годинник: через 31 день токен відхиляється; очищення спершу залишає вилучений токен (щоб крадіжка все ще виявлялася) і видаляє обидва токени сесії через 61 день.
- Токен доступу перевіряється бібліотекою JWT незалежно від сервісу: правильні видавець, одержувач і підпис,
sub– ідентифікатор користувача, аunique_name– ім’я користувача.
Перевірка
powershell
dotnet test --solution Chatex.slnxОбидва тестові проєкти виконуються паралельно, кожен зі своїм контейнером. У підсумку 31 тест: 19 тестів даних і 12 бізнес-тестів, усі проходять.
Тепер навмисно зламайте один тест: в AuthService.RefreshAsync закоментуйте рядок await refreshTokens.RevokeAllForUserAsync(...) у гілці крадіжки й запустіть
powershell
dotnet test --project Tests/Chatex.Core.Tests --filter-method "*Reusing*"Тест Reusing_a_refresh_token_signs_the_user_out_everywhere падає: другий токен усе ще працює. Поверніть рядок на місце.