iotedgedev 3.3.4__zip

s/build/lib/iotedgedev/telemetry.py

@@ -0,0 +1,155 @@
+import datetime
+import json
+import os
+import platform
+import subprocess
+import sys
+import uuid
+from collections import defaultdict
+from functools import wraps
+
+from . import telemetryuploader
+from .telemetryconfig import TelemetryConfig
+from .decorators import hash256_result, suppress_all_exceptions
+
+PRODUCT_NAME = 'iotedgedev'
+
+
+class TelemetrySession(object):
+    def __init__(self, correlation_id=None):
+        self.start_time = None
+        self.end_time = None
+        self.correlation_id = correlation_id or str(uuid.uuid4())
+        self.command = 'command_name'
+        self.parameters = []
+        self.result = 'None'
+        self.result_summary = None
+        self.exception = None
+        self.extra_props = {}
+        self.machineId = self._get_hash_mac_address()
+        self.events = defaultdict(list)
+
+    def generate_payload(self):
+        props = {
+            'EventId': str(uuid.uuid4()),
+            'CorrelationId': self.correlation_id,
+            'MachineId': self.machineId,
+            'ProductName': PRODUCT_NAME,
+            'ProductVersion': _get_core_version(),
+            'CommandName': self.command,
+            'OS.Type': platform.system().lower(),
+            'OS.Version': platform.version().lower(),
+            'Result': self.result,
+            'StartTime': str(self.start_time),
+            'EndTime': str(self.end_time),
+            'Parameters': ','.join(self.parameters)
+        }
+
+        if self.result_summary:
+            props['ResultSummary'] = self.result_summary
+
+        if self.exception:
+            props['Exception'] = self.exception
+
+        props.update(self.extra_props)
+
+        self.events[_get_AI_key()].append({
+            'name': '{}/command'.format(PRODUCT_NAME),
+            'properties': props
+        })
+
+        payload = json.dumps(self.events)
+        return _remove_symbols(payload)
+
+    @suppress_all_exceptions()
+    @hash256_result
+    def _get_hash_mac_address(self):
+        s = ''
+        for index, c in enumerate(hex(uuid.getnode())[2:].upper()):
+            s += c
+            if index % 2:
+                s += '-'
+
+        s = s.strip('-')
+        return s
+
+
+_session = TelemetrySession()
+
+
+def _user_agrees_to_telemetry(func):
+    @wraps(func)
+    def _wrapper(*args, **kwargs):
+        config = TelemetryConfig()
+        if not config.get_boolean(config.DEFAULT_DIRECT, config.TELEMETRY_SECTION):
+            return None
+        return func(*args, **kwargs)
+
+    return _wrapper
+
+
+@suppress_all_exceptions()
+def start(cmdname, params=[]):
+    _session.command = cmdname
+    _session.start_time = datetime.datetime.utcnow()
+    if params is not None:
+        _session.parameters.extend(params)
+
+
+@suppress_all_exceptions()
+def success():
+    _session.result = 'Success'
+
+
+@suppress_all_exceptions()
+def fail(exception, summary):
+    _session.exception = exception
+    _session.result = 'Fail'
+    _session.result_summary = summary
+
+
+@suppress_all_exceptions()
+def add_extra_props(props):
+    if props is not None:
+        _session.extra_props.update(props)
+
+
+@_user_agrees_to_telemetry
+@suppress_all_exceptions()
+def flush():
+    # flush out current information
+    _session.end_time = datetime.datetime.utcnow()
+
+    payload = _session.generate_payload()
+    if payload:
+        _upload_telemetry_with_user_agreement(payload)
+
+    # reset session fields, retaining correlation id and application
+    _session.__init__(correlation_id=_session.correlation_id)
+
+
+@suppress_all_exceptions(fallback_return=None)
+def _get_core_version():
+    from iotedgedev import __version__ as core_version
+    return core_version
+
+
+@suppress_all_exceptions()
+def _get_AI_key():
+    from iotedgedev import __AIkey__ as key
+    return key
+
+
+# This includes a final user-agreement-check; ALL methods sending telemetry MUST call this.
+@_user_agrees_to_telemetry
+@suppress_all_exceptions()
+def _upload_telemetry_with_user_agreement(payload, **kwargs):
+    # Call telemetry uploader as a subprocess to prevent blocking iotedgedev process
+    subprocess.Popen([sys.executable, os.path.realpath(telemetryuploader.__file__), payload], **kwargs)
+
+
+def _remove_symbols(s):
+    if isinstance(s, str):
+        for c in '$%^&|':
+            s = s.replace(c, '_')
+    return s

