Merge pull request #1439 from FernandoOjeda/ft/authorize_storage

Authorize block and file storage to a hardware server

Author: allmightyspiff

SoftLayer/CLI/hardware/authorize_storage.py

@@ -0,0 +1,24 @@
+"""Authorize File or Block Storage to a Hardware Server"""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--username-storage', '-u', type=click.STRING,
+              help="The storage username to be added to the hardware server")
+@environment.pass_env
+def cli(env, identifier, username_storage):
+    """Authorize File or Block Storage to a Hardware Server."""
+    hardware = SoftLayer.HardwareManager(env.client)
+    hardware_id = helpers.resolve_id(hardware.resolve_ids, identifier, 'hardware')
+
+    if not hardware.authorize_storage(hardware_id, username_storage):
+        raise exceptions.CLIAbort('Authorize Storage Failed')
+    env.fout('Successfully Storage Added.')

SoftLayer/CLI/routes.py

@@ -256,6 +256,7 @@
     ('hardware:rescue', 'SoftLayer.CLI.hardware.power:rescue'),
     ('hardware:ready', 'SoftLayer.CLI.hardware.ready:cli'),
     ('hardware:toggle-ipmi', 'SoftLayer.CLI.hardware.toggle_ipmi:cli'),
+    ('hardware:authorize-storage', 'SoftLayer.CLI.hardware.authorize_storage:cli'),
     ('hardware:dns-sync', 'SoftLayer.CLI.hardware.dns:cli'),
     ('hardware:storage', 'SoftLayer.CLI.hardware.storage:cli'),
     ('hardware:upgrade', 'SoftLayer.CLI.hardware.upgrade:cli'),

SoftLayer/fixtures/SoftLayer_Account.py

@@ -1021,6 +1021,25 @@
     }
 ]
 
+getNetworkStorage = [
+    {
+        "accountId": 1111111,
+        "capacityGb": 20,
+        "createDate": "2016-01-21T12:11:07-06:00",
+        "id": 1234567,
+        "nasType": "ISCSI",
+        "username": "SL01SEL301234-11",
+    },
+    {
+        "accountId": 1111111,
+        "capacityGb": 20,
+        "createDate": "2015-04-29T07:55:55-06:00",
+        "id": 4917123,
+        "nasType": "NAS",
+        "username": "SL01SEV1234567_111"
+    }
+]
+
 getRouters = [
     {
         "accountId": 1,

SoftLayer/fixtures/SoftLayer_Hardware.py

@@ -57,3 +57,5 @@
         {'tag': {'name': 'a tag'}}
     ],
 }
+
+allowAccessToNetworkStorageList = True

SoftLayer/managers/hardware.py

@@ -788,6 +788,34 @@ def get_hardware_item_prices(self, location):
         return self.client.call('SoftLayer_Product_Package', 'getItemPrices', mask=object_mask, filter=object_filter,
                                 id=package['id'])
 
+    def authorize_storage(self, hardware_id, username_storage):
+        """Authorize File or Block Storage to a Hardware Server.
+
+        :param int hardware_id: Hardware server id.
+        :param string username_storage: Storage username.
+
+        :return: bool.
+        """
+        _filter = {"networkStorage": {"username": {"operation": username_storage}}}
+
+        storage_result = self.client.call('Account', 'getNetworkStorage', filter=_filter)
+
+        if len(storage_result) == 0:
+            raise SoftLayerError("The Storage with username: %s was not found, please"
+                                 " enter a valid storage username" % username_storage)
+
+        storage_template = [
+            {
+                "id": storage_result[0]['id'],
+                "username": username_storage
+            }
+        ]
+
+        result = self.client.call('Hardware', 'allowAccessToNetworkStorageList',
+                                  storage_template, id=hardware_id)
+
+        return result
+
     def upgrade(self, instance_id, memory=None,
                 nic_speed=None, drive_controller=None,
                 public_bandwidth=None, test=False):

docs/cli/hardware.rst

@@ -120,6 +120,10 @@ This function updates the firmware of a server. If already at the latest version
    :prog: hardware guests
    :show-nested:
 
+.. click:: SoftLayer.CLI.hardware.authorize_storage:cli
+   :prog: hardware authorize-storage
+   :show-nested:
+
 .. click:: SoftLayer.CLI.hardware.upgrade:cli
    :prog: hardware upgrade
    :show-nested:

tests/CLI/modules/server_tests.py

@@ -904,6 +904,27 @@ def test_hardware_guests_empty(self):
         self.assertEqual(result.exit_code, 2)
         self.assertIsInstance(result.exception, exceptions.CLIAbort)
 
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_authorize_hw_no_confirm(self, confirm_mock):
+        confirm_mock.return_value = False
+        result = self.run_command(['hw', 'authorize-storage', '-u', '1234'])
+
+        self.assertEqual(result.exit_code, 2)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_authorize_hw_empty(self, confirm_mock):
+        confirm_mock.return_value = True
+        storage_result = self.set_mock('SoftLayer_Account', 'getNetworkStorage')
+        storage_result.return_value = []
+        result = self.run_command(['hw', 'authorize-storage', '--username-storage=#', '1234'])
+
+        self.assertEqual(str(result.exception), "The Storage with username: # was not found, "
+                                                "please enter a valid storage username")
+
+    def test_authorize_hw(self):
+        result = self.run_command(['hw', 'authorize-storage', '--username-storage=SL01SEL301234-11', '1234'])
+        self.assert_no_fail(result)
+
     def test_upgrade_no_options(self, ):
         result = self.run_command(['hw', 'upgrade', '100'])
         self.assertEqual(result.exit_code, 2)
@@ -928,4 +949,5 @@ def test_upgrade(self, confirm_mock):
         confirm_mock.return_value = True
         result = self.run_command(['hw', 'upgrade', '100', '--memory=32', '--public-bandwidth=500',
                                    '--drive-controller=RAID', '--network=10000 Redundant'])
+
         self.assert_no_fail(result)

tests/managers/hardware_tests.py

@@ -841,6 +841,18 @@ def test_get_hardware_guests(self):
 
         self.assertEqual("NSX-T Manager", result[0]['hostname'])
 
+    def test_authorize_storage(self):
+        options = self.hardware.authorize_storage(1234, "SL01SEL301234-11")
+
+        self.assertEqual(True, options)
+
+    def test_authorize_storage_empty(self):
+        mock = self.set_mock('SoftLayer_Account', 'getNetworkStorage')
+        mock.return_value = []
+        self.assertRaises(SoftLayer.exceptions.SoftLayerError,
+                          self.hardware.authorize_storage,
+                          1234, "#")
+
     def test_get_price_id_memory_capacity(self):
         upgrade_prices = [
             {'categories': [{'categoryCode': 'ram'}], 'item': {'capacity': 1}, 'id': 99}