Merge "HTTP status value naming normalization"

Author: Jenkins

swift/account/server.py

@@ -36,6 +36,7 @@
 from swift.common.constraints import ACCOUNT_LISTING_LIMIT, \
     check_mount, check_float, check_utf8
 from swift.common.db_replicator import ReplicatorRpc
+from swift.common.http import HTTPInsufficientStorage
 
 
 DATADIR = 'accounts'
@@ -70,7 +71,7 @@ def DELETE(self, req):
             return HTTPBadRequest(body=str(err), content_type='text/plain',
                                                     request=req)
         if self.mount_check and not check_mount(self.root, drive):
-            return Response(status='507 %s is not mounted' % drive)
+            return HTTPInsufficientStorage(drive=drive, request=req)
         if 'x-timestamp' not in req.headers or \
                     not check_float(req.headers['x-timestamp']):
             return HTTPBadRequest(body='Missing timestamp', request=req,
@@ -90,7 +91,7 @@ def PUT(self, req):
             return HTTPBadRequest(body=str(err), content_type='text/plain',
                                   request=req)
         if self.mount_check and not check_mount(self.root, drive):
-            return Response(status='507 %s is not mounted' % drive)
+            return HTTPInsufficientStorage(drive=drive, request=req)
         broker = self._get_account_broker(drive, part, account)
         if container:   # put account container
             if 'x-trans-id' in req.headers:
@@ -149,7 +150,7 @@ def HEAD(self, req):
             return HTTPBadRequest(body=str(err), content_type='text/plain',
                                                     request=req)
         if self.mount_check and not check_mount(self.root, drive):
-            return Response(status='507 %s is not mounted' % drive)
+            return HTTPInsufficientStorage(drive=drive, request=req)
         broker = self._get_account_broker(drive, part, account)
         if not container:
             broker.pending_timeout = 0.1
@@ -180,7 +181,7 @@ def GET(self, req):
             return HTTPBadRequest(body=str(err), content_type='text/plain',
                                                     request=req)
         if self.mount_check and not check_mount(self.root, drive):
-            return Response(status='507 %s is not mounted' % drive)
+            return HTTPInsufficientStorage(drive=drive, request=req)
         broker = self._get_account_broker(drive, part, account)
         broker.pending_timeout = 0.1
         broker.stale_reads_ok = True
@@ -274,7 +275,7 @@ def REPLICATE(self, req):
                                                     request=req)
         drive, partition, hash = post_args
         if self.mount_check and not check_mount(self.root, drive):
-            return Response(status='507 %s is not mounted' % drive)
+            return HTTPInsufficientStorage(drive=drive, request=req)
         try:
             args = simplejson.load(req.environ['wsgi.input'])
         except ValueError, err:
@@ -295,7 +296,7 @@ def POST(self, req):
             return HTTPBadRequest(body='Missing or bad timestamp',
                 request=req, content_type='text/plain')
         if self.mount_check and not check_mount(self.root, drive):
-            return Response(status='507 %s is not mounted' % drive)
+            return HTTPInsufficientStorage(drive=drive, request=req)
         broker = self._get_account_broker(drive, part, account)
         if broker.is_deleted():
             return HTTPNotFound(request=req)

swift/common/bench.py

@@ -24,6 +24,7 @@
 from swift.common.utils import TRUE_VALUES
 from swift.common import client
 from swift.common import direct_client
+from swift.common.http import HTTP_CONFLICT
 
 
 class ConnectionPool(eventlet.pools.Pool):
@@ -152,7 +153,7 @@ def run(self):
             try:
                 client.delete_container(self.url, self.token, container)
             except client.ClientException, e:
-                if e.http_status != 409:
+                if e.http_status != HTTP_CONFLICT:
                     self._log_status("Unable to delete container '%s'. " \
                         "Got http status '%d'." % (container, e.http_status))
 

swift/common/direct_client.py

@@ -28,6 +28,8 @@
 from swift.common.bufferedhttp import http_connect
 from swift.common.client import ClientException, json_loads
 from swift.common.utils import normalize_timestamp
+from swift.common.http import HTTP_NO_CONTENT, HTTP_INSUFFICIENT_STORAGE, \
+    is_success, is_server_error
 
 
 def quote(value, safe='/'):
