11e8b94362
This patchset removes the ability to specify metadata when creating a
queue as per the Marconi Weekly Meeting held on July 18th, 2013.
It also adds a new endpoint: /v1/queues/{name}/metadata with operations
- GET
- PUT
Removes:
- GET /v1/queues/{queue_name} # replaced by metadata ^^
- the request body from PUT /v1/queues/{queue_name}
Rationale:
The addition of the metadata endpoint increases the extensibility of
the API, and decouples metadata updates from queue creation. This
makes it easier for us in the future to add other endpoints, say
/v1/queues/{name}/config for modifying special values that change the
behavior of the queue.
With that addition, creating a queue with metadata became slightly
more dangerous. In the case where a user accidentally tries to create
a queue that already exists, the metadata for the existing queue would
be overwritten by the PUT request body. By removing the ability to
modify metadata at queue creation time, it also prevents these types
of accidents.
Tests:
New unit tests added to capture expected behavior. Old tests were also
updated to reflect new endpoint and behavior.
Storage API changes:
- storage(queue): get -> get_metadata
Change-Id: Ie3a79a63a865035a789609dac770adabe4dc6ed7
Implements: blueprint metadata-resource
127 lines
4.4 KiB
Python
127 lines
4.4 KiB
Python
# Copyright (c) 2013 Rackspace, Inc.
|
|
#
|
|
# 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.
|
|
|
|
import falcon
|
|
from wsgiref import simple_server
|
|
|
|
from marconi.common import config
|
|
import marconi.openstack.common.log as logging
|
|
from marconi import transport
|
|
from marconi.transport import auth
|
|
from marconi.transport.wsgi import claims
|
|
from marconi.transport.wsgi import health
|
|
from marconi.transport.wsgi import messages
|
|
from marconi.transport.wsgi import metadata
|
|
from marconi.transport.wsgi import queues
|
|
from marconi.transport.wsgi import stats
|
|
|
|
OPTIONS = {
|
|
'bind': '0.0.0.0',
|
|
'port': 8888
|
|
}
|
|
|
|
PROJECT_CFG = config.project('marconi')
|
|
GLOBAL_CFG = PROJECT_CFG.from_options()
|
|
WSGI_CFG = config.namespace('drivers:transport:wsgi').from_options(**OPTIONS)
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
def _check_media_type(req, resp, params):
|
|
if not req.client_accepts('application/json'):
|
|
raise falcon.HTTPNotAcceptable(
|
|
'''
|
|
Endpoint only serves `application/json`; specify client-side
|
|
media type support with the "Accept" header.''',
|
|
href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html",
|
|
href_text='"14.1 Accept", Hypertext Transfer Protocol -- HTTP/1.1')
|
|
|
|
|
|
def _extract_project_id(req, resp, params):
|
|
params['project_id'] = req.get_header('X-PROJECT-ID')
|
|
|
|
|
|
class Driver(transport.DriverBase):
|
|
|
|
def __init__(self, storage):
|
|
super(Driver, self).__init__(storage)
|
|
|
|
self._init_routes()
|
|
self._init_middleware()
|
|
|
|
def _init_routes(self):
|
|
"""Initialize URI routes to resources."""
|
|
self.app = falcon.API(before=[_check_media_type, _extract_project_id])
|
|
|
|
queue_controller = self.storage.queue_controller
|
|
message_controller = self.storage.message_controller
|
|
claim_controller = self.storage.claim_controller
|
|
|
|
# Queues Endpoints
|
|
queue_collection = queues.CollectionResource(queue_controller)
|
|
self.app.add_route('/v1/queues', queue_collection)
|
|
|
|
queue_item = queues.ItemResource(queue_controller, message_controller)
|
|
self.app.add_route('/v1/queues/{queue_name}', queue_item)
|
|
|
|
stats_endpoint = stats.Resource(queue_controller)
|
|
self.app.add_route('/v1/queues/{queue_name}'
|
|
'/stats', stats_endpoint)
|
|
|
|
# Metadata Endpoints
|
|
metadata_endpoint = metadata.Resource(queue_controller)
|
|
self.app.add_route('/v1/queues/{queue_name}'
|
|
'/metadata', metadata_endpoint)
|
|
|
|
# Messages Endpoints
|
|
msg_collection = messages.CollectionResource(message_controller)
|
|
self.app.add_route('/v1/queues/{queue_name}'
|
|
'/messages', msg_collection)
|
|
|
|
msg_item = messages.ItemResource(message_controller)
|
|
self.app.add_route('/v1/queues/{queue_name}'
|
|
'/messages/{message_id}', msg_item)
|
|
|
|
# Claims Endpoints
|
|
claim_collection = claims.CollectionResource(claim_controller)
|
|
self.app.add_route('/v1/queues/{queue_name}'
|
|
'/claims', claim_collection)
|
|
|
|
claim_item = claims.ItemResource(claim_controller)
|
|
self.app.add_route('/v1/queues/{queue_name}'
|
|
'/claims/{claim_id}', claim_item)
|
|
|
|
# Health
|
|
self.app.add_route('/v1/health', health.HealthResource())
|
|
|
|
def _init_middleware(self):
|
|
"""Initialize WSGI middlewarez."""
|
|
|
|
# NOTE(flaper87): Install Auth
|
|
if GLOBAL_CFG.auth_strategy:
|
|
strategy = auth.strategy(GLOBAL_CFG.auth_strategy)
|
|
self.app = strategy.install(self.app, PROJECT_CFG.conf)
|
|
|
|
def listen(self):
|
|
"""Self-host using 'bind' and 'port' from the WSGI config group."""
|
|
|
|
msg = _('Serving on host %(bind)s:%(port)s')
|
|
msg %= {'bind': WSGI_CFG.bind, 'port': WSGI_CFG.port}
|
|
LOG.info(msg)
|
|
|
|
httpd = simple_server.make_server(WSGI_CFG.bind, WSGI_CFG.port,
|
|
self.app)
|
|
httpd.serve_forever()
|