issue#1210 - Correcting formatting and adding input check.

Author: oarosale

SoftLayer/CLI/block/subnets/assign.py

@@ -7,25 +7,31 @@
 
 
 @click.command()
-@click.argument('access_id')
+@click.argument('access_id', type=int)
 @click.option('--subnet-id', multiple=True, type=int,
               help="ID of the subnets to assign; e.g.: --subnet-id 1234")
 @environment.pass_env
 def cli(env, access_id, subnet_id):
     """Assign block storage subnets to the given host id.
 
-    access_id is the allowed_host_id from slcli block access-list
+    access_id is the host_id obtained by: slcli block access-list <volume_id>
     """
-    subnets_id = list(subnet_id)
-    block_manager = SoftLayer.BlockStorageManager(env.client)
-    assigned_subnets = block_manager.assign_subnets_to_acl(access_id,
-                                                           subnets_id)
+    try:
+        subnet_ids = list(subnet_id)
+        block_manager = SoftLayer.BlockStorageManager(env.client)
+        assigned_subnets = block_manager.assign_subnets_to_acl(access_id, subnet_ids)
 
-    for subnet in assigned_subnets:
-        click.echo("Successfully assigned subnet id: " + str(subnet) +
-                   ' to allowed host id: ' + str(access_id) + '.')
+        for subnet in assigned_subnets:
+            message = "{0}".format("Successfully assigned subnet id: " + str(subnet) +
+                                   ' to allowed host id: ' + str(access_id) + '.')
+            click.echo(message)
 
-    failed_to_assign_subnets = list(set(subnets_id) - set(assigned_subnets))
-    for subnet in failed_to_assign_subnets:
-        click.echo("Failed to assign subnet id: " + str(subnet) +
-                   ' to allowed host id: ' + str(access_id) + '.')
+        failed_to_assign_subnets = list(set(subnet_ids) - set(assigned_subnets))
+        for subnet in failed_to_assign_subnets:
+            message = "{0}".format("Failed to assign subnet id: " + str(subnet) +
+                                   ' to allowed host id: ' + str(access_id) + '.')
+            click.echo(message)
+
+    except SoftLayer.SoftLayerAPIError as ex:
+        message = "{0}".format("Unable to assign subnets.\nReason: " + ex.faultString)
+        click.echo(message)

SoftLayer/CLI/block/subnets/list.py

@@ -16,23 +16,29 @@
 
 
 @click.command()
-@click.argument('access_id')
+@click.argument('access_id', type=int)
 @environment.pass_env
 def cli(env, access_id):
     """List block storage assigned subnets for the given host id.
 
-    access_id is the allowed_host_id from slcli block access-list
+    access_id is the host_id obtained by: slcli block access-list <volume_id>
     """
 
-    block_manager = SoftLayer.BlockStorageManager(env.client)
-    subnets = block_manager.get_subnets_in_acl(access_id)
+    try:
+        block_manager = SoftLayer.BlockStorageManager(env.client)
+        subnets = block_manager.get_subnets_in_acl(access_id)
 
-    table = formatting.Table(COLUMNS)
-    for subnet in subnets:
-        row = ["{0}".format(subnet['id']),
-               "{0}".format(subnet['createDate']),
-               "{0}".format(subnet['networkIdentifier']),
-               "{0}".format(subnet['cidr'])]
-        table.add_row(row)
+        table = formatting.Table(COLUMNS)
+        for subnet in subnets:
+            row = ["{0}".format(subnet['id']),
+                   "{0}".format(subnet['createDate']),
+                   "{0}".format(subnet['networkIdentifier']),
+                   "{0}".format(subnet['cidr'])]
+            table.add_row(row)
 
-    env.fout(table)
+        env.fout(table)
+
+    except SoftLayer.SoftLayerAPIError as ex:
+        message = "{0}".format("Unable to list assigned subnets for access-id: " +
+                               str(access_id) + ".\nReason: " + ex.faultString)
+        click.echo(message)

SoftLayer/CLI/block/subnets/remove.py

@@ -7,25 +7,31 @@
 
 
 @click.command()
-@click.argument('access_id')
+@click.argument('access_id', type=int)
 @click.option('--subnet-id', multiple=True, type=int,
               help="ID of the subnets to remove; e.g.: --subnet-id 1234")
 @environment.pass_env
 def cli(env, access_id, subnet_id):
     """Remove block storage subnets for the given host id.
 
-    access_id is the allowed_host_id from slcli block access-list
+    access_id is the host_id obtained by: slcli block access-list <volume_id>
     """
