Add --default option to "volume type list"

Add "--default" option to volume v2's "type list"
command, it will show which volume type the volume
service has set as default.

Implements: bp cinder-command-support
Change-Id: Iae7ebc633ebe5554cc88390a84361887ec211fb2

Author: jiahui.qiang

doc/source/command-objects/volume-type.rst

@@ -87,7 +87,7 @@ List volume types
 
     os volume type list
         [--long]
-        [--public | --private]
+        [--default | --public | --private]
 
 .. option:: --long
 
@@ -105,6 +105,12 @@ List volume types
 
     *Volume version 2 only*
 
+.. option:: --default
+
+    List the default volume type
+
+    *Volume version 2 only*
+
 volume type set
 ---------------
 

openstackclient/tests/functional/volume/v2/test_volume_type.py

@@ -42,6 +42,11 @@ def test_volume_type_list(self):
         raw_output = self.openstack('volume type list' + opts)
         self.assertIn(self.NAME, raw_output)
 
+    def test_volume_type_list_default(self):
+        opts = self.get_opts(self.HEADERS)
+        raw_output = self.openstack('volume type list --default' + opts)
+        self.assertEqual("lvmdriver-1\n", raw_output)
+
     def test_volume_type_show(self):
         opts = self.get_opts(self.FIELDS)
         raw_output = self.openstack('volume type show ' + self.NAME + opts)

openstackclient/tests/unit/volume/v2/test_type.py

@@ -172,7 +172,11 @@ class TestTypeList(TestType):
         "Description",
         "Properties"
     ]
-
+    data_with_default_type = [(
+        volume_types[0].id,
+        volume_types[0].name,
+        True
+    )]
     data = []
     for t in volume_types:
         data.append((
@@ -194,6 +198,7 @@ def setUp(self):
         super(TestTypeList, self).setUp()
 
         self.types_mock.list.return_value = self.volume_types
+        self.types_mock.default.return_value = self.volume_types[0]
         # get the command to test
         self.cmd = volume_type.ListVolumeType(self.app, None)
 
@@ -203,6 +208,7 @@ def test_type_list_without_options(self):
             ("long", False),
             ("private", False),
             ("public", False),
+            ("default", False),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
@@ -220,6 +226,7 @@ def test_type_list_with_options(self):
             ("long", True),
             ("private", False),
             ("public", True),
+            ("default", False),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
@@ -236,6 +243,7 @@ def test_type_list_with_private_option(self):
             ("long", False),
             ("private", True),
             ("public", False),
+            ("default", False),
         ]
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
 
@@ -244,6 +252,23 @@ def test_type_list_with_private_option(self):
         self.assertEqual(self.columns, columns)
         self.assertEqual(self.data, list(data))
 
+    def test_type_list_with_default_option(self):
+        arglist = [
+            "--default",
+        ]
+        verifylist = [
+            ("long", False),
+            ("private", False),
+            ("public", False),
+            ("default", True),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        columns, data = self.cmd.take_action(parsed_args)
+        self.types_mock.default.assert_called_once_with()
+        self.assertEqual(self.columns, columns)
+        self.assertEqual(self.data_with_default_type, list(data))
+
 
 class TestTypeSet(TestType):
 

openstackclient/volume/v2/volume_type.py

@@ -160,8 +160,15 @@ def get_parser(self, prog_name):
             '--long',
             action='store_true',
             default=False,
-            help=_('List additional fields in output'))
+            help=_('List additional fields in output')
+        )
         public_group = parser.add_mutually_exclusive_group()
+        public_group.add_argument(
+            "--default",
+            action='store_true',
+            default=False,
+            help=_('List the default volume type')
+        )
         public_group.add_argument(
             "--public",
             action="store_true",
@@ -175,21 +182,24 @@ def get_parser(self, prog_name):
         return parser
 
     def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
         if parsed_args.long:
             columns = ['ID', 'Name', 'Is Public', 'Description', 'Extra Specs']
             column_headers = [
                 'ID', 'Name', 'Is Public', 'Description', 'Properties']
         else:
             columns = ['ID', 'Name', 'Is Public']
             column_headers = columns
-
-        is_public = None
-        if parsed_args.public:
-            is_public = True
-        if parsed_args.private:
-            is_public = False
-        data = self.app.client_manager.volume.volume_types.list(
-            is_public=is_public)
+        if parsed_args.default:
+            data = [volume_client.volume_types.default()]
+        else:
+            is_public = None
+            if parsed_args.public:
+                is_public = True
+            if parsed_args.private:
+                is_public = False
+            data = volume_client.volume_types.list(
+                is_public=is_public)
         return (column_headers,
                 (utils.get_item_properties(
                     s, columns,
@@ -240,7 +250,6 @@ def take_action(self, parsed_args):
 
         volume_type = utils.find_resource(
             volume_client.volume_types, parsed_args.volume_type)
-
         result = 0
         kwargs = {}
         if parsed_args.name:

releasenotes/notes/bp-cinder-command-support-82dbadef47454c18.yaml

@@ -0,0 +1,7 @@
+---
+features:
+  - |
+    Add ``--default`` option to ``volume type list`` command, in
+    order to show which volume type the volume sets as it's
+    default.
+    [Blueprint :oscbp:`cinder-command-support`]