Merge pull request #1407 from Rajarajan97/master

Adding disaster recovery failover api method

Author: allmightyspiff

SoftLayer/CLI/block/replication/disaster_recovery_failover.py

@@ -0,0 +1,38 @@
+"""Failover an inaccessible block volume to its available replicant volume."""
+# :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 formatting
+
+
+@click.command(epilog="""Failover an inaccessible block volume to its available replicant volume.
+If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately
+failover to an available replica in another location. This method does not allow for failback via API.
+After using this method, to failback to the original volume, please open a support ticket.
+If you wish to test failover, please use replica-failover.""")
+@click.argument('volume-id')
+@click.option('--replicant-id', help="ID of the replicant volume")
+@environment.pass_env
+def cli(env, volume_id, replicant_id):
+    """Failover an inaccessible block volume to its available replicant volume."""
+    block_storage_manager = SoftLayer.BlockStorageManager(env.client)
+
+    click.secho("""WARNING : Failover an inaccessible block volume to its available replicant volume."""
+                """If a volume (with replication) becomes inaccessible due to a disaster event,"""
+                """this method can be used to immediately failover to an available replica in another location."""
+                """This method does not allow for failback via the API."""
+                """To failback to the original volume after using this method, open a support ticket."""
+                """If you wish to test failover, use replica-failover instead.""", fg='red')
+
+    if not formatting.confirm('Are you sure you want to continue?'):
+        raise exceptions.CLIAbort('Aborted.')
+
+    block_storage_manager.disaster_recovery_failover_to_replicant(
+        volume_id,
+        replicant_id
+    )
+
+    click.echo("Disaster Recovery Failover to replicant is now in progress.")

SoftLayer/CLI/file/replication/disaster_recovery_failover.py

@@ -0,0 +1,39 @@
+"""Failover an inaccessible file volume to its available replicant volume."""
+# :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 formatting
+
+
+@click.command(epilog="""Failover an inaccessible file volume to its available replicant volume.
+If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately
+failover to an available replica in another location. This method does not allow for failback via API.
+After using this method, to failback to the original volume, please open a support ticket.
+If you wish to test failover, please use replica-failover.
+""")
+@click.argument('volume-id')
+@click.option('--replicant-id', help="ID of the replicant volume")
+@environment.pass_env
+def cli(env, volume_id, replicant_id):
+    """Failover an inaccessible file volume to its available replicant volume."""
+    file_storage_manager = SoftLayer.FileStorageManager(env.client)
+
+    click.secho("""WARNING : Failover an inaccessible file volume to its available replicant volume."""
+                """If a volume (with replication) becomes inaccessible due to a disaster event,"""
+                """this method can be used to immediately failover to an available replica in another location."""
+                """This method does not allow for failback via the API."""
+                """To failback to the original volume after using this method, open a support ticket."""
+                """If you wish to test failover, use replica-failover instead.""", fg='red')
+
+    if not formatting.confirm('Are you sure you want to continue?'):
+        raise exceptions.CLIAbort('Aborted.')
+
+    file_storage_manager.disaster_recovery_failover_to_replicant(
+        volume_id,
+        replicant_id
+    )
+
+    click.echo("Disaster Recovery Failover to replicant is now in progress.")

SoftLayer/CLI/routes.py

@@ -92,6 +92,7 @@
     ('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:disaster-recovery-failover', 'SoftLayer.CLI.block.replication.disaster_recovery_failover:cli'),
     ('block:replica-order', 'SoftLayer.CLI.block.replication.order:cli'),
     ('block:replica-partners', 'SoftLayer.CLI.block.replication.partners:cli'),
     ('block:replica-locations', 'SoftLayer.CLI.block.replication.locations:cli'),
@@ -127,6 +128,7 @@
     ('file:access-revoke', 'SoftLayer.CLI.file.access.revoke:cli'),
     ('file:replica-failback', 'SoftLayer.CLI.file.replication.failback:cli'),
     ('file:replica-failover', 'SoftLayer.CLI.file.replication.failover:cli'),