s/build/lib/iotedgedev/telemetryconfig.py

@@ -0,0 +1,85 @@
+import os
+
+import configparser
+
+from .decorators import suppress_all_exceptions
+
+PRIVACY_STATEMENT = """
+Welcome to iotedgedev!
+-------------------------
+Telemetry
+---------
+The iotedgedev collects usage data in order to improve your experience.
+The data is anonymous and does not include commandline argument values.
+The data is collected by Microsoft.
+
+You can change your telemetry settings by updating '{0}' to 'no' in {1}
+"""
+
+
+class TelemetryConfig(object):
+    DEFAULT_DIRECT = 'DEFAULT'
+    FIRSTTIME_SECTION = 'firsttime'
+    TELEMETRY_SECTION = 'collect_telemetry'
+
+    def __init__(self):
+        self.config_parser = configparser.ConfigParser({
+            self.FIRSTTIME_SECTION: 'yes'
+        })
+        self.setup()
+
+    @suppress_all_exceptions()
+    def setup(self):
+        config_path = self.get_config_path()
+        config_folder = os.path.dirname(config_path)
+        if not os.path.exists(config_folder):
+            os.makedirs(config_folder)
+        if not os.path.exists(config_path):
+            self.dump()
+        else:
+            self.load()
+            self.dump()
+
+    @suppress_all_exceptions()
+    def load(self):
+        with open(self.get_config_path(), 'r') as f:
+            if hasattr(self.config_parser, 'read_file'):
+                self.config_parser.read_file(f)
+
+    @suppress_all_exceptions()
+    def dump(self):
+        with open(self.get_config_path(), 'w') as f:
+            self.config_parser.write(f)
+
+    @suppress_all_exceptions()
+    def get(self, direct, section):
+        return self.config_parser.get(direct, section)
+
+    @suppress_all_exceptions()
+    def get_boolean(self, direct, section):
+        return self.config_parser.getboolean(direct, section)
+
+    @suppress_all_exceptions()
+    def set(self, direct, section, val):
+        if val is not None:
+            self.config_parser.set(direct, section, val)
+            self.dump()
+
+    @suppress_all_exceptions()
+    def check_firsttime(self):
+        if self.get(self.DEFAULT_DIRECT, self.FIRSTTIME_SECTION) != 'no':
+            self.set(self.DEFAULT_DIRECT, self.FIRSTTIME_SECTION, 'no')
+            print(PRIVACY_STATEMENT.format(self.TELEMETRY_SECTION, self.get_config_path()))
+            self.set(self.DEFAULT_DIRECT, self.TELEMETRY_SECTION, 'yes')
+            self.dump()
+
+    @suppress_all_exceptions()
+    def get_config_path(self):
+        config_folder = self.get_config_folder()
+        if config_folder:
+            return os.path.join(config_folder, 'setting.ini')
+        return None
+
+    @suppress_all_exceptions()
+    def get_config_folder(self):
+        return os.path.join(os.path.expanduser("~"), '.iotedgedev')

s/build/lib/iotedgedev/telemetryuploader.py

@@ -0,0 +1,53 @@
+import json
+import sys
+
+from applicationinsights import TelemetryClient
+from applicationinsights.channel import (SynchronousQueue, SynchronousSender,
+                                         TelemetryChannel)
+from applicationinsights.exceptions import enable
+from urllib.request import Request, urlopen
+
+from iotedgedev.decorators import suppress_all_exceptions
+
+
+class LimitedRetrySender(SynchronousSender):
+    def __init__(self):
+        super(LimitedRetrySender, self).__init__()
+
+    def send(self, data_to_send):
+        """ Override the default resend mechanism in SenderBase. Stop resend when it fails."""
+        request_payload = json.dumps([a.write() for a in data_to_send])
+
+        req = Request(self._service_endpoint_uri, bytearray(request_payload, 'utf-8'),
+                      {'Accept': 'application/json', 'Content-Type': 'application/json; charset=utf-8'})
+        try:
+            urlopen(req, timeout=10)
+        except Exception:
+            pass
+
+
+@suppress_all_exceptions()
+def upload(data_to_save):
+    data_to_save = json.loads(data_to_save)
+
+    for instrumentation_key in data_to_save:
+        client = TelemetryClient(instrumentation_key=instrumentation_key,
+                                 telemetry_channel=TelemetryChannel(queue=SynchronousQueue(LimitedRetrySender())))
+        enable(instrumentation_key)
+        for record in data_to_save[instrumentation_key]:
+            name = record['name']
+            raw_properties = record['properties']
+            properties = {}
+            measurements = {}
+            for k, v in raw_properties.items():
+                if isinstance(v, str):
+                    properties[k] = v
+                else:
+                    measurements[k] = v
+            client.track_event(name, properties, measurements)
+        client.flush()
+
+
+if __name__ == '__main__':
+    # If user doesn't agree to upload telemetry, this scripts won't be executed. The caller should control.
+    upload(sys.argv[1])

