Skip to content

Commit 406b94b

Browse files
Zuulopenstack-gerrit
Zuul
authored and
openstack-gerrit
committed
Merge "volume: Add v3-specific backup record module"
2 parents 666b8a7 + d6ca31c commit 406b94b

4 files changed

Lines changed: 239 additions & 2 deletions

File tree

‎openstackclient/tests/unit/volume/v3/fakes.py‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,35 @@ def get_backups(backups=None, count=2):
439439
return mock.Mock(side_effect=backups)
440440

441441

442+
def create_backup_record():
443+
"""Gets a fake backup record for a given backup.
444+
445+
:return: An "exported" backup record.
446+
"""
447+
448+
return {
449+
'backup_service': 'cinder.backup.drivers.swift.SwiftBackupDriver',
450+
'backup_url': 'eyJzdGF0dXMiOiAiYXZh',
451+
}
452+
453+
454+
def import_backup_record():
455+
"""Creates a fake backup record import response from a backup.
456+
457+
:return: The fake backup object that was encoded.
458+
"""
459+
return {
460+
'backup': {
461+
'id': 'backup.id',
462+
'name': 'backup.name',
463+
'links': [
464+
{'href': 'link1', 'rel': 'self'},
465+
{'href': 'link2', 'rel': 'bookmark'},
466+
],
467+
},
468+
}
469+
470+
442471
def create_one_cluster(attrs=None):
443472
"""Create a fake service cluster.
444473

‎openstackclient/tests/unit/volume/v3/test_backup_record.py‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
#
2+
# Licensed under the Apache License, Version 2.0 (the "License"); you may
3+
# not use this file except in compliance with the License. You may obtain
4+
# a copy of the License at
5+
#
6+
# http://www.apache.org/licenses/LICENSE-2.0
7+
#
8+
# Unless required by applicable law or agreed to in writing, software
9+
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
10+
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
11+
# License for the specific language governing permissions and limitations
12+
# under the License.
13+
14+
from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
15+
from openstackclient.volume.v3 import backup_record
16+
17+
18+
class TestBackupRecord(volume_fakes.TestVolume):
19+
def setUp(self):
20+
super().setUp()
21+
22+
self.backups_mock = self.volume_client.backups
23+
self.backups_mock.reset_mock()
24+
25+
26+
class TestBackupRecordExport(TestBackupRecord):
27+
new_backup = volume_fakes.create_one_backup(
28+
attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
29+
)
30+
new_record = volume_fakes.create_backup_record()
31+
32+
def setUp(self):
33+
super().setUp()
34+
35+
self.backups_mock.export_record.return_value = self.new_record
36+
self.backups_mock.get.return_value = self.new_backup
37+
38+
# Get the command object to mock
39+
self.cmd = backup_record.ExportBackupRecord(self.app, None)
40+
41+
def test_backup_export_table(self):
42+
arglist = [
43+
self.new_backup.name,
44+
]
45+
verifylist = [
46+
("backup", self.new_backup.name),
47+
]
48+
49+
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
50+
parsed_args.formatter = 'table'
51+
columns, __ = self.cmd.take_action(parsed_args)
52+
53+
self.backups_mock.export_record.assert_called_with(
54+
self.new_backup.id,
55+
)
56+
57+
expected_columns = ('Backup Service', 'Metadata')
58+
self.assertEqual(columns, expected_columns)
59+
60+
def test_backup_export_json(self):
61+
arglist = [
62+
self.new_backup.name,
63+
]
64+
verifylist = [
65+
("backup", self.new_backup.name),
66+
]
67+
68+
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
69+
parsed_args.formatter = 'json'
70+
columns, __ = self.cmd.take_action(parsed_args)
71+
72+
self.backups_mock.export_record.assert_called_with(
73+
self.new_backup.id,
74+
)
75+
76+
expected_columns = ('backup_service', 'backup_url')
77+
self.assertEqual(columns, expected_columns)
78+
79+
80+
class TestBackupRecordImport(TestBackupRecord):
81+
new_backup = volume_fakes.create_one_backup(
82+
attrs={'volume_id': 'a54708a2-0388-4476-a909-09579f885c25'},
83+
)
84+
new_import = volume_fakes.import_backup_record()
85+
86+
def setUp(self):
87+
super().setUp()
88+
89+
self.backups_mock.import_record.return_value = self.new_import
90+
91+
# Get the command object to mock
92+
self.cmd = backup_record.ImportBackupRecord(self.app, None)
93+
94+
def test_backup_import(self):
95+
arglist = [
96+
"cinder.backup.drivers.swift.SwiftBackupDriver",
97+
"fake_backup_record_data",
98+
]
99+
verifylist = [
100+
(
101+
"backup_service",
102+
"cinder.backup.drivers.swift.SwiftBackupDriver",
103+
),
104+
("backup_metadata", "fake_backup_record_data"),
105+
]
106+
107+
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
108+
columns, __ = self.cmd.take_action(parsed_args)
109+
110+
self.backups_mock.import_record.assert_called_with(
111+
"cinder.backup.drivers.swift.SwiftBackupDriver",
112+
"fake_backup_record_data",
113+
)
114+
self.assertEqual(columns, ('backup',))

‎openstackclient/volume/v3/backup_record.py‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
#
2+
# Licensed under the Apache License, Version 2.0 (the "License"); you may
3+
# not use this file except in compliance with the License. You may obtain
4+
# a copy of the License at
5+
#
6+
# http://www.apache.org/licenses/LICENSE-2.0
7+
#
8+
# Unless required by applicable law or agreed to in writing, software
9+
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
10+
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
11+
# License for the specific language governing permissions and limitations
12+
# under the License.
13+
14+
"""Volume v3 Backup action implementations"""
15+
16+
import argparse
17+
import logging
18+
from collections.abc import Iterable, Sequence
19+
from typing import Any
20+
21+
from osc_lib import utils
22+
23+
from openstackclient import command
24+
from openstackclient.i18n import _
25+
26+
LOG = logging.getLogger(__name__)
27+
28+
29+
class ExportBackupRecord(command.ShowOne):
30+
_description = _(
31+
"""Export volume backup details.
32+
33+
Backup information can be imported into a new service instance to be able to
34+
restore."""
35+
)
36+
37+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
38+
parser = super().get_parser(prog_name)
39+
parser.add_argument(
40+
"backup",
41+
metavar="<backup>",
42+
help=_("Backup to export (name or ID)"),
43+
)
44+
return parser
45+
46+
def take_action(
47+
self, parsed_args: argparse.Namespace
48+
) -> tuple[Sequence[str], Iterable[Any]]:
49+
volume_client = self.app.client_manager.volume
50+
backup = utils.find_resource(volume_client.backups, parsed_args.backup)
51+
backup_data = volume_client.backups.export_record(backup.id)
52+
53+
# We only want to show "friendly" display names, but also want to keep
54+
# json structure compatibility with cinderclient
55+
if parsed_args.formatter == 'table':
56+
backup_data['Backup Service'] = backup_data.pop('backup_service')
57+
backup_data['Metadata'] = backup_data.pop('backup_url')
58+
59+
col_headers, col_data = zip(*sorted(backup_data.items()))
60+
return col_headers, col_data
61+
62+
63+
class ImportBackupRecord(command.ShowOne):
64+
_description = _(
65+
"""Import volume backup details.
66+
67+
Exported backup details contain the metadata necessary to restore to a new or
68+
rebuilt service instance"""
69+
)
70+
71+
def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
72+
parser = super().get_parser(prog_name)
73+
parser.add_argument(
74+
"backup_service",
75+
metavar="<backup_service>",
76+
help=_("Backup service containing the backup."),
77+
)
78+
parser.add_argument(
79+
"backup_metadata",
80+
metavar="<backup_metadata>",
81+
help=_("Encoded backup metadata from export."),
82+
)
83+
return parser
84+
85+
def take_action(
86+
self, parsed_args: argparse.Namespace
87+
) -> tuple[Sequence[str], Iterable[Any]]:
88+
volume_client = self.app.client_manager.volume
89+
backup_data = volume_client.backups.import_record(
90+
parsed_args.backup_service, parsed_args.backup_metadata
91+
)
92+
backup_data.pop('links', None)
93+
col_headers, col_data = zip(*sorted(backup_data.items()))
94+
return col_headers, col_data

‎pyproject.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -719,8 +719,8 @@ volume_backup_unset = "openstackclient.volume.v3.volume_backup:UnsetVolumeBackup
719719
volume_backup_show = "openstackclient.volume.v3.volume_backup:ShowVolumeBackup"
720720
volume_backend_capability_show = "openstackclient.volume.v3.volume_backend:ShowCapability"
721721
volume_backend_pool_list = "openstackclient.volume.v3.volume_backend:ListPool"
722-
volume_backup_record_export = "openstackclient.volume.v2.backup_record:ExportBackupRecord"
723-
volume_backup_record_import = "openstackclient.volume.v2.backup_record:ImportBackupRecord"
722+
volume_backup_record_export = "openstackclient.volume.v3.backup_record:ExportBackupRecord"
723+
volume_backup_record_import = "openstackclient.volume.v3.backup_record:ImportBackupRecord"
724724
volume_group_create = "openstackclient.volume.v3.volume_group:CreateVolumeGroup"
725725
volume_group_delete = "openstackclient.volume.v3.volume_group:DeleteVolumeGroup"
726726
volume_group_list = "openstackclient.volume.v3.volume_group:ListVolumeGroup"

0 commit comments

Comments
 (0)