openstack
/
python-openstackclient
Code Issues Proposed changes

Add "server group create" command 

Support compute v2 "server group create" command in OSC.

Implements: blueprint nova-server-group-support
Partial-Bug: #1542171

Change-Id: I96ffb07764d3adb715e048943cfee3b879c280f6
This commit is contained in:
Rui Chen 2016-03-26 18:15:31 +08:00
parent 4639148b1d
commit a06bb28bcc
6 changed files with 242 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/source/command-objects/server-group.rst Normal file
View File

@ -0,0 +1,29 @@
============
server group
============
Server group provide a mechanism to group servers according to certain policy.
Compute v2
server group create
-------------------
Create a new server group
.. program:: server group create
.. code-block:: bash
os server group create
--policy <policy> [--policy <policy>] ...
<name>
.. option:: --policy <policy>
Add a policy to :ref:`\<name\> <server_group_create-name>`
(repeat option to add multiple policies)
.. _server_group_create-name:
.. describe:: <name>
New server group name

1
doc/source/commands.rst
View File

@ -118,6 +118,7 @@ referring to both Compute and Volume quotas.
* ``security group rule``: (**Compute**, **Network**) - the individual rules that define protocol/IP/port access
* ``server``: (**Compute**) virtual machine instance
* ``server dump``: (**Compute**) a dump file of a server created by features like kdump
* ``server group``: (**Compute**) a grouping of servers
* ``server image``: (**Compute**) saved server disk image
* ``service``: (**Identity**) a cloud service
* ``service provider``: (**Identity**) a resource that consumes assertions from an ``identity provider``

68
openstackclient/compute/v2/server_group.py Normal file
View File

@ -0,0 +1,68 @@
# Copyright 2016 Huawei, Inc. All rights reserved.
#
# 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.
#
"""Compute v2 Server Group action implementations"""
from openstackclient.common import command
from openstackclient.common import utils
_formatters = {
'policies': utils.format_list,
'members': utils.format_list,
}
def _get_columns(info):
columns = list(info.keys())
if 'metadata' in columns:
# NOTE(RuiChen): The metadata of server group is always empty since API
# compatible, so hide it in order to avoid confusion.
columns.remove('metadata')
return tuple(sorted(columns))
class CreateServerGroup(command.ShowOne):
"""Create a new server group."""
def get_parser(self, prog_name):
parser = super(CreateServerGroup, self).get_parser(prog_name)
parser.add_argument(
'name',
metavar='<name>',
help='New server group name',
)
parser.add_argument(
'--policy',
metavar='<policy>',
action='append',
required=True,
help='Add a policy to <name> '
'(repeat option to add multiple policies)',
)
return parser
def take_action(self, parsed_args):
compute_client = self.app.client_manager.compute
info = {}
server_group = compute_client.server_groups.create(
name=parsed_args.name,
policies=parsed_args.policy)
info.update(server_group._info)
columns = _get_columns(info)
data = utils.get_dict_properties(info, columns,
formatters=_formatters)
return columns, data

34
openstackclient/tests/compute/v2/fakes.py
View File

@ -177,6 +177,9 @@ class FakeComputev2Client(object):
self.hosts = mock.Mock()
self.hosts.resource_class = fakes.FakeResource(None, {})
self.server_groups = mock.Mock()
self.server_groups.resource_class = fakes.FakeResource(None, {})
self.auth_token = kwargs['token']
self.management_url = kwargs['endpoint']
@ -899,3 +902,34 @@ class FakeHost(object):
info=copy.deepcopy(host_info),
loaded=True)
return host
class FakeServerGroup(object):
"""Fake one server group"""
@staticmethod
def create_one_server_group(attrs=None):
"""Create a fake server group
:param Dictionary attrs:
A dictionary with all attributes
:return:
A FakeResource object, with id and other attributes
"""
if attrs is None:
attrs = {}
server_group_info = {
'id': 'server-group-id-' + uuid.uuid4().hex,
'members': [],
'metadata': {},
'name': 'server-group-name-' + uuid.uuid4().hex,
'policies': [],
'project_id': 'server-group-project-id-' + uuid.uuid4().hex,
'user_id': 'server-group-user-id-' + uuid.uuid4().hex,
}
server_group_info.update(attrs)
server_group = fakes.FakeResource(
info=copy.deepcopy(server_group_info),
loaded=True)
return server_group

108
openstackclient/tests/compute/v2/test_server_group.py Normal file
View File

@ -0,0 +1,108 @@
# Copyright 2016 Huawei, Inc. All rights reserved.
#
# 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.common import utils
from openstackclient.compute.v2 import server_group
from openstackclient.tests.compute.v2 import fakes as compute_fakes
from openstackclient.tests import utils as tests_utils
class TestServerGroup(compute_fakes.TestComputev2):
fake_server_group = compute_fakes.FakeServerGroup.create_one_server_group()
columns = (
'id',
'members',
'name',
'policies',
'project_id',
'user_id',
)
data = (
fake_server_group.id,
utils.format_list(fake_server_group.members),
fake_server_group.name,
utils.format_list(fake_server_group.policies),
fake_server_group.project_id,
fake_server_group.user_id,
)
def setUp(self):
super(TestServerGroup, self).setUp()
# Get a shortcut to the ServerGroupsManager Mock
self.server_groups_mock = self.app.client_manager.compute.server_groups
self.server_groups_mock.reset_mock()
class TestServerGroupCreate(TestServerGroup):
def setUp(self):
super(TestServerGroupCreate, self).setUp()
self.server_groups_mock.create.return_value = self.fake_server_group
self.cmd = server_group.CreateServerGroup(self.app, None)
def test_server_group_create(self):
arglist = [
'--policy', 'affinity',
'affinity_group',
]
verifylist = [
('policy', ['affinity']),
('name', 'affinity_group'),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.server_groups_mock.create.assert_called_once_with(
name=parsed_args.name,
policies=parsed_args.policy,
)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
def test_server_group_create_with_multiple_policies(self):
arglist = [
'--policy', 'affinity',
'--policy', 'soft-affinity',
'affinity_group',
]
verifylist = [
('policy', ['affinity', 'soft-affinity']),
('name', 'affinity_group'),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.server_groups_mock.create.assert_called_once_with(
name=parsed_args.name,
policies=parsed_args.policy,
)
self.assertEqual(self.columns, columns)
self.assertEqual(self.data, data)
def test_server_group_create_no_policy(self):
arglist = [
'affinity_group',
]
verifylist = None
self.assertRaises(tests_utils.ParserException,
self.check_parser,
self.cmd,
arglist,
verifylist)

2
setup.cfg
View File

@ -131,6 +131,8 @@ openstack.compute.v2 =
server_unset = openstackclient.compute.v2.server:UnsetServer
server_unshelve = openstackclient.compute.v2.server:UnshelveServer
server_group_create = openstackclient.compute.v2.server_group:CreateServerGroup
usage_list = openstackclient.compute.v2.usage:ListUsage
usage_show = openstackclient.compute.v2.usage:ShowUsage