s/build/lib/iotedgedev/template/.env.tmp

@@ -0,0 +1,87 @@
+#
+# CONNECTION STRINGS
+#
+
+IOTHUB_CONNECTION_STRING=""
+
+DEVICE_CONNECTION_STRING=""
+
+#
+# CONTAINER REGISTRY
+#
+    # Settings for your default container registry.
+    # - Local Registry: Set CONTAINER_REGISTRY_SERVER to "localhost:5000" - USERNAME/PASSWORD are not required.
+    # - Azure Container Registry: Set CONTAINER_REGISTRY_SERVER to "myregistry.azurecr.io". USERNAME/PASSWORD are required.
+    # - Docker Hub: Set CONTAINER_REGISTRY_SERVER and CONTAINER_REGISTRY_USERNAME to your Docker Hub username. Set CONTAINER_REGISTRY_PASSWORD to your Docker Hub password.
+
+CONTAINER_REGISTRY_SERVER="localhost:5000"
+CONTAINER_REGISTRY_USERNAME=""
+CONTAINER_REGISTRY_PASSWORD=""
+
+    # To specify additional container registries ensure the prefix is CONTAINER_REGISTRY_SERVER_, CONTAINER_REGISTRY_USERNAME_, CONTAINER_REGISTRY_PASSWORD_
+    # And the token following the prefix uniquely associates the SERVER/USERNAME/PASSWORD
+    # Token can be any string of alphanumeric characters
+
+# CONTAINER_REGISTRY_SERVER_2=""
+# CONTAINER_REGISTRY_USERNAME_2=""
+# CONTAINER_REGISTRY_PASSWORD_2=""
+
+#
+# HOST
+#
+
+EDGE_RUNTIME_VERSION="%EDGE_RUNTIME_VERSION%"
+EDGEAGENT_SCHEMA_VERSION="%EDGEAGENT_SCHEMA_VERSION%"
+EDGEHUB_SCHEMA_VERSION="%EDGEHUB_SCHEMA_VERSION%"
+
+#
+# MODULES
+#
+
+BYPASS_MODULES=""
+    # "" - to build all modules
+    # "*" - to bypass all modules
+    # "filtermodule, module1" - Comma delimited list of modules to bypass when building
+
+CONTAINER_TAG=""
+
+#
+# SOLUTION SETTINGS
+#
+
+CONFIG_OUTPUT_DIR="config"
+DEPLOYMENT_CONFIG_TEMPLATE_FILE="deployment.template.json"
+DEPLOYMENT_CONFIG_DEBUG_TEMPLATE_FILE="deployment.debug.template.json"
+DEFAULT_PLATFORM="amd64"
+MODULES_PATH="modules"
+
+LOGS_PATH="logs"
+
+#
+# DOCKER LOGS COMMAND
+#
+# Command used when calling iotedgedev docker --logs or --show-logs
+
+LOGS_CMD="start /B start cmd.exe @cmd /k docker logs {0} -f"
+    # "start /B start cmd.exe @cmd /k docker logs {0} -f" - for CMD
+    # "docker logs {0} -f -new_console:sV" - for ConEmu
+
+#
+# AZURE SETTINGS
+#
+# These settings will override parameters to the `iotedgedev azure --setup` command.
+# CREDENTIALS="username password"
+# SERVICE_PRINCIPAL="username password tenant"
+# RESOURCE_GROUP_LOCATION="australiaeast|australiasoutheast|brazilsouth|canadacentral|canadaeast|centralindia|centralus|eastasia|eastus|eastus2|japanwest|japaneast|northeurope|northcentralus|southindia|uksouth|ukwest|westus|westeurope|southcentralus|westcentralus|westus2"
+# IOTHUB_SKU="F1|S1|S2|S3"
+# UPDATE_DOTENV="True|False"
+
+SUBSCRIPTION_ID=""
+RESOURCE_GROUP_NAME=""
+RESOURCE_GROUP_LOCATION=""
+IOTHUB_NAME=""
+IOTHUB_SKU=""
+EDGE_DEVICE_ID=""
+CREDENTIALS=""
+SERVICE_PRINCIPAL=""
+UPDATE_DOTENV=""

