From 808caecc6db84c649a76e5df5d119e93b23000e6 Mon Sep 17 00:00:00 2001 From: Trevor McCasland Date: Tue, 17 Jan 2017 11:06:51 -0600 Subject: [PATCH] Add backup-list to OSC This change adds database support to the python-openstackclient project for the backup-list command. The trove command backup-list is now: openstack database backup list Change-Id: I9aafb76c5a0d4a49b92a356e8465abf5919ab0ac Partially-Implements: trove-support-in-python-openstackclient --- ...d-backup-list-to-osc-ea5cbfb579f3ffc7.yaml | 5 ++ setup.cfg | 1 + troveclient/osc/v1/database_backups.py | 66 +++++++++++++++++++ troveclient/tests/osc/v1/fakes.py | 8 +++ .../tests/osc/v1/test_database_backups.py | 50 ++++++++++++++ 5 files changed, 130 insertions(+) create mode 100644 releasenotes/notes/add-backup-list-to-osc-ea5cbfb579f3ffc7.yaml create mode 100644 troveclient/osc/v1/database_backups.py create mode 100644 troveclient/tests/osc/v1/test_database_backups.py diff --git a/releasenotes/notes/add-backup-list-to-osc-ea5cbfb579f3ffc7.yaml b/releasenotes/notes/add-backup-list-to-osc-ea5cbfb579f3ffc7.yaml new file mode 100644 index 00000000..d77f5097 --- /dev/null +++ b/releasenotes/notes/add-backup-list-to-osc-ea5cbfb579f3ffc7.yaml @@ -0,0 +1,5 @@ +--- +features: + - The command ``trove backup-list`` is now available to use in + the python-openstackclient CLI as ``openstack database backup + list`` diff --git a/setup.cfg b/setup.cfg index 1bb07a7b..bdc32896 100644 --- a/setup.cfg +++ b/setup.cfg @@ -30,6 +30,7 @@ openstack.cli.extension = database = troveclient.osc.plugin openstack.database.v1 = + database_backup_list = troveclient.osc.v1.database_backups:ListDatabaseBackups database_flavor_list = troveclient.osc.v1.database_flavors:ListDatabaseFlavors [build_sphinx] diff --git a/troveclient/osc/v1/database_backups.py b/troveclient/osc/v1/database_backups.py new file mode 100644 index 00000000..a7bd29e1 --- /dev/null +++ b/troveclient/osc/v1/database_backups.py @@ -0,0 +1,66 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""Database v1 Backups action implementations""" + +from osc_lib.command import command +from osc_lib import utils as osc_utils + +from troveclient.i18n import _ + + +class ListDatabaseBackups(command.Lister): + + _description = _("List database backups") + columns = ['ID', 'Instance ID', 'Name', 'Status', 'Parent ID', + 'Updated'] + + def get_parser(self, prog_name): + parser = super(ListDatabaseBackups, self).get_parser(prog_name) + parser.add_argument( + '--limit', + dest='limit', + metavar='', + default=None, + help=_('Return up to N number of the most recent bcakups.') + ) + parser.add_argument( + '--marker', + dest='marker', + metavar='', + type=str, + default=None, + help=_('Begin displaying the results for IDs greater than the' + 'specified marker. When used with :option:`--limit,` set' + 'this to the last ID displayed in the previous run.') + ) + parser.add_argument( + '--datastore', + dest='datastore', + metavar='', + default=None, + help=_('ID or name of the datastore (to filter backups by).') + ) + return parser + + def take_action(self, parsed_args): + database_backups = self.app.client_manager.database.backups + items = database_backups.list(limit=parsed_args.limit, + datastore=parsed_args.datastore, + marker=parsed_args.marker) + backups = items + while items.next and not parsed_args.limit: + items = database_backups.list(marker=items.next) + backups += items + backups = [osc_utils.get_item_properties(b, self.columns) + for b in backups] + return self.columns, backups diff --git a/troveclient/tests/osc/v1/fakes.py b/troveclient/tests/osc/v1/fakes.py index 0b0267f6..9df54b20 100644 --- a/troveclient/tests/osc/v1/fakes.py +++ b/troveclient/tests/osc/v1/fakes.py @@ -15,6 +15,7 @@ import mock from troveclient.tests import fakes from troveclient.tests.osc import utils +from troveclient.v1 import backups from troveclient.v1 import flavors @@ -29,3 +30,10 @@ class FakeFlavors(object): def get_flavors_1(self): return flavors.Flavor(None, self.fake_flavors[0]) + + +class FakeBackups(object): + fake_backups = fakes.FakeHTTPClient().get_backups()[2]['backups'] + + def get_backup_bk_1234(self): + return backups.Backup(None, self.fake_backups[0]) diff --git a/troveclient/tests/osc/v1/test_database_backups.py b/troveclient/tests/osc/v1/test_database_backups.py new file mode 100644 index 00000000..05fa18ba --- /dev/null +++ b/troveclient/tests/osc/v1/test_database_backups.py @@ -0,0 +1,50 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +from troveclient import common +from troveclient.osc.v1 import database_backups +from troveclient.tests.osc.v1 import fakes + + +class TestBackups(fakes.TestDatabasev1): + fake_backups = fakes.FakeBackups() + + def setUp(self): + super(TestBackups, self).setUp() + self.mock_client = self.app.client_manager.database + self.backup_client = self.app.client_manager.database.backups + + +class TestBackupList(TestBackups): + + defaults = { + 'datastore': None, + 'limit': None, + 'marker': None + } + + columns = database_backups.ListDatabaseBackups.columns + values = ('bk-1234', '1234', 'bkp_1', 'COMPLETED', None, + '2015-05-16T14:23:08') + + def setUp(self): + super(TestBackupList, self).setUp() + self.cmd = database_backups.ListDatabaseBackups(self.app, None) + data = [self.fake_backups.get_backup_bk_1234()] + self.backup_client.list.return_value = common.Paginated(data) + + def test_backup_list_defaults(self): + parsed_args = self.check_parser(self.cmd, [], []) + columns, data = self.cmd.take_action(parsed_args) + self.backup_client.list.assert_called_once_with(**self.defaults) + self.assertEqual(self.columns, columns) + self.assertEqual([self.values], data)