Merge pull request #8 from fgheysels/frgh/feat/testable_configuration

fgheysels · web-flow · commit 337d9ad71269 · 2023-02-21T17:36:53.000+01:00
Add ModuleConfiguration factory method to easier test ModuleConfiguration implementations
diff --git a/src/Fg.IoTEdgeModule.Tests/Fg.IoTEdgeModule.Tests.csproj b/src/Fg.IoTEdgeModule.Tests/Fg.IoTEdgeModule.Tests.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>net6.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-
+      <LangVersion>Preview</LangVersion>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
diff --git a/src/Fg.IoTEdgeModule.Tests/ModuleConfigurationTests.cs b/src/Fg.IoTEdgeModule.Tests/ModuleConfigurationTests.cs
@@ -1,4 +1,3 @@
-using System.Security.Cryptography.X509Certificates;
 using Fg.IoTEdgeModule.Configuration;
 using Microsoft.Azure.Devices.Client;
 using Microsoft.Azure.Devices.Shared;
@@ -11,7 +10,7 @@ public class ModuleConfigurationTests : IClassFixture<EnvironmentFixture>
     {
         public ModuleConfigurationTests(EnvironmentFixture environmentFixture)
         {
-                
+
         }
 
         [Fact]
@@ -25,18 +24,35 @@ var config
             Assert.NotNull(config);
         }
 
+        [Fact]
+        public void CanInitializeConfiguration()
+        {
+            var desiredProperties = new TwinCollection("""{"SomeIntProperty":42, "SomeStringProperty": "stringvalue"}""");
+
+            var config = ModuleConfiguration.CreateFromTwin<TestModuleConfiguration>(desiredProperties, NullLogger.Instance);
+
+            Assert.Equal(42, config.SomeIntProperty);
+            Assert.Equal("stringvalue", config.SomeStringProperty);
+        }
+
         private class TestModuleConfiguration : ModuleConfiguration
         {
-           public TestModuleConfiguration(ILogger logger):base(logger){}
+            public TestModuleConfiguration(ILogger logger) : base(logger) { }
+
             protected override string ModuleName => "TestModule";
+           
+            public int SomeIntProperty { get; private set; }
+            public string SomeStringProperty { get; private set; }
+            
             protected override void InitializeFromTwin(TwinCollection desiredProperties)
             {
-                int x = desiredProperties.Count;
+                SomeIntProperty = desiredProperties["SomeIntProperty"];
+                SomeStringProperty = desiredProperties["SomeStringProperty"];
             }
 
             protected override void SetReportedProperties(TwinCollection reportedProperties)
             {
-             
+
             }
         }
     }
diff --git a/src/Fg.IoTEdgeModule/Configuration/ModuleConfiguration.cs b/src/Fg.IoTEdgeModule/Configuration/ModuleConfiguration.cs
@@ -44,6 +44,26 @@ public static async Task<TModuleConfiguration> CreateFromTwinAsync<TModuleConfig
             return config;
         }
 
+        /// <summary>
+        /// Instantiate a <paramref name="TModuleConfiguration"/> instance and populate the configuration properties
+        /// with values that are present in the <paramref name="desiredProperties"/> twin-collection.
+        /// </summary>
+        /// <remarks>Use this method for testing your <see cref="ModuleConfiguration"/> implementation.</remarks>
+        public static TModuleConfiguration CreateFromTwin<TModuleConfiguration>(TwinCollection desiredProperties, ILogger logger) where TModuleConfiguration : ModuleConfiguration
+        {
+            var config =
+                (TModuleConfiguration)Activator.CreateInstance(
+                    typeof(TModuleConfiguration),
+                    BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic,
+                    null,
+                    new object[] { logger },
+                    null);
+
+            config.InitializeFromTwin(desiredProperties);
+
+            return config;
+        }
+
         /// <summary>
         /// Reports the configuration settings via the Module Twin reported properties.
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-using System.Security.Cryptography.X509Certificates;`
`2`	`1`	`using Fg.IoTEdgeModule.Configuration;`
`3`	`2`	`using Microsoft.Azure.Devices.Client;`
`4`	`3`	`using Microsoft.Azure.Devices.Shared;`
`@@ -11,7 +10,7 @@ public class ModuleConfigurationTests : IClassFixture<EnvironmentFixture>`
`11`	`10`	`{`
`12`	`11`	`public ModuleConfigurationTests(EnvironmentFixture environmentFixture)`
`13`	`12`	`{`
`14`		`-`
	`13`	`+`
`15`	`14`	`}`
`16`	`15`
`17`	`16`	`[Fact]`
`@@ -25,18 +24,35 @@ var config`
`25`	`24`	`Assert.NotNull(config);`
`26`	`25`	`}`
`27`	`26`
	`27`	`+ [Fact]`
	`28`	`+ public void CanInitializeConfiguration()`
	`29`	`+ {`
	`30`	`+ var desiredProperties = new TwinCollection("""{"SomeIntProperty":42, "SomeStringProperty": "stringvalue"}""");`
	`31`	`+`
	`32`	`+ var config = ModuleConfiguration.CreateFromTwin<TestModuleConfiguration>(desiredProperties, NullLogger.Instance);`
	`33`	`+`
	`34`	`+ Assert.Equal(42, config.SomeIntProperty);`
	`35`	`+ Assert.Equal("stringvalue", config.SomeStringProperty);`
	`36`	`+ }`
	`37`	`+`
`28`	`38`	`private class TestModuleConfiguration : ModuleConfiguration`
`29`	`39`	`{`
`30`		`- public TestModuleConfiguration(ILogger logger):base(logger){}`
	`40`	`+ public TestModuleConfiguration(ILogger logger) : base(logger) { }`
	`41`	`+`
`31`	`42`	`protected override string ModuleName => "TestModule";`
	`43`	`+`
	`44`	`+ public int SomeIntProperty { get; private set; }`
	`45`	`+ public string SomeStringProperty { get; private set; }`
	`46`	`+`
`32`	`47`	`protected override void InitializeFromTwin(TwinCollection desiredProperties)`
`33`	`48`	`{`
`34`		`- int x = desiredProperties.Count;`
	`49`	`+ SomeIntProperty = desiredProperties["SomeIntProperty"];`
	`50`	`+ SomeStringProperty = desiredProperties["SomeStringProperty"];`
`35`	`51`	`}`
`36`	`52`
`37`	`53`	`protected override void SetReportedProperties(TwinCollection reportedProperties)`
`38`	`54`	`{`
`39`		`-`
	`55`	`+`
`40`	`56`	`}`
`41`	`57`	`}`
`42`	`58`	`}`