From c5bac3a32c6a48a1f81e242638e586749a1f514b Mon Sep 17 00:00:00 2001
From: Jamie Lennox <jamielennox@gmail.com>
Date: Mon, 5 Dec 2016 11:03:20 +1100
Subject: [PATCH] Don't issue deprecation warning when nesting adapters

Auth token middleware does a bit of a hack where it passes an Adapter in
as a session to the client. This is useful there because we need to know
much more about the authentication information than we do in most
clients.

We should look at fixing this in auth_token middleware, however for now
we shouldn't issue a deprecation warning when a user passes an Adapter
as a session object because this has always been designed to work - just
not something we recommend.

Change-Id: If7ebe59d5908275e607f32244027c8e6f3d1e157
Closes-Bug: #1647230
---
 keystoneauth1/adapter.py                 |  3 +-
 keystoneauth1/tests/unit/test_session.py | 40 ++++++++++++++++++++----
 2 files changed, 36 insertions(+), 7 deletions(-)

diff --git a/keystoneauth1/adapter.py b/keystoneauth1/adapter.py
index 6afedf81..6fb59355 100644
--- a/keystoneauth1/adapter.py
+++ b/keystoneauth1/adapter.py
@@ -123,9 +123,10 @@ class Adapter(object):
         if self.allow:
             kwargs.setdefault('allow', self.allow)
 
-        if isinstance(self.session, session.Session):
+        if isinstance(self.session, (session.Session, Adapter)):
             # these things are unsupported by keystoneclient's session so be
             # careful with them until everyone has transitioned to ksa.
+            # Allowing adapter allows adapter nesting that auth_token does.
             if self.client_name:
                 kwargs.setdefault('client_name', self.client_name)
             if self.client_version:
diff --git a/keystoneauth1/tests/unit/test_session.py b/keystoneauth1/tests/unit/test_session.py
index de4c564a..ed2de77a 100644
--- a/keystoneauth1/tests/unit/test_session.py
+++ b/keystoneauth1/tests/unit/test_session.py
@@ -434,6 +434,7 @@ class AuthPlugin(plugin.BaseAuthPlugin):
 class CalledAuthPlugin(plugin.BaseAuthPlugin):
 
     ENDPOINT = 'http://fakeendpoint/'
+    TOKEN = utils.TestCase.TEST_TOKEN
     USER_ID = uuid.uuid4().hex
     PROJECT_ID = uuid.uuid4().hex
 
@@ -448,7 +449,7 @@ class CalledAuthPlugin(plugin.BaseAuthPlugin):
 
     def get_token(self, session):
         self.get_token_called = True
-        return utils.TestCase.TEST_TOKEN
+        return self.TOKEN
 
     def get_endpoint(self, session, **kwargs):
         self.get_endpoint_called = True
@@ -787,11 +788,9 @@ class AdapterTest(utils.TestCase):
 
     TEST_URL = CalledAuthPlugin.ENDPOINT
 
-    def _create_loaded_adapter(self):
-        auth = CalledAuthPlugin()
-        sess = client_session.Session()
-        return adapter.Adapter(sess,
-                               auth=auth,
+    def _create_loaded_adapter(self, sess=None, auth=None):
+        return adapter.Adapter(sess or client_session.Session(),
+                               auth=auth or CalledAuthPlugin(),
                                service_type=self.SERVICE_TYPE,
                                service_name=self.SERVICE_NAME,
                                interface=self.INTERFACE,
@@ -1150,6 +1149,35 @@ class AdapterTest(utils.TestCase):
         self.assertEqual(override_user_agent,
                          self.requests_mock.last_request.headers['User-Agent'])
 
+    def test_nested_adapters(self):
+        text = uuid.uuid4().hex
+        token = uuid.uuid4().hex
+        url = 'http://keystone.example.com/path'
+
+        sess = client_session.Session()
+        auth = CalledAuthPlugin()
+        auth.ENDPOINT = url
+        auth.TOKEN = token
+
+        adap1 = adapter.Adapter(session=sess,
+                                interface='public')
+        adap2 = adapter.Adapter(session=adap1,
+                                service_type='identity',
+                                auth=auth)
+
+        self.requests_mock.get(url + '/test', text=text)
+
+        resp = adap2.get('/test')
+
+        self.assertEqual(text, resp.text)
+        self.assertTrue(auth.get_endpoint_called)
+
+        self.assertEqual('public', auth.endpoint_arguments['interface'])
+        self.assertEqual('identity', auth.endpoint_arguments['service_type'])
+
+        last_token = self.requests_mock.last_request.headers['X-Auth-Token']
+        self.assertEqual(token, last_token)
+
 
 class TCPKeepAliveAdapterTest(utils.TestCase):