Refactoring: create ironic.conductor.inspection

... to reduce the already frightening size of ironic.conductor.manager
and make space for more inspection additions.

While here, fix up log messages for clarity and brevity.

Change-Id: I5196d58016ae094f17e0aad187a11d9cceaab04b

2 files changed, 121 insertions, 113 deletions

diff --git a/ironic/tests/unit/conductor/test_inspection.py b/ironic/tests/unit/conductor/test_inspection.py
new file mode 100644
index 000000000..c64b883e4
--- /dev/null
+++ b/ironic/tests/unit/conductor/test_inspection.py
@@ -0,0 +1,118 @@
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from unittest import mock
+
+from ironic.common import exception
+from ironic.common import states
+from ironic.conductor import inspection
+from ironic.conductor import task_manager
+from ironic.tests.unit.db import base as db_base
+from ironic.tests.unit.objects import utils as obj_utils
+
+
+@mock.patch('ironic.drivers.modules.fake.FakeInspect.inspect_hardware',
+            autospec=True)
+class TestInspectHardware(db_base.DbTestCase):
+
+    def test_inspect_hardware_ok(self, mock_inspect):
+        node = obj_utils.create_test_node(
+            self.context, driver='fake-hardware',
+            provision_state=states.INSPECTING,
+            driver_internal_info={'agent_url': 'url',
+                                  'agent_secret_token': 'token'})
+        task = task_manager.TaskManager(self.context, node.uuid)
+        mock_inspect.return_value = states.MANAGEABLE
+        inspection.inspect_hardware(task)
+        node.refresh()
+        self.assertEqual(states.MANAGEABLE, node.provision_state)
+        self.assertEqual(states.NOSTATE, node.target_provision_state)
+        self.assertIsNone(node.last_error)
+        mock_inspect.assert_called_once_with(task.driver.inspect, task)
+        task.node.refresh()
+        self.assertNotIn('agent_url', task.node.driver_internal_info)
+        self.assertNotIn('agent_secret_token', task.node.driver_internal_info)
+
+    def test_inspect_hardware_return_inspecting(self, mock_inspect):
+        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
+                                          provision_state=states.INSPECTING)
+        task = task_manager.TaskManager(self.context, node.uuid)
+        mock_inspect.return_value = states.INSPECTING
+        self.assertRaises(exception.HardwareInspectionFailure,
+                          inspection.inspect_hardware, task)
+
+        node.refresh()
+        self.assertIn('driver returned unexpected state', node.last_error)
+        self.assertEqual(states.INSPECTFAIL, node.provision_state)
+        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
+        mock_inspect.assert_called_once_with(task.driver.inspect, task)
+
+    def test_inspect_hardware_return_inspect_wait(self, mock_inspect):
+        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
+                                          provision_state=states.INSPECTING)
+        task = task_manager.TaskManager(self.context, node.uuid)
+        mock_inspect.return_value = states.INSPECTWAIT
+        inspection.inspect_hardware(task)
+        node.refresh()
+        self.assertEqual(states.INSPECTWAIT, node.provision_state)
+        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
+        self.assertIsNone(node.last_error)
+        mock_inspect.assert_called_once_with(task.driver.inspect, task)
+
+    @mock.patch.object(inspection, 'LOG', autospec=True)
+    def test_inspect_hardware_return_other_state(self, log_mock, mock_inspect):
+        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
+                                          provision_state=states.INSPECTING)
+        task = task_manager.TaskManager(self.context, node.uuid)
+        mock_inspect.return_value = None
+        self.assertRaises(exception.HardwareInspectionFailure,
+                          inspection.inspect_hardware, task)
+        node.refresh()
+        self.assertEqual(states.INSPECTFAIL, node.provision_state)
+        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
+        self.assertIsNotNone(node.last_error)
+        mock_inspect.assert_called_once_with(task.driver.inspect, task)
+        self.assertTrue(log_mock.error.called)
+
+    def test_inspect_hardware_raises_error(self, mock_inspect):
+        mock_inspect.side_effect = exception.HardwareInspectionFailure('test')
+        state = states.MANAGEABLE
+        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
+                                          provision_state=states.INSPECTING,
+                                          target_provision_state=state)
+        task = task_manager.TaskManager(self.context, node.uuid)
+
+        self.assertRaisesRegex(exception.HardwareInspectionFailure, '^test$',
+                               inspection.inspect_hardware, task)
+        node.refresh()
+        self.assertEqual(states.INSPECTFAIL, node.provision_state)
+        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
+        self.assertEqual('test', node.last_error)
+        self.assertTrue(mock_inspect.called)
+
+    def test_inspect_hardware_unexpected_error(self, mock_inspect):
+        mock_inspect.side_effect = RuntimeError('x')
+        state = states.MANAGEABLE
+        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
+                                          provision_state=states.INSPECTING,
+                                          target_provision_state=state)
+        task = task_manager.TaskManager(self.context, node.uuid)
+
+        self.assertRaisesRegex(exception.HardwareInspectionFailure,
+                               'Unexpected exception of type RuntimeError: x',
+                               inspection.inspect_hardware, task)
+        node.refresh()
+        self.assertEqual(states.INSPECTFAIL, node.provision_state)
+        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
+        self.assertEqual('Unexpected exception of type RuntimeError: x',
+                         node.last_error)
+        self.assertTrue(mock_inspect.called)
diff --git a/ironic/tests/unit/conductor/test_manager.py b/ironic/tests/unit/conductor/test_manager.py
index 6a6f7e08f..7278486a5 100644
--- a/ironic/tests/unit/conductor/test_manager.py
+++ b/ironic/tests/unit/conductor/test_manager.py
@@ -46,6 +46,7 @@ from ironic.common import nova
 from ironic.common import states
 from ironic.conductor import cleaning
 from ironic.conductor import deployments
