Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert RetryDelegatingHandlerTests to Moq #2929

Merged
merged 5 commits into from
Nov 3, 2022
Merged

Convert RetryDelegatingHandlerTests to Moq #2929

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f2b5897
Convert test to Moq
ngastelum-ms Oct 31, 2022
38c7e08
Convert RetryDelegatingHandlerTests to Moq
ngastelum-ms Nov 1, 2022
7917e0d
Remove NSubstitute
ngastelum-ms Nov 1, 2022
1f8e81c
Convert test to use FluentAssertions
ngastelum-ms Nov 2, 2022
6fe5432
Use fluent assertions checks in tests
ngastelum-ms Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 112 additions & 70 deletions iothub/device/tests/Pipeline/RetryDelegatingHandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
using Microsoft.Azure.Devices.Client.Transport;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using FluentAssertions;
using NSubstitute;
using Moq;

namespace Microsoft.Azure.Devices.Client.Test
Expand All @@ -29,21 +28,24 @@ public async Task RetryDelegatingHandler_OpenAsyncRetries()
int callCounter = 0;

var ct = CancellationToken.None;
PipelineContext contextMock = Substitute.For<PipelineContext>();
PipelineContext contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionStatusInfo) => { };
IDelegatingHandler nextHandlerMock = Substitute.For<IDelegatingHandler>();

var nextHandlerMock = new Mock<IDelegatingHandler>();

nextHandlerMock
.OpenAsync(ct)
.Returns(t =>
.Setup(x => x.OpenAsync(ct))
.Returns(() =>
{
return ++callCounter == 1
? throw new IotHubClientException("Test transient exception", isTransient: true)
: Task.CompletedTask;
});
nextHandlerMock.WaitForTransportClosedAsync().Returns(Task.Delay(TimeSpan.FromSeconds(10)));
nextHandlerMock
.Setup(x => x.WaitForTransportClosedAsync())
.Returns(() => Task.Delay(TimeSpan.FromSeconds(10)));

var retryDelegatingHandler = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var retryDelegatingHandler = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// act
await retryDelegatingHandler.OpenAsync(ct).ConfigureAwait(false);
Expand All @@ -58,14 +60,20 @@ public async Task RetryDelegatingHandler_SendTelemetryAsyncRetries()
// arrange
int callCounter = 0;

PipelineContext contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionStatusInfo) => { };
IDelegatingHandler nextHandlerMock = Substitute.For<IDelegatingHandler>();

var nextHandlerMock = new Mock<IDelegatingHandler>();
var message = new TelemetryMessage(new byte[] { 1, 2, 3 });
nextHandlerMock.OpenAsync(Arg.Any<CancellationToken>()).Returns(Task.CompletedTask);
IEnumerable<TelemetryMessage> messages = new[] { message };

