openstack
/
magnum
Code Issues Proposed changes

Implement Service object Rest APIs 

Partially Implements: blueprint magnum-backend-kubernetes

Change-Id: I27bb1d4ec2174abb30e7770daaeab24c26987d01
This commit is contained in:
Pradeep Kilambi 2014-12-11 13:01:59 -05:00
parent 99509fa5ce
commit 598b9aae99
5 changed files with 322 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
magnum/api/controllers/v1/__init__.py
View File

@ -31,6 +31,7 @@ from magnum.api.controllers.v1 import bay
from magnum.api.controllers.v1 import container
from magnum.api.controllers.v1 import node
from magnum.api.controllers.v1 import pod
from magnum.api.controllers.v1 import service
class APIBase(wtypes.Base):
@ -149,7 +150,7 @@ class Controller(rest.RestController):
containers = container.ContainersController()
nodes = node.NodesController()
pods = pod.PodsController()
# services = service.ServicesController()
services = service.ServicesController()
@wsme_pecan.wsexpose(V1)
def get(self):

299
magnum/api/controllers/v1/service.py
View File

@ -10,62 +10,293 @@
# See the License for the specific language governing permissions and
# limitations under the License.
import uuid
import datetime
import pecan
from pecan import rest
import wsme
from wsme import types as wtypes
import wsmeext.pecan as wsme_pecan
from magnum.api.controllers.v1.base import Base
from magnum.api.controllers import base
from magnum.api.controllers import link
from magnum.api.controllers.v1 import collection
from magnum.api.controllers.v1 import types
from magnum.api.controllers.v1 import utils as api_utils
from magnum.common import exception
from magnum.common import yamlutils
from magnum import objects
# NOTE(dims): We don't depend on oslo*i18n yet
_ = _LI = _LW = _LE = _LC = lambda x: x
class ServiceController(rest.RestController):
@exception.wrap_pecan_controller_exception
@pecan.expose(content_type='application/x-yaml')
def get(self):
"""Retrieve a service by UUID."""
res_yaml = yamlutils.dump({'dummy_data'})
pecan.response.status = 200
return res_yaml
class ServicePatchType(types.JsonPatchType):
@exception.wrap_pecan_controller_exception
@pecan.expose(content_type='application/x-yaml')
def put(self):
"""Create a new service."""
res_yaml = yamlutils.dump({'dummy_data'})
pecan.response.status = 200
return res_yaml
@exception.wrap_pecan_controller_exception
@pecan.expose(content_type='application/x-yaml')
def delete(self):
"""Delete an existing service."""
res_yaml = yamlutils.dump({'dummy_data'})
pecan.response.status = 200
return res_yaml
@staticmethod
def mandatory_attrs():
return ['/service_uuid']
class Service(Base):
id = wtypes.text
""" The ID of the services."""
class Service(base.APIBase):
_service_uuid = None
def _get_service_uuid(self):
return self._service_uuid
def _set_service_uuid(self, value):
if value and self._service_uuid != value:
try:
service = objects.Service.get(pecan.request.context, value)
self._service_uuid = service.uuid
self.service_id = service.id
except exception.ServiceNotFound as e:
# Change error code because 404 (NotFound) is inappropriate
# response for a POST request to create a Service
e.code = 400 # BadRequest
raise e
elif value == wtypes.Unset:
self._service_uuid = wtypes.Unset
uuid = types.uuid
"""Unique UUID for this service"""
name = wsme.wsattr(wtypes.text, mandatory=True)
""" The name of the service."""
desc = wsme.wsattr(wtypes.text, mandatory=True)
bay_uuid = types.uuid
"""Unique UUID of the bay the service runs on"""
links = wsme.wsattr([link.Link], readonly=True)
"""A list containing a self link and associated service links"""
def __init__(self, **kwargs):
super(Service, self).__init__(**kwargs)
self.fields = []
fields = list(objects.Service.fields)
fields.append('service_uuid')
for field in fields:
# Skip fields we do not expose.
if not hasattr(self, field):
continue
self.fields.append(field)
setattr(self, field, kwargs.get(field, wtypes.Unset))
self.fields.append('service_id')
setattr(self, 'service_uuid', kwargs.get('service_id', wtypes.Unset))
@staticmethod
def _convert_with_links(service, url, expand=True):
if not expand:
service.unset_fields_except(['uuid', 'name', 'bay_uuid'])
# never expose the service_id attribute
service.service_id = wtypes.Unset
service.links = [link.Link.make_link('self', url,
'services', service.uuid),
link.Link.make_link('bookmark', url,
'services', service.uuid,
bookmark=True)
]
return service
@classmethod
def convert_with_links(cls, rpc_service, expand=True):
service = Service(**rpc_service.as_dict())
return cls._convert_with_links(service, pecan.request.host_url, expand)
@classmethod
def sample(cls, expand=True):
sample = cls(uuid='fe78db47-9a37-4e9f-8572-804a10abc0aa',
name='MyService',
bay_uuid='7ae81bb3-dec3-4289-8d6c-da80bd8001ae',
created_at=datetime.datetime.utcnow(),
updated_at=datetime.datetime.utcnow())
sample._service_uuid = '87504bd9-ca50-40fd-b14e-bcb23ed42b27'
return cls._convert_with_links(sample, 'http://localhost:9511', expand)
class ServiceCollection(collection.Collection):
"""API representation of a collection of services."""
services = [Service]
"""A list containing services objects"""
def __init__(self, **kwargs):
self._type = 'services'
@staticmethod
def convert_with_links(rpc_services, limit, url=None,
expand=False, **kwargs):
collection = ServiceCollection()
collection.services = [Service.convert_with_links(p, expand)
for p in rpc_services]
collection.next = collection.get_next(limit, url=url, **kwargs)
return collection
@classmethod
def sample(cls):
return cls(id=str(uuid.uuid1(),
name="Docker",
desc='Docker Services'))
sample = cls()
sample.services = [Service.sample(expand=False)]
return sample
class ServicesController(rest.RestController):
"""REST controller for Services."""
from_services = False
"""A flag to indicate if the requests to this controller are coming
from the top-level resource Services."""
_custom_actions = {
'detail': ['GET'],
}
def _get_services_collection(self, marker, limit,
sort_key, sort_dir, expand=False,
resource_url=None):
limit = api_utils.validate_limit(limit)
sort_dir = api_utils.validate_sort_dir(sort_dir)
marker_obj = None
if marker:
marker_obj = objects.Service.get_by_uuid(pecan.request.context,
marker)
services = objects.Service.list(pecan.request.context, limit,
marker_obj, sort_key=sort_key,
sort_dir=sort_dir)
return ServiceCollection.convert_with_links(services, limit,
url=resource_url,
expand=expand,
sort_key=sort_key,
sort_dir=sort_dir)
@wsme_pecan.wsexpose(ServiceCollection, types.uuid,
types.uuid, int, wtypes.text, wtypes.text)
def get_all(self, service_uuid=None, marker=None, limit=None,
sort_key='id', sort_dir='asc'):
"""Retrieve a list of services.
:param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result.
:param sort_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
"""
return self._get_services_collection(marker, limit, sort_key,
sort_dir)
@wsme_pecan.wsexpose(ServiceCollection, types.uuid,
types.uuid, int, wtypes.text, wtypes.text)
def detail(self, service_uuid=None, marker=None, limit=None,
sort_key='id', sort_dir='asc'):
"""Retrieve a list of services with detail.
:param service_uuid: UUID of a service, to get only
services for that service.
:param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result.
:param sort_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc.
"""
# NOTE(lucasagomes): /detail should only work agaist collections
parent = pecan.request.path.split('/')[:-1][-1]
if parent != "services":
raise exception.HTTPNotFound
expand = True
resource_url = '/'.join(['services', 'detail'])
return self._get_services_collection(marker, limit,
sort_key, sort_dir, expand,
resource_url)
@wsme_pecan.wsexpose(Service, types.uuid)
def get_one(self, service_uuid):
"""Retrieve information about the given service.
:param service_uuid: UUID of a service.
"""
if self.from_services:
raise exception.OperationNotPermitted
rpc_service = objects.Service.get_by_uuid(pecan.request.context,
service_uuid)
return Service.convert_with_links(rpc_service)
@wsme_pecan.wsexpose(Service, body=Service, status_code=201)
def post(self, service):
"""Create a new service.
:param service: a service within the request body.
"""
if self.from_services:
raise exception.OperationNotPermitted
new_service = objects.Service(pecan.request.context,
**service.as_dict())
new_service.create()
# Set the HTTP Location Header
pecan.response.location = link.build_url('services', new_service.uuid)
return Service.convert_with_links(new_service)
@wsme.validate(types.uuid, [ServicePatchType])
@wsme_pecan.wsexpose(Service, types.uuid, body=[ServicePatchType])
def patch(self, service_uuid, patch):
"""Update an existing service.
:param service_uuid: UUID of a service.
:param patch: a json PATCH document to apply to this service.
"""
if self.from_services:
raise exception.OperationNotPermitted
rpc_service = objects.Service.get_by_uuid(pecan.request.context,
service_uuid)
try:
service_dict = rpc_service.as_dict()
# NOTE(lucasagomes):
# 1) Remove service_id because it's an internal value and
# not present in the API object
# 2) Add service_uuid
service_dict['service_uuid'] = service_dict.pop('service_id', None)
service = Service(**api_utils.apply_jsonpatch(service_dict, patch))
except api_utils.JSONPATCH_EXCEPTIONS as e:
raise exception.PatchError(patch=patch, reason=e)
# Update only the fields that have changed
for field in objects.Service.fields:
try:
patch_val = getattr(service, field)
except AttributeError:
# Ignore fields that aren't exposed in the API
continue
if patch_val == wtypes.Unset:
patch_val = None
if rpc_service[field] != patch_val:
rpc_service[field] = patch_val
if hasattr(pecan.request, 'rpcapi'):
rpc_service = objects.Service.get_by_id(pecan.request.context,
rpc_service.service_id)
topic = pecan.request.rpcapi.get_topic_for(rpc_service)
new_service = pecan.request.rpcapi.update_service(
pecan.request.context, rpc_service, topic)
return Service.convert_with_links(new_service)
else:
rpc_service.save()
return Service.convert_with_links(rpc_service)
@wsme_pecan.wsexpose(None, types.uuid, status_code=204)
def delete(self, service_uuid):
"""Delete a service.
:param service_uuid: UUID of a service.
"""
if self.from_services:
raise exception.OperationNotPermitted
rpc_service = objects.Service.get_by_uuid(pecan.request.context,
service_uuid)
rpc_service.destroy()

