Merge "Identify the keystone service when raising 503"

keystonemiddleware/auth_token/__init__.py

@@ -778,7 +778,8 @@ class AuthProtocol(BaseAuthProtocol):
                 ksm_exceptions.RevocationListError,
                 ksm_exceptions.ServiceError) as e:
             self.log.critical('Unable to validate token: %s', e)
-            raise webob.exc.HTTPServiceUnavailable()
+            raise webob.exc.HTTPServiceUnavailable(
+                'The Keystone service is temporarily unavailable.')
         except ksm_exceptions.InvalidToken:
             self.log.debug('Token validation failure.', exc_info=True)
             if token_hashes:

keystonemiddleware/tests/unit/auth_token/base.py

@@ -15,6 +15,7 @@ from oslo_config import cfg
 from oslo_config import fixture as cfg_fixture
 from oslo_log import log as logging
 from requests_mock.contrib import fixture as rm_fixture
+import six
 from six.moves import http_client
 import webob.dec
 
@@ -48,7 +49,8 @@ class BaseAuthTokenTestCase(utils.MiddlewareTestCase):
         return auth_token.AuthProtocol(_do_cb, opts)
 
     def call(self, middleware, method='GET', path='/', headers=None,
-             expected_status=http_client.OK):
+             expected_status=http_client.OK,
+             expected_body_string=None):
         req = webob.Request.blank(path)
         req.method = method
 
@@ -57,5 +59,7 @@ class BaseAuthTokenTestCase(utils.MiddlewareTestCase):
 
         resp = req.get_response(middleware)
         self.assertEqual(expected_status, resp.status_int)
+        if expected_body_string:
+            self.assertIn(expected_body_string, six.text_type(resp.body))
         resp.request = req
         return resp

keystonemiddleware/tests/unit/auth_token/test_auth_token_middleware.py

@@ -1071,13 +1071,15 @@ class CommonAuthTokenMiddlewareTest(object):
 
     def test_http_request_max_retries(self):
         times_retry = 10
+        body_string = 'The Keystone service is temporarily unavailable.'
 
         conf = {'http_request_max_retries': '%s' % times_retry}
         self.set_middleware(conf=conf)
 
         with mock.patch('time.sleep') as mock_obj:
             self.call_middleware(headers={'X-Auth-Token': ERROR_TOKEN},
-                                 expected_status=503)
+                                 expected_status=503,
+                                 expected_body_string=body_string)
 
         self.assertEqual(mock_obj.call_count, times_retry)
 

releasenotes/notes/bug-1747655-6e563d9317bb0f13.yaml

@@ -0,0 +1,9 @@
+---
+fixes:
+  - |
+    [`bug/1747655 <https://bugs.launchpad.net/keystonemiddleware/+bug/1747655>`_]
+    When keystone is temporarily unavailable, keystonemiddleware correctly
+    sends a 503 response to the HTTP client but was not identifying which
+    service was down, leading to confusion on whether it was keystone or the
+    service using keystonemiddleware that was unavailable. This change
+    identifies keystone in the error response.