Consolidate module sample into one, and add reconnection logic (#151)

* samples(iot-device): Consolidate module sample into one, and add reconnection logic
Azure-Samples · Oct 6, 2020 · b757af5 · b757af5
1 parent c86bbff
commit b757af5
Show file tree

Hide file tree

Showing 27 changed files with 715 additions and 322 deletions.
diff --git a/...ctionSample/Logging/ColorConsoleLogger.cs → .../ColorConsoleLogger/ColorConsoleLogger.cs b/...ctionSample/Logging/ColorConsoleLogger.cs → .../ColorConsoleLogger/ColorConsoleLogger.cs
@@ -6,7 +6,7 @@
 using System.Globalization;
 using System.Linq;
 
-namespace Microsoft.Azure.Devices.Client.Samples
+namespace Microsoft.Azure.Devices.Logging
 {
     /// <summary>
     /// The ILogger implementation for writing color log entries to console.
@@ -19,7 +19,6 @@ public class ColorConsoleLogger : ILogger
         /// <summary>
         /// Initializes an instance of <see cref="ColorConsoleLogger"/>.
         /// </summary>
-        /// <param name="name">The category name for each <see cref="ILogger"/> instance. This is usually the class name where the logger is initialized.</param>
         /// <param name="config">The <see cref="ColorConsoleLoggerConfiguration"/> settings to be used for logging.</param>
         public ColorConsoleLogger(ColorConsoleLoggerConfiguration config)
         {
@@ -64,7 +63,7 @@ public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Except
             var color = _config.LogLevelToColorMapping[logLevel];
             if (_config.EventIds.Contains(ColorConsoleLoggerConfiguration.DefaultEventId) || _config.EventIds.Contains(eventId.Id))
             {
-                var initialColor = Console.ForegroundColor;
+                ConsoleColor initialColor = Console.ForegroundColor;
 
                 Console.ForegroundColor = ConsoleColor.Green;
                 Console.Write($"{DateTime.Now.ToString("yyyy-MM-ddTHH:mm:ss.fffffff", CultureInfo.InvariantCulture)}>> ");

diff --git a/helpers/ColorConsoleLogger/ColorConsoleLogger.csproj b/helpers/ColorConsoleLogger/ColorConsoleLogger.csproj
@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="3.1.8" />
+  </ItemGroup>
+
+</Project>
diff --git a/...ogging/ColorConsoleLoggerConfiguration.cs → ...Logger/ColorConsoleLoggerConfiguration.cs b/...ogging/ColorConsoleLoggerConfiguration.cs → ...Logger/ColorConsoleLoggerConfiguration.cs
@@ -5,7 +5,7 @@
 using System;
 using System.Collections.Generic;
 
-namespace Microsoft.Azure.Devices.Client.Samples
+namespace Microsoft.Azure.Devices.Logging
 {
     /// <summary>
     /// A color console logger configuration that creates different color console entries per log level, sets the default log level to Information and logs all events.

diff --git a/...e/Logging/ColorConsoleLoggerExtensions.cs → ...oleLogger/ColorConsoleLoggerExtensions.cs b/...e/Logging/ColorConsoleLoggerExtensions.cs → ...oleLogger/ColorConsoleLoggerExtensions.cs
@@ -3,7 +3,7 @@
 
 using Microsoft.Extensions.Logging;
 
-namespace Microsoft.Azure.Devices.Client.Samples
+namespace Microsoft.Azure.Devices.Logging
 {
     /// <summary>
     /// Extension methods to help simplify creation of a new <see cref="ColorConsoleLoggerProvider"/> instance.

diff --git a/...ple/Logging/ColorConsoleLoggerProvider.cs → ...nsoleLogger/ColorConsoleLoggerProvider.cs b/...ple/Logging/ColorConsoleLoggerProvider.cs → ...nsoleLogger/ColorConsoleLoggerProvider.cs
@@ -4,7 +4,7 @@
 using Microsoft.Extensions.Logging;
 using System.Collections.Concurrent;
 
-namespace Microsoft.Azure.Devices.Client.Samples
+namespace Microsoft.Azure.Devices.Logging
 {
     /// <summary>
     /// The <see cref="ILoggerProvider"/> implementation that creates the <see cref="ColorConsoleLogger"/> instance.

diff --git a/...ionSample/Logging/ConsoleEventListener.cs → ...olorConsoleLogger/ConsoleEventListener.cs b/...ionSample/Logging/ConsoleEventListener.cs → ...olorConsoleLogger/ConsoleEventListener.cs
@@ -2,9 +2,11 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using Microsoft.Extensions.Logging;
+using System;
+using System.Diagnostics.Tracing;
 using System.Linq;
 
-namespace System.Diagnostics.Tracing
+namespace Microsoft.Azure.Devices.Logging
 {
     /// <summary>
     /// Prints SDK events to Console output - the log level is set to TRACE

diff --git a/iot-hub/Samples/device/DeviceReconnectionSample/DeviceReconnectionSample.csproj b/iot-hub/Samples/device/DeviceReconnectionSample/DeviceReconnectionSample.csproj
@@ -10,7 +10,10 @@
   <ItemGroup>
     <PackageReference Include="CommandLineParser" Version="2.8.0" />
     <PackageReference Include="Microsoft.Azure.Devices.Client" Version="1.31.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="3.1.8" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\helpers\ColorConsoleLogger\ColorConsoleLogger.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/iot-hub/Samples/device/DeviceReconnectionSample/Program.cs b/iot-hub/Samples/device/DeviceReconnectionSample/Program.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using CommandLine;
+using Microsoft.Azure.Devices.Logging;
 using Microsoft.Extensions.Logging;
 using System;
 using System.Diagnostics.Tracing;
@@ -41,7 +42,7 @@ public static async Task<int> Main(string[] args)
             var logger = loggerFactory.CreateLogger<Program>();
 
             const string SdkEventProviderPrefix = "Microsoft-Azure-";
-            // Instantiating this seems to do all we need for outputing SDK events to our console log
+            // Instantiating this seems to do all we need for outputting SDK events to our console log
             _ = new ConsoleEventListener(SdkEventProviderPrefix, logger);
 
             // Run the sample

diff --git a/iot-hub/Samples/device/IoTHubDeviceSamples.sln b/iot-hub/Samples/device/IoTHubDeviceSamples.sln
@@ -23,6 +23,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Thermostat", "PnpDeviceSamp
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PnpHelpers", "PnpDeviceSamples\PnpConvention\PnpHelpers.csproj", "{DCFC3AF8-5E7D-4ADD-A08E-D50B3768564F}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ColorConsoleLogger", "..\..\..\helpers\ColorConsoleLogger\ColorConsoleLogger.csproj", "{0819BE3F-DC5D-4E0E-B415-DEAFC10B1A90}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -65,6 +67,10 @@ Global
 		{DCFC3AF8-5E7D-4ADD-A08E-D50B3768564F}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{DCFC3AF8-5E7D-4ADD-A08E-D50B3768564F}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{DCFC3AF8-5E7D-4ADD-A08E-D50B3768564F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{0819BE3F-DC5D-4E0E-B415-DEAFC10B1A90}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{0819BE3F-DC5D-4E0E-B415-DEAFC10B1A90}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{0819BE3F-DC5D-4E0E-B415-DEAFC10B1A90}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{0819BE3F-DC5D-4E0E-B415-DEAFC10B1A90}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/iot-hub/Samples/module/IoTHubModuleSamples.sln b/iot-hub/Samples/module/IoTHubModuleSamples.sln
@@ -1,11 +1,11 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.26124.0
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.30523.141
 MinimumVisualStudioVersion = 15.0.26124.0
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ModuleClientMqttSample", "MessageSample\ModuleClientMqttSample.csproj", "{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ModuleSample", "ModuleSample\ModuleSample.csproj", "{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TwinSample", "TwinSample\TwinSample.csproj", "{934E4549-321F-4811-A36F-AA2489014008}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ColorConsoleLogger", "..\..\..\helpers\ColorConsoleLogger\ColorConsoleLogger.csproj", "{52140ADA-52E1-4C10-82BE-18AF86E02AC9}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -17,30 +17,30 @@ Global
 		Release|x86 = Release|x86
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Debug|x64.Build.0 = Debug|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Debug|x86.Build.0 = Debug|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Release|Any CPU.Build.0 = Release|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Release|x64.ActiveCfg = Release|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Release|x64.Build.0 = Release|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Release|x86.ActiveCfg = Release|Any CPU
-		{80EECD5A-E88A-4D18-B508-CFF6E8DB6A16}.Release|x86.Build.0 = Release|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Debug|x64.ActiveCfg = Debug|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Debug|x64.Build.0 = Debug|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Debug|x86.ActiveCfg = Debug|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Debug|x86.Build.0 = Debug|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Release|Any CPU.Build.0 = Release|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Release|x64.ActiveCfg = Release|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Release|x64.Build.0 = Release|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Release|x86.ActiveCfg = Release|Any CPU
-		{934E4549-321F-4811-A36F-AA2489014008}.Release|x86.Build.0 = Release|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Debug|x64.Build.0 = Debug|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Debug|x86.Build.0 = Debug|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Release|Any CPU.Build.0 = Release|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Release|x64.ActiveCfg = Release|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Release|x64.Build.0 = Release|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Release|x86.ActiveCfg = Release|Any CPU
+		{4AF90C42-AD0A-4BB0-BFB6-CDD894A43252}.Release|x86.Build.0 = Release|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Debug|x64.Build.0 = Debug|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Debug|x86.Build.0 = Debug|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Release|x64.ActiveCfg = Release|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Release|x64.Build.0 = Release|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Release|x86.ActiveCfg = Release|Any CPU
+		{52140ADA-52E1-4C10-82BE-18AF86E02AC9}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/iot-hub/Samples/module/MessageSample/.vscode/launch.json b/iot-hub/Samples/module/MessageSample/.vscode/launch.json
diff --git a/iot-hub/Samples/module/MessageSample/.vscode/tasks.json b/iot-hub/Samples/module/MessageSample/.vscode/tasks.json
diff --git a/iot-hub/Samples/module/MessageSample/MessageSample.cs b/iot-hub/Samples/module/MessageSample/MessageSample.cs
diff --git a/iot-hub/Samples/module/MessageSample/ModuleClientMqttSample.csproj b/iot-hub/Samples/module/MessageSample/ModuleClientMqttSample.csproj
diff --git a/iot-hub/Samples/module/MessageSample/Program.cs b/iot-hub/Samples/module/MessageSample/Program.cs
diff --git a/iot-hub/Samples/module/MessageSample/Properties/launchSettings.json.template b/iot-hub/Samples/module/MessageSample/Properties/launchSettings.json.template