3
magnum/db/sqlalchemy/models.py
View File

@ -170,7 +170,7 @@ class Pod(Base):
bay_uuid = Column(String(36))
class ServiceObject(Base):
class Service(Base):
"""Represents a software service."""
__tablename__ = 'service'
@ -180,4 +180,5 @@ class ServiceObject(Base):
)
id = Column(Integer, primary_key=True)
uuid = Column(String(36))
name = Column(String(255))
bay_uuid = Column(String(36))

7
magnum/objects/service.py
View File

@ -34,6 +34,7 @@ class Service(base.MagnumObject):
fields = {
'id': int,
'uuid': obj_utils.str_or_none,
'name': obj_utils.str_or_none,
'bay_uuid': obj_utils.str_or_none,
}
@ -114,9 +115,9 @@ class Service(base.MagnumObject):
"""
db_services = cls.dbapi.get_service_list(limit=limit,
marker=marker,
sort_key=sort_key,
sort_dir=sort_dir)
marker=marker,
sort_key=sort_key,
sort_dir=sort_dir)
return Service._from_db_object_list(db_services, cls, context)
@base.remotable

57
magnum/tests/api/controllers/v1/test_all_objects.py
View File

@ -20,15 +20,15 @@ from mock import patch
class TestRootController(tests.FunctionalTest):
def test_version(self):
expected = {u'default_version':
{u'id': u'v1', u'links':
[{u'href': u'http://localhost/v1/', u'rel': u'self'}]},
u'description': u'Magnum is an OpenStack project which '
'aims to provide container management.',
u'name': u'OpenStack Magnum API',
u'versions': [{u'id': u'v1',
{u'id': u'v1', u'links':
[{u'href': u'http://localhost/v1/', u'rel': u'self'}]},
u'description': u'Magnum is an OpenStack project which '
'aims to provide container management.',
u'name': u'OpenStack Magnum API',
u'versions': [{u'id': u'v1',
u'links':
[{u'href': u'http://localhost/v1/',
u'rel': u'self'}]}]}
[{u'href': u'http://localhost/v1/',
u'rel': u'self'}]}]}
response = self.app.get('/')
self.assertEqual(expected, response.json)
@ -240,3 +240,44 @@ class TestContainerController(db_base.DbTestCase):
self.assertEqual(response.status_int, 200)
c = response.json['containers']
self.assertEqual(0, len(c))
class TestServiceController(db_base.DbTestCase):
def test_service_api(self):
# Create a service
params = '{"name": "service_foo",'\
'"bay_uuid": "7ae81bb3-dec3-4289-8d6c-da80bd8001ae"}'
response = self.app.post('/v1/services',
params=params,
content_type='application/json')
self.assertEqual(response.status_int, 201)
# Get all services
response = self.app.get('/v1/services')
self.assertEqual(response.status_int, 200)
self.assertEqual(1, len(response.json))
c = response.json['services'][0]
self.assertIsNotNone(c.get('uuid'))
self.assertEqual('service_foo', c.get('name'))
self.assertEqual('7ae81bb3-dec3-4289-8d6c-da80bd8001ae',
c.get('bay_uuid'))
# Get just the one we created
response = self.app.get('/v1/services/%s' % c.get('uuid'))
self.assertEqual(response.status_int, 200)
# Update the description
params = [{'path': '/name',
'value': 'service_bar',
'op': 'replace'}]
response = self.app.patch_json('/v1/services/%s' % c.get('uuid'),
params=params)
self.assertEqual(response.status_int, 200)
# Delete the service we created
response = self.app.delete('/v1/services/%s' % c.get('uuid'))
self.assertEqual(response.status_int, 204)
response = self.app.get('/v1/services')
self.assertEqual(response.status_int, 200)
c = response.json['services']
self.assertEqual(0, len(c))