s/build/lib/iotedgedev/template/.gitignore

@@ -0,0 +1,10 @@
+**/.vs
+**/bin
+**/obj
+**/out
+build
+.env
+venv
+logs
+.config
+config

s/build/lib/iotedgedev/template/deployment.template.json

@@ -0,0 +1,79 @@
+{
+  "$schema-template": "4.0.0",
+  "modulesContent": {
+    "$edgeAgent": {
+      "properties.desired": {
+        "schemaVersion": "${EDGEAGENT_SCHEMA_VERSION}",
+        "runtime": {
+          "type": "docker",
+          "settings": {
+            "minDockerVersion": "v1.25",
+            "loggingOptions": "",
+            "registryCredentials": {}
+          }
+        },
+        "systemModules": {
+          "edgeAgent": {
+            "type": "docker",
+            "settings": {
+              "image": "mcr.microsoft.com/azureiotedge-agent:${EDGE_RUNTIME_VERSION}",
+              "createOptions": {}
+            }
+          },
+          "edgeHub": {
+            "type": "docker",
+            "status": "running",
+            "restartPolicy": "always",
+            "settings": {
+              "image": "mcr.microsoft.com/azureiotedge-hub:${EDGE_RUNTIME_VERSION}",
+              "createOptions": {
+                "HostConfig": {
+                  "PortBindings": {
+                    "5671/tcp": [
+                      {
+                        "HostPort": "5671"
+                      }
+                    ],
+                    "8883/tcp": [
+                      {
+                        "HostPort": "8883"
+                      }
+                    ],
+                    "443/tcp": [
+                      {
+                        "HostPort": "443"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "modules": {
+          "tempSensor": {
+            "version": "1.0",
+            "type": "docker",
+            "status": "running",
+            "restartPolicy": "always",
+            "settings": {
+              "image": "mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0",
+              "createOptions": {}
+            }
+          }
+        }
+      }
+    },
+    "$edgeHub": {
+      "properties.desired": {
+        "schemaVersion": "${EDGEHUB_SCHEMA_VERSION}",
+        "routes": {
+          "sensorTo%MODULE%": "FROM /messages/modules/tempSensor/outputs/temperatureOutput INTO BrokeredEndpoint(\"/modules/%MODULE%/inputs/input1\")"
+        },
+        "storeAndForwardConfiguration": {
+          "timeToLiveSecs": 7200
+        }
+      }
+    }
+  }
+}

s/build/lib/iotedgedev/template/launch_c.json

@@ -0,0 +1,50 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "%MODULE% Remote Debug (C)",
+      "type": "cppdbg",
+      "request": "attach",
+      "program": "./main",
+      "processId": "${command:pickRemoteProcess}",
+      "pipeTransport": {
+        "pipeCwd": "${workspaceFolder}",
+        "pipeProgram": "docker",
+        "pipeArgs": [
+          "exec",
+          "-i",
+          "%MODULE%",
+          "sh",
+          "-c"
+        ],
+        "debuggerPath": "/usr/bin/gdb"
+      },
+      "sourceFileMap": {
+        "%APP_FOLDER%": "${workspaceFolder}/modules/%MODULE_FOLDER%"
+      },
+      "linux": {
+        "MIMode": "gdb",
+        "setupCommands": [
+          {
+            "description": "Enable pretty-printing for gdb",
+            "text": "-enable-pretty-printing",
+            "ignoreFailures": true
+          }
+        ]
+      },
+      "osx": {
+        "MIMode": "lldb"
+      },
+      "windows": {
+        "MIMode": "gdb",
+        "setupCommands": [
+          {
+            "description": "Enable pretty-printing for gdb",
+            "text": "-enable-pretty-printing",
+            "ignoreFailures": true
+          }
+        ]
+      }
+    }
+  ]
+}

s/build/lib/iotedgedev/template/launch_csharp.json

@@ -0,0 +1,43 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "%MODULE% Remote Debug (.NET Core)",
+      "type": "coreclr",
+      "request": "attach",
+      "processId": "${command:pickRemoteProcess}",
+      "pipeTransport": {
+        "pipeProgram": "docker",
+        "pipeArgs": [
+          "exec",
+          "-i",
+          "%MODULE%",
+          "sh",
+          "-c"
+        ],
+        "debuggerPath": "~/vsdbg/vsdbg",
+        "pipeCwd": "${workspaceFolder}",
+        "quoteArgs": true
+      },
+      "sourceFileMap": {
+        "%APP_FOLDER%": "${workspaceFolder}/modules/%MODULE_FOLDER%"
+      },
+      "justMyCode": true
+    },
+    {
+      "name": "%MODULE% Local Debug (.NET Core)",
+      "type": "coreclr",
+      "request": "launch",
+      "program": "${workspaceRoot}/modules/%MODULE_FOLDER%/bin/Debug/netcoreapp2.1/%MODULE%.dll",
+      "args": [],
+      "cwd": "${workspaceRoot}/modules/%MODULE_FOLDER%",
+      "internalConsoleOptions": "openOnSessionStart",
+      "stopAtEntry": false,
+      "console": "internalConsole",
+      "env": {
+        "EdgeHubConnectionString": "${config:azure-iot-edge.EdgeHubConnectionString}",
+        "EdgeModuleCACertificateFile": "${config:azure-iot-edge.EdgeModuleCACertificateFile}"
+      }
+    }
+  ]
+}

s/build/lib/iotedgedev/template/launch_java.json

@@ -0,0 +1,27 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "java",
+            "name": "%MODULE% Local Debug (java)",
+            "request": "launch",
+            "cwd": "${workspaceRoot}/modules/%MODULE_FOLDER%",
+            "console": "internalConsole",
+            "stopOnEntry": false,
+            "mainClass": "%GROUP_ID%.App",
+            "args": "",
+            "projectName": "%MODULE%",
+            "env": {
+                "EdgeHubConnectionString": "${config:azure-iot-edge.EdgeHubConnectionString}",
+                "EdgeModuleCACertificateFile": "${config:azure-iot-edge.EdgeModuleCACertificateFile}"
+            }
+        },
+        {
+            "type": "java",
+            "name": "%MODULE% Remote Debug (java)",
+            "request": "attach",
+            "hostName": "localhost",
+            "port": 5005
+        }
+    ]
+}

