Merge pull request #131 from Azure-Samples/drwill/params

Sample using a command-line parser

Author: David R. Williamson

iot-hub/Samples/device/DeviceReconnectionSample/DeviceReconnectionSample.cs

@@ -45,7 +45,10 @@ public DeviceReconnectionSample(List<string> deviceConnectionStrings, TransportT
                 throw new ArgumentException("At least one connection string must be provided.", nameof(deviceConnectionStrings));
             }
             _deviceConnectionStrings = deviceConnectionStrings;
+            _logger.LogInformation($"Supplied with {_deviceConnectionStrings.Count} connection string(s).");
+
             _transportType = transportType;
+            _logger.LogInformation($"Using {_transportType} transport.");
 
             InitializeClient();
         }

iot-hub/Samples/device/DeviceReconnectionSample/DeviceReconnectionSample.csproj

@@ -1,14 +1,16 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.1</TargetFramework>
     <LangVersion>8.0</LangVersion>
+    <RootNamespace>Microsoft.Azure.Devices.Client.Samples</RootNamespace>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.Devices.Client" Version="1.27.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="3.1.5" />
+    <PackageReference Include="CommandLineParser" Version="2.8.0" />
+    <PackageReference Include="Microsoft.Azure.Devices.Client" Version="1.28.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="3.1.8" />
   </ItemGroup>
 
 </Project>

iot-hub/Samples/device/DeviceReconnectionSample/ExceptionExtensions.cs

