Add unit tests for the save commands method #1139

CGI-FR · Sep 1, 2022 · 9d78bc7 · 9d78bc7
1 parent 80b08c1
commit 9d78bc7
Show file tree

Hide file tree

Showing 3 changed files with 146 additions and 15 deletions.
diff --git a/src/AzureIoTHub.Portal.Tests.Unit/Server/Services/EdgeModelServiceTest.cs b/src/AzureIoTHub.Portal.Tests.Unit/Server/Services/EdgeModelServiceTest.cs
@@ -3,28 +3,29 @@
 
 namespace AzureIoTHub.Portal.Tests.Unit.Server.Services
 {
-    using Azure;
-    using System.Collections.Generic;
     using System;
+    using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using System.Linq.Expressions;
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Azure;
     using Azure.Data.Tables;
+    using AzureIoTHub.Portal.Models.v10;
+    using AzureIoTHub.Portal.Server.Controllers.V10.LoRaWAN;
+    using AzureIoTHub.Portal.Server.Entities;
+    using AzureIoTHub.Portal.Server.Exceptions;
     using AzureIoTHub.Portal.Server.Factories;
     using AzureIoTHub.Portal.Server.Managers;
     using AzureIoTHub.Portal.Server.Mappers;
     using AzureIoTHub.Portal.Server.Services;
-    using Moq;
-    using NUnit.Framework;
-    using AzureIoTHub.Portal.Models.v10;
-    using System.Linq;
-    using System.Threading;
-    using System.Threading.Tasks;
-    using Microsoft.AspNetCore.Http;
-    using AzureIoTHub.Portal.Server.Controllers.V10.LoRaWAN;
-    using System.IO;
+    using AzureIoTHub.Portal.Shared.Models.v10;
     using FluentAssertions;
-    using AzureIoTHub.Portal.Server.Exceptions;
+    using Microsoft.AspNetCore.Http;
     using Microsoft.Azure.Devices;
-    using AzureIoTHub.Portal.Server.Entities;
-    using System.Linq.Expressions;
+    using Moq;
+    using NUnit.Framework;
 
     [TestFixture]
     public class EdgeModelServiceTest
@@ -721,6 +722,132 @@ public async Task UpdateEdgeModelAvatarShouldUpdateValue()
             this.mockRepository.VerifyAll();
         }
 