@@ -69,7 +71,7 @@ def direct_get_account(node, part, account, marker=None, limit=None,
                             'GET', path, query_string=qs)
     with Timeout(response_timeout):
         resp = conn.getresponse()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         resp.read()
         raise ClientException(
             'Account server %s:%s direct GET %s gave status %s' % (node['ip'],
@@ -81,7 +83,7 @@ def direct_get_account(node, part, account, marker=None, limit=None,
     resp_headers = {}
     for header, value in resp.getheaders():
         resp_headers[header.lower()] = value
-    if resp.status == 204:
+    if resp.status == HTTP_NO_CONTENT:
         resp.read()
         return resp_headers, []
     return resp_headers, json_loads(resp.read())
@@ -108,7 +110,7 @@ def direct_head_container(node, part, account, container, conn_timeout=5,
     with Timeout(response_timeout):
         resp = conn.getresponse()
         resp.read()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         raise ClientException(
                 'Container server %s:%s direct HEAD %s gave status %s' %
                 (node['ip'], node['port'],
@@ -157,7 +159,7 @@ def direct_get_container(node, part, account, container, marker=None,
                             'GET', path, query_string=qs)
     with Timeout(response_timeout):
         resp = conn.getresponse()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         resp.read()
         raise ClientException(
             'Container server %s:%s direct GET %s gave stats %s' % (node['ip'],
@@ -169,7 +171,7 @@ def direct_get_container(node, part, account, container, marker=None,
     resp_headers = {}
     for header, value in resp.getheaders():
         resp_headers[header.lower()] = value
-    if resp.status == 204:
+    if resp.status == HTTP_NO_CONTENT:
         resp.read()
         return resp_headers, []
     return resp_headers, json_loads(resp.read())
@@ -185,7 +187,7 @@ def direct_delete_container(node, part, account, container, conn_timeout=5,
     with Timeout(response_timeout):
         resp = conn.getresponse()
         resp.read()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         raise ClientException(
                 'Container server %s:%s direct DELETE %s gave status %s' %
                 (node['ip'], node['port'],
@@ -218,7 +220,7 @@ def direct_head_object(node, part, account, container, obj, conn_timeout=5,
     with Timeout(response_timeout):
         resp = conn.getresponse()
         resp.read()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         raise ClientException(
                 'Object server %s:%s direct HEAD %s gave status %s' %
                 (node['ip'], node['port'],
@@ -256,7 +258,7 @@ def direct_get_object(node, part, account, container, obj, conn_timeout=5,
                 'GET', path, headers=headers)
     with Timeout(response_timeout):
         resp = conn.getresponse()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         resp.read()
         raise ClientException(
                 'Object server %s:%s direct GET %s gave status %s' %
@@ -326,7 +328,7 @@ def direct_put_object(node, part, account, container, name, contents,
     with Timeout(response_timeout):
         resp = conn.getresponse()
         resp.read()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         raise ClientException(
                 'Object server %s:%s direct PUT %s gave status %s' %
                 (node['ip'], node['port'],
@@ -361,7 +363,7 @@ def direct_post_object(node, part, account, container, name, headers,
     with Timeout(response_timeout):
         resp = conn.getresponse()
         resp.read()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         raise ClientException(
                 'Object server %s:%s direct POST %s gave status %s' %
                 (node['ip'], node['port'],
@@ -394,7 +396,7 @@ def direct_delete_object(node, part, account, container, obj,
     with Timeout(response_timeout):
         resp = conn.getresponse()
         resp.read()
-    if resp.status < 200 or resp.status >= 300:
+    if not is_success(resp.status):
         raise ClientException(
                 'Object server %s:%s direct DELETE %s gave status %s' %
                 (node['ip'], node['port'],
@@ -440,8 +442,8 @@ def retry(func, *args, **kwargs):
         except ClientException, err:
             if error_log:
                 error_log(err)
-            if attempts > retries or err.http_status < 500 or \
-                    err.http_status == 507 or err.http_status > 599:
+            if attempts > retries or not is_server_error(err.http_status) or \
+                    err.http_status == HTTP_INSUFFICIENT_STORAGE:
                 raise
         sleep(backoff)
         backoff *= 2

swift/common/http.py

@@ -0,0 +1,193 @@
+# Copyright (c) 2010-2012 OpenStack, LLC.
+#
+# 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 webob.exc import HTTPClientError,\
+    HTTPInsufficientStorage as BaseHTTPInsufficientStorage
+
+
+class HTTPClientDisconnect(HTTPClientError):
+    """
+    subclass of :class:`~HTTPClientError`
+
+    This code is introduced to log the case when the connection is closed by
+    client while HTTP server is processing its request
+
+    code: 499, title: Client Disconnect
+    """
+    code = 499
+    title = 'Client Disconnect'
+    explanation = (
+        'This code is introduced to log the case when the connection '
+        'is closed by client while HTTP server is processing its request')
+
+
+class HTTPInsufficientStorage(BaseHTTPInsufficientStorage):
+    """
+    subclass of :class:`~HTTPInsufficientStorage`
+
+    The server is unable to store the representation needed to
+    complete the request.
+
+    code: 507, title: Insufficient Storage
+    """
+    def __init__(self, drive=None, *args, **kwargs):
+        if drive:
+            self.explanation = ('%s is not mounted' % drive)
+        super(HTTPInsufficientStorage, self).__init__(*args, **kwargs)
+
+
+def is_informational(status):
+    """
+    Check if HTTP status code is informational.
+
+    :param status: http status code
+    :returns: True if status is successful, else False
+    """
+    return 100 <= status and status <= 199
+
+
+def is_success(status):
+    """
+    Check if HTTP status code is successful.
+
+    :param status: http status code
+    :returns: True if status is successful, else False
+    """
+    return 200 <= status and status <= 299
+
+
+def is_redirection(status):
+    """
+    Check if HTTP status code is redirection.
+
+    :param status: http status code
+    :returns: True if status is redirection, else False
+    """
+    return 300 <= status and status <= 399
+
+
+def is_client_error(status):
+    """
+    Check if HTTP status code is client error.
+
+    :param status: http status code
+    :returns: True if status is client error, else False
+    """
+    return 400 <= status and status <= 499
+
+
+def is_server_error(status):
+    """
+    Check if HTTP status code is server error.
+
+    :param status: http status code
+    :returns: True if status is server error, else False
+    """
+    return 500 <= status and status <= 599
+
+
+# List of HTTP status codes
+
+###############################################################################
+## 1xx Informational
+###############################################################################
+
+HTTP_CONTINUE = 100
+HTTP_SWITCHING_PROTOCOLS = 101
+HTTP_PROCESSING = 102  # WebDAV
+HTTP_CHECKPOINT = 103
+HTTP_REQUEST_URI_TOO_LONG = 122
+
+###############################################################################
+## 2xx Success
+###############################################################################
+
+HTTP_OK = 200
+HTTP_CREATED = 201
+HTTP_ACCEPTED = 202
+HTTP_NON_AUTHORITATIVE_INFORMATION = 203
+HTTP_NO_CONTENT = 204
+HTTP_RESET_CONTENT = 205
+HTTP_PARTIAL_CONTENT = 206
+HTTP_MULTI_STATUS = 207  # WebDAV
+HTTP_IM_USED = 226
+
+###############################################################################
+## 3xx Redirection
+###############################################################################
+
+HTTP_MULTIPLE_CHOICES = 300
+HTTP_MOVED_PERMANENTLY = 301
+HTTP_FOUND = 302
+HTTP_SEE_OTHER = 303
+HTTP_NOT_MODIFIED = 304
+HTTP_USE_PROXY = 305
+HTTP_SWITCH_PROXY = 306
+HTTP_TEMPORARY_REDIRECT = 307
+HTTP_RESUME_INCOMPLETE = 308
+
+###############################################################################
+## 4xx Client Error
+###############################################################################
+
+HTTP_BAD_REQUEST = 400
+HTTP_UNAUTHORIZED = 401
+HTTP_PAYMENT_REQUIRED = 402
+HTTP_FORBIDDEN = 403
+HTTP_NOT_FOUND = 404
+HTTP_METHOD_NOT_ALLOWED = 405
+HTTP_NOT_ACCEPTABLE = 406
+HTTP_PROXY_AUTHENTICATION_REQUIRED = 407
+HTTP_REQUEST_TIMEOUT = 408
+HTTP_CONFLICT = 409
+HTTP_GONE = 410
+HTTP_LENGTH_REQUIRED = 411
+HTTP_PRECONDITION_FAILED = 412
+HTTP_REQUEST_ENTITY_TOO_LARGE = 413
+HTTP_REQUEST_URI_TOO_LONG = 414
+HTTP_UNSUPPORTED_MEDIA_TYPE = 415
+HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416
+HTTP_EXPECTATION_FAILED = 417
+HTTP_IM_A_TEAPOT = 418
+HTTP_UNPROCESSABLE_ENTITY = 422  # WebDAV
+HTTP_LOCKED = 423  # WebDAV
+HTTP_FAILED_DEPENDENCY = 424  # WebDAV
+HTTP_UNORDERED_COLLECTION = 425
+HTTP_UPGRADE_REQUIED = 426
+HTTP_PRECONDITION_REQUIRED = 428
+HTTP_TOO_MANY_REQUESTS = 429
+HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431
+HTTP_NO_RESPONSE = 444
+HTTP_RETRY_WITH = 449
+HTTP_BLOCKED_BY_WINDOWS_PARENTAL_CONTROLS = 450
+HTTP_CLIENT_CLOSED_REQUEST = 499
+
+###############################################################################
+## 5xx Server Error
+###############################################################################
+
+HTTP_INTERNAL_SERVER_ERROR = 500
+HTTP_NOT_IMPLEMENTED = 501
+HTTP_BAD_GATEWAY = 502
+HTTP_SERVICE_UNAVAILABLE = 503
+HTTP_GATEWAY_TIMEOUT = 504
+HTTP_VERSION_NOT_SUPPORTED = 505
+HTTP_VARIANT_ALSO_NEGOTIATES = 506
+HTTP_INSUFFICIENT_STORAGE = 507  # WebDAV
+HTTP_BANDWIDTH_LIMIT_EXCEEDED = 509
+HTTP_NOT_EXTENDED = 510
+HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511
+HTTP_NETWORK_READ_TIMEOUT_ERROR = 598     # not used in RFC
+HTTP_NETWORK_CONNECT_TIMEOUT_ERROR = 599  # not used in RFC