nextHandlerMock
.SendTelemetryAsync(Arg.Is(message), Arg.Any<CancellationToken>())
.Returns(t =>
.Setup(x => x.OpenAsync(It.IsAny<CancellationToken>()))
.Returns(() => Task.CompletedTask);

nextHandlerMock
.Setup(x => x.SendTelemetryBatchAsync(messages, It.IsAny<CancellationToken>()))
.Returns(() =>
{
if (++callCounter == 1)
{
Expand All @@ -74,11 +82,11 @@ public async Task RetryDelegatingHandler_SendTelemetryAsyncRetries()
return Task.CompletedTask;
});

var retryDelegatingHandler = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var retryDelegatingHandler = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// act
await retryDelegatingHandler.OpenAsync(CancellationToken.None).ConfigureAwait(false);
await retryDelegatingHandler.SendTelemetryAsync(message, CancellationToken.None).ConfigureAwait(false);
await retryDelegatingHandler.SendTelemetryBatchAsync(messages, CancellationToken.None).ConfigureAwait(false);

// assert
callCounter.Should().Be(2);
Expand All @@ -98,7 +106,7 @@ public async Task RetryDelegatingHandler_DoesNotRetryOnNotSupportedException()

nextHandlerMock
.Setup(x => x.OpenAsync(It.IsAny<CancellationToken>()))
.Returns(Task.CompletedTask);
.Returns(() => Task.CompletedTask);

nextHandlerMock
.Setup(x => x.SendTelemetryAsync(message, It.IsAny<CancellationToken>()))
Expand All @@ -112,9 +120,10 @@ public async Task RetryDelegatingHandler_DoesNotRetryOnNotSupportedException()

// act and assert
await retryDelegatingHandler.OpenAsync(CancellationToken.None).ConfigureAwait(false);
var exception = await retryDelegatingHandler
.SendTelemetryAsync(message, CancellationToken.None)
.ExpectedAsync<NotSupportedException>()
Func<Task> telemetry = () => retryDelegatingHandler.SendTelemetryAsync(message, CancellationToken.None);

var exception = await telemetry.Should()
.ThrowAsync<NotSupportedException>()
.ConfigureAwait(false);
callCounter.Should().Be(1);
}
Expand All @@ -125,15 +134,18 @@ public async Task RetryOneMessageHasBeenTouchedTransientExceptionOccuredSuccess(
// arrange
int callCounter = 0;

var contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionStatusInfo) => { };
var nextHandlerMock = Substitute.For<IDelegatingHandler>();
var nextHandlerMock = new Mock<IDelegatingHandler>();
var message = new TelemetryMessage(new byte[] { 1, 2, 3 });
IEnumerable<TelemetryMessage> messages = new[] { message };
nextHandlerMock.OpenAsync(Arg.Any<CancellationToken>()).Returns(Task.CompletedTask);

nextHandlerMock
.SendTelemetryBatchAsync(Arg.Is(messages), Arg.Any<CancellationToken>())
.Returns(t =>
.Setup(x => x.OpenAsync(It.IsAny<CancellationToken>()))
.Returns(() => Task.CompletedTask);
nextHandlerMock
.Setup(x => x.SendTelemetryBatchAsync((IEnumerable<TelemetryMessage>)messages, It.IsAny<CancellationToken>()))
.Returns(() =>
{
if (++callCounter == 1)
{
Expand All @@ -142,7 +154,7 @@ public async Task RetryOneMessageHasBeenTouchedTransientExceptionOccuredSuccess(
return Task.CompletedTask;
});

var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// act
await sut.OpenAsync(CancellationToken.None).ConfigureAwait(false);
Expand All @@ -158,14 +170,18 @@ public async Task RetryMessageWithSeekableStreamHasBeenReadTransientExceptionOcc
// arrange
int callCounter = 0;

var contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionStatusInfo) => { };
var nextHandlerMock = Substitute.For<IDelegatingHandler>();
var nextHandlerMock = new Mock<IDelegatingHandler>();
var message = new TelemetryMessage(new byte[] { 1, 2, 3 });
nextHandlerMock.OpenAsync(Arg.Any<CancellationToken>()).Returns(Task.CompletedTask);
IEnumerable<TelemetryMessage> messages = new[] { message };

nextHandlerMock
.SendTelemetryAsync(Arg.Is(message), Arg.Any<CancellationToken>())
.Returns(t =>
.Setup(x => x.OpenAsync(It.IsAny<CancellationToken>()))
.Returns(() => Task.CompletedTask);
nextHandlerMock
.Setup(x => x.SendTelemetryBatchAsync(messages, It.IsAny<CancellationToken>()))
.Returns(() =>
{
if (++callCounter == 1)
{
Expand All @@ -174,11 +190,11 @@ public async Task RetryMessageWithSeekableStreamHasBeenReadTransientExceptionOcc
return Task.CompletedTask;
});

var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// act
await sut.OpenAsync(CancellationToken.None).ConfigureAwait(false);
await sut.SendTelemetryAsync(message, CancellationToken.None).ConfigureAwait(false);
await sut.SendTelemetryBatchAsync(messages, CancellationToken.None).ConfigureAwait(false);

// assert
callCounter.Should().Be(2);
Expand All @@ -190,12 +206,12 @@ public async Task RetryNonTransientErrorThrownThrows()
// arrange
int callCounter = 0;

var contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionStatusInfo) => { };
var nextHandlerMock = Substitute.For<IDelegatingHandler>();
var nextHandlerMock = new Mock<IDelegatingHandler>();
nextHandlerMock
.OpenAsync(CancellationToken.None)
.Returns(t =>
.Setup(x => x.OpenAsync(CancellationToken.None))
.Returns(() =>
{
if (++callCounter == 1)
{
Expand All @@ -204,10 +220,14 @@ public async Task RetryNonTransientErrorThrownThrows()
return Task.CompletedTask;
});

var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// arrange
await sut.OpenAsync(CancellationToken.None).ExpectedAsync<InvalidOperationException>().ConfigureAwait(false);
Func<Task> open = () => sut.OpenAsync(CancellationToken.None);

await open.Should()
.ThrowAsync<InvalidOperationException>()
.ConfigureAwait(false);

// act
callCounter.Should().Be(1);
Expand All @@ -217,10 +237,12 @@ public async Task RetryNonTransientErrorThrownThrows()
public async Task DeviceNotFoundExceptionReturnsDeviceDisabledStatus()
{
// arrange
var contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionInfo) => { };
var nextHandlerMock = Substitute.For<IDelegatingHandler>();
nextHandlerMock.OpenAsync(Arg.Any<CancellationToken>()).Returns(t => throw new IotHubClientException(IotHubClientErrorCode.DeviceNotFound));
var nextHandlerMock = new Mock<IDelegatingHandler>();
nextHandlerMock
.Setup(x => x.OpenAsync(It.IsAny<CancellationToken>()))
.Returns(() => throw new IotHubClientException(IotHubClientErrorCode.DeviceNotFound));

ConnectionStatusInfo connectionStatusInfo = new ConnectionStatusInfo();
Action<ConnectionStatusInfo> statusChangeHandler = (c) =>
Expand All @@ -230,16 +252,17 @@ public async Task DeviceNotFoundExceptionReturnsDeviceDisabledStatus()

contextMock.ConnectionStatusChangeHandler = statusChangeHandler;

var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// act and assert for exception type
var exception = await sut
.OpenAsync(CancellationToken.None)
.ExpectedAsync<IotHubClientException>()
Func<Task> open = () => sut.OpenAsync(CancellationToken.None);

var exception = await open.Should()
.ThrowAsync<IotHubClientException>()
.ConfigureAwait(false);

// assert for exception status code
exception.ErrorCode.Should().Be(IotHubClientErrorCode.DeviceNotFound);
exception.Which.ErrorCode.Should().Be(IotHubClientErrorCode.DeviceNotFound);

// assert for connection status
connectionStatusInfo.Status.Should().Be(ConnectionStatus.Disconnected);
Expand All @@ -251,14 +274,14 @@ public async Task OperationCanceledExceptionThrownAfterNumberOfRetriesThrows()
{
// arrange
using var cts = new CancellationTokenSource(100);
var contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionStatusInfo) => { };
var nextHandlerMock = Substitute.For<IDelegatingHandler>();
var nextHandlerMock = new Mock<IDelegatingHandler>();
nextHandlerMock
.OpenAsync(cts.Token)
.Returns(t => throw new IotHubClientException(TestExceptionMessage, isTransient: true));
.Setup(x => x.OpenAsync(cts.Token))
.Returns(() => throw new IotHubClientException(TestExceptionMessage, isTransient: true));

var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// act and assert
Func<Task> open = () => sut.OpenAsync(cts.Token);
Expand All @@ -272,36 +295,48 @@ public async Task OperationCanceledExceptionThrownAfterNumberOfRetriesThrows()
public async Task RetryCancellationTokenCanceledOpen()
{
// arrange
var contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionInfo) => { };
var nextHandlerMock = Substitute.For<IDelegatingHandler>();
using var cts = new CancellationTokenSource();
cts.Cancel();
nextHandlerMock.OpenAsync(Arg.Any<CancellationToken>()).Returns(Task.CompletedTask);
var nextHandlerMock = new Mock<IDelegatingHandler>();
var ct = new CancellationToken(true);
nextHandlerMock
.Setup(x => x.OpenAsync(It.IsAny<CancellationToken>()))
.Returns(() => Task.CompletedTask);

var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);

// act and assert
await sut.OpenAsync(cts.Token).ExpectedAsync<OperationCanceledException>().ConfigureAwait(false);
Func<Task> open = () => sut.OpenAsync(ct);

await open.Should()
.ThrowAsync<OperationCanceledException>()
.ConfigureAwait(false);
}

[TestMethod]
public async Task RetryCancellationTokenCanceledSendEvent()
{
// arrange
var contextMock = Substitute.For<PipelineContext>();
var contextMock = new PipelineContext();
contextMock.ConnectionStatusChangeHandler = (connectionInfo) => { };
var nextHandlerMock = Substitute.For<IDelegatingHandler>();
nextHandlerMock.OpenAsync(Arg.Any<CancellationToken>()).Returns(Task.CompletedTask);
nextHandlerMock.SendTelemetryAsync((TelemetryMessage)null, CancellationToken.None).ReturnsForAnyArgs(Task.CompletedTask);
var nextHandlerMock = new Mock<IDelegatingHandler>();
nextHandlerMock
.Setup(x => x.OpenAsync(It.IsAny<CancellationToken>()))
.Returns(() => Task.CompletedTask);
nextHandlerMock
.Setup(x => x.SendTelemetryBatchAsync(null, CancellationToken.None))
.Returns(() => Task.CompletedTask);

var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock);
var sut = new RetryDelegatingHandler(contextMock, nextHandlerMock.Object);
await sut.OpenAsync(CancellationToken.None).ConfigureAwait(false);
using var cts = new CancellationTokenSource();
cts.Cancel();
var ct = new CancellationToken(true);

// act and assert
await sut.SendTelemetryAsync(Arg.Any<TelemetryMessage>(), cts.Token).ExpectedAsync<OperationCanceledException>().ConfigureAwait(false);
Func<Task> sendTelemetry = () => sut.SendTelemetryAsync(It.IsAny<TelemetryMessage>(), ct);

var result = await sendTelemetry
.Should().ThrowAsync<OperationCanceledException>()
.ConfigureAwait(false);
}

[TestMethod]
Expand All @@ -325,7 +360,12 @@ public async Task RetryCancellationTokenCanceledSendEventWithIEnumMessage()
var telemetry = new List<TelemetryMessage>(0);

// act and assert
await sut.SendTelemetryBatchAsync(telemetry, ct).ExpectedAsync<OperationCanceledException>().ConfigureAwait(false);
Func<Task> sendTelemetry = () => sut.SendTelemetryBatchAsync(telemetry, ct);

var result = await sendTelemetry
.Should().ThrowAsync<OperationCanceledException>()
.ConfigureAwait(false);

nextHandlerMock.Verify(
x => x.SendTelemetryBatchAsync(It.IsAny<IEnumerable<TelemetryMessage>>(), It.IsAny<CancellationToken>()),
Times.Never());
Expand Down Expand Up @@ -356,15 +396,17 @@ public async Task RetrySetRetryPolicyVerifyInternalsSuccess()
});

// act and assert
var exception = await sut.OpenAsync(CancellationToken.None).ExpectedAsync<IotHubClientException>().ConfigureAwait(false);
exception.ErrorCode.Should().Be(IotHubClientErrorCode.NetworkErrors);
Func<Task> open = () => sut.OpenAsync(CancellationToken.None);

var exception = await open.Should().ThrowAsync<IotHubClientException>().ConfigureAwait(false);
exception.Which.ErrorCode.Should().Be(IotHubClientErrorCode.NetworkErrors);
nextHandlerCallCounter.Should().Be(2);
retryPolicy.Counter.Should().Be(2);

sut.SetRetryPolicy(new IotHubClientNoRetry());

exception = await sut.OpenAsync(CancellationToken.None).ExpectedAsync<IotHubClientException>().ConfigureAwait(false);
exception.ErrorCode.Should().Be(IotHubClientErrorCode.NetworkErrors);
exception = await open.Should().ThrowAsync<IotHubClientException>().ConfigureAwait(false);
exception.Which.ErrorCode.Should().Be(IotHubClientErrorCode.NetworkErrors);
nextHandlerCallCounter.Should().Be(3);
retryPolicy.Counter.Should().Be(2);
}
Expand Down