+        [Test]
+        public async Task SaveModuleCommandsShouldUpsertModuleCommandTemplates()
+        {
+            // Arrange
+            var edgeModelService = CreateEdgeModelService();
+
+            var modules = new List<IoTEdgeModule>()
+            {
+                new IoTEdgeModule
+                {
+                    ModuleName = "Test",
+                    Commands = new List<IoTEdgeModuleCommand>
+                    {
+                        new IoTEdgeModuleCommand
+                        {
+                            Name = "Command"
+                        }
+                    }
+                }
+            };
+
+            var iotEdgeModel = new IoTEdgeModel
+            {
+                ModelId = Guid.NewGuid().ToString(),
+                EdgeModules = modules,
+            };
+
+            var mockModuleCommandResponse = this.mockRepository.Create<Response>();
+
+            var mockModuleCommands = Pageable<EdgeModuleCommand>.FromPages(new[]
+            {
+                Page<EdgeModuleCommand>.FromValues(Array.Empty<EdgeModuleCommand>(), null, mockModuleCommandResponse.Object)
+            });
+
+            _ = this.mockEdgeModuleCommands.Setup(c => c.Query(
+                        It.IsAny<Expression<Func<EdgeModuleCommand, bool>>>(),
+                        It.IsAny<int?>(),
+                        It.IsAny<IEnumerable<string>>(),
+                        It.IsAny<CancellationToken>()))
+                    .Returns(mockModuleCommands);
+
+            _ = this.mockEdgeModuleCommands
+                   .Setup(c => c.UpsertEntity(
+                    It.Is<EdgeModuleCommand>(x => x.RowKey == "Test-Command" && x.PartitionKey == iotEdgeModel.ModelId),
+                    It.IsAny<TableUpdateMode>(),
+                    It.IsAny<CancellationToken>()))
+               .Returns((Response)null);
+
+            _ = this.mockTableClientFactory.Setup(c => c.GetEdgeModuleCommands())
+               .Returns(this.mockEdgeModuleCommands.Object);
+
+            // Act
+            await edgeModelService.SaveModuleCommands(iotEdgeModel);
+
+            // Assert
+            this.mockEdgeModuleCommands.Verify(c => c.UpsertEntity(It.IsAny<EdgeModuleCommand>(), TableUpdateMode.Merge, default), Times.Once);
+            this.mockTableClientFactory.Verify(c => c.GetEdgeModuleCommands(), Times.Exactly(2));
+            this.mockRepository.VerifyAll();
+        }
+
+        [Test]
+        public async Task SaveModuleCommandsShouldDeleteModuleCommandTemplates()
+        {
+            // Arrange
+            var edgeModelService = CreateEdgeModelService();
+
+            var modules = new List<IoTEdgeModule>()
+            {
+                new IoTEdgeModule
+                {
+                    ModuleName = "Test",
+                    Commands = new List<IoTEdgeModuleCommand>()
+                }
+            };
+
+            var iotEdgeModel = new IoTEdgeModel
+            {
+                ModelId = Guid.NewGuid().ToString(),
+                EdgeModules = modules,
+            };
+
+            var mockModuleCommandResponse = this.mockRepository.Create<Response>();
+
+            var mockModuleCommands = Pageable<EdgeModuleCommand>.FromPages(new[]
+            {
+                Page<EdgeModuleCommand>.FromValues(new EdgeModuleCommand[1]
+                {
+                    new EdgeModuleCommand
+                    {
+                        PartitionKey = iotEdgeModel.ModelId,
+                        RowKey = "Test-Command",
+                        Timestamp = DateTime.Now,
+                        Name = "Command",
+                    }
+                }, null, mockModuleCommandResponse.Object)
+            });
+
+            var mockResponse = this.mockRepository.Create<Response>();
+
+            _ = this.mockEdgeModuleCommands.Setup(c => c.Query(
+                        It.IsAny<Expression<Func<EdgeModuleCommand, bool>>>(),
+                        It.IsAny<int?>(),
+                        It.IsAny<IEnumerable<string>>(),
+                        It.IsAny<CancellationToken>()))
+                    .Returns(mockModuleCommands);
+
+            _ = this.mockEdgeModuleCommands
+                   .Setup(c => c.DeleteEntityAsync(
+                    It.IsAny<string>(),
+                    It.IsAny<string>(),
+                    It.IsAny<ETag>(),
+                    It.IsAny<CancellationToken>()))
+               .ReturnsAsync(mockResponse.Object);
+
+            _ = this.mockTableClientFactory.Setup(c => c.GetEdgeModuleCommands())
+               .Returns(this.mockEdgeModuleCommands.Object);
+
+            // Act
+            await edgeModelService.SaveModuleCommands(iotEdgeModel);
+
+            // Assert
+            this.mockEdgeModuleCommands.Verify(c => c.DeleteEntityAsync(It.IsAny<string>(), It.IsAny<string>(), default, default), Times.Once);
+            this.mockTableClientFactory.Verify(c => c.GetEdgeModuleCommands(), Times.Exactly(2));
+            this.mockRepository.VerifyAll();
+        }
+
         [Test]
         public void WhenGetEntityAsyncFailedUpdateEdgeModelAvatarShouldThrowInternalServerErrorException()
         {

diff --git a/src/AzureIoTHub.Portal/Server/Entities/EdgeModuleCommand.cs b/src/AzureIoTHub.Portal/Server/Entities/EdgeModuleCommand.cs
@@ -3,6 +3,9 @@
 
 namespace AzureIoTHub.Portal.Server.Entities
 {
+    /// <summary>
+    /// Represents an edge module command.
+    /// </summary>
     public class EdgeModuleCommand : EntityBase
     {
         /// <summary>

diff --git a/src/AzureIoTHub.Portal/Server/Services/EdgeModelService.cs b/src/AzureIoTHub.Portal/Server/Services/EdgeModelService.cs
@@ -318,7 +318,7 @@ private async Task SaveEntity(TableEntity entity, IoTEdgeModel deviceModelObject
         /// <param name="deviceModelObject">The device model object.</param>
         /// <returns></returns>
         /// <exception cref="InternalServerErrorException"></exception>
-        private async Task SaveModuleCommands(IoTEdgeModel deviceModelObject)
+        public async Task SaveModuleCommands(IoTEdgeModel deviceModelObject)
         {
             IEnumerable<EdgeModuleCommand> moduleCommands = deviceModelObject.EdgeModules
                 .SelectMany(x => x.Commands.Select(cmd => new EdgeModuleCommand
@@ -328,6 +328,7 @@ private async Task SaveModuleCommands(IoTEdgeModel deviceModelObject)
                     Timestamp = DateTime.Now,
                     Name = cmd.Name,
                 })).ToArray();
+
             try
             {
                 var existingCommands = this.tableClientFactory.GetEdgeModuleCommands()