From 940ee3279b81914e09035a3db8382591044cecec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Harald=20Jens=C3=A5s?= <hjensas@redhat.com>
Date: Tue, 4 Dec 2018 00:35:48 +0100
Subject: [PATCH] Add '--provide' option to node clean command

Provide (make available) the nodes once cleaning is
completed.

Also add tests for node cleaning.

Closes-Bug: #1806502
Change-Id: Ic9212236e4372faaf7d43da8958adec5eac9df06
---
 .../v1/overcloud_node/test_overcloud_node.py  | 95 +++++++++++++++++++
 tripleoclient/v1/overcloud_node.py            | 16 +++-
 2 files changed, 110 insertions(+), 1 deletion(-)

diff --git a/tripleoclient/tests/v1/overcloud_node/test_overcloud_node.py b/tripleoclient/tests/v1/overcloud_node/test_overcloud_node.py
index 45176a2fa..3a55a21f4 100644
--- a/tripleoclient/tests/v1/overcloud_node/test_overcloud_node.py
+++ b/tripleoclient/tests/v1/overcloud_node/test_overcloud_node.py
@@ -339,6 +339,101 @@ class TestIntrospectNode(fakes.TestOvercloudNode):
                           self.cmd, argslist, verifylist)
 
 
+class TestCleanNode(fakes.TestOvercloudNode):
+
+    def setUp(self):
+        super(TestCleanNode, self).setUp()
+
+        self.workflow = self.app.client_manager.workflow_engine
+        execution = mock.Mock()
+        execution.id = "IDID"
+        self.workflow.executions.create.return_value = execution
+        client = self.app.client_manager.tripleoclient
+        self.websocket = client.messaging_websocket()
+
+        # Get the command object to test
+        self.cmd = overcloud_node.CleanNode(self.app, None)
+
+    def _check_clean_all_manageable(self, parsed_args, provide=False):
+        self.websocket.wait_for_messages.return_value = iter([{
+            "status": "SUCCESS",
+            "message": "Success",
+            "cleaned_nodes": {},
+            "execution": {"id": "IDID"}
+        }] * 2)
+
+        self.cmd.take_action(parsed_args)
+
+        call_list = [mock.call(
+            'tripleo.baremetal.v1.clean_manageable_nodes',
+            workflow_input={}
+        )]
+
+        if provide:
+            call_list.append(mock.call(
+                'tripleo.baremetal.v1.provide_manageable_nodes',
+                workflow_input={}
+            ))
+
+        self.workflow.executions.create.assert_has_calls(call_list)
+        self.assertEqual(self.workflow.executions.create.call_count,
+                         2 if provide else 1)
+
+    def _check_clean_nodes(self, parsed_args, nodes, provide=False):
+        self.websocket.wait_for_messages.return_value = [{
+            "status": "SUCCESS",
+            "message": "Success",
+            "execution": {"id": "IDID"}
+        }]
+
+        self.cmd.take_action(parsed_args)
+
+        call_list = [mock.call(
+            'tripleo.baremetal.v1.clean_nodes', workflow_input={
+                'node_uuids': nodes}
+        )]
+
+        if provide:
+            call_list.append(mock.call(
+                'tripleo.baremetal.v1.provide', workflow_input={
+                    'node_uuids': nodes}
+            ))
+
+        self.workflow.executions.create.assert_has_calls(call_list)
+        self.assertEqual(self.workflow.executions.create.call_count,
+                         2 if provide else 1)
+
+    def test_clean_all_manageable_nodes_without_provide(self):
+        parsed_args = self.check_parser(self.cmd,
+                                        ['--all-manageable'],
+                                        [('all_manageable', True)])
+        self._check_clean_all_manageable(parsed_args, provide=False)
+
+    def test_clean_all_manageable_nodes_with_provide(self):
+        parsed_args = self.check_parser(self.cmd,
+                                        ['--all-manageable', '--provide'],
+                                        [('all_manageable', True),
+                                         ('provide', True)])
+        self._check_clean_all_manageable(parsed_args, provide=True)
+
+    def test_clean_nodes_without_provide(self):
+        nodes = ['node_uuid1', 'node_uuid2']
+        parsed_args = self.check_parser(self.cmd,
+                                        nodes,
+                                        [('node_uuids', nodes)])
+        self._check_clean_nodes(parsed_args, nodes, provide=False)
+
+    def test_clean_nodes_with_provide(self):
+        nodes = ['node_uuid1', 'node_uuid2']
+        argslist = nodes + ['--provide']
+
+        parsed_args = self.check_parser(self.cmd,
+                                        argslist,
+                                        [('node_uuids', nodes),
+                                         ('provide', True)])
+        self._check_clean_nodes(parsed_args, nodes, provide=True)
+
+
 class TestImportNode(fakes.TestOvercloudNode):
 
     def setUp(self):
diff --git a/tripleoclient/v1/overcloud_node.py b/tripleoclient/v1/overcloud_node.py
index 654ac040f..e2674d854 100644
--- a/tripleoclient/v1/overcloud_node.py
+++ b/tripleoclient/v1/overcloud_node.py
@@ -140,17 +140,31 @@ class CleanNode(command.Command):
                            action='store_true',
                            help=_("Clean all nodes currently in 'manageable'"
                                   " state"))
+        parser.add_argument('--provide',
+                            action='store_true',
+                            help=_('Provide (make available) the nodes once '
+                                   'cleaned'))
         return parser
 
     def take_action(self, parsed_args):
         self.log.debug("take_action(%s)" % parsed_args)
 
-        if parsed_args.node_uuids:
+        nodes = parsed_args.node_uuids
+
+        if nodes:
             baremetal.clean_nodes(self.app.client_manager,
                                   node_uuids=parsed_args.node_uuids)
         else:
             baremetal.clean_manageable_nodes(self.app.client_manager)
 
+        if parsed_args.provide:
+            if nodes:
+                baremetal.provide(self.app.client_manager,
+                                  node_uuids=nodes,
+                                  )
+            else:
+                baremetal.provide_manageable_nodes(self.app.client_manager)
+
 
 class IntrospectNode(command.Command):
     """Introspect specified nodes or all nodes in 'manageable' state."""