Merge pull request #1214 from oarosale/issue#1210

issue#1210 file block storage - adding new feature to list, assign, a…

Author: allmightyspiff

SoftLayer/CLI/block/subnets/__init__.py

@@ -0,0 +1 @@
+"""Block Storage Subnets Control."""

SoftLayer/CLI/block/subnets/assign.py

@@ -0,0 +1,37 @@
+"""Assign block storage subnets to the given host id."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+import SoftLayer
+from SoftLayer.CLI import environment
+
+
+@click.command()
+@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 host_id obtained by: slcli block access-list <volume_id>
+
+    SoftLayer_Account::iscsiisolationdisabled must be False to use this command
+    """
+    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:
+            message = "Successfully assigned subnet id: {} to allowed host id: {}".format(subnet, access_id)
+            click.echo(message)
+
+        failed_to_assign_subnets = list(set(subnet_ids) - set(assigned_subnets))
+        for subnet in failed_to_assign_subnets:
+            message = "Failed to assign subnet id: {} to allowed host id: {}".format(subnet, access_id)
+            click.echo(message)
+
+    except SoftLayer.SoftLayerAPIError as ex:
+        message = "Unable to assign subnets.\nReason: {}".format(ex.faultString)
+        click.echo(message)

SoftLayer/CLI/block/subnets/list.py

