Merge "Prepare for WebOb 1.8.1"

glance/common/wsgi.py

@@ -53,6 +53,12 @@ from glance import i18n
 from glance.i18n import _, _LE, _LI, _LW
 
 
+try:
+    from webob.acceptparse import AcceptLanguageValidHeader  # noqa
+    USING_WEBOB_1_8 = True
+except ImportError:
+    USING_WEBOB_1_8 = False
+
 bind_opts = [
     cfg.HostAddressOpt('bind_host',
                        default='0.0.0.0',
@@ -1024,7 +1030,7 @@ class Request(webob.Request):
         else:
             return content_type
 
-    def best_match_language(self):
+    def _best_match_language_1_7(self):
         """Determines best available locale from the Accept-Language header.
 
         :returns: the best language match or None if the 'Accept-Language'
@@ -1035,6 +1041,29 @@ class Request(webob.Request):
         langs = i18n.get_available_languages('glance')
         return self.accept_language.best_match(langs)
 
+    def _best_match_language_1_8(self):
+        """Determines best available locale from the Accept-Language header.
+
+        :returns: the best language match or None if the 'Accept-Language'
+                  header was not available in the request.
+        """
+        if not self.accept_language:
+            return None
+        langs = i18n.get_available_languages('glance')
+        # NOTE(rosmaita): give the webob lookup() function a sentinal value
+        # for default so we can preserve the behavior of this function as
+        # indicated by the current unit tests.  See Launchpad bug #1765748.
+        best_match = self.accept_language.lookup(langs, default='fake_LANG')
+        if best_match == 'fake_LANG':
+            best_match = None
+        return best_match
+
+    def best_match_language(self):
+        if USING_WEBOB_1_8:
+            return self._best_match_language_1_8()
+        else:
+            return self._best_match_language_1_7()
+
     def get_range_from_request(self, image_size):
         """Return the `Range` in a request."""
 

glance/tests/unit/common/test_wsgi.py

@@ -184,16 +184,31 @@ class RequestTest(test_utils.BaseTestCase):
         req = wsgi.Request.blank('/', headers={'Accept-Language': 'unknown'})
         self.assertIsNone(req.best_match_language())
 
-    @mock.patch.object(webob.acceptparse.AcceptLanguage, 'best_match')
-    def test_best_match_language_unknown(self, mock_best_match):
+    def test_best_match_language_unknown(self):
         # Test that we are actually invoking language negotiation by webop
         request = wsgi.Request.blank('/')
         accepted = 'unknown-lang'
         request.headers = {'Accept-Language': accepted}
 
-        mock_best_match.return_value = None
+        # TODO(rosmaita): simplify when lower_constraints has webob >= 1.8.1
+        try:
+            from webob.acceptparse import AcceptLanguageValidHeader  # noqa
+            cls = webob.acceptparse.AcceptLanguageValidHeader
+            funcname = 'lookup'
+            # Bug #1765748: see comment in code in the function under test
+            # to understand why this is the correct return value for the
+            # webob 1.8.x mock
+            retval = 'fake_LANG'
+        except ImportError:
+            cls = webob.acceptparse.AcceptLanguage
+            funcname = 'best_match'
+            retval = None
 
-        self.assertIsNone(request.best_match_language())
+        with mock.patch.object(cls, funcname) as mocked_function:
+            mocked_function.return_value = retval
+
+            self.assertIsNone(request.best_match_language())
+            mocked_function.assert_called_once()
 
         # If Accept-Language is missing or empty, match should be None
         request.headers = {'Accept-Language': ''}
@@ -392,19 +407,27 @@ class ResourceTest(test_utils.BaseTestCase):
                               resource, request)
         self.assertEqual(message_es, str(e))
 
-    @mock.patch.object(webob.acceptparse.AcceptLanguage, 'best_match')
     @mock.patch.object(i18n, 'translate')
-    def test_translate_exception(self, mock_translate, mock_best_match):
+    def test_translate_exception(self, mock_translate):
+        # TODO(rosmaita): simplify when lower_constraints has webob >= 1.8.1
+        try:
+            from webob.acceptparse import AcceptLanguageValidHeader  # noqa
+            cls = webob.acceptparse.AcceptLanguageValidHeader
+            funcname = 'lookup'
+        except ImportError:
+            cls = webob.acceptparse.AcceptLanguage
+            funcname = 'best_match'
 
-        mock_translate.return_value = 'No Encontrado'
-        mock_best_match.return_value = 'de'
+        with mock.patch.object(cls, funcname) as mocked_function:
+            mock_translate.return_value = 'No Encontrado'
+            mocked_function.return_value = 'de'
 
-        req = wsgi.Request.blank('/tests/123')
-        req.headers["Accept-Language"] = "de"
+            req = wsgi.Request.blank('/tests/123')
+            req.headers["Accept-Language"] = "de"
 
-        e = webob.exc.HTTPNotFound(explanation='Not Found')
-        e = wsgi.translate_exception(req, e)
-        self.assertEqual('No Encontrado', e.explanation)
+            e = webob.exc.HTTPNotFound(explanation='Not Found')
+            e = wsgi.translate_exception(req, e)
+            self.assertEqual('No Encontrado', e.explanation)
 
     def test_response_headers_encoded(self):
         # prepare environment