Merge "volume: Add v3-specific volume host module"

Author: Zuul

openstackclient/tests/unit/volume/v3/test_volume_host.py

@@ -0,0 +1,115 @@
+#
+#   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 openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
+from openstackclient.volume.v3 import volume_host
+
+
+class TestVolumeHost(volume_fakes.TestVolume):
+    def setUp(self):
+        super().setUp()
+
+        self.host_mock = self.volume_client.services
+        self.host_mock.reset_mock()
+
+
+class TestVolumeHostSet(TestVolumeHost):
+    service = volume_fakes.create_one_service()
+
+    def setUp(self):
+        super().setUp()
+
+        self.host_mock.freeze_host.return_value = None
+        self.host_mock.thaw_host.return_value = None
+
+        # Get the command object to mock
+        self.cmd = volume_host.SetVolumeHost(self.app, None)
+
+    def test_volume_host_set_nothing(self):
+        arglist = [
+            self.service.host,
+        ]
+        verifylist = [
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.freeze_host.assert_not_called()
+        self.host_mock.thaw_host.assert_not_called()
+        self.assertIsNone(result)
+
+    def test_volume_host_set_enable(self):
+        arglist = [
+            '--enable',
+            self.service.host,
+        ]
+        verifylist = [
+            ('enable', True),
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.thaw_host.assert_called_with(self.service.host)
+        self.host_mock.freeze_host.assert_not_called()
+        self.assertIsNone(result)
+
+    def test_volume_host_set_disable(self):
+        arglist = [
+            '--disable',
+            self.service.host,
+        ]
+        verifylist = [
+            ('disable', True),
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.freeze_host.assert_called_with(self.service.host)
+        self.host_mock.thaw_host.assert_not_called()
+        self.assertIsNone(result)
+
+
+class TestVolumeHostFailover(TestVolumeHost):
+    service = volume_fakes.create_one_service()
+
+    def setUp(self):
+        super().setUp()
+
+        self.host_mock.failover_host.return_value = None
+
+        # Get the command object to mock
+        self.cmd = volume_host.FailoverVolumeHost(self.app, None)
+
+    def test_volume_host_failover(self):
+        arglist = [
+            '--volume-backend',
+            'backend_test',
+            self.service.host,
+        ]
+        verifylist = [
+            ('volume_backend', 'backend_test'),
+            ('host', self.service.host),
+        ]
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        result = self.cmd.take_action(parsed_args)
+
+        self.host_mock.failover_host.assert_called_with(
+            self.service.host, 'backend_test'
+        )
+        self.assertIsNone(result)

openstackclient/volume/v3/volume_host.py

@@ -0,0 +1,74 @@
+#
+#   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.
+
+"""Volume v3 host action implementations"""
+
+import argparse
+
+from openstackclient import command
+from openstackclient.i18n import _
+
+
+class FailoverVolumeHost(command.Command):
+    _description = _("Failover volume host to different backend")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "host", metavar="<host-name>", help=_("Name of volume host")
+        )
+        parser.add_argument(
+            "--volume-backend",
+            metavar="<backend-id>",
+            required=True,
+            help=_(
+                "The ID of the volume backend replication "
+                "target where the host will failover to (required)"
+            ),
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        service_client = self.app.client_manager.volume
+        service_client.services.failover_host(
+            parsed_args.host, parsed_args.volume_backend
+        )
+
+
+class SetVolumeHost(command.Command):
+    _description = _("Set volume host properties")
+
+    def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "host", metavar="<host-name>", help=_("Name of volume host")
+        )
+        enabled_group = parser.add_mutually_exclusive_group()
+        enabled_group.add_argument(
+            "--disable",
+            action="store_true",
+            help=_("Freeze and disable the specified volume host"),
+        )
+        enabled_group.add_argument(
+            "--enable",
+            action="store_true",
+            help=_("Thaw and enable the specified volume host"),
+        )
+        return parser
+
+    def take_action(self, parsed_args: argparse.Namespace) -> None:
+        service_client = self.app.client_manager.volume
+        if parsed_args.enable:
+            service_client.services.thaw_host(parsed_args.host)
+        if parsed_args.disable:
+            service_client.services.freeze_host(parsed_args.host)

pyproject.toml

@@ -736,7 +736,7 @@ volume_group_type_delete = "openstackclient.volume.v3.volume_group_type:DeleteVo
 volume_group_type_list = "openstackclient.volume.v3.volume_group_type:ListVolumeGroupType"
 volume_group_type_set = "openstackclient.volume.v3.volume_group_type:SetVolumeGroupType"
 volume_group_type_show = "openstackclient.volume.v3.volume_group_type:ShowVolumeGroupType"
-volume_host_set = "openstackclient.volume.v2.volume_host:SetVolumeHost"
+volume_host_set = "openstackclient.volume.v3.volume_host:SetVolumeHost"
 volume_message_delete = "openstackclient.volume.v3.volume_message:DeleteMessage"
 volume_message_list = "openstackclient.volume.v3.volume_message:ListMessages"
 volume_message_show = "openstackclient.volume.v3.volume_message:ShowMessage"