Stephen Finucane ca7f23d0d1 compute: Add 'server volume update' command
We're not going to expose the ability to swap volumes since that's a
things humans should not generally use. From the API docs [1]:

  When updating volumeId, this API is typically meant to only be used
  as part of a larger orchestrated volume migration operation initiated
  in the block storage service via the os-retype or os-migrate_volume
  volume actions. Direct usage of this API to update volumeId is not
  recommended and may result in needing to hard reboot the server to
  update details within the guest such as block storage serial IDs.
  Furthermore, updating volumeId via this API is only implemented by
  certain compute drivers.

We *do* want users to have the ability to change the delete on
termination behavior though, so that's what we expose.

[1] https://docs.openstack.org/api-ref/compute/?expanded=update-a-volume-attachment-detail#update-a-volume-attachment

Change-Id: I50938e1237b4d298521b26a5f9cb90c018dfebaf
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-01-12 16:29:07 +00:00

288 lines
9.3 KiB
Python

# 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 novaclient import api_versions
from osc_lib import exceptions
from openstackclient.compute.v2 import server_volume
from openstackclient.tests.unit.compute.v2 import fakes as compute_fakes
class TestServerVolume(compute_fakes.TestComputev2):
def setUp(self):
super().setUp()
# Get a shortcut to the compute client ServerManager Mock
self.servers_mock = self.app.client_manager.compute.servers
self.servers_mock.reset_mock()
# Get a shortcut to the compute client VolumeManager mock
self.servers_volumes_mock = self.app.client_manager.compute.volumes
self.servers_volumes_mock.reset_mock()
class TestServerVolumeList(TestServerVolume):
def setUp(self):
super().setUp()
self.server = compute_fakes.FakeServer.create_one_server()
self.volume_attachments = (
compute_fakes.FakeVolumeAttachment.create_volume_attachments())
self.servers_mock.get.return_value = self.server
self.servers_volumes_mock.get_server_volumes.return_value = (
self.volume_attachments)
# Get the command object to test
self.cmd = server_volume.ListServerVolume(self.app, None)
def test_server_volume_list(self):
self.app.client_manager.compute.api_version = \
api_versions.APIVersion('2.1')
arglist = [
self.server.id,
]
verifylist = [
('server', self.server.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(('ID', 'Device', 'Server ID', 'Volume ID'), columns)
self.assertEqual(
(
(
self.volume_attachments[0].id,
self.volume_attachments[0].device,
self.volume_attachments[0].serverId,
self.volume_attachments[0].volumeId,
),
(
self.volume_attachments[1].id,
self.volume_attachments[1].device,
self.volume_attachments[1].serverId,
self.volume_attachments[1].volumeId,
),
),
tuple(data),
)
self.servers_volumes_mock.get_server_volumes.assert_called_once_with(
self.server.id)
def test_server_volume_list_with_tags(self):
self.app.client_manager.compute.api_version = \
api_versions.APIVersion('2.70')
arglist = [
self.server.id,
]
verifylist = [
('server', self.server.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(
('ID', 'Device', 'Server ID', 'Volume ID', 'Tag',), columns,
)
self.assertEqual(
(
(
self.volume_attachments[0].id,
self.volume_attachments[0].device,
self.volume_attachments[0].serverId,
self.volume_attachments[0].volumeId,
self.volume_attachments[0].tag,
),
(
self.volume_attachments[1].id,
self.volume_attachments[1].device,
self.volume_attachments[1].serverId,
self.volume_attachments[1].volumeId,
self.volume_attachments[1].tag,
),
),
tuple(data),
)
self.servers_volumes_mock.get_server_volumes.assert_called_once_with(
self.server.id)
def test_server_volume_list_with_delete_on_attachment(self):
self.app.client_manager.compute.api_version = \
api_versions.APIVersion('2.79')
arglist = [
self.server.id,
]
verifylist = [
('server', self.server.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.assertEqual(
(
'ID', 'Device', 'Server ID', 'Volume ID', 'Tag',
'Delete On Termination?',
),
columns,
)
self.assertEqual(
(
(
self.volume_attachments[0].id,
self.volume_attachments[0].device,
self.volume_attachments[0].serverId,
self.volume_attachments[0].volumeId,
self.volume_attachments[0].tag,
self.volume_attachments[0].delete_on_termination,
),
(
self.volume_attachments[1].id,
self.volume_attachments[1].device,
self.volume_attachments[1].serverId,
self.volume_attachments[1].volumeId,
self.volume_attachments[1].tag,
self.volume_attachments[1].delete_on_termination,
),
),
tuple(data),
)
self.servers_volumes_mock.get_server_volumes.assert_called_once_with(
self.server.id)
class TestServerVolumeUpdate(TestServerVolume):
def setUp(self):
super().setUp()
self.server = compute_fakes.FakeServer.create_one_server()
self.servers_mock.get.return_value = self.server
# Get the command object to test
self.cmd = server_volume.UpdateServerVolume(self.app, None)
def test_server_volume_update(self):
arglist = [
self.server.id,
'foo',
]
verifylist = [
('server', self.server.id),
('volume', 'foo'),
('delete_on_termination', None),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
# This is a no-op
self.servers_volumes_mock.update_server_volume.assert_not_called()
self.assertIsNone(result)
def test_server_volume_update_with_delete_on_termination(self):
self.app.client_manager.compute.api_version = \
api_versions.APIVersion('2.85')
arglist = [
self.server.id,
'foo',
'--delete-on-termination',
]
verifylist = [
('server', self.server.id),
('volume', 'foo'),
('delete_on_termination', True),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.servers_volumes_mock.update_server_volume.assert_called_once_with(
self.server.id, 'foo', 'foo',
delete_on_termination=True)
self.assertIsNone(result)
def test_server_volume_update_with_preserve_on_termination(self):
self.app.client_manager.compute.api_version = \
api_versions.APIVersion('2.85')
arglist = [
self.server.id,
'foo',
'--preserve-on-termination',
]
verifylist = [
('server', self.server.id),
('volume', 'foo'),
('delete_on_termination', False),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.servers_volumes_mock.update_server_volume.assert_called_once_with(
self.server.id, 'foo', 'foo',
delete_on_termination=False)
self.assertIsNone(result)
def test_server_volume_update_with_delete_on_termination_pre_v285(self):
self.app.client_manager.compute.api_version = \
api_versions.APIVersion('2.84')
arglist = [
self.server.id,
'foo',
'--delete-on-termination',
]
verifylist = [
('server', self.server.id),
('volume', 'foo'),
('delete_on_termination', True),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(
exceptions.CommandError,
self.cmd.take_action,
parsed_args)
def test_server_volume_update_with_preserve_on_termination_pre_v285(self):
self.app.client_manager.compute.api_version = \
api_versions.APIVersion('2.84')
arglist = [
self.server.id,
'foo',
'--preserve-on-termination',
]
verifylist = [
('server', self.server.id),
('volume', 'foo'),
('delete_on_termination', False),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(
exceptions.CommandError,
self.cmd.take_action,
parsed_args)