Skip to content

Commit

Permalink
component property e2e tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@abhipsaMisra
abhipsaMisra committed Jun 4, 2021
1 parent af885fc commit a8dded2
Show file tree
Hide file tree
Showing 4 changed files with 289 additions and 282 deletions.
203 changes: 108 additions & 95 deletions e2e/test/Helpers/TestDeviceCallbackHandler.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System;
using System.Linq;
using System.Runtime.ExceptionServices;
using System.Text;
using System.Threading;
Expand Down Expand Up @@ -60,31 +59,34 @@ public object ExpectedClientPropertyValue

public async Task SetDeviceReceiveMethodAsync(string methodName, string deviceResponseJson, string expectedServiceRequestJson)
{
await _deviceClient.SetMethodHandlerAsync(methodName,
(request, context) =>
{
try
await _deviceClient
.SetMethodHandlerAsync(
methodName,
(request, context) =>
{
_logger.Trace($"{nameof(SetDeviceReceiveMethodAsync)}: DeviceClient {_testDevice.Id} callback method: {request.Name} {request.ResponseTimeout}.");
request.Name.Should().Be(methodName, "The expected method name should match what was sent from service");
request.DataAsJson.Should().Be(expectedServiceRequestJson, "The expected method data should match what was sent from service");

return Task.FromResult(new MethodResponse(Encoding.UTF8.GetBytes(deviceResponseJson), 200));
}
catch (Exception ex)
{
_logger.Trace($"{nameof(SetDeviceReceiveMethodAsync)}: Error during DeviceClient callback method: {ex}.");

_methodExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
return Task.FromResult(new MethodResponse(500));
}
finally
{
// Always notify that we got the callback.
_methodCallbackSemaphore.Release();
}
},
null).ConfigureAwait(false);
try
{
_logger.Trace($"{nameof(SetDeviceReceiveMethodAsync)}: DeviceClient {_testDevice.Id} callback method: {request.Name} {request.ResponseTimeout}.");
request.Name.Should().Be(methodName, "The expected method name should match what was sent from service");
request.DataAsJson.Should().Be(expectedServiceRequestJson, "The expected method data should match what was sent from service");

return Task.FromResult(new MethodResponse(Encoding.UTF8.GetBytes(deviceResponseJson), 200));
}
catch (Exception ex)
{
_logger.Trace($"{nameof(SetDeviceReceiveMethodAsync)}: Error during DeviceClient callback method: {ex}.");

_methodExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
return Task.FromResult(new MethodResponse(500));
}
finally
{
// Always notify that we got the callback.
_methodCallbackSemaphore.Release();
}
},
null)
.ConfigureAwait(false);
}

public async Task WaitForMethodCallbackAsync(CancellationToken ct)
Expand All @@ -97,29 +99,32 @@ public async Task SetTwinPropertyUpdateCallbackHandlerAsync(string expectedPropN
{
string userContext = "myContext";

await _deviceClient.SetDesiredPropertyUpdateCallbackAsync(
(patch, context) =>
{
_logger.Trace($"{nameof(SetTwinPropertyUpdateCallbackHandlerAsync)}: DeviceClient {_testDevice.Id} callback twin: DesiredProperty: {patch}, {context}");

try
{
string propertyValue = patch[expectedPropName];
propertyValue.Should().Be(ExpectedTwinPropertyValue, "The property value should match what was set by service");
context.Should().Be(userContext, "The context should match what was set by service");
}
catch (Exception ex)
await _deviceClient
.SetDesiredPropertyUpdateCallbackAsync(
(patch, context) =>
{
_twinExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
}
finally
{
// Always notify that we got the callback.
_twinCallbackSemaphore.Release();
}

return Task.FromResult<bool>(true);
}, userContext).ConfigureAwait(false);
_logger.Trace($"{nameof(SetTwinPropertyUpdateCallbackHandlerAsync)}: DeviceClient {_testDevice.Id} callback twin: DesiredProperty: {patch}, {context}");

try
{
string propertyValue = patch[expectedPropName];
propertyValue.Should().Be(ExpectedTwinPropertyValue, "The property value should match what was set by service");
context.Should().Be(userContext, "The context should match what was set by service");
}
catch (Exception ex)
{
_twinExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
}
finally
{
// Always notify that we got the callback.
_twinCallbackSemaphore.Release();
}

return Task.FromResult<bool>(true);
},
userContext)
.ConfigureAwait(false);
}

public async Task WaitForTwinCallbackAsync(CancellationToken ct)
Expand All @@ -130,31 +135,33 @@ public async Task WaitForTwinCallbackAsync(CancellationToken ct)