@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Collections.ObjectModel;
 
 namespace Microsoft.Azure.Devices.Client.Samples
 {
@@ -14,22 +13,25 @@ internal static IEnumerable<Exception> Unwind(this Exception exception, bool unw
             while (exception != null)
             {
                 yield return exception;
+
                 if (!unwindAggregate)
                 {
                     exception = exception.InnerException;
                     continue;
                 }
-                ReadOnlyCollection<Exception> excepetions = (exception as AggregateException)?.InnerExceptions;
-                if (excepetions != null)
+
+                if (exception is AggregateException aggEx
+                    && aggEx.InnerExceptions != null)
                 {
-                    foreach (Exception ex in excepetions)
+                    foreach (Exception ex in aggEx.InnerExceptions)
                     {
                         foreach (Exception innerEx in ex.Unwind(true))
                         {
                             yield return innerEx;
                         }
                     }
                 }
+
                 exception = exception.InnerException;
             }
         }

…ReconnectionSample/ColorConsoleLogger.cs …tionSample/Logging/ColorConsoleLogger.csiot-hub/Samples/device/DeviceReconnectionSample/ColorConsoleLogger.cs renamed to iot-hub/Samples/device/DeviceReconnectionSample/Logging/ColorConsoleLogger.cs iot-hub/Samples/device/DeviceReconnectionSample/ColorConsoleLogger.cs renamed to iot-hub/Samples/device/DeviceReconnectionSample/Logging/ColorConsoleLogger.cs

@@ -10,6 +10,7 @@ namespace Microsoft.Azure.Devices.Client.Samples
 {
     /// <summary>
     /// The ILogger implementation for writing color log entries to console.
+    /// For additional details, see https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.ilogger?view=dotnet-plat-ext-3.1.
     /// </summary>
     public class ColorConsoleLogger : ILogger
     {

…ample/ColorConsoleLoggerConfiguration.cs …gging/ColorConsoleLoggerConfiguration.csiot-hub/Samples/device/DeviceReconnectionSample/ColorConsoleLoggerConfiguration.cs renamed to iot-hub/Samples/device/DeviceReconnectionSample/Logging/ColorConsoleLoggerConfiguration.cs iot-hub/Samples/device/DeviceReconnectionSample/ColorConsoleLoggerConfiguration.cs renamed to iot-hub/Samples/device/DeviceReconnectionSample/Logging/ColorConsoleLoggerConfiguration.cs

@@ -0,0 +1,48 @@
+using CommandLine;
+using System.Collections.Generic;
+
+namespace Microsoft.Azure.Devices.Client.Samples
+{
+    /// <summary>
+    /// Parameters for the application.
+    /// </summary>
+    internal class Parameters
+    {
+        [Option(
+            'p',
+            "PrimaryConnectionString",
+            Required = true,
+            HelpText = "The primary connection string for the device to simulate.")]
+        public string PrimaryConnectionString { get; set; }
+
+        [Option(
+            's',
+            "SecondaryConnectionString",
+            Required = false,
+            HelpText = "The secondary connection string for the device to simulate.")]
+        public string SecondaryConnectionString { get; set; }
+
+        [Option(
+            't',
+            "TransportType",
+            Default = TransportType.Mqtt,
+            Required = false,
+            HelpText = "The transport to use to communicate with the IoT Hub. Possible values include Mqtt, Mqtt_WebSocket_Only, Mqtt_Tcp_Only, Amqp, Amqp_WebSocket_Only, Amqp_Tcp_only, and Http1.")]
+        public TransportType TransportType { get; set; }
+
+        public List<string> GetConnectionStrings()
+        {
+            var cs = new List<string>(2)
+            {
+                PrimaryConnectionString,
+            };
+
+            if (!string.IsNullOrWhiteSpace(SecondaryConnectionString))
+            {
+                cs.Add(SecondaryConnectionString);
+            }
+
+            return cs;
+        }
+    }
+}

…onSample/ColorConsoleLoggerExtensions.cs …/Logging/ColorConsoleLoggerExtensions.csiot-hub/Samples/device/DeviceReconnectionSample/ColorConsoleLoggerExtensions.cs renamed to iot-hub/Samples/device/DeviceReconnectionSample/Logging/ColorConsoleLoggerExtensions.cs iot-hub/Samples/device/DeviceReconnectionSample/ColorConsoleLoggerExtensions.cs renamed to iot-hub/Samples/device/DeviceReconnectionSample/Logging/ColorConsoleLoggerExtensions.cs

@@ -1,43 +1,32 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using CommandLine;
 using Microsoft.Extensions.Logging;
 using System;
-using System.Collections.Generic;
 using System.Diagnostics.Tracing;
 using System.Threading.Tasks;
 
 namespace Microsoft.Azure.Devices.Client.Samples
 {
     public class Program
     {
-        // String containing Hostname, Device Id & Device Key in one of the following formats:
-        //  "HostName=<iothub_host_name>;DeviceId=<device_id>;SharedAccessKey=<device_key>"
-        //  "HostName=<iothub_host_name>;CredentialType=SharedAccessSignature;DeviceId=<device_id>;SharedAccessSignature=SharedAccessSignature sr=<iot_host>/devices/<device_id>&sig=<token>&se=<expiry_time>";
-
-        // For this sample either
-        // - pass this value as a command-prompt argument
-        // - set the IOTHUB_DEVICE_CONN_STRING environment variable 
-        // - create a launchSettings.json (see launchSettings.json.template) containing the variable
-        private static string s_deviceConnectionStringPrimary = Environment.GetEnvironmentVariable("IOTHUB_DEVICE_CONN_STRING");
-        private static string s_deviceConnectionStringSecondary = Environment.GetEnvironmentVariable("IOTHUB_DEVICE_CONN_STRING_SECONDARY");
-
-        // Specify one of the following transports used by DeviceClient to connect to IoT Hub.
-        //   Mqtt
-        //   Mqtt_WebSocket_Only
-        //   Mqtt_Tcp_Only
-        //   Amqp
-        //   Amqp_WebSocket_Only
-        //   Amqp_Tcp_only
-        //   Http1
-        private static readonly string s_transportType = Environment.GetEnvironmentVariable("IOTHUB_DEVICE_TRANSPORT_TYPE");
-
         public static async Task<int> Main(string[] args)
         {
-            // Create a console logger, that logs all events that are categorized at Debug level or higher.
-            // For additional details, see https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.ilogger?view=dotnet-plat-ext-3.1.
-            ILoggerFactory loggerFactory = new LoggerFactory();
+            // Parse application parameters
+            Parameters parameters = null;
+            ParserResult<Parameters> result = Parser.Default.ParseArguments<Parameters>(args)
+                .WithParsed(parsedParams =>
+                {
+                    parameters = parsedParams;
+                })
+                .WithNotParsed(errors =>
+                {
+                    Environment.Exit(1);
+                });
 
+            // Set up logging
+            ILoggerFactory loggerFactory = new LoggerFactory();
             loggerFactory.AddColorConsoleLogger(
                 new ColorConsoleLoggerConfiguration
                 {
@@ -49,46 +38,12 @@ public static async Task<int> Main(string[] args)
             // Instantiating this seems to do all we need for outputing SDK events to our console log
             _ = new ConsoleEventListener(SdkEventProviderPrefix, logger);
 
-            var connectionStrings = new List<string>(2);
-            if (string.IsNullOrEmpty(s_deviceConnectionStringPrimary) && args.Length > 0)
-            {
-                s_deviceConnectionStringPrimary = args[0];
-            }
-            connectionStrings.Add(s_deviceConnectionStringPrimary);
-
-            if (string.IsNullOrEmpty(s_deviceConnectionStringSecondary) && args.Length > 1)
-            {
-                s_deviceConnectionStringSecondary = args[1];
-            }
-            if (!string.IsNullOrWhiteSpace(s_deviceConnectionStringSecondary))
-            {
-                connectionStrings.Add(s_deviceConnectionStringSecondary);
-            }
-
-            var sample = new DeviceReconnectionSample(connectionStrings, GetTransportType(args), logger);
+            // Run the sample
+            var sample = new DeviceReconnectionSample(parameters.GetConnectionStrings(), parameters.TransportType, logger);
             await sample.RunSampleAsync();
 
             logger.LogInformation("Done.");
             return 0;
         }
-
-        private static TransportType GetTransportType(string[] args)
-        {
-            // Check environment variable for transport type
-            if (Enum.TryParse(s_transportType, true, out TransportType transportType))
-            {
-                return transportType;
-            }
-
-                // then check argument for transport type
-            if (args.Length > 2
-                && Enum.TryParse(args[2], true, out transportType))
-            {
-                return transportType;
-            }
-
-                    // otherwise default to MQTT
-            return TransportType.Mqtt;
-        }
     }
 }