s/build/lib/iotedgedev/template/launch_node.json

@@ -0,0 +1,36 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "%MODULE% Remote Debug (Node.js)",
+            "type": "node",
+            "request": "attach",
+            "port": 9229,
+            "address": "localhost",
+            "localRoot": "${workspaceRoot}/modules/%MODULE_FOLDER%",
+            "remoteRoot": "/app",
+            "protocol": "inspector"
+        },
+        {
+          "name": "%MODULE% Remote Debug (Node.js in Windows Container)",
+          "type": "node",
+          "request": "attach",
+          "port": 9229,
+          "address": "localhost",
+          "localRoot": "${workspaceRoot}/modules/%MODULE_FOLDER%",
+          "remoteRoot": "C:\\app",
+          "protocol": "inspector"
+        },
+        {
+            "name": "%MODULE% Local Debug (Node.js)",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceRoot}/modules/%MODULE_FOLDER%/app.js",
+            "console": "integratedTerminal",
+            "env": {
+                "EdgeHubConnectionString": "${config:azure-iot-edge.EdgeHubConnectionString}",
+                "EdgeModuleCACertificateFile": "${config:azure-iot-edge.EdgeModuleCACertificateFile}"
+            }
+        }
+    ]
+  }

s/build/lib/iotedgedev/template/launch_python.json

@@ -0,0 +1,22 @@
+{
+    "version": "0.2.0",
+    "configurations": [{
+        "name": "%MODULE% Remote Debug (Python)",
+        "type": "python",
+        "request": "attach",
+        "port": 5678,
+        "host": "localhost",
+        "logToFile": true,
+        "redirectOutput": true,
+        "pathMappings": [{
+            "localRoot": "${workspaceFolder}/modules/%MODULE_FOLDER%",
+            "remoteRoot": "%APP_FOLDER%"
+        }],
+        "windows": {
+            "pathMappings": [{
+                "localRoot": "${workspaceFolder}\\modules\\%MODULE_FOLDER%",
+                "remoteRoot": "%APP_FOLDER%"
+            }]
+        }
+    }]
+}