Update unit test GenerateModulesContentShouldReturnValue (#1360)

Update unit tests on ConfigHelper Add info link on how to configure a container create options Add container create options on create/edit edge module #1170 Co-authored-by: Hocine Hacherouf <hacherouf.hocine@gmail.com>
CGI-FR · Oct 16, 2022 · de5ef92 · de5ef92
1 parent 18aaf95
commit de5ef92
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 8 deletions.
diff --git a/src/AzureIoTHub.Portal.Tests.Unit/Server/Helpers/ConfigHelperTest.cs b/src/AzureIoTHub.Portal.Tests.Unit/Server/Helpers/ConfigHelperTest.cs
@@ -88,13 +88,16 @@ public void CreateGatewayModuleShouldReturnValue()
             // Arrange
             var config = new Configuration("config_test");
 
+            var expectedContainerCreateOptions = /*lang=json,strict*/ "{\"HostConfig\":{\"PortBindings\":{\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}],\"443/tcp\":[{\"HostPort\":\"443\"}]}}}";
+
             var jPropModule = new Dictionary<string, object>()
             {
                 { "status", "running" },
                 { "version", "1.0" },
                 { "settings", new Dictionary<string, object>()
                     {
-                        { "image", "image_test" }
+                        { "image", "image_test" },
+                        { "createOptions", expectedContainerCreateOptions }
                     }
                 },
                 { "env", new Dictionary<string, object>()
@@ -118,6 +121,7 @@ public void CreateGatewayModuleShouldReturnValue()
             Assert.IsNotNull(result);
             Assert.AreEqual("running", result.Status);
             Assert.AreEqual("image_test", result.ImageURI);
+            Assert.AreEqual(expectedContainerCreateOptions, result.ContainerCreateOptions);
             Assert.AreEqual(1, result.EnvironmentVariables.Count);
         }
 
@@ -151,21 +155,26 @@ public void CreateGatewayModuleWithNullModuleShouldThrowException()
         public void GenerateModulesContentShouldReturnValue()
         {
             // Arrange
+            var expectedModuleName = "ModuleTest";
+            var expectedContainerCreateOptions = /*lang=json,strict*/
+                "{\"HostConfig\":{\"PortBindings\":{\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}],\"443/tcp\":[{\"HostPort\":\"443\"}]}}}";
+
             var edgeModel = new IoTEdgeModel()
             {
                 ModelId = Guid.NewGuid().ToString(),
                 Name = "Model test",
                 Description = "Description Test",
                 EdgeModules = new List<IoTEdgeModule>()
                 {
-                    new IoTEdgeModule()
+                    new()
                     {
-                        ModuleName = "ModuleTest",
+                        ModuleName = expectedModuleName,
                         Status = "running",
                         ImageURI = "image",
+                        ContainerCreateOptions = expectedContainerCreateOptions,
                         EnvironmentVariables = new List<IoTEdgeModuleEnvironmentVariable>()
                         {
-                            new IoTEdgeModuleEnvironmentVariable(){ Name = "envTest01", Value = "test" }
+                            new() { Name = "envTest01", Value = "test" }
                         },
                         ModuleIdentityTwinSettings = new List<IoTEdgeModuleTwinSetting>()
                     }
@@ -179,6 +188,9 @@ public void GenerateModulesContentShouldReturnValue()
             Assert.IsNotNull(result);
             Assert.IsAssignableFrom<Dictionary<string, IDictionary<string, object>>>(result);
             Assert.AreEqual(2, result.Count);
+            var edgeHubPropertiesDesired = (EdgeAgentPropertiesDesired)result["$edgeAgent"]["properties.desired"];
+            _ = edgeHubPropertiesDesired.Modules[expectedModuleName].Settings.CreateOptions.Should()
+                .Be(expectedContainerCreateOptions);
         }
 
         [Test]

diff --git a/src/AzureIoTHub.Portal/Client/Pages/EdgeModels/EdgeModule/ModuleDialog.razor b/src/AzureIoTHub.Portal/Client/Pages/EdgeModels/EdgeModule/ModuleDialog.razor
@@ -1,8 +1,5 @@
 @using AzureIoTHub.Portal.Models.v10
 @using AzureIoTHub.Portal.Shared.Models.v10
-@inject HttpClient Http
-@inject IJSRuntime JS
-@inject ISnackbar Snackbar
 
 <MudDialog ContentStyle="overflow:auto;max-height:600px;">
     <DialogContent >
@@ -23,6 +20,16 @@
                               For="@(()=> Module.ImageURI)"
                               Required="true" />
             </MudItem>
+            <MudItem xs="12">
+                <MudTextField @bind-Value="@currentContainerCreateOptions"
+                              id=@nameof(IoTEdgeModule.ContainerCreateOptions)
+                              Label="Container Create Options"
+                              Variant="Variant.Outlined"
+                              For="@(()=> Module.ContainerCreateOptions)" />
+            </MudItem>
+            <MudItem xs="12">
+                <MudAlert Severity="Severity.Info"><MudLink Href="https://learn.microsoft.com/en-us/azure/iot-edge/how-to-use-create-options" Target="_blank ">How to configure container create options for IoT Edge modules</MudLink></MudAlert>
+            </MudItem>
         </MudGrid>
 
         <MudTabs Elevation="1" Class="mt-10" Rounded="true" PanelClass="mt-6 scrollable-tab-content">
@@ -55,6 +62,7 @@
 
     private string currentModuleName;
     private string currentImageUri;
+    private string currentContainerCreateOptions;
 
     private List<IoTEdgeModuleEnvironmentVariable> currentEnvironmentVariables = new();
     private List<IoTEdgeModuleTwinSetting> currentModuleIdentityTwinSettings = new();
@@ -69,6 +77,7 @@
 
         currentModuleName = Module.ModuleName;
         currentImageUri = Module.ImageURI;
+        currentContainerCreateOptions = Module.ContainerCreateOptions;
         currentEnvironmentVariables = new List<IoTEdgeModuleEnvironmentVariable>(Module.EnvironmentVariables.ToArray());
         currentModuleIdentityTwinSettings = new List<IoTEdgeModuleTwinSetting>(Module.ModuleIdentityTwinSettings.ToArray());
         currentCommands = new List<IoTEdgeModuleCommand>(Module.Commands.ToArray());
@@ -80,6 +89,7 @@
     {
         Module.ModuleName = currentModuleName;
         Module.ImageURI = currentImageUri;
+        Module.ContainerCreateOptions = currentContainerCreateOptions;
         Module.EnvironmentVariables = new List<IoTEdgeModuleEnvironmentVariable>(currentEnvironmentVariables.ToArray());
         Module.ModuleIdentityTwinSettings = new List<IoTEdgeModuleTwinSetting>(currentModuleIdentityTwinSettings.ToArray());
         Module.Commands = new List<IoTEdgeModuleCommand>(currentCommands.ToArray());

diff --git a/src/AzureIoTHub.Portal/Server/Helpers/ConfigHelper.cs b/src/AzureIoTHub.Portal/Server/Helpers/ConfigHelper.cs
@@ -149,6 +149,7 @@ public static IoTEdgeModule CreateGatewayModule(Configuration config, JProperty
             {
                 ModuleName = module.Name,
                 ImageURI = module.Value["settings"]["image"]?.Value<string>(),
+                ContainerCreateOptions = module.Value["settings"]["createOptions"]?.Value<string>(),
                 Status = module.Value["status"]?.Value<string>(),
             };
 
@@ -248,7 +249,8 @@ public static Dictionary<string, IDictionary<string, object>> GenerateModulesCon
                     Status = "running",
                     Settings = new ModuleSettings()
                     {
-                        Image = module.ImageURI
+                        Image = module.ImageURI,
+                        CreateOptions = module.ContainerCreateOptions
                     },
                     RestartPolicy = "always",
                     EnvironmentVariables = new Dictionary<string, EnvironmentVariable>()

diff --git a/src/AzureIoTHub.Portal/Shared/Models/v1.0/IoTEdgeModule.cs b/src/AzureIoTHub.Portal/Shared/Models/v1.0/IoTEdgeModule.cs
@@ -24,6 +24,8 @@ public class IoTEdgeModule
         [Required(ErrorMessage = "The device image uri is required.")]
         public string ImageURI { get; set; }
 
+        public string ContainerCreateOptions { get; set; }
+
         /// <summary>
         /// The module status.
         /// </summary>