-    subnets_id = list(subnet_id)
-    block_manager = SoftLayer.BlockStorageManager(env.client)
-    removed_subnets = block_manager.remove_subnets_from_acl(access_id,
-                                                            subnets_id)
+    try:
+        subnet_ids = list(subnet_id)
+        block_manager = SoftLayer.BlockStorageManager(env.client)
+        removed_subnets = block_manager.remove_subnets_from_acl(access_id, subnet_ids)
 
-    for subnet in removed_subnets:
-        click.echo("Successfully removed subnet id: " + str(subnet) +
-                   ' to allowed host id: ' + str(access_id) + '.')
+        for subnet in removed_subnets:
+            message = "{0}".format("Successfully removed subnet id: " + str(subnet) +
+                                   ' for allowed host id: ' + str(access_id) + '.')
+            click.echo(message)
 
-    failed_to_remove_subnets = list(set(subnets_id) - set(removed_subnets))
-    for subnet in failed_to_remove_subnets:
-        click.echo("Failed to remove subnet id: " + str(subnet) +
-                   ' to allowed host id: ' + str(access_id) + '.')
+        failed_to_remove_subnets = list(set(subnet_ids) - set(removed_subnets))
+        for subnet in failed_to_remove_subnets:
+            message = "{0}".format("Failed to remove subnet id: " + str(subnet) +
+                                   ' for allowed host id: ' + str(access_id) + '.')
+            click.echo(message)
+
+    except SoftLayer.SoftLayerAPIError as ex:
+        message = "{0}".format("Unable to remove subnets.\nReason: " + ex.faultString)
+        click.echo(message)

SoftLayer/managers/block.py

@@ -201,33 +201,39 @@ def deauthorize_host_to_volume(self, volume_id,
         return self.client.call('Network_Storage', 'removeAccessFromHostList',
                                 host_templates, id=volume_id, **kwargs)
 
-    def assign_subnets_to_acl(self, access_id, subnets_id):
+    def assign_subnets_to_acl(self, access_id, subnet_ids):
         """Assigns subnet records to ACL for the access host.
 
+        access_id is the host_id obtained by: slcli block access-list <volume_id>
+
         :param integer access_id: id of the access host
-        :param integer subnets_id: The ids of the subnets to be assigned
+        :param list subnet_ids: The ids of the subnets to be assigned
         :return: Returns int array of assigned subnet ids
         """
         return self.client.call('Network_Storage_Allowed_Host',
                                 'assignSubnetsToAcl',
-                                subnets_id,
+                                subnet_ids,
                                 id=access_id)
 
-    def remove_subnets_from_acl(self, access_id, subnets_id):
+    def remove_subnets_from_acl(self, access_id, subnet_ids):
         """Removes subnet records from ACL for the access host.
 
+        access_id is the host_id obtained by: slcli block access-list <volume_id>
+
         :param integer access_id: id of the access host
-        :param integer subnets_id: The ids of the subnets to be removed
+        :param list subnet_ids: The ids of the subnets to be removed
         :return: Returns int array of removed subnet ids
         """
         return self.client.call('Network_Storage_Allowed_Host',
                                 'removeSubnetsFromAcl',
-                                subnets_id,
+                                subnet_ids,
                                 id=access_id)
 
     def get_subnets_in_acl(self, access_id):
         """Returns a list of subnet records for the access host.
 
+         access_id is the host_id obtained by: slcli block access-list <volume_id>
+
         :param integer access_id: id of the access host
         :return: Returns an array of SoftLayer_Network_Subnet objects
         """

tests/managers/block_tests.py

@@ -489,7 +489,7 @@ def test_deauthorize_host_to_volume(self):
     def test_assign_subnets_to_acl(self):
         result = self.block.assign_subnets_to_acl(
             12345,
-            subnets_id=[12345678])
+            subnet_ids=[12345678])
 
         self.assertEqual(fixtures.SoftLayer_Network_Storage_Allowed_Host.
                          assignSubnetsToAcl, result)
@@ -502,7 +502,7 @@ def test_assign_subnets_to_acl(self):
     def test_remove_subnets_from_acl(self):
         result = self.block.remove_subnets_from_acl(
             12345,
-            subnets_id=[12345678])
+            subnet_ids=[12345678])
 
         self.assertEqual(fixtures.SoftLayer_Network_Storage_Allowed_Host.
                          removeSubnetsFromAcl, result)