public async Task SetMessageReceiveCallbackHandlerAsync()
{
await _deviceClient.SetReceiveMessageHandlerAsync(
async (receivedMessage, context) =>
{
_logger.Trace($"{nameof(SetMessageReceiveCallbackHandlerAsync)}: DeviceClient {_testDevice.Id} received message with Id: {receivedMessage.MessageId}.");

try
{
receivedMessage.MessageId.Should().Be(ExpectedMessageSentByService.MessageId, "Received message Id should match what was sent by service");
receivedMessage.UserId.Should().Be(ExpectedMessageSentByService.UserId, "Received user Id should match what was sent by service");

await CompleteMessageAsync(receivedMessage).ConfigureAwait(false);
_logger.Trace($"{nameof(SetMessageReceiveCallbackHandlerAsync)}: DeviceClient completed message with Id: {receivedMessage.MessageId}.");
}
catch (Exception ex)
{
_logger.Trace($"{nameof(SetMessageReceiveCallbackHandlerAsync)}: Error during DeviceClient receive message callback: {ex}.");
_receiveMessageExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
}
finally
await _deviceClient
.SetReceiveMessageHandlerAsync(
async (receivedMessage, context) =>
{
// Always notify that we got the callback.
_receivedMessageCallbackSemaphore.Release();
}
},
null).ConfigureAwait(false);
_logger.Trace($"{nameof(SetMessageReceiveCallbackHandlerAsync)}: DeviceClient {_testDevice.Id} received message with Id: {receivedMessage.MessageId}.");

try
{
receivedMessage.MessageId.Should().Be(ExpectedMessageSentByService.MessageId, "Received message Id should match what was sent by service");
receivedMessage.UserId.Should().Be(ExpectedMessageSentByService.UserId, "Received user Id should match what was sent by service");

await CompleteMessageAsync(receivedMessage).ConfigureAwait(false);
_logger.Trace($"{nameof(SetMessageReceiveCallbackHandlerAsync)}: DeviceClient completed message with Id: {receivedMessage.MessageId}.");
}
catch (Exception ex)
{
_logger.Trace($"{nameof(SetMessageReceiveCallbackHandlerAsync)}: Error during DeviceClient receive message callback: {ex}.");
_receiveMessageExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
}
finally
{
// Always notify that we got the callback.
_receivedMessageCallbackSemaphore.Release();
}
},
null)
.ConfigureAwait(false);
}

private async Task CompleteMessageAsync(Client.Message message)
Expand All @@ -168,34 +175,40 @@ public async Task WaitForReceiveMessageCallbackAsync(CancellationToken ct)
_receiveMessageExceptionDispatch?.Throw();
}

public async Task SetClientPropertyUpdateCallbackHandlerAsync<T>(string expectedPropName)
public async Task SetClientPropertyUpdateCallbackHandlerAsync<T>(string expectedPropName, string componentName = default)
{
string userContext = "myContext";

await _deviceClient.SubscribeToWritablePropertiesEventAsync(
(patch, context) =>
{
_logger.Trace($"{nameof(SetClientPropertyUpdateCallbackHandlerAsync)}: DeviceClient {_testDevice.Id} callback property: WritableProperty: {patch}, {context}");

try
{
bool isPropertyPresent = patch.TryGetValue(expectedPropName, out T propertyFromCollection);
isPropertyPresent.Should().BeTrue();
propertyFromCollection.Should().BeEquivalentTo((T)ExpectedClientPropertyValue);
context.Should().Be(userContext);
}
catch (Exception ex)
await _deviceClient
.SubscribeToWritablePropertiesEventAsync(
(patch, context) =>
{
_clientPropertyExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
}
finally
{
// Always notify that we got the callback.
_clientPropertyCallbackSemaphore.Release();
}

return Task.FromResult(true);
}, userContext).ConfigureAwait(false);
_logger.Trace($"{nameof(SetClientPropertyUpdateCallbackHandlerAsync)}: DeviceClient {_testDevice.Id} callback property: WritableProperty: {patch}, {context}");

try
{
bool isPropertyPresent = componentName == null
? patch.TryGetValue(expectedPropName, out T propertyFromCollection)
: patch.TryGetValue(componentName, expectedPropName, out propertyFromCollection);

isPropertyPresent.Should().BeTrue();
propertyFromCollection.Should().BeEquivalentTo((T)ExpectedClientPropertyValue);
context.Should().Be(userContext);
}
catch (Exception ex)
{
_clientPropertyExceptionDispatch = ExceptionDispatchInfo.Capture(ex);
}
finally
{
// Always notify that we got the callback.
_clientPropertyCallbackSemaphore.Release();
}

return Task.FromResult(true);
},
userContext)
.ConfigureAwait(false);
}

public async Task WaitForClientPropertyUpdateCallbcakAsync(CancellationToken ct)
Expand Down
5 changes: 2 additions & 3 deletions e2e/test/iothub/properties/PropertiesE2ETests.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,7 @@ await deviceClient
prop2Value.Should().Be(propValue);

// Sending a null value for a property will result in service removing the property from the client's twin representation.
// As a result, for the property patch sent here will result in propName2 being removed.
// For the property patch sent here will result in propName2 being removed.
await deviceClient
.UpdateClientPropertiesAsync(
new ClientPropertyCollection
Expand All @@ -396,8 +396,7 @@ await deviceClient
string serializedActualProperty = JsonConvert.SerializeObject(serviceTwin.Properties.Reported[propName1]);
serializedActualProperty.Should().Be(propEmptyValue);

// Sending a null value for a property will result in service removing the property from the client's twin representation.
// As a result, for the property patch sent here will result in propName1 being removed.
// For the property patch sent here will result in propName1 being removed.
await deviceClient
.UpdateClientPropertiesAsync(
new ClientPropertyCollection
Expand Down
Loading

0 comments on commit a8dded2

Please sign in to comment.