Files
Umbraco-CMS/tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/AuditEntryServiceTests.cs
Laura Neto 7fc2bc84de Audit entries rework (#19345)
* Introduce new AuditEntryService

- Moved logic related to the IAuditEntryRepository from the AuditService to the new service
- Introduced new Async methods
  - Using ids (for easier transition from the previous Write method)
  - Using keys
- Moved and updated integration tests related to the audit entries to a new test class `AuditEntryServiceTests`
- Added unit tests class `AuditEntryServiceTests` and added a few unit tests
- Added migration to add columns for `performingUserKey` and `affectedUserKey` and convert existing user ids
- Adjusted usages of the old AuditService.Write method to use the new one (mostly notification handlers)

* Apply suggestions from code review

* Small improvement

* Some adjustments following code review. Removed UnknownUserKey and used null instead.

* Small adjustments

* Better handle audits performed during the migration state

* Update TODO comment
2025-06-06 13:12:35 +02:00

95 lines
3.6 KiB
C#

// Copyright (c) Umbraco.
// See LICENSE for more details.
using Microsoft.Extensions.DependencyInjection;
using NUnit.Framework;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Tests.Common.Builders;
using Umbraco.Cms.Tests.Common.Testing;
using Umbraco.Cms.Tests.Integration.Testing;
namespace Umbraco.Cms.Tests.Integration.Umbraco.Infrastructure.Services;
[TestFixture]
[UmbracoTest(Database = UmbracoTestOptions.Database.NewSchemaPerTest)]
internal sealed class AuditEntryServiceTests : UmbracoIntegrationTest
{
[Test]
public async Task Write_and_GetAll()
{
var sut = (AuditEntryService)Services.GetRequiredService<IAuditEntryService>();
var expected = new AuditEntryBuilder()
.Build();
var result = await sut.WriteAsync(
expected.PerformingUserKey.Value,
expected.PerformingDetails,
expected.PerformingIp,
expected.EventDateUtc,
expected.AffectedUserKey.Value,
expected.AffectedDetails,
expected.EventType,
expected.EventDetails);
Assert.NotNull(result);
var actual = result;
var entries = sut.GetAll().ToArray();
Assert.Multiple(() =>
{
Assert.AreEqual(expected.PerformingUserId, actual.PerformingUserId);
Assert.AreEqual(expected.PerformingUserKey, actual.PerformingUserKey);
Assert.AreEqual(expected.PerformingDetails, actual.PerformingDetails);
Assert.AreEqual(expected.EventDateUtc, actual.EventDateUtc);
Assert.AreEqual(expected.AffectedUserId, actual.AffectedUserId);
Assert.AreEqual(expected.AffectedUserKey, actual.AffectedUserKey);
Assert.AreEqual(expected.AffectedDetails, actual.AffectedDetails);
Assert.AreEqual(expected.EventType, actual.EventType);
Assert.AreEqual(expected.EventDetails, actual.EventDetails);
Assert.IsNotNull(entries);
Assert.AreEqual(1, entries.Length);
Assert.AreEqual(expected.PerformingUserKey, entries[0].PerformingUserKey);
});
}
[Test]
public async Task Write_and_GetAll_With_Keys()
{
var sut = (AuditEntryService)Services.GetRequiredService<IAuditEntryService>();
var eventDateUtc = DateTime.UtcNow;
var result = await sut.WriteAsync(
Constants.Security.SuperUserKey,
"performingDetails",
"performingIp",
eventDateUtc,
null,
"affectedDetails",
"umbraco/test",
"eventDetails");
Assert.NotNull(result);
var actual = result;
var entries = sut.GetAll().ToArray();
Assert.Multiple(() =>
{
Assert.AreEqual(Constants.Security.SuperUserId, actual.PerformingUserId);
Assert.AreEqual(Constants.Security.SuperUserKey, actual.PerformingUserKey);
Assert.AreEqual("performingDetails", actual.PerformingDetails);
Assert.AreEqual("performingIp", actual.PerformingIp);
Assert.AreEqual(eventDateUtc, actual.EventDateUtc);
Assert.AreEqual(Constants.Security.UnknownUserId, actual.AffectedUserId);
Assert.AreEqual(null, actual.AffectedUserKey);
Assert.AreEqual("affectedDetails", actual.AffectedDetails);
Assert.AreEqual("umbraco/test", actual.EventType);
Assert.AreEqual("eventDetails", actual.EventDetails);
Assert.IsNotNull(entries);
Assert.AreEqual(1, entries.Length);
Assert.AreEqual(Constants.Security.SuperUserId, entries[0].PerformingUserId);
});
}
}