@@ -0,0 +1,43 @@
+"""List block storage assigned subnets for the given host id."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+
+COLUMNS = [
+    'id',
+    'createDate',
+    'networkIdentifier',
+    'cidr'
+]
+
+
+@click.command()
+@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 host_id obtained by: slcli block access-list <volume_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)
+
+        env.fout(table)
+
+    except SoftLayer.SoftLayerAPIError as ex:
+        message = "Unable to list assigned subnets for access-id: {}.\nReason: {}".format(access_id, ex.faultString)
+        click.echo(message)

SoftLayer/CLI/block/subnets/remove.py

@@ -0,0 +1,37 @@
+"""Remove block storage subnets for the given host id."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+import SoftLayer
+from SoftLayer.CLI import environment
+
+
+@click.command()
+@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 host_id obtained by: slcli block access-list <volume_id>
+
+    SoftLayer_Account::iscsiisolationdisabled must be False to use this command
+    """
+    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:
+            message = "Successfully removed subnet id: {} for allowed host id: {}".format(subnet, access_id)
+            click.echo(message)
+
+        failed_to_remove_subnets = list(set(subnet_ids) - set(removed_subnets))
+        for subnet in failed_to_remove_subnets:
+            message = "Failed to remove subnet id: {} for allowed host id: {}".format(subnet, access_id)
+            click.echo(message)
+
+    except SoftLayer.SoftLayerAPIError as ex:
+        message = "Unable to remove subnets.\nReason: {}".format(ex.faultString)
+        click.echo(message)

SoftLayer/CLI/routes.py

@@ -80,6 +80,9 @@
     ('block:access-list', 'SoftLayer.CLI.block.access.list:cli'),
     ('block:access-revoke', 'SoftLayer.CLI.block.access.revoke:cli'),
     ('block:access-password', 'SoftLayer.CLI.block.access.password:cli'),
+    ('block:subnets-list', 'SoftLayer.CLI.block.subnets.list:cli'),
+    ('block:subnets-assign', 'SoftLayer.CLI.block.subnets.assign:cli'),
+    ('block:subnets-remove', 'SoftLayer.CLI.block.subnets.remove:cli'),
     ('block:replica-failback', 'SoftLayer.CLI.block.replication.failback:cli'),
     ('block:replica-failover', 'SoftLayer.CLI.block.replication.failover:cli'),
     ('block:replica-order', 'SoftLayer.CLI.block.replication.order:cli'),

SoftLayer/fixtures/SoftLayer_Network_Storage_Allowed_Host.py

@@ -1 +1,61 @@
+TEST_ALLOWED_HOST = {
+    'id': 12345,
+    'name': 'Test Allowed Host',
+    'accountId': 1234,
+    'credentialId': None,
+    'createDate': '2020-01-01 00:00:01',
+    'iscsiAclCredentials': {
+        'id': 129,
+        'allowedHostId': 12345,
+        'subnetId': 12345678
+    },
+    'subnetsInAcl': [{
+        'id': 12345678,
+        'accountId': 1234,
+        'networkIdentifier': '10.11.12.13',
+        'cidr': '14',
+        'billingRecordId': None,
+        'parentId': None,
+        'networkVlanId': None,
+        'createDate': '2020-01-02 00:00:01',
+        'modifyDate': None,
+        'subnetType': 'SECONDARY_ON_VLAN',
+        'restrictAllocationFlag': 0,
+        'leafFlag': 1,
+        'ownerId': 1,
+        'ipAddressBegin': 129123,
+        'ipAddressEnd': 129145,
+        'purgeFlag': 0
+    }]
+}
+
+getObject = TEST_ALLOWED_HOST
+
+getSubnetsInAcl = [{
+        'id': 12345678,
+        'accountId': 1234,
+        'networkIdentifier': '10.11.12.13',
+        'cidr': '14',
+        'billingRecordId': None,
+        'parentId': None,
+        'networkVlanId': None,
+        'createDate': '2020-01-02 00:00:01',
+        'modifyDate': None,
+        'subnetType': 'SECONDARY_ON_VLAN',
+        'restrictAllocationFlag': 0,
+        'leafFlag': 1,
+        'ownerId': 1,
+        'ipAddressBegin': 129123,
+        'ipAddressEnd': 129145,
+        'purgeFlag': 0
+}]
+
+assignSubnetsToAcl = [
+    12345678
+]
+
+removeSubnetsFromAcl = [
+    12345678
+]
+
 setCredentialPassword = True

SoftLayer/managers/block.py

@@ -208,6 +208,46 @@ 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, 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 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',
+                                subnet_ids,
+                                id=access_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 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',
+                                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
+        """
+        return self.client.call('Network_Storage_Allowed_Host',
+                                'getSubnetsInAcl',
+                                id=access_id)
+
     def get_replication_partners(self, volume_id):
         """Acquires list of replicant volumes pertaining to the given volume.
 

tests/CLI/modules/block_tests.py

@@ -438,6 +438,23 @@ def test_deauthorize_host_to_volume(self):
 
         self.assert_no_fail(result)
 
+    def test_assign_subnets_to_acl(self):
+        result = self.run_command(['block', 'subnets-assign', '12345',
+                                   '--subnet-id=12345678'])
+
+        self.assert_no_fail(result)
+
+    def test_remove_subnets_from_acl(self):
+        result = self.run_command(['block', 'subnets-remove', '12345',
+                                   '--subnet-id=12345678'])
+
+        self.assert_no_fail(result)
+
+    def test_get_subnets_in_acl(self):
+        result = self.run_command(['block', 'subnets-list', '12345'])
+
+        self.assert_no_fail(result)
+
     def test_replicant_failover(self):
         result = self.run_command(['block', 'replica-failover', '12345678',
                                    '--replicant-id=5678'])

tests/managers/block_tests.py

@@ -486,6 +486,43 @@ def test_deauthorize_host_to_volume(self):
             'removeAccessFromHostList',
             identifier=50)
 
+    def test_assign_subnets_to_acl(self):
+        result = self.block.assign_subnets_to_acl(
+            12345,
+            subnet_ids=[12345678])
+
+        self.assertEqual(fixtures.SoftLayer_Network_Storage_Allowed_Host.
+                         assignSubnetsToAcl, result)
+
+        self.assert_called_with(
+            'SoftLayer_Network_Storage_Allowed_Host',
+            'assignSubnetsToAcl',
+            identifier=12345)
+
+    def test_remove_subnets_from_acl(self):
+        result = self.block.remove_subnets_from_acl(
+            12345,
+            subnet_ids=[12345678])
+
+        self.assertEqual(fixtures.SoftLayer_Network_Storage_Allowed_Host.
+                         removeSubnetsFromAcl, result)
+
+        self.assert_called_with(
+            'SoftLayer_Network_Storage_Allowed_Host',
+            'removeSubnetsFromAcl',
+            identifier=12345)
+
+    def test_get_subnets_in_acl(self):
+        result = self.block.get_subnets_in_acl(12345)
+
+        self.assertEqual(fixtures.SoftLayer_Network_Storage_Allowed_Host.
+                         getSubnetsInAcl, result)
+
+        self.assert_called_with(
+            'SoftLayer_Network_Storage_Allowed_Host',
+            'getSubnetsInAcl',
+            identifier=12345)
+
     def test_create_snapshot(self):
         result = self.block.create_snapshot(123, 'hello world')