Add delete_on_termination support for server creation

This adds the --delete-on-termination option to the openstack
server create command when booting a server from a volume.

The option allows users to automatically delete the boot volume
when the server is deleted by passing delete_on_termination in the
block device mapping.

The option is only valid with --boot-from-volume and returns a
CommandError when used without a boot volume.

Change-Id: I2a79fb3de4a372584b9d4c8a391e0725a3bf1852
Signed-off-by: Udayendu Kar <udayendu.kar@gmail.com>

Author: Udayendu

openstackclient/compute/v2/server.py

@@ -1239,6 +1239,15 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
                 'options.'
             ),
         )
+        parser.add_argument(
+            '--delete-on-termination',
+            action='store_true',
+            default=False,
+            help=_(
+                'Delete the boot volume automatically when the server is '
+                'deleted (only valid with --boot-from-volume).'
+            ),
+        )
         # TODO(stephenfin): Remove this in the v7.0
         parser.add_argument(
             '--block-device-mapping',
@@ -1698,6 +1707,16 @@ def _match_image(image_api: Any, wanted_properties: Any) -> Any:
                 ignore_missing=False,
             ).id
 
+        if (
+            parsed_args.delete_on_termination
+            and not parsed_args.boot_from_volume
+        ):
+            msg = _(
+                "--delete-on-termination can only be used with "
+                "--boot-from-volume"
+            )
+            raise exceptions.CommandError(msg)
+
         snapshot = None
         if parsed_args.snapshot:
             # --snapshot and --boot-from-volume are mutually exclusive.
@@ -1783,6 +1802,7 @@ def _match_image(image_api: Any, wanted_properties: Any) -> Any:
                     'source_type': 'image',
                     'destination_type': 'volume',
                     'volume_size': parsed_args.boot_from_volume,
+                    'delete_on_termination': parsed_args.delete_on_termination,
                 }
             ]
             # If booting from volume we do not pass an image to compute.

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

@@ -3404,6 +3404,86 @@ def test_server_create_volume_boot_from_volume_conflict(self):
         )
         self.compute_client.create_server.assert_not_called()
 
+    def test_server_create_delete_on_termination_without_boot_from_volume(
+        self,
+    ):
+        # Fail if --delete-on-termination is used without --boot-from-volume
+        arglist = [
+            '--image',
+            self.image.id,
+            '--flavor',
+            self.flavor.id,
+            '--delete-on-termination',
+            self.server.name,
+        ]
+        verifylist = [
+            ('image', self.image.id),
+            ('flavor', self.flavor.id),
+            ('delete_on_termination', True),
+            ('config_drive', False),
+            ('server_name', self.server.name),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        exc = self.assertRaises(
+            exceptions.CommandError,
+            self.cmd.take_action,
+            parsed_args,
+        )
+
+        self.assertIn(
+            '--delete-on-termination can only be used with --boot-from-volume',
+            str(exc),
+        )
+
+        self.compute_client.create_server.assert_not_called()
+
+    def test_server_create_boot_from_volume_delete_on_termination(self):
+        arglist = [
+            '--image',
+            self.image.id,
+            '--flavor',
+            self.flavor.id,
+            '--boot-from-volume',
+            '10',
+            '--delete-on-termination',
+            self.server.name,
+        ]
+        verifylist = [
+            ('image', self.image.id),
+            ('flavor', self.flavor.id),
+            ('boot_from_volume', 10),
+            ('delete_on_termination', True),
+            ('config_drive', False),
+            ('server_name', self.server.name),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        columns, data = self.cmd.take_action(parsed_args)
+
+        self.compute_client.create_server.assert_called_once_with(
+            name=self.server.name,
+            image_id='',
+            flavor_id=self.flavor.id,
+            min_count=1,
+            max_count=1,
+            networks=[],
+            block_device_mapping=[
+                {
+                    'uuid': self.image.id,
+                    'boot_index': 0,
+                    'source_type': 'image',
+                    'destination_type': 'volume',
+                    'volume_size': 10,
+                    'delete_on_termination': True,
+                },
+            ],
+        )
+
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.datalist(), data)
+
     def test_server_create_boot_from_volume_no_image(self):
         # Test --boot-from-volume option without --image or
         # --image-property.