iotedgedev 3.3.5__zip → 3.3.7__zip

s/iotedgedev/cli.py

@@ -25,11 +25,17 @@ from .solution import Solution
 from .utility import Utility
 
 # Extend click.Group#add_command(cmd, name) to take deprecated=bool flag by monkey patching.
-def add_command_with_deprecation(self, cmd: Command, name: t.Optional[str] = None, deprecated = False):
+def add_command_with_deprecation(self, cmd: Command, name: t.Optional[str] = None, deprecated = False, alt:  t.Optional[str] = None):
     # Directly changing the deprecated flag of the cmd has side-effects on the reference source.
     # To avoid this, copy the cmd object with deepcopy.
     copied_command = copy.deepcopy(cmd)
     copied_command.deprecated = deprecated
+    if copied_command.short_help is None:
+        copied_command.short_help = copied_command.help
+    if alt is not None:
+        alt_cmd = "[Use `iotedgedev " + alt + "` instead]"
+        copied_command.short_help += " " + alt_cmd  # use space for formatting short_help in `iotedgedev --help`
+        copied_command.help += "\n\n" + alt_cmd  # use newline for formatting help in `iotedgedev <command> --help`
     self.add_command(copied_command, name)
 
 Group.add_command_with_deprecation = add_command_with_deprecation
@@ -99,7 +105,7 @@ def new(name, module, template, edge_runtime_version, group_id):
     sol = Solution(output, utility)
     sol.create(name, module, template, edge_runtime_version, group_id)
 
-main.add_command_with_deprecation(new, deprecated=True)
+main.add_command_with_deprecation(new, deprecated=True, alt="solution new")
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS,
@@ -132,7 +138,7 @@ def init(name, module, template, group_id, edge_runtime_version):
     utility.call_proc(azsetupcmd.split())
 
 
-main.add_command_with_deprecation(init, deprecated=True)
+main.add_command_with_deprecation(init, deprecated=True, alt="solution init")
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Push, deploy, start, monitor")
@@ -155,7 +161,7 @@ def add(name, template, group_id):
     mod.add(name, template, group_id)
 
 
-main.add_command_with_deprecation(add, deprecated=True)
+main.add_command_with_deprecation(add, deprecated=True, alt="solution add")
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Build the solution")
@@ -197,7 +203,7 @@ def build(ctx, push, do_deploy, template_file, platform):
         ctx.invoke(deploy)
 
 
-main.add_command_with_deprecation(build, deprecated=True)
+main.add_command_with_deprecation(build, deprecated=True, alt="solution build")
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Push module images to container registry")
@@ -238,7 +244,7 @@ def push(ctx, do_deploy, no_build, template_file, platform):
         ctx.invoke(deploy)
 
 
-main.add_command_with_deprecation(push, deprecated=True)
+main.add_command_with_deprecation(push, deprecated=True, alt="solution push")
 
 
 @solution.command(context_settings=CONTEXT_SETTINGS, help="Deploy solution to IoT Edge device")
@@ -256,7 +262,7 @@ def deploy(manifest_file):
     edge.deploy(manifest_file)
 
 