+    ('file:disaster-recovery-failover', 'SoftLayer.CLI.file.replication.disaster_recovery_failover:cli'),
     ('file:replica-order', 'SoftLayer.CLI.file.replication.order:cli'),
     ('file:replica-partners', 'SoftLayer.CLI.file.replication.partners:cli'),
     ('file:replica-locations', 'SoftLayer.CLI.file.replication.locations:cli'),

SoftLayer/fixtures/SoftLayer_Network_Storage.py

@@ -221,6 +221,7 @@
 failoverToReplicant = True
 failbackFromReplicant = True
 restoreFromSnapshot = True
+disasterRecoveryFailoverToReplicant = True
 
 createSnapshot = {
     'id': 449

SoftLayer/managers/storage.py

@@ -398,13 +398,21 @@ def failover_to_replicant(self, volume_id, replicant_id):
         """
         return self.client.call('Network_Storage', 'failoverToReplicant', replicant_id, id=volume_id)
 
+    def disaster_recovery_failover_to_replicant(self, volume_id, replicant_id):
+        """Disaster Recovery Failover to a volume replicant.
+
+        :param integer volume_id: The id of the volume
+        :param integer replicant: ID of replicant to failover to
+        :return: Returns whether failover to successful or not
+        """
+        return self.client.call('Network_Storage', 'disasterRecoveryFailoverToReplicant', replicant_id, id=volume_id)
+
     def failback_from_replicant(self, volume_id):
         """Failback from a volume replicant.
 
         :param integer volume_id: The id of the volume
         :return: Returns whether failback was successful or not
         """
-
         return self.client.call('Network_Storage', 'failbackFromReplicant', id=volume_id)
 
     def cancel_volume(self, volume_id, reason='No longer needed', immediate=False):

docs/cli/block.rst

@@ -142,3 +142,7 @@ Block Commands
 .. click:: SoftLayer.CLI.block.set_note:cli
     :prog: block volume-set-note
     :show-nested:
+
+.. click:: SoftLayer.CLI.block.replication.disaster_recovery_failover:cli
+    :prog: block disaster-recovery-failover
+    :show-nested:

docs/cli/file.rst

@@ -121,4 +121,8 @@ File Commands
 
 .. click:: SoftLayer.CLI.file.set_note:cli
     :prog: file volume-set-note
+    :show-nested:
+
+.. click:: SoftLayer.CLI.file.replication.disaster_recovery_failover:cli
+    :prog: file disaster-recovery-failover
     :show-nested:

tests/CLI/modules/block_tests.py

@@ -4,9 +4,11 @@
 
     :license: MIT, see LICENSE for more details.
 """
-from SoftLayer import exceptions
+from SoftLayer.CLI import exceptions
+from SoftLayer import SoftLayerAPIError
 from SoftLayer import testing
 
+
 import json
 import mock
 
@@ -48,7 +50,7 @@ def test_volume_set_lun_id_in_range_missing_value(self):
     def test_volume_set_lun_id_not_in_range(self):
         value = '-1'
         lun_mock = self.set_mock('SoftLayer_Network_Storage', 'createOrUpdateLunId')
-        lun_mock.side_effect = exceptions.SoftLayerAPIError(
+        lun_mock.side_effect = SoftLayerAPIError(
             'SoftLayer_Exception_Network_Storage_Iscsi_InvalidLunId',
             'The LUN ID specified is out of the valid range: %s [min: 0 max: 4095]' % (value))
         result = self.run_command('block volume-set-lun-id 1234 42'.split())
@@ -496,8 +498,18 @@ def test_replicant_failover(self):
                                    '--replicant-id=5678'])
 
         self.assert_no_fail(result)
-        self.assertEqual('Failover to replicant is now in progress.\n',
-                         result.output)
+        self.assertEqual('Failover to replicant is now in progress.\n', result.output)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    @mock.patch('SoftLayer.BlockStorageManager.disaster_recovery_failover_to_replicant')
+    def test_disaster_recovery_failover(self, disaster_recovery_failover_mock, confirm_mock):
+        confirm_mock.return_value = True
+        disaster_recovery_failover_mock.return_value = True
+        result = self.run_command(['block', 'disaster-recovery-failover', '12345678',
+                                   '--replicant-id=5678'])
+
+        self.assert_no_fail(result)
+        self.assertIn('Disaster Recovery Failover to replicant is now in progress.\n', result.output)
 
     def test_replication_locations(self):
         result = self.run_command(['block', 'replica-locations', '1234'])
