clear_foreign_config() succeeds if no foreign disk

When clear_foreign_config() does not detect a foreign disk, instead
of failing and raising an exception, it succeeds and returns a value
which informs the caller nothing further needs to be done.

Change-Id: I4cea95659db11747b1c8708e1dbe7cac53c0eaf9
(cherry picked from commit 8eec25c00d)

dracclient/resources/raid.py

@@ -94,6 +94,8 @@ VirtualDisk = collections.namedtuple(
      'status', 'raid_status', 'span_depth', 'span_length',
      'pending_operations', 'physical_disks'])
 
+NO_FOREIGN_DRIVE = "STOR018"
+
 
 class RAIDManagement(object):
 
@@ -809,7 +811,34 @@ class RAIDManagement(object):
 
         doc = self.client.invoke(uris.DCIM_RAIDService, 'ClearForeignConfig',
                                  selectors, properties,
-                                 expected_return_value=utils.RET_SUCCESS)
-
-        return utils.build_return_dict(doc, uris.DCIM_RAIDService,
-                                       is_commit_required_value=True)
+                                 check_return_value=False)
+
+        is_commit_required_value = True
+        is_reboot_required_value = None
+
+        ret_value = utils.find_xml(doc,
+                                   'ReturnValue',
+                                   uris.DCIM_RAIDService).text
+
+        if ret_value == utils.RET_ERROR:
+            message_id = utils.find_xml(doc,
+                                        'MessageID',
+                                        uris.DCIM_RAIDService).text
+
+            # A MessageID 'STOR018' indicates no foreign drive was
+            # detected. Return a value which informs the caller nothing
+            # further needs to be done.
+            if message_id == NO_FOREIGN_DRIVE:
+                is_commit_required_value = False
+                is_reboot_required_value = constants.RebootRequired.false
+            else:
+                message = utils.find_xml(doc,
+                                         'Message',
+                                         uris.DCIM_RAIDService).text
+                raise exceptions.DRACOperationFailed(
+                    drac_messages=message)
+
+        return utils.build_return_dict(
+            doc, uris.DCIM_RAIDService,
+            is_commit_required_value=is_commit_required_value,
+            is_reboot_required_value=is_reboot_required_value)

dracclient/tests/test_raid.py

@@ -639,6 +639,7 @@ class ClientRAIDManagementTestCase(base.BaseTest):
         mock_invoke.return_value = lxml.etree.fromstring(
             test_utils.RAIDInvocations[uris.DCIM_RAIDService][
                 'ClearForeignConfig']['ok'])
+
         result = self.drac_client.clear_foreign_config(
             self.raid_controller_fqdd)
         self.assertEqual({'is_commit_required': True,
@@ -648,21 +649,49 @@ class ClientRAIDManagementTestCase(base.BaseTest):
         mock_invoke.assert_called_once_with(
             mock.ANY, uris.DCIM_RAIDService, 'ClearForeignConfig',
             expected_selectors, expected_properties,
-            expected_return_value=utils.RET_SUCCESS)
+            check_return_value=False)
+
+    @mock.patch.object(dracclient.client.WSManClient, 'invoke',
+                       spec_set=True, autospec=True)
+    def test_clear_foreign_config_with_no_foreign_drive(self,
+                                                        mock_requests,
+                                                        mock_invoke):
+        expected_selectors = {'SystemCreationClassName': 'DCIM_ComputerSystem',
+                              'CreationClassName': 'DCIM_RAIDService',
+                              'SystemName': 'DCIM:ComputerSystem',
+                              'Name': 'DCIM:RAIDService'}
+        expected_properties = {'Target': self.raid_controller_fqdd}
+        mock_invoke.return_value = lxml.etree.fromstring(
+            test_utils.RAIDInvocations[uris.DCIM_RAIDService][
+                'ClearForeignConfig']['no_foreign_drive'])
+
+        result = self.drac_client.clear_foreign_config(
+            self.raid_controller_fqdd)
+        self.assertEqual({'is_commit_required': False,
+                          'is_reboot_required':
+                          constants.RebootRequired.false},
+                         result)
+        mock_invoke.assert_called_once_with(
+            mock.ANY, uris.DCIM_RAIDService, 'ClearForeignConfig',
+            expected_selectors, expected_properties,
+            check_return_value=False)
 
     @mock.patch.object(dracclient.client.WSManClient,
                        'wait_until_idrac_is_ready', spec_set=True,
                        autospec=True)
-    def test_clear_foreign_config_fail(self, mock_requests,
-                                       mock_wait_until_idrac_is_ready):
+    def test_clear_foreign_config_with_invalid_controller_id(
+            self,
+            mock_requests,
+            mock_wait_until_idrac_is_ready):
         mock_requests.post(
             'https://1.2.3.4:443/wsman',
             text=test_utils.RAIDInvocations[
-                uris.DCIM_RAIDService]['ClearForeignConfig']['error'])
+                uris.DCIM_RAIDService]['ClearForeignConfig']
+            ['invalid_controller_id'])
 
         self.assertRaises(
             exceptions.DRACOperationFailed,
-            self.drac_client.clear_foreign_config, self.raid_controller_fqdd)
+            self.drac_client.clear_foreign_config, 'bad')
 
     @mock.patch.object(dracclient.resources.job.JobManagement,
                        'create_config_job', spec_set=True, autospec=True)

dracclient/tests/utils.py

@@ -263,8 +263,10 @@ RAIDInvocations = {
         'ClearForeignConfig': {
             'ok': load_wsman_xml(
                 'raid_service-invoke-clear_foreign_config-ok'),
-            'error': load_wsman_xml(
-                'raid_service-invoke-clear_foreign_config-error'),
+            'no_foreign_drive': load_wsman_xml(
+                'raid_service-invoke-clear_foreign_config-no_foreign_drive'),
+            'invalid_controller_id': load_wsman_xml(
+                'raid_service-invoke-clear_foreign_config-invalid_controller'),
         }
     }
 }

dracclient/tests/wsman_mocks/raid_service-invoke-clear_foreign_config-invalid_controller.xml

@@ -0,0 +1,17 @@
+<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
+            xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing"
+            xmlns:n1="http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_RAIDService">
+  <s:Header>
+    <wsa:To>http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous</wsa:To>
+    <wsa:Action>http://schemas.dell.com/wbem/wscim/1/cim-schema/2/DCIM_RAIDService/ClearForeignConfigResponse</wsa:Action>
+    <wsa:RelatesTo>uuid:f9487fcf-103a-103a-8002-fd0aa2bdb228</wsa:RelatesTo>
+    <wsa:MessageID>uuid:000852e6-1040-1040-8997-a36fc6fe83b0</wsa:MessageID>
+  </s:Header>
+  <s:Body>
+    <n1:ClearForeignConfig_OUTPUT>
+      <n1:Message>Controller not found</n1:Message>
+      <n1:MessageID>STOR030</n1:MessageID>
+      <n1:ReturnValue>2</n1:ReturnValue>
+    </n1:ClearForeignConfig_OUTPUT>
+  </s:Body>
+</s:Envelope>

dracclient/tests/wsman_mocks/raid_service-invoke-clear_foreign_config-no_foreign_drive.xml

@@ -9,7 +9,7 @@
   </s:Header>
   <s:Body>
     <n1:ClearForeignConfig_OUTPUT>
-      <n1:Message>>No foreign drives detected</n1:Message>
+      <n1:Message>No foreign drives detected</n1:Message>
       <n1:MessageID>STOR018</n1:MessageID>
       <n1:ReturnValue>2</n1:ReturnValue>
     </n1:ClearForeignConfig_OUTPUT>