-main.add_command_with_deprecation(deploy, deprecated=True)
+main.add_command_with_deprecation(deploy, deprecated=True, alt="solution deploy")
 
 
 @iothub.command(
@@ -351,7 +357,7 @@ def genconfig(template_file, platform, fail_on_validation_error):
     mod.build_push(template_file, platform, no_build=True, no_push=True, fail_on_validation_error=fail_on_validation_error)
 
 
-main.add_command_with_deprecation(genconfig, deprecated=True)
+main.add_command_with_deprecation(genconfig, deprecated=True, alt="solution genconfig")
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -374,7 +380,7 @@ def setup_simulator(gateway_host, iothub_connection_string):
     sim.setup(gateway_host, iothub_connection_string)
 
 
-main.add_command_with_deprecation(setup_simulator, deprecated=True)
+main.add_command_with_deprecation(setup_simulator, deprecated=True, alt="simulator setup")
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -449,7 +455,7 @@ def start_simulator(setup, solution, build, manifest_file, platform, verbose, in
         sim.start_single(inputs, port)
 
 
-main.add_command_with_deprecation(start_simulator, deprecated=True)
+main.add_command_with_deprecation(start_simulator, deprecated=True, alt="simulator start")
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -461,7 +467,7 @@ def stop_simulator():
     sim.stop()
 
 
-main.add_command_with_deprecation(stop_simulator, deprecated=True)
+main.add_command_with_deprecation(stop_simulator, deprecated=True, alt="simulator stop")
 
 
 @simulator.command(context_settings=CONTEXT_SETTINGS,
@@ -501,7 +507,7 @@ def monitor(timeout):
     ih.monitor_events(timeout)
 
 
-main.add_command_with_deprecation(monitor, deprecated=True)
+main.add_command_with_deprecation(monitor, deprecated=True, alt="iothub monitor")
 
 
 def ensure_azure_cli_iot_ext():
@@ -622,25 +628,31 @@ def validate_option(ctx, param, value):
 def list_edge_devices_and_set_default():
     if not azure_cli.list_edge_devices(envvars.IOTHUB_NAME):
         sys.exit()
-    return "iotedgedev-edgedevice"
+    output.info("Enter the IoT Edge Device Id (Creates a new Edge Device if not found) [iotedgedev-edgedevice]:")
+    return input() or "iotedgedev-edgedevice"
 
 
 def list_iot_hubs_and_set_default():
     if not azure_cli.list_iot_hubs(envvars.RESOURCE_GROUP_NAME):
         sys.exit()
 
+    subscription_rg_hash = hashlib.sha1((default_subscriptionId + envvars.RESOURCE_GROUP_NAME).encode('utf-8')).hexdigest()[:6]
+    iothub_name = "iotedgedev-iothub-" + subscription_rg_hash
+
     first_iothub = azure_cli.get_first_iothub(envvars.RESOURCE_GROUP_NAME)
     if first_iothub:
-        return first_iothub
-    else:
-        subscription_rg_hash = hashlib.sha1((default_subscriptionId + envvars.RESOURCE_GROUP_NAME).encode('utf-8')).hexdigest()[:6]
-        return "iotedgedev-iothub-" + subscription_rg_hash
+        iothub_name = first_iothub
+
+    output.info(f"Enter the IoT Hub Name (Creates a new IoT Hub if not found) [{iothub_name}]:")
+    return input() or iothub_name
 
 
 def list_resource_groups_and_set_default():
     if not azure_cli.list_resource_groups():
         sys.exit()
-    return "iotedgedev-rg"
+
+    output.info("Enter Resource Group Name (Creates a new Resource Group if not found) [iotedgedev-rg]:")
+    return input() or "iotedgedev-rg"
 
 
 def list_subscriptions_and_set_default():
@@ -657,14 +669,30 @@ def list_subscriptions_and_set_default():
     if not azure_cli.list_subscriptions():
         sys.exit()
     default_subscriptionId = azure_cli.get_default_subscription()
-    return default_subscriptionId
+    output.info(f"Select an Azure Subscription Name or Id [{default_subscriptionId}]:")
+    return input() or default_subscriptionId
 
 
-def header_and_default(header, default, default2=None):
+def header_and_default(header, prompt, default, options=None):
     output.header(header)
-    if default == '' and default2 is not None:
-        return default2
-    return default
+    output.info(f"{prompt} [{default}]:")
+    output.info(f"Available options: {options}")
+    return input() or default
+
+
+def handle_vm_create():
+    output.header("CREATE VIRTUAL MACHINE")
+    output.info("The virtual machine will be created with the IoT Edge runtime installed.\n"
+                "The deployment template can be found at: https://aka.ms/iotedge-vm-deploy \n"
+                "The name of the virtual machine will be a unique string generated by the template.\n"
+                "Details: os=ubuntu20_04-lts, size=Standard_DS1_v2, username=azureuser, allowSsh=true")
+    ssh_key_file = output.prompt_question("SSH Key file (must be located in ~/.ssh and will be created if it doesn't exist)", "id_rsa_iotedgedev")
+    if not azure_cli.create_edge_vm(ssh_key_file, envvars.EDGE_DEVICE_ID, envvars.IOTHUB_NAME, envvars.RESOURCE_GROUP_NAME):
+        raise click.BadParameter(f('Could not create Virtual Machine in {envvars.RESOURCE_GROUP_NAME}'))
+    else:
+        output.info("Virtual Machine created successfully. Check Azure Portal for details on how to connect.\n"
+                    "WARNING: Check the details of the Network Security Group, it is setup to allow SSH from all addresses.\n"
+                    "You will be able to connect using the SSH Key file: ~/.ssh/" + ssh_key_file)
 
 
 @iothub.command(context_settings=CONTEXT_SETTINGS,
@@ -688,51 +716,46 @@ def header_and_default(header, default, default2=None):
               help="Enter Azure Service Principal Credentials (username password tenant).")
 @click.option('--subscription',
               envvar=envvars.get_envvar_key_if_val("SUBSCRIPTION_ID"),
-              default=lambda: list_subscriptions_and_set_default(),
+              default=list_subscriptions_and_set_default,
               required=True,
               callback=validate_option,
-              prompt="Select an Azure Subscription Name or Id:",
               help="The Azure Subscription Name or Id.")
 @click.option('--resource-group-location',
               envvar=envvars.get_envvar_key_if_val("RESOURCE_GROUP_LOCATION"),
               required=True,
-              default=lambda: header_and_default('RESOURCE GROUP LOCATION', envvars.RESOURCE_GROUP_LOCATION, 'westus'),
-              type=click.Choice(['australiaeast', 'australiasoutheast', 'brazilsouth', 'canadacentral', 'canadaeast', 'centralindia', 'centralus', 'eastasia', 'eastus', 'eastus2',
-                                 'japanwest', 'japaneast', 'northeurope', 'northcentralus', 'southindia', 'uksouth', 'ukwest', 'westus', 'westeurope', 'southcentralus', 'westcentralus', 'westus2']),
+              default=lambda: header_and_default('RESOURCE GROUP LOCATION', 'Enter a Resource Group Location', envvars.RESOURCE_GROUP_LOCATION or 'westus',
+                                                 ['australiaeast', 'australiasoutheast', 'brazilsouth', 'canadacentral', 'canadaeast', 'centralindia', 'centralus', 'eastasia', 'eastus', 'eastus2',
+                                                  'japanwest', 'japaneast', 'northeurope', 'northcentralus', 'southindia', 'uksouth', 'ukwest', 'westus', 'westeurope', 'southcentralus', 'westcentralus', 'westus2']),
+              type=str,
               callback=validate_option,
-              prompt="Enter a Resource Group Location:",
               help="The Resource Group Location.")
 @click.option('--resource-group-name',
               envvar=envvars.get_envvar_key_if_val("RESOURCE_GROUP_NAME"),
               required=True,
-              default=lambda: list_resource_groups_and_set_default(),
+              default=list_resource_groups_and_set_default,
               type=str,
               callback=validate_option,
-              prompt="Enter Resource Group Name (Creates a new Resource Group if not found):",
               help="The Resource Group Name (Creates a new Resource Group if not found).")
 @click.option('--iothub-sku',
               envvar=envvars.get_envvar_key_if_val("IOTHUB_SKU"),
               required=True,
-              default=lambda: header_and_default('IOTHUB SKU', 'F1'),
-              type=click.Choice(['F1', 'S1', 'S2', 'S3']),
+              default=lambda: header_and_default('IOTHUB SKU', 'Enter IoT Hub SKU', 'F1', ['F1', 'S1', 'S2', 'S3']),
+              type=str,
               callback=validate_option,
-              prompt="Enter IoT Hub SKU (F1|S1|S2|S3):",
               help="The IoT Hub SKU.")
 @click.option('--iothub-name',
               envvar=envvars.get_envvar_key_if_val("IOTHUB_NAME"),
               required=True,
-              default=lambda: list_iot_hubs_and_set_default(),
+              default=list_iot_hubs_and_set_default,
               type=str,
               callback=validate_option,
-              prompt='Enter the IoT Hub Name (Creates a new IoT Hub if not found):',
               help='The IoT Hub Name (Creates a new IoT Hub if not found).')
 @click.option('--edge-device-id',
               envvar=envvars.get_envvar_key_if_val("EDGE_DEVICE_ID"),
               required=True,
-              default=lambda: list_edge_devices_and_set_default(),
+              default=list_edge_devices_and_set_default,
               type=str,
               callback=validate_option,
-              prompt='Enter the IoT Edge Device Id (Creates a new Edge Device if not found):',
               help='The IoT Edge Device Id (Creates a new Edge Device if not found).')
 @click.option('--update-dotenv',
               "-u",
@@ -743,6 +766,14 @@ def header_and_default(header, default, default2=None):
               is_flag=True,
               prompt='Update the .env file with connection strings?',
               help='If True, the current .env will be updated with the IoT Hub and Device connection strings.')
+@click.option('--create-edge-vm',
+              envvar=envvars.get_envvar_key_if_val("CREATE_EDGE_VM"),
+              required=True,
+              default=False,
+              show_default=True,
+              is_flag=True,
+              prompt='Create a new Virtual Machine with IoTEdge?',
+              help='If true, creates a new Virtual Machine with IoTEdge.')
 @with_telemetry
 def setup_iothub(credentials,
                  service_principal,
@@ -752,13 +783,17 @@ def setup_iothub(credentials,
                  iothub_sku,
                  iothub_name,
                  edge_device_id,
-                 update_dotenv):
+                 update_dotenv,
+                 create_edge_vm):
     if update_dotenv:
         if envvars.backup_dotenv():
             envvars.save_envvar("IOTHUB_CONNECTION_STRING", envvars.IOTHUB_CONNECTION_STRING)
             envvars.save_envvar("DEVICE_CONNECTION_STRING", envvars.DEVICE_CONNECTION_STRING)
             output.info("Updated current .env file")
 
+    if create_edge_vm:
+        handle_vm_create()
+
 
 @docker.command(context_settings=CONTEXT_SETTINGS,
                 help="Pull Edge runtime images from Microsoft Container Registry and push to your specified container registry. "
@@ -835,7 +870,7 @@ def log(show, save):
     dock.handle_logs_cmd(show, save)
 
 
-main.add_command_with_deprecation(log, deprecated=True)
+main.add_command_with_deprecation(log, deprecated=True, alt="docker log")
 
 if __name__ == "__main__":
     main()

s/iotedgedev/envvars.py

@@ -119,6 +119,7 @@ class EnvVars:
                 self.IOTHUB_NAME = self.get_envvar("IOTHUB_NAME")
                 self.IOTHUB_SKU = self.get_envvar("IOTHUB_SKU")
                 self.EDGE_DEVICE_ID = self.get_envvar("EDGE_DEVICE_ID")
+                self.CREATE_EDGE_VM = self.get_envvar("CREATE_EDGE_VM")
                 self.CREDENTIALS = self.get_envvar("CREDENTIALS")
                 self.UPDATE_DOTENV = self.get_envvar("UPDATE_DOTENV")
 

s/iotedgedev/output.py

@@ -55,3 +55,7 @@ class Output:
 
     def confirm(self, text, default=False, abort=True):
         return click.confirm(text, default=default, abort=abort)
+
+    def prompt_question(self, text, default=""):
+        self.line()
+        return click.prompt(text, default=default)

s/iotedgedev.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: iotedgedev
-Version: 3.3.5
+Version: 3.3.7
 Summary: The Azure IoT Edge Dev Tool greatly simplifies the IoT Edge development process by automating many routine manual tasks, such as building, deploying, pushing modules and configuring the IoT Edge Runtime.
 Home-page: https://github.com/azure/iotedgedev
 Author: Microsoft Corporation

s/iotedgedev.egg-info/requires.txt

@@ -5,7 +5,7 @@ python-dotenv
 requests<=2.25.1,>=2.20.0
 fstrings
 azure-cli-core<2.35.0,>=2.34.1
-iotedgehubdev==0.14.14
+iotedgehubdev==0.14.18
 applicationinsights==0.11.9
 commentjson==0.9.0
 pyyaml>=5.4

s/requirements.txt

@@ -4,7 +4,7 @@ python-dotenv==0.19.0
 requests==2.25.1
 fstrings==0.1.0
 msrestazure==0.6.4
-iotedgehubdev==0.14.14
+iotedgehubdev==0.14.18
 applicationinsights==0.11.9
 commentjson==0.9.0
 azure-cli-core==2.34.1

s/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.3.5
+current_version = 3.3.7
 commit = True
 tag = True
 

s/setup.py

@@ -15,7 +15,7 @@ requirements = [
     # Note >=2.35.0 cannot be used as is not compatible with the docker dependency;
     # docker requires websocket-client==0.56.0 and azure-cli-core>=2.35.0 requires websocket-client==1.31.1.
     'azure-cli-core >= 2.34.1, < 2.35.0',
-    'iotedgehubdev == 0.14.14',
+    'iotedgehubdev == 0.14.18',
     'applicationinsights == 0.11.9',
     'commentjson == 0.9.0',
     'pyyaml>=5.4',
@@ -33,7 +33,7 @@ test_requirements = [
 
 setup(
     name='iotedgedev',
-    version='3.3.5',
+    version='3.3.7',
     description='The Azure IoT Edge Dev Tool greatly simplifies the IoT Edge development process by automating many routine manual tasks, such as building, deploying, pushing modules and configuring the IoT Edge Runtime.',
     long_description='See https://github.com/azure/iotedgedev for usage instructions.',
     author='Microsoft Corporation',

s/tests/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = 'Microsoft Corporation'
 __email__ = 'opencode@microsoft.com'
-__version__ = '3.3.5'
+__version__ = '3.3.7'