@@ -558,6 +570,16 @@ def test_replicant_failover_unsuccessful(self, failover_mock):
         self.assertEqual('Failover operation could not be initiated.\n',
                          result.output)
 
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_disaster_recovery_failover_aborted(self, confirm_mock):
+        confirm_mock.return_value = False
+
+        result = self.run_command(['block', 'disaster-recovery-failover', '12345678',
+                                   '--replicant-id=5678'])
+
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.CLIAbort)
+
     def test_replicant_failback(self):
         result = self.run_command(['block', 'replica-failback', '12345678'])
 

tests/CLI/modules/file_tests.py

@@ -4,7 +4,8 @@
 
     :license: MIT, see LICENSE for more details.
 """
-from SoftLayer import exceptions
+from SoftLayer.CLI import exceptions
+from SoftLayer import SoftLayerError
 from SoftLayer import testing
 
 import json
@@ -126,7 +127,7 @@ def test_volume_cancel_without_billing_item(self):
         result = self.run_command([
             '--really', 'file', 'volume-cancel', '1234'])
 
-        self.assertIsInstance(result.exception, exceptions.SoftLayerError)
+        self.assertIsInstance(result.exception, SoftLayerError)
 
     def test_volume_detail(self):
         result = self.run_command(['file', 'volume-detail', '1234'])
@@ -493,6 +494,26 @@ def test_replicant_failover_unsuccessful(self, failover_mock):
         self.assertEqual('Failover operation could not be initiated.\n',
                          result.output)
 
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    @mock.patch('SoftLayer.FileStorageManager.disaster_recovery_failover_to_replicant')
+    def test_disaster_recovery_failover(self, disaster_recovery_failover_mock, confirm_mock):
+        confirm_mock.return_value = True
+        disaster_recovery_failover_mock.return_value = True
+        result = self.run_command(['file', 'disaster-recovery-failover', '12345678', '--replicant-id=5678'])
+
+        self.assert_no_fail(result)
+        self.assertIn('Disaster Recovery Failover to replicant is now in progress.\n', result.output)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_disaster_recovery_failover_aborted(self, confirm_mock):
+        confirm_mock.return_value = False
+
+        result = self.run_command(['file', 'disaster-recovery-failover', '12345678',
+                                   '--replicant-id=5678'])
+
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.CLIAbort)
+
     def test_replicant_failback(self):
         result = self.run_command(['file', 'replica-failback', '12345678'])
 

tests/managers/block_tests.py

@@ -384,6 +384,18 @@ def test_replicant_failover(self):
             identifier=1234,
         )
 
+    def test_disaster_recovery_failover(self):
+        result = self.block.disaster_recovery_failover_to_replicant(1234, 5678)
+
+        self.assertEqual(
+            SoftLayer_Network_Storage.disasterRecoveryFailoverToReplicant, result)
+        self.assert_called_with(
+            'SoftLayer_Network_Storage',
+            'disasterRecoveryFailoverToReplicant',
+            args=(5678,),
+            identifier=1234,
+        )
+
     def test_replicant_failback(self):
         result = self.block.failback_from_replicant(1234)
 

tests/managers/file_tests.py

@@ -289,6 +289,18 @@ def test_replicant_failover(self):
             identifier=1234,
         )
 
+    def test_disaster_recovery_failover(self):
+        result = self.file.disaster_recovery_failover_to_replicant(1234, 5678)
+
+        self.assertEqual(
+            SoftLayer_Network_Storage.disasterRecoveryFailoverToReplicant, result)
+        self.assert_called_with(
+            'SoftLayer_Network_Storage',
+            'disasterRecoveryFailoverToReplicant',
+            args=(5678,),
+            identifier=1234,
+        )
+
     def test_replicant_failback(self):
         result = self.file.failback_from_replicant(1234)