Umbraco-CMS/tests/Umbraco.Tests.UnitTests/Umbraco.Core/Scoping/ScopedNotificationPublisherTests.cs

using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Abstractions;
using Microsoft.Extensions.Options;
using Moq;
using NUnit.Framework;
using Umbraco.Cms.Core.Cache;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.DistributedLocking;
using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.Hosting;
using Umbraco.Cms.Core.IO;
using Umbraco.Cms.Core.Notifications;
using Umbraco.Cms.Core.Scoping;
using Umbraco.Cms.Core.Strings;
using Umbraco.Cms.Infrastructure.Persistence;
using Umbraco.Cms.Infrastructure.Scoping;
using Umbraco.Cms.Tests.Common;

namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Core.Scoping;

[TestFixture]
public class ScopedNotificationPublisherTests
{
    [Test]
    public void ScopeUsesInjectedNotificationPublisher()
    {
        var notificationPublisherMock = new Mock<IScopedNotificationPublisher>();
        var scopeProvider = GetScopeProvider(out var eventAggregatorMock);

        using (ICoreScope scope = scopeProvider.CreateScope(notificationPublisher: notificationPublisherMock.Object))
        {
            scope.Notifications.Publish(Mock.Of<INotification>());
            scope.Notifications.PublishCancelable(Mock.Of<ICancelableNotification>());

            notificationPublisherMock.Verify(x => x.Publish(It.IsAny<INotification>()), Times.Once);
            notificationPublisherMock.Verify(x => x.PublishCancelable(It.IsAny<ICancelableNotification>()), Times.Once);

            // Ensure that the custom scope provider is till used in inner scope.
            using (ICoreScope innerScope = scopeProvider.CreateScope())
            {
                innerScope.Notifications.Publish(Mock.Of<INotification>());
                innerScope.Notifications.PublishCancelable(Mock.Of<ICancelableNotification>());

                notificationPublisherMock.Verify(x => x.Publish(It.IsAny<INotification>()), Times.Exactly(2));
                notificationPublisherMock.Verify(x => x.PublishCancelable(It.IsAny<ICancelableNotification>()), Times.Exactly(2));
            }

            // Ensure scope exit is not called until outermost scope is being disposed
            notificationPublisherMock.Verify(x => x.ScopeExit(It.IsAny<bool>()), Times.Never());
        }

        notificationPublisherMock.Verify(x => x.ScopeExit(It.IsAny<bool>()), Times.Once());

        // Ensure that the event aggregator isn't used directly.
        eventAggregatorMock.Verify(x => x.Publish(It.IsAny<INotification>()), Times.Never);
        eventAggregatorMock.Verify(x => x.PublishCancelable(It.IsAny<ICancelableNotification>()), Times.Never);
    }

    [Test]
    public void SpecifyingNotificationPublishInInnerScopeCausesError()
    {
        var notificationPublisherMock = new Mock<IScopedNotificationPublisher>();
        var scopeProvider = GetScopeProvider(out var eventAggregatorMock);

        using (var scope = scopeProvider.CreateScope())
        {
            Assert.Throws<ArgumentException>(() =>
                scopeProvider.CreateScope(notificationPublisher: notificationPublisherMock.Object));
        }
    }

    private ScopeProvider GetScopeProvider(out Mock<IEventAggregator> eventAggregatorMock)
    {
        var loggerFactory = NullLoggerFactory.Instance;

        var fileSystems = new FileSystems(
            loggerFactory,
            Mock.Of<IIOHelper>(),
            Options.Create(new GlobalSettings()),
            Mock.Of<IHostingEnvironment>());

        var mediaFileManager = new MediaFileManager(
            Mock.Of<IFileSystem>(),
            Mock.Of<IMediaPathScheme>(),
            loggerFactory.CreateLogger<MediaFileManager>(),
            Mock.Of<IShortStringHelper>(),
            Mock.Of<IServiceProvider>());

        eventAggregatorMock = new Mock<IEventAggregator>();

        return new ScopeProvider(
            new AmbientScopeStack(),
                new AmbientScopeContextStack(),Mock.Of<IDistributedLockingMechanismFactory>(),
            Mock.Of<IUmbracoDatabaseFactory>(),
            fileSystems,
            new TestOptionsMonitor<CoreDebugSettings>(new CoreDebugSettings()),
            mediaFileManager,
            loggerFactory,

            eventAggregatorMock.Object);
    }
}