Allow CouchDB.session_login to take credentials as arguments

Author: smithsz

src/cloudant/_common_util.py

@@ -370,6 +370,19 @@ def request(self, method, url, **kwargs):  # pylint: disable=W0221
 
         return resp
 
+    def set_credentials(self, username, password):
+        """
+        Set a new username and password.
+
+        :param str username: New username.
+        :param str password: New password.
+        """
+        if username is not None:
+            self._username = username
+
+        if password is not None:
+            self._password = password
+
 
 class IAMSession(ClientSession):
     """
@@ -443,6 +456,16 @@ def request(self, method, url, **kwargs):  # pylint: disable=W0221
 
         return resp
 
+    def set_credentials(self, username, api_key):
+        """
+        Set a new IAM API key.
+
+        :param str username: Username parameter is unused.
+        :param str api_key: New IAM API key.
+        """
+        if api_key is not None:
+            self._api_key = api_key
+
     def _get_access_token(self):
         """
         Get IAM access token using API key.

src/cloudant/client.py

@@ -161,14 +161,15 @@ def session_cookie(self):
             return None
         return self.r_session.cookies.get('AuthSession')
 
-    def session_login(self):
+    def session_login(self, user=None, passwd=None):
         """
         Performs a session login by posting the auth information
         to the _session endpoint.
         """
         if self.admin_party:
             return
 
+        self.r_session.set_credentials(user, passwd)
         self.r_session.login()
 
     def session_logout(self):

tests/unit/client_tests.py

@@ -28,7 +28,8 @@
 import os
 import datetime
 
-from requests import ConnectTimeout
+from requests import ConnectTimeout, HTTPError
+from time import sleep
 
 from cloudant import cloudant, cloudant_bluemix, couchdb, couchdb_admin_party
 from cloudant.client import Cloudant, CouchDB
@@ -492,6 +493,30 @@ class CloudantClientTests(UnitTestDbBase):
     Cloudant specific client unit tests
     """
 
+    def test_cloudant_session_login(self):
+        """
+        Test that the Cloudant client session successfully authenticates.
+        """
+        self.client.connect()
+        old_cookie = self.client.session_cookie()
+
+        sleep(5)  # ensure we get a different cookie back
+
+        self.client.session_login()
+        self.assertNotEqual(self.client.session_cookie(), old_cookie)
+
+    def test_cloudant_session_login_with_new_credentials(self):
+        """
+        Test that the Cloudant client session fails to authenticate when
+        passed incorrect credentials.
+        """
+        self.client.connect()
+
+        with self.assertRaises(HTTPError) as cm:
+            self.client.session_login('invalid-user-123', 'pa$$w0rd01')
+
+        self.assertTrue(str(cm.exception).find('Name or password is incorrect'))
+
     def test_cloudant_context_helper(self):
         """
         Test that the cloudant context helper works as expected.

tests/unit/iam_auth_tests.py

@@ -88,6 +88,15 @@ def _mock_cookie(expires_secs=300):
             rest={'HttpOnly': None},
             rfc2109=True)
 
+    def test_iam_set_credentials(self):
+        iam = IAMSession(MOCK_API_KEY, 'http://127.0.0.1:5984')
+        self.assertEquals(iam._api_key, MOCK_API_KEY)
+
+        new_api_key = 'some_new_api_key'
+        iam.set_credentials(None, new_api_key)
+
+        self.assertEquals(iam._api_key, new_api_key)
+
     @mock.patch('cloudant._common_util.ClientSession.request')
     def test_iam_get_access_token(self, m_req):
         m_response = mock.MagicMock()
@@ -306,6 +315,38 @@ def test_iam_client_create(self, m_req, m_login):
         self.assertEqual(m_req.call_count, 1)
         self.assertEqual(dbs, ['animaldb'])
 
+    @mock.patch('cloudant._common_util.IAMSession.login')
+    @mock.patch('cloudant._common_util.IAMSession.set_credentials')
+    def test_iam_client_session_login(self, m_set, m_login):
+        # create IAM client
+        client = Cloudant.iam('foo', MOCK_API_KEY)
+        client.connect()
+
+        # add a valid cookie to jar
+        client.r_session.cookies.set_cookie(self._mock_cookie())
+
+        client.session_login()
+
+        m_set.assert_called_with(None, None)
+        self.assertEqual(m_login.call_count, 2)
+        self.assertEqual(m_set.call_count, 2)
+
+    @mock.patch('cloudant._common_util.IAMSession.login')
+    @mock.patch('cloudant._common_util.IAMSession.set_credentials')
+    def test_iam_client_session_login_with_new_credentials(self, m_set, m_login):
+        # create IAM client
+        client = Cloudant.iam('foo', MOCK_API_KEY)
+        client.connect()
+
+        # add a valid cookie to jar
+        client.r_session.cookies.set_cookie(self._mock_cookie())
+
+        client.session_login('bar', 'baz')  # new creds
+
+        m_set.assert_called_with('bar', 'baz')
+        self.assertEqual(m_login.call_count, 2)
+        self.assertEqual(m_set.call_count, 2)
+
 
 if __name__ == '__main__':
     unittest.main()