File: TelemetryTests\SenderTests.cs
Web Access
Project: ..\..\..\test\dotnet.Tests\dotnet.Tests.csproj (dotnet.Tests)
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
#nullable disable
 
using System.Net;
using System.Runtime.CompilerServices;
using Moq;
 
namespace Microsoft.DotNet.Cli.Telemetry.PersistenceChannel.Tests
{
    public class SenderTests : SdkTest
    {
        private int _deleteCount;
 
        private Mock<StorageTransmission> TransmissionMock { get; }
 
        private Mock<BaseStorageService> StorageBaseMock { get; }
 
        public SenderTests(ITestOutputHelper log) : base(log)
        {
            StorageBaseMock = new Mock<BaseStorageService>();
            TransmissionMock = new Mock<StorageTransmission>(string.Empty, new Uri("http://some/url"), new byte[] { },
                string.Empty, string.Empty);
            _deleteCount = 0;
            StorageBaseMock.Setup(storage => storage.Delete(It.IsAny<StorageTransmission>()))
                .Callback(() => _deleteCount++);
        }
 
        [Fact]
        public void WhenServerReturn503TransmissionWillBeRetried()
        {
            var Sender = GetSenderUnderTest();
            int peekCounts = 0;
 
            // Setup transmission.SendAsync() to throw WebException that has 503 status Code
            TransmissionMock.Setup(transmission => transmission.SendAsync())
                .Throws(GenerateWebException((HttpStatusCode)503));
 
            // Setup Storage.Peek() to return the mocked transmission, and stop the loop after 10 peeks.
            StorageBaseMock.Setup(storage => storage.Peek())
                .Returns(TransmissionMock.Object)
                .Callback(() =>
                {
                    if (peekCounts++ == 10)
                    {
                        Sender.StopAsync();
                    }
                });
 
            // Act 
            Sender.SendLoop();
            _deleteCount.Should().Be(0,
                "delete is not expected to be called on 503, request is expected to be send forever.");
        }
 
        [Fact]
        public void WhenServerReturn400IntervalWillBe10Seconds()
        {
            var Sender = GetSenderUnderTest();
            int peekCounts = 0;
 
            // Setup transmission.SendAsync() to throw WebException that has 400 status Code
            TransmissionMock.Setup(transmission => transmission.SendAsync())
                .Throws(GenerateWebException((HttpStatusCode)400));
 
            // Setup Storage.Peek() to return the mocked transmission, and stop the loop after 10 peeks.
            StorageBaseMock.Setup(storage => storage.Peek())
                .Returns(TransmissionMock.Object)
                .Callback(() =>
                {
                    if (peekCounts++ == 10)
                    {
                        Sender.StopAsync();
                    }
                });
 
            // Cache the interval (it is a parameter passed to the Send method).
            TimeSpan intervalOnSixIteration = TimeSpan.Zero;
            Sender.OnSend = interval => intervalOnSixIteration = interval;
 
            // Act 
            Sender.SendLoop();
 
            intervalOnSixIteration.TotalSeconds.Should().Be(5);
            _deleteCount.Should().Be(10, "400 should not be retried so delete should always be called.");
        }
 
        [Fact]
        public void DisposeDoesNotThrow()
        {
            new Sender(StorageBaseMock.Object,
                    new PersistenceTransmitter(
                        CreateStorageService(),
                        3))
                .Dispose();
        }
 
        [Fact]
        public void WhenServerReturnDnsErrorRequestWillBeRetried()
        {
            var Sender = GetSenderUnderTest();
            int peekCounts = 0;
 
            // Setup transmission.SendAsync() to throw WebException with ProxyNameResolutionFailure failure
            WebException webException = new(
                string.Empty,
                new Exception(),
                WebExceptionStatus.ProxyNameResolutionFailure,
                null);
            TransmissionMock.Setup(transmission => transmission.SendAsync()).Throws(webException);
 
            // Setup Storage.Peek() to return the mocked transmission, and stop the loop after 10 peeks.
            StorageBaseMock.Setup(storage => storage.Peek())
                .Returns(TransmissionMock.Object)
                .Callback(() =>
                {
                    if (peekCounts++ == 10)
                    {
                        Sender.StopAsync();
                    }
                });
 
            // Act 
            Sender.SendLoop();
 
            _deleteCount.Should().Be(0,
                "delete is not expected to be called on Dns errors since it , request is expected to be retried forever.");
        }
 
        private WebException GenerateWebException(HttpStatusCode httpStatusCode)
        {
            Mock<HttpWebResponse> httpWebResponse = new();
            httpWebResponse.SetupGet(webResponse => webResponse.StatusCode).Returns(httpStatusCode);
 
            WebException webException = new(string.Empty, new Exception(), WebExceptionStatus.SendFailure,
                httpWebResponse.Object);
 
            return webException;
        }
 
        /// <summary>
        ///     A class that inherits from Sender, to expose its protected methods.
        /// </summary>
        internal class SenderUnderTest : Sender
        {
            internal Action<TimeSpan> OnSend = nextSendInterval => { };
 
            internal SenderUnderTest(BaseStorageService storage, PersistenceTransmitter transmitter)
                : base(storage, transmitter, false)
            {
            }
 
            internal AutoResetEvent IntervalAutoResetEvent => DelayHandler;
 
            internal new void SendLoop()
            {
                base.SendLoop();
            }
 
            protected override bool Send(StorageTransmission transmission, ref TimeSpan nextSendInterval)
            {
                OnSend(nextSendInterval);
                DelayHandler.Set();
                return base.Send(transmission, ref nextSendInterval);
            }
        }
 
        private StorageService CreateStorageService([CallerMemberName] string testName = null)
        {
            string tempPath = Path.Combine(_testAssetsManager.CreateTestDirectory("TestStorageService", identifier: testName).Path, Path.GetTempFileName());
            StorageService storageService = new();
            storageService.Init(tempPath);
            return storageService;
        }
 
        private SenderUnderTest GetSenderUnderTest([CallerMemberName] string testName = null)
        {
            StorageService storageService = CreateStorageService(testName);
            PersistenceTransmitter transmitter = new(storageService, 0);
            return new SenderUnderTest(StorageBaseMock.Object, transmitter);
        }
    }
}