deb-zaqar/zaqar/transport/wsgi/v1_1/stats.py
Eva Balycheva d97327e95b Add description to 404 and 409 error responses
It would be better if Zaqar could provide descriptions in it's 404 and
409 error response bodies.

Reasons:

1. RFC 7231 asks to do it:
   https://tools.ietf.org/html/rfc7231#section-6.5
2. Sometimes it might be hard for the user to figure out why Zaqar
   returns 409 response code without description in response body.
3. Zaqar already provides descriptions in these error responses:
   400 401 403 500 503 406
4. Keystone project is a good example of a project, which includes info
   in 404 responses. We can follow this example.

This patch makes it so.

Change-Id: I0d5c5b73498a40b5ec949ceb74f9bb7dcf925009
Closes-Bug: 1547258
2016-02-26 03:26:03 +03:00

74 lines
2.3 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.
from oslo_log import log as logging
import six
from zaqar.i18n import _
from zaqar.storage import errors as storage_errors
from zaqar.transport import utils
from zaqar.transport.wsgi import errors as wsgi_errors
LOG = logging.getLogger(__name__)
class Resource(object):
__slots__ = '_queue_ctrl'
def __init__(self, queue_controller):
self._queue_ctrl = queue_controller
def on_get(self, req, resp, project_id, queue_name):
try:
resp_dict = self._queue_ctrl.stats(queue_name,
project=project_id)
message_stats = resp_dict['messages']
if message_stats['total'] != 0:
base_path = req.path[:req.path.rindex('/')] + '/messages/'
newest = message_stats['newest']
newest['href'] = base_path + newest['id']
del newest['id']
oldest = message_stats['oldest']
oldest['href'] = base_path + oldest['id']
del oldest['id']
resp.body = utils.to_json(resp_dict)
# status defaults to 200
except storage_errors.QueueDoesNotExist as ex:
resp_dict = {
'messages': {
'claimed': 0,
'free': 0,
'total': 0
}
}
resp.body = utils.to_json(resp_dict)
except storage_errors.DoesNotExist as ex:
LOG.debug(ex)
raise wsgi_errors.HTTPNotFound(six.text_type(ex))
except Exception as ex:
LOG.exception(ex)
description = _(u'Queue stats could not be read.')
raise wsgi_errors.HTTPServiceUnavailable(description)