Add 'all-projects' option to 'volume backup list'

Similar to what 'volume list --all-projects' does, 'volume backup
list --all-projects' list volume backups accross all projects.

Change-Id: Id5dda9b5adc822c4ddfb2dda339946d3322858e2

Author: Jordan Pittier

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

@@ -94,6 +94,7 @@ List volume backups
         [--volume <volume>]
         [--marker <marker>]
         [--limit <limit>]
+        [--all-projects]
 
 .. _volume_backup_list-backup:
 .. option:: --long
@@ -125,6 +126,10 @@ List volume backups
 
     *Volume version 2 only*
 
+.. option:: --all-projects
+
+    Include all projects (admin only)
+
 volume backup restore
 ---------------------
 

openstackclient/tests/unit/volume/v1/test_backup.py

@@ -260,6 +260,7 @@ def test_backup_list_without_options(self):
             ("name", None),
             ("status", None),
             ("volume", None),
+            ('all_projects', False),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -269,8 +270,9 @@ def test_backup_list_without_options(self):
             "name": None,
             "status": None,
             "volume_id": None,
+            "all_tenants": False,
         }
-        self.volumes_mock.get.assert_not_called
+        self.volumes_mock.get.assert_not_called()
         self.backups_mock.list.assert_called_with(
             search_opts=search_opts,
         )
@@ -283,12 +285,14 @@ def test_backup_list_with_options(self):
             "--name", self.backups[0].name,
             "--status", "error",
             "--volume", self.volume.id,
+            "--all-projects"
         ]
         verifylist = [
             ("long", True),
             ("name", self.backups[0].name),
             ("status", "error"),
             ("volume", self.volume.id),
+            ('all_projects', True),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -298,6 +302,7 @@ def test_backup_list_with_options(self):
             "name": self.backups[0].name,
             "status": "error",
             "volume_id": self.volume.id,
+            "all_tenants": True,
         }
         self.volumes_mock.get.assert_called_once_with(self.volume.id)
         self.backups_mock.list.assert_called_with(

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

@@ -294,6 +294,7 @@ def test_backup_list_without_options(self):
             ("volume", None),
             ("marker", None),
             ("limit", None),
+            ('all_projects', False),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -303,9 +304,10 @@ def test_backup_list_without_options(self):
             "name": None,
             "status": None,
             "volume_id": None,
+            'all_tenants': False,
         }
-        self.volumes_mock.get.assert_not_called
-        self.backups_mock.get.assert_not_called
+        self.volumes_mock.get.assert_not_called()
+        self.backups_mock.get.assert_not_called()
         self.backups_mock.list.assert_called_with(
             search_opts=search_opts,
             marker=None,
@@ -321,6 +323,7 @@ def test_backup_list_with_options(self):
             "--status", "error",
             "--volume", self.volume.id,
             "--marker", self.backups[0].id,
+            "--all-projects",
             "--limit", "3",
         ]
         verifylist = [
@@ -329,6 +332,7 @@ def test_backup_list_with_options(self):
             ("status", "error"),
             ("volume", self.volume.id),
             ("marker", self.backups[0].id),
+            ('all_projects', True),
             ("limit", 3),
         ]
 
@@ -339,6 +343,7 @@ def test_backup_list_with_options(self):
             "name": self.backups[0].name,
             "status": "error",
             "volume_id": self.volume.id,
+            'all_tenants': True,
         }
         self.volumes_mock.get.assert_called_once_with(self.volume.id)
         self.backups_mock.get.assert_called_once_with(self.backups[0].id)

openstackclient/volume/v1/backup.py

@@ -172,6 +172,12 @@ def get_parser(self, prog_name):
             help=_("Filters results by the volume which they "
                    "backup (name or ID)")
         )
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Include all projects (admin only)'),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -215,6 +221,7 @@ def _format_volume_id(volume_id):
             'name': parsed_args.name,
             'status': parsed_args.status,
             'volume_id': filter_volume_id,
+            'all_tenants': parsed_args.all_projects,
         }
         data = volume_client.backups.list(
             search_opts=search_opts,

openstackclient/volume/v2/backup.py

@@ -212,6 +212,12 @@ def get_parser(self, prog_name):
             metavar='<limit>',
             help=_('Maximum number of backups to display'),
         )
+        parser.add_argument(
+            '--all-projects',
+            action='store_true',
+            default=False,
+            help=_('Include all projects (admin only)'),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -259,6 +265,7 @@ def _format_volume_id(volume_id):
             'name': parsed_args.name,
             'status': parsed_args.status,
             'volume_id': filter_volume_id,
+            'all_tenants': parsed_args.all_projects,
         }
         data = volume_client.backups.list(
             search_opts=search_opts,

releasenotes/notes/backup_list_all-projects_option-4bb23e0b9b075cac.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - The ``openstack volume backup list`` command now supports the
+    ``all-projects`` option to list volume backups accross all projects.