+from ironic.conductor import inspection
 from ironic.conductor import manager
 from ironic.conductor import notification_utils
 from ironic.conductor import steps as conductor_steps
@@ -6461,77 +6462,6 @@ class ManagerSyncLocalStateTestCase(mgr_utils.CommonMixIn, db_base.DbTestCase):
 @mgr_utils.mock_record_keepalive
 class NodeInspectHardware(mgr_utils.ServiceSetUpMixin, db_base.DbTestCase):
 
-    @mock.patch('ironic.drivers.modules.fake.FakeInspect.inspect_hardware',
-                autospec=True)
-    def test_inspect_hardware_ok(self, mock_inspect):
-        self._start_service()
-        node = obj_utils.create_test_node(
-            self.context, driver='fake-hardware',
-            provision_state=states.INSPECTING,
-            driver_internal_info={'agent_url': 'url',
-                                  'agent_secret_token': 'token'})
-        task = task_manager.TaskManager(self.context, node.uuid)
-        mock_inspect.return_value = states.MANAGEABLE
-        manager._do_inspect_hardware(task)
-        node.refresh()
-        self.assertEqual(states.MANAGEABLE, node.provision_state)
-        self.assertEqual(states.NOSTATE, node.target_provision_state)
-        self.assertIsNone(node.last_error)
-        mock_inspect.assert_called_once_with(task.driver.inspect, task)
-        task.node.refresh()
-        self.assertNotIn('agent_url', task.node.driver_internal_info)
-        self.assertNotIn('agent_secret_token', task.node.driver_internal_info)
-
-    @mock.patch('ironic.drivers.modules.fake.FakeInspect.inspect_hardware',
-                autospec=True)
-    def test_inspect_hardware_return_inspecting(self, mock_inspect):
-        self._start_service()
-        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
-                                          provision_state=states.INSPECTING)
-        task = task_manager.TaskManager(self.context, node.uuid)
-        mock_inspect.return_value = states.INSPECTING
-        self.assertRaises(exception.HardwareInspectionFailure,
-                          manager._do_inspect_hardware, task)
-
-        node.refresh()
-        self.assertIn('driver returned unexpected state', node.last_error)
-        self.assertEqual(states.INSPECTFAIL, node.provision_state)
-        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
-        mock_inspect.assert_called_once_with(task.driver.inspect, task)
-
-    @mock.patch('ironic.drivers.modules.fake.FakeInspect.inspect_hardware',
-                autospec=True)
-    def test_inspect_hardware_return_inspect_wait(self, mock_inspect):
-        self._start_service()
-        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
-                                          provision_state=states.INSPECTING)
-        task = task_manager.TaskManager(self.context, node.uuid)
-        mock_inspect.return_value = states.INSPECTWAIT
-        manager._do_inspect_hardware(task)
-        node.refresh()
-        self.assertEqual(states.INSPECTWAIT, node.provision_state)
-        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
-        self.assertIsNone(node.last_error)
-        mock_inspect.assert_called_once_with(task.driver.inspect, task)
-
-    @mock.patch.object(manager, 'LOG', autospec=True)
-    @mock.patch('ironic.drivers.modules.fake.FakeInspect.inspect_hardware',
-                autospec=True)
-    def test_inspect_hardware_return_other_state(self, mock_inspect, log_mock):
-        self._start_service()
-        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
-                                          provision_state=states.INSPECTING)
-        task = task_manager.TaskManager(self.context, node.uuid)
-        mock_inspect.return_value = None
-        self.assertRaises(exception.HardwareInspectionFailure,
-                          manager._do_inspect_hardware, task)
-        node.refresh()
-        self.assertEqual(states.INSPECTFAIL, node.provision_state)
-        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
-        self.assertIsNotNone(node.last_error)
-        mock_inspect.assert_called_once_with(task.driver.inspect, task)
-        self.assertTrue(log_mock.error.called)
-
     def test__check_inspect_wait_timeouts(self):
         self._start_service()
         CONF.set_override('inspect_wait_timeout', 1, group='conductor')
@@ -6609,46 +6539,6 @@ class NodeInspectHardware(mgr_utils.ServiceSetUpMixin, db_base.DbTestCase):
     def test_inspect_hardware_power_validate_fail(self, mock_validate):
         self._test_inspect_hardware_validate_fail(mock_validate)
 
-    @mock.patch('ironic.drivers.modules.fake.FakeInspect.inspect_hardware',
-                autospec=True)
-    def test_inspect_hardware_raises_error(self, mock_inspect):
-        self._start_service()
-        mock_inspect.side_effect = exception.HardwareInspectionFailure('test')
-        state = states.MANAGEABLE
-        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
-                                          provision_state=states.INSPECTING,
-                                          target_provision_state=state)
-        task = task_manager.TaskManager(self.context, node.uuid)
-
-        self.assertRaisesRegex(exception.HardwareInspectionFailure, '^test$',
-                               manager._do_inspect_hardware, task)
-        node.refresh()
-        self.assertEqual(states.INSPECTFAIL, node.provision_state)
-        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
-        self.assertEqual('test', node.last_error)
-        self.assertTrue(mock_inspect.called)
-
-    @mock.patch('ironic.drivers.modules.fake.FakeInspect.inspect_hardware',
-                autospec=True)
-    def test_inspect_hardware_unexpected_error(self, mock_inspect):
-        self._start_service()
-        mock_inspect.side_effect = RuntimeError('x')
-        state = states.MANAGEABLE
-        node = obj_utils.create_test_node(self.context, driver='fake-hardware',
-                                          provision_state=states.INSPECTING,
-                                          target_provision_state=state)
-        task = task_manager.TaskManager(self.context, node.uuid)
-
-        self.assertRaisesRegex(exception.HardwareInspectionFailure,
-                               'Unexpected exception of type RuntimeError: x',
-                               manager._do_inspect_hardware, task)
-        node.refresh()
-        self.assertEqual(states.INSPECTFAIL, node.provision_state)
-        self.assertEqual(states.MANAGEABLE, node.target_provision_state)
-        self.assertEqual('Unexpected exception of type RuntimeError: x',
-                         node.last_error)
-        self.assertTrue(mock_inspect.called)
-
 
 @mock.patch.object(conductor_utils, 'node_history_record',
                    mock.Mock(spec=conductor_utils.node_history_record))
@@ -8247,7 +8137,7 @@ class NodeTraitsTestCase(mgr_utils.ServiceSetUpMixin, db_base.DbTestCase):
 class DoNodeInspectAbortTestCase(mgr_utils.CommonMixIn,
                                  mgr_utils.ServiceSetUpMixin,
                                  db_base.DbTestCase):
-    @mock.patch.object(manager, 'LOG', autospec=True)
+    @mock.patch.object(inspection, 'LOG', autospec=True)
     @mock.patch('ironic.drivers.modules.fake.FakeInspect.abort', autospec=True)
     @mock.patch('ironic.conductor.task_manager.acquire', autospec=True)
     def test_do_inspect_abort_interface_not_support(self, mock_acquire,
@@ -8268,7 +8158,7 @@ class DoNodeInspectAbortTestCase(mgr_utils.CommonMixIn,
                          exc.exc_info[0])
         self.assertTrue(mock_log.error.called)
 
-    @mock.patch.object(manager, 'LOG', autospec=True)
+    @mock.patch.object(inspection, 'LOG', autospec=True)
     @mock.patch('ironic.drivers.modules.fake.FakeInspect.abort', autospec=True)
     @mock.patch('ironic.conductor.task_manager.acquire', autospec=True)
     def test_do_inspect_abort_interface_return_failed(self, mock_acquire,