Add --property option to 'server rebuild' command

Add '--property' option to the 'server rebuild' command, to provide
the ability to specify properties of the rebuilt instance.

This is equivalent to the '--meta' option of the compute's
'nova rebuild' command.

Change-Id: I25ea6622e970416090109316e1e28fab8b0b3f07
Story: #2003979
Task: #26922

Author: Ruby Loo

openstackclient/compute/v2/server.py

@@ -1517,6 +1517,13 @@ def get_parser(self, prog_name):
             metavar='<password>',
             help=_("Set the password on the rebuilt instance"),
         )
+        parser.add_argument(
+            '--property',
+            metavar='<key=value>',
+            action=parseractions.KeyValueAction,
+            help=_('Set a property on the rebuilt instance '
+                   '(repeat option to set multiple values)'),
+        )
         parser.add_argument(
             '--wait',
             action='store_true',
@@ -1542,7 +1549,11 @@ def _show_progress(progress):
             'image', {}).get('id')
         image = utils.find_resource(image_client.images, image_id)
 
-        server = server.rebuild(image, parsed_args.password)
+        kwargs = {}
+        if parsed_args.property:
+            kwargs['meta'] = parsed_args.property
+
+        server = server.rebuild(image, parsed_args.password, **kwargs)
         if parsed_args.wait:
             if utils.wait_for_status(
                 compute_client.servers.get,

openstackclient/tests/unit/compute/v2/test_server.py

@@ -2496,6 +2496,27 @@ def test_rebuild_with_wait_fails(self, mock_wait_for_status):
         self.images_mock.get.assert_called_with(self.image.id)
         self.server.rebuild.assert_called_with(self.image, None)
 
+    def test_rebuild_with_property(self):
+        arglist = [
+            self.server.id,
+            '--property', 'key1=value1',
+            '--property', 'key2=value2'
+        ]
+        expected_property = {'key1': 'value1', 'key2': 'value2'}
+        verifylist = [
+            ('server', self.server.id),
+            ('property', expected_property)
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        # Get the command object to test
+        self.cmd.take_action(parsed_args)
+
+        self.servers_mock.get.assert_called_with(self.server.id)
+        self.images_mock.get.assert_called_with(self.image.id)
+        self.server.rebuild.assert_called_with(
+            self.image, None, meta=expected_property)
+
 
 class TestServerRemoveFixedIP(TestServer):
 

releasenotes/notes/server-rebuild-property-e8c6439b04e27c80.yaml

@@ -0,0 +1,6 @@
+---
+features:
+  - |
+    Add ``--property`` option to the ``server rebuild`` command, to provide
+    the ability to specify properties of the rebuilt instance.
+    [Story `2003979 <https://storyboard.openstack.org/#!/story/2003979>`_]