update template to not valid cert in windows and rename edge config t… (#4)

* update template to not valid cert in windows and rename edge config to deployment.json
* upgrade to 1.0.0 for public
* update readme

Author: Summer

Microsoft.Azure.IoT.Edge.Module.nuspec

@@ -2,7 +2,7 @@
 <package>
     <metadata>
     <id>Microsoft.Azure.IoT.Edge.Module</id>
-    <version>0.9.0</version>
+    <version>1.0.0</version>
     <title>Azure IoT Edge Module</title>
     <authors>Microsoft</authors>
     <owners>microsoft, nugetazureiotedge</owners>

README.md

@@ -1,19 +1,14 @@
 # dotnet-template-azure-iot-edge-module
-> dotnet template to do scaffolding tool for azure iot edge module development.
+> dotnet template to do scaffolding for Azure IoT Edge module development.
 
-This ReadMe consists of two parts:
-- Guidance of how to install the dotnet template step by step
-- Containerize the the custom module to docker
-
-  The dotnet template sets up all necessary files for you to focus on module functionality programming.
-
-  After the coding part completed, following the steps in this part to leverage docker to containerize your module so that they can be deployed and monitored by the new features of Azure IoT Edge more straight forward.
+This README will introduce how to install the dotnet template and then create Azure IoT Edge module with the template step by step.
+The template will set up all necessary files for you to focus on functionality programming.
 
 ## Get Started
 
-Make sure you have [.NET Core SDK](https://www.microsoft.com/net/core#windowscmd) and [Nuget](https://www.nuget.org/) installed.
+Make sure you have [.Net Core 2.0 SDK](https://www.microsoft.com/net/download/core) installed.
 
-Run dotnet command to install the template:
+Run `dotnet` command to install the template:
 
 ```
 dotnet new -i Microsoft.Azure.IoT.Edge.Module
@@ -46,14 +41,13 @@ MVC ViewStart                                     viewstart
 
 Check out the template details:
 ```
-PS C:\Users\qisun\Desktop> dotnet new aziotedgemodule --help
+PS C:\> dotnet new aziotedgemodule --help
 Usage: new [options]
 
 Options:
   -h, --help          Displays help for this command.
   -l, --list          Lists templates containing the specified name. If no name is specified, lists all templates.
-  -n, --name          The name for the output being created. If no name is specified, the name of the current directory
-is used.
+  -n, --name          The name for the output being created. If no name is specified, the name of the current directory is used.
   -o, --output        Location to place the generated output.
   -i, --install       Installs a source or a template pack.
   -u, --uninstall     Uninstalls a source or a template pack.
@@ -65,61 +59,33 @@ is used.
 Azure IoT Edge Module (C#)
 Author: Summer Sun
 Options:
-  -s|--skipRestore
-                    bool - Optional
-                    Default: false
+  -t|--target
+                          all
+                          deploy
+                      Default: all
 
   -lx|--linux-x64
-                    bool - Optional
-                    Default: true
-```
-
-Now create the azure iot edge module by the template with name:
-
-```
-dotnet new aziotedgemodule -n <name>
-```
-
-We support multiple architectures, but currently only linux-x64 is ready. So it is set the default.
-
-## Containerize the custom module
-
-azure-iot-edge-module sets up the Azure IoT Edge Module development environment, generating all necessary files for you.
-
-To run the module in docker container, there are several steps to do.
+                      bool - Optional
+                      Default: true
 
-### Install docker
-Ubuntu
+  -wn|--windows-nano
+                      bool - Optional
+                      Default: true
 
-https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/
-
-Windows 10
-
-https://download.docker.com/win/stable/InstallDocker.msi
-
-MAC
-
-https://store.docker.com/editions/community/docker-ce-desktop-mac
-
-Now navigate to the generated module folder in the first place.
-
-### Setup azure resources
-
-If you have develop experience with Azure, you could skip this part and go ahead to next one.
-
-1. Create an active Azure account
-
-(If you don't have an account, you can create one [free account](http://azure.microsoft.com/pricing/free-trial/) in minutes.)
+  -s|--skipRestore
+                      bool - Optional
+                      Default: false
 
-2. Create an Azure IoT Hub
+```
 
-Reference [How to create an azure iot hub] (https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-create-through-portal) for step by step guidance.
+Parameter `-t` means you if want all Azure IoT Edge module files or just a deployment.json file.
 
-3. Create a device in azure iot hub
+Parameter `-lx` means you if want Dockerfile for linux-x64 or not. So does the `-wn` for windows-nano.
 
-Navigate to your iot hub in azure portal, find the **Device Explorer** to **Add** a device in the portal.
-Mark up the device connection string after creating completed.
+Parameter `-s` means if you want to skip the restore of packages referenced in module project.
 
-### Deploy the run the module
+Now create the Azure IoT Edge module by the template with name:
 
-TBD
+```
+dotnet new aziotedgemodule -n <your_module_name>
+```

content/dotnet-template-azure-iot-edge-module/CSharp/.template.config/template.json

@@ -19,10 +19,18 @@
         }
     ],
     "symbols": {
-        "skipRestore": {
+        "target": {
             "type": "parameter",
-            "datatype": "bool",
-            "defaultValue": "false"
+            "datatype": "choice",
+            "defaultValue": "all",
+            "choices": [
+                {
+                    "choice": "all"
+                },
+                {
+                    "choice": "deploy"
+                }
+            ]
         },
         "linux-x64": {
             "type": "parameter",
@@ -34,18 +42,10 @@
             "datatype": "bool",
             "defaultValue": "true"
         },
-        "target": {
+        "skipRestore": {
             "type": "parameter",
-            "datatype": "choice",
-            "defaultValue": "All",
-            "choices": [
-                {
-                    "choice": "All"
-                },
-                {
-                    "choice": "Config"
-                }
-            ]
+            "datatype": "bool",
+            "defaultValue": "false"
         }
     },
     "sources": [
@@ -58,19 +58,19 @@
             ],
             "modifiers": [
                 {
-                    "condition": "(windows-nano && target != 'Config')",
+                    "condition": "(windows-nano && target != 'deploy')",
                     "include": [
                         "Docker/windows-nano/*"
                     ]
                 },
                 {
-                    "condition": "(linux-x64 && target != 'Config')",
+                    "condition": "(linux-x64 && target != 'deploy')",
                     "include": [
                         "Docker/linux-x64/*"
                     ]
                 },
                 {
-                    "condition": "(target == 'Config')",
+                    "condition": "(target == 'deploy')",
                     "exclude": [
                         "*.cs", "*.csproj", ".gitignore"
                     ]
@@ -80,11 +80,11 @@
     ],
     "postActions": [
         {
-            "condition": "(!skipRestore && target != 'Config')",
+            "condition": "(!skipRestore && target != 'deploy')",
             "description": "Restore NuGet packages required by this project.",
             "manualInstructions": [
                 {
-                    "text": "Run 'dotnet restore -s https://www.myget.org/F/aziot-device-sdk/api/v3/index.json'"
+                    "text": "Run 'dotnet restore'"
                 }
             ],
             "actionId": "210D431B-A78B-4D2F-B762-4ED3E3EA9025",

content/dotnet-template-azure-iot-edge-module/CSharp/Program.cs

@@ -1,8 +1,9 @@
 namespace SampleModule
 {
     using System;
-    using System.Collections.Generic;
     using System.IO;
+    using System.Collections.Generic;
+    using System.Runtime.InteropServices;
     using System.Runtime.Loader;
     using System.Security.Cryptography.X509Certificates;
     using System.Text;
@@ -19,11 +20,10 @@ class Program
 
         static void Main(string[] args)
         {
-            // Install CA certificate
+            // The Edge runtime gives us the connection string we need -- it is injected as an environment variable
+            string connectionString = Environment.GetEnvironmentVariable("EdgeHubConnectionString");
             InstallCert();
-
-            // Initialize Edge Module
-            InitEdgeModule().Wait();
+            Init(connectionString).Wait();
 
             // Wait until the app unloads or is cancelled
             var cts = new CancellationTokenSource();
@@ -47,16 +47,23 @@ public static Task WhenCancelled(CancellationToken cancellationToken)
         /// </summary>
         static void InstallCert()
         {
+            // Suppress cert validation on Windows for now
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+            {
+                return;
+            }
+
             string certPath = Environment.GetEnvironmentVariable("EdgeModuleCACertificateFile");
             if (string.IsNullOrWhiteSpace(certPath))
             {
                 // We cannot proceed further without a proper cert file
-                Console.WriteLine("Missing path to certificate collection file.");
+                Console.WriteLine($"Missing path to certificate collection file: {certPath}");
                 throw new InvalidOperationException("Missing path to certificate file.");
-            } else if (!File.Exists(certPath))
+            }
+            else if (!File.Exists(certPath))
             {
                 // We cannot proceed further without a proper cert file
-                Console.WriteLine("Missing certificate collection file.");
+                Console.WriteLine($"Missing path to certificate collection file: {certPath}");
                 throw new InvalidOperationException("Missing certificate file.");
             }
             X509Store store = new X509Store(StoreName.Root, StoreLocation.CurrentUser);
@@ -68,36 +75,28 @@ static void InstallCert()
 
 
         /// <summary>
-        /// Initializes the Azure IoT Client for the Edge Module
+        /// Initializes the DeviceClient and sets up the callback to receive
+        /// messages containing temperature information
         /// </summary>
-        static async Task InitEdgeModule()
+        static async Task Init(string connectionString)
         {
-            try
-            {
-                // Open a connection to the Edge runtime using MQTT transport and
-                // the connection string provided as an environment variable
-                DeviceClient ioTHubModuleClient = DeviceClient.CreateFromConnectionString(Environment.GetEnvironmentVariable("EdgeHubConnectionString"), TransportType.Mqtt_Tcp_Only);
-                await ioTHubModuleClient.OpenAsync();
-                Console.WriteLine("IoT Hub module client initialized.");
+            Console.WriteLine("Connection String {0}", connectionString);
 
-                // Register callback to be called when a message is received by the module
-                await ioTHubModuleClient.SetInputMessageHandlerAsync("input1", PipeMessage, ioTHubModuleClient);
-
-            }
-            catch (AggregateException ex)
+            MqttTransportSettings mqttSetting = new MqttTransportSettings(TransportType.Mqtt_Tcp_Only);
+            // Suppress cert validation on Windows for now
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
             {
-                foreach (Exception exception in ex.InnerExceptions)
-                {
-                    Console.WriteLine();
-                    Console.WriteLine("Error when initializing module: {0}", exception);
-                }
-            }
-            catch (Exception ex)
-            {
-                Console.WriteLine();
-                Console.WriteLine("Error when initializing module: {0}", ex.Message);
+                mqttSetting.RemoteCertificateValidationCallback = (sender, certificate, chain, sslPolicyErrors) => true;
             }
+            ITransportSettings[] settings = { mqttSetting };
+
+            // Open a connection to the Edge runtime
+            DeviceClient deviceClient = DeviceClient.CreateFromConnectionString(connectionString, settings);
+            await deviceClient.OpenAsync();
+            Console.WriteLine("IoT Hub module client initialized.");
 
+            // Register callback to be called when a message is received by the module
+            await deviceClient.SetInputMessageHandlerAsync("input1", PipeMessage, deviceClient);
         }
 
         /// <summary>
@@ -132,4 +131,4 @@ static async Task<MessageResponse> PipeMessage(Message message, object userConte
             return MessageResponse.Completed;
         }
     }
-}
+}

content/dotnet-template-azure-iot-edge-module/CSharp/SampleModule.csproj

@@ -10,7 +10,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Azure.Devices.Client" Version="1.6.0-preview-004" />
+    <PackageReference Include="Microsoft.Azure.Devices.Client" Version="1.6.0-preview-001" />
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="2.0.0-preview2-final" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="2.0.0-preview2-final" />
     <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="2.0.0-preview2-final" />