Umbraco-CMS/tests/Umbraco.Tests.UnitTests/Umbraco.Infrastructure/HostedServices/KeepAliveTests.cs

// Copyright (c) Umbraco.
// See LICENSE for more details.

using System;
using System.Net;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Moq;
using Moq.Protected;
using NUnit.Framework;
using Umbraco.Cms.Core.Configuration.Models;
using Umbraco.Cms.Core.Hosting;
using Umbraco.Cms.Core.Logging;
using Umbraco.Cms.Core.Runtime;
using Umbraco.Cms.Core.Scoping;
using Umbraco.Cms.Core.Sync;
using Umbraco.Cms.Infrastructure.HostedServices;

namespace Umbraco.Cms.Tests.UnitTests.Umbraco.Infrastructure.HostedServices
{
    [TestFixture]
    public class KeepAliveTests
    {
        private Mock<HttpMessageHandler> _mockHttpMessageHandler;

        private const string ApplicationUrl = "https://mysite.com";

        [Test]
        public async Task Does_Not_Execute_When_Not_Enabled()
        {
            KeepAlive sut = CreateKeepAlive(enabled: false);
            await sut.PerformExecuteAsync(null);
            VerifyKeepAliveRequestNotSent();
        }

        [Test]
        public async Task Does_Not_Execute_When_Server_Role_Is_Subscriber()
        {
            KeepAlive sut = CreateKeepAlive(serverRole: ServerRole.Subscriber);
            await sut.PerformExecuteAsync(null);
            VerifyKeepAliveRequestNotSent();
        }

        [Test]
        public async Task Does_Not_Execute_When_Server_Role_Is_Unknown()
        {
            KeepAlive sut = CreateKeepAlive(serverRole: ServerRole.Unknown);
            await sut.PerformExecuteAsync(null);
            VerifyKeepAliveRequestNotSent();
        }

        [Test]
        public async Task Does_Not_Execute_When_Not_Main_Dom()
        {
            KeepAlive sut = CreateKeepAlive(isMainDom: false);
            await sut.PerformExecuteAsync(null);
            VerifyKeepAliveRequestNotSent();
        }

        [Test]
        public async Task Executes_And_Calls_Ping_Url()
        {
            KeepAlive sut = CreateKeepAlive();
            await sut.PerformExecuteAsync(null);
            VerifyKeepAliveRequestSent();
        }

        private KeepAlive CreateKeepAlive(
            bool enabled = true,
            ServerRole serverRole = ServerRole.Single,
            bool isMainDom = true)
        {
            var settings = new KeepAliveSettings
            {
                DisableKeepAliveTask = !enabled,
            };

            var mockHostingEnvironment = new Mock<IHostingEnvironment>();
            mockHostingEnvironment.SetupGet(x => x.ApplicationMainUrl).Returns(new Uri(ApplicationUrl));
            mockHostingEnvironment.Setup(x => x.ToAbsolute(It.IsAny<string>()))
                .Returns((string s) => s.TrimStart('~'));

            var mockServerRegistrar = new Mock<IServerRoleAccessor>();
            mockServerRegistrar.Setup(x => x.CurrentServerRole).Returns(serverRole);

            var mockMainDom = new Mock<IMainDom>();
            mockMainDom.SetupGet(x => x.IsMainDom).Returns(isMainDom);

            var mockScopeProvider = new Mock<IScopeProvider>();
            var mockLogger = new Mock<ILogger<KeepAlive>>();
            var mockProfilingLogger = new Mock<IProfilingLogger>();

            _mockHttpMessageHandler = new Mock<HttpMessageHandler>();
            _mockHttpMessageHandler.Protected()
                .Setup<Task<HttpResponseMessage>>("SendAsync", ItExpr.IsAny<HttpRequestMessage>(), ItExpr.IsAny<CancellationToken>())
                .ReturnsAsync(new HttpResponseMessage(HttpStatusCode.OK))
                .Verifiable();
            _mockHttpMessageHandler.As<IDisposable>().Setup(s => s.Dispose());
            var httpClient = new HttpClient(_mockHttpMessageHandler.Object);

            var mockHttpClientFactory = new Mock<IHttpClientFactory>(MockBehavior.Strict);
            mockHttpClientFactory.Setup(x => x.CreateClient(It.IsAny<string>())).Returns(httpClient);

            return new KeepAlive(
                mockHostingEnvironment.Object,
                mockMainDom.Object,
                Options.Create(settings),
                mockLogger.Object,
                mockProfilingLogger.Object,
                mockServerRegistrar.Object,
                mockHttpClientFactory.Object);
        }

        private void VerifyKeepAliveRequestNotSent() => VerifyKeepAliveRequestSentTimes(Times.Never());

        private void VerifyKeepAliveRequestSent() => VerifyKeepAliveRequestSentTimes(Times.Once());

        private void VerifyKeepAliveRequestSentTimes(Times times) => _mockHttpMessageHandler.Protected()
            .Verify(
                "SendAsync",
                times,
                ItExpr.Is<HttpRequestMessage>(x => x.RequestUri.ToString() == $"{ApplicationUrl}/api/keepalive/ping"),
                ItExpr.IsAny<CancellationToken>());
    }
}