Test with an IAM authenticated client

Author: smithsz

Jenkinsfile

@@ -26,6 +26,33 @@ def test_python(pythonVersion)
   }
 }
 
+def test_python_iam(pythonVersion)
+{
+  node {
+    // Unstash the source on this node
+    unstash name: 'source'
+    // Set up the environment and test
+    withCredentials([[$class: 'UsernamePasswordMultiBinding', credentialsId: 'iam-testy023', usernameVariable: 'DB_USER', passwordVariable: 'IAM_API_KEY']]) {
+      try {
+        sh """  virtualenv tmp -p /usr/local/lib/python${pythonVersion}/bin/${pythonVersion.startsWith('3') ? "python3" : "python"}
+                . ./tmp/bin/activate
+                echo \$DB_USER
+                export RUN_CLOUDANT_TESTS=1
+                export CLOUDANT_ACCOUNT=\$DB_USER
+                # Temporarily disable the _db_updates tests pending resolution of case 71610
+                export SKIP_DB_UPDATES=1
+                pip install -r requirements.txt
+                pip install -r test-requirements.txt
+                pylint ./src/cloudant
+                nosetests -w ./tests/unit --with-xunit"""
+      } finally {
+        // Load the test results
+        junit 'nosetests.xml'
+      }
+    }
+  }
+}
+
 // Start of build
 stage('Checkout'){
   // Checkout and stash the source
@@ -38,6 +65,8 @@ stage('Test'){
   // Run tests in parallel for multiple python versions
   parallel(
     Python2: {test_python('2.7.12')},
-    Python3: {test_python('3.5.2')}
+    Python3: {test_python('3.5.2')},
+    'Python2-IAM': {test_python_iam('2.7.12')},
+    'Python3-IAM': {test_python_iam('3.5.2')}
   )
 }

tests/unit/auth_renewal_tests.py

@@ -25,7 +25,7 @@
 
 from cloudant.client_session import CookieSession
 
-from .unit_t_db_base import UnitTestDbBase
+from .unit_t_db_base import skip_for_iam, UnitTestDbBase
 
 @unittest.skipIf(os.environ.get('ADMIN_PARTY') == 'true', 'Skipping - Admin Party mode')
 class AuthRenewalTests(UnitTestDbBase):
@@ -44,7 +44,8 @@ def tearDown(self):
         Override UnitTestDbBase.tearDown() with no tear down
         """
         pass
-        
+
+    @skip_for_iam
     def test_client_db_doc_stack_success(self):
         """
         Ensure that auto renewal of cookie auth happens as expected and applies

tests/unit/client_tests.py

@@ -39,7 +39,7 @@
 from cloudant.error import CloudantArgumentError, CloudantClientException
 from cloudant.feed import Feed, InfiniteFeed
 
-from .unit_t_db_base import UnitTestDbBase
+from .unit_t_db_base import skip_for_iam, UnitTestDbBase
 from .. import bytes_, str_
 
 class CloudantClientExceptionTests(unittest.TestCase):
@@ -164,6 +164,7 @@ def test_multiple_connect(self):
             self.client.disconnect()
             self.assertIsNone(self.client.r_session)
 
+    @skip_for_iam
     def test_auto_renew_enabled(self):
         """
         Test that CookieSession is used when auto_renew is enabled.
@@ -178,6 +179,7 @@ def test_auto_renew_enabled(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_auto_renew_enabled_with_auto_connect(self):
         """
         Test that CookieSession is used when auto_renew is enabled along with
@@ -192,6 +194,7 @@ def test_auto_renew_enabled_with_auto_connect(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_session(self):
         """
         Test getting session information.  
@@ -207,6 +210,7 @@ def test_session(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_session_cookie(self):
         """
         Test getting the session cookie.
@@ -315,6 +319,7 @@ def test_change_credentials_basic(self, m_req):
         )
         self.assertEquals(all_dbs, ['animaldb'])
 
+    @skip_for_iam
     def test_basic_auth_str(self):
         """
         Test getting the basic authentication string.
@@ -589,6 +594,7 @@ class CloudantClientTests(UnitTestDbBase):
     Cloudant specific client unit tests
     """
 
+    @skip_for_iam
     def test_cloudant_session_login(self):
         """
         Test that the Cloudant client session successfully authenticates.
@@ -601,6 +607,7 @@ def test_cloudant_session_login(self):
         self.client.session_login()
         self.assertNotEqual(self.client.session_cookie(), old_cookie)
 
+    @skip_for_iam
     def test_cloudant_session_login_with_new_credentials(self):
         """
         Test that the Cloudant client session fails to authenticate when
@@ -613,6 +620,7 @@ def test_cloudant_session_login_with_new_credentials(self):
 
         self.assertTrue(str(cm.exception).find('Name or password is incorrect'))
 
+    @skip_for_iam
     def test_cloudant_context_helper(self):
         """
         Test that the cloudant context helper works as expected.
@@ -624,6 +632,7 @@ def test_cloudant_context_helper(self):
         except Exception as err:
             self.fail('Exception {0} was raised.'.format(str(err)))
 
+    @skip_for_iam
     def test_cloudant_bluemix_context_helper(self):
         """
         Test that the cloudant_bluemix context helper works as expected.
@@ -688,6 +697,7 @@ def test_constructor_with_account(self):
             'https://{0}.cloudant.com'.format(self.account)
             )
 
+    @skip_for_iam
     def test_bluemix_constructor(self):
         """
         Test instantiating a client object using a VCAP_SERVICES environment
@@ -720,6 +730,7 @@ def test_bluemix_constructor(self):
         finally:
             c.disconnect()
 
+    @skip_for_iam
     def test_bluemix_constructor_specify_instance_name(self):
         """
         Test instantiating a client object using a VCAP_SERVICES environment
@@ -752,6 +763,7 @@ def test_bluemix_constructor_specify_instance_name(self):
         finally:
             c.disconnect()
 
+    @skip_for_iam
     def test_bluemix_constructor_with_multiple_services(self):
         """
         Test instantiating a client object using a VCAP_SERVICES environment
@@ -819,6 +831,7 @@ def test_connect_headers(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_connect_timeout(self):
         """
         Test that a connect timeout occurs when instantiating
@@ -845,6 +858,7 @@ def test_db_updates_infinite_feed_call(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_billing_data(self):
         """
         Test the retrieval of billing data
@@ -939,6 +953,7 @@ def test_set_year_with_invalid_month_for_billing_data(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_volume_usage_data(self):
         """
         Test the retrieval of volume usage data
@@ -1030,6 +1045,7 @@ def test_set_year_with_invalid_month_for_volume_usage_data(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_requests_usage_data(self):
         """
         Test the retrieval of requests usage data
@@ -1121,6 +1137,7 @@ def test_set_year_with_invalid_month_for_requests_usage_data(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_shared_databases(self):
         """
         Test the retrieval of shared database list
@@ -1131,6 +1148,7 @@ def test_shared_databases(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_generate_api_key(self):
         """
         Test the generation of an API key for this client account
@@ -1144,6 +1162,7 @@ def test_generate_api_key(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_cors_configuration(self):
         """
         Test the retrieval of the current CORS configuration for this client
@@ -1157,6 +1176,7 @@ def test_cors_configuration(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_cors_origins(self):
         """
         Test the retrieval of the CORS origins list
@@ -1168,6 +1188,7 @@ def test_cors_origins(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_disable_cors(self):
         """
         Test disabling CORS (assuming CORS is enabled)
@@ -1188,6 +1209,7 @@ def test_disable_cors(self):
         finally:
             self.client.disconnect()
 
+    @skip_for_iam
     def test_update_cors_configuration(self):
         """
         Test updating CORS configuration

tests/unit/database_tests.py

@@ -38,7 +38,7 @@
 from cloudant.feed import Feed, InfiniteFeed
 from tests.unit._test_util import LONG_NUMBER
 
-from .unit_t_db_base import UnitTestDbBase
+from .unit_t_db_base import skip_for_iam, UnitTestDbBase
 from .. import unicode_
 
 class CloudantDatabaseExceptionTests(unittest.TestCase):
@@ -151,6 +151,7 @@ def test_retrieve_db_url(self):
             '/'.join((self.client.server_url, self.test_dbname))
         )
 
+    @skip_for_iam
     def test_retrieve_creds(self):
         """
         Test retrieving client credentials. The client credentials are None if
@@ -370,6 +371,7 @@ def test_retrieve_design_document(self):
         ddoc = self.db.get_design_document('_design/ddoc01')
         self.assertEqual(ddoc, local_ddoc)
 
+    @skip_for_iam
     def test_get_security_document(self):
         """
         Test retrieving the database security document
@@ -995,6 +997,7 @@ def test_unshare_database_uses_custom_encoder(self):
         with self.assertRaises(TypeError):
             database.unshare_database(share)
 
+    @skip_for_iam
     def test_security_document(self):
         """
         Test the retrieval of the security document.
@@ -1004,6 +1007,7 @@ def test_security_document(self):
         expected = {'cloudant': {share: ['_reader']}}
         self.assertDictEqual(self.db.security_document(), expected)
 
+    @skip_for_iam
     def test_share_database_default_permissions(self):
         """
         Test the sharing of a database applying default permissions.
@@ -1014,6 +1018,7 @@ def test_share_database_default_permissions(self):
         expected = {'cloudant': {share: ['_reader']}}
         self.assertDictEqual(self.db.security_document(), expected)
 
+    @skip_for_iam
     def test_share_database(self):
         """
         Test the sharing of a database.
@@ -1024,6 +1029,7 @@ def test_share_database(self):
         expected = {'cloudant': {share: ['_writer']}}
         self.assertDictEqual(self.db.security_document(), expected)
 
+    @skip_for_iam
     def test_share_database_with_redundant_role_entries(self):
         """
         Test the sharing of a database works when the list of roles contains
@@ -1066,6 +1072,7 @@ def test_share_database_empty_role_list(self):
             '\'_db_updates\', \'_design\', \'_shards\', \'_security\']'
         )
 
+    @skip_for_iam
     def test_unshare_database(self):
         """
         Test the un-sharing of a database from a specified user.

tests/unit/replicator_tests.py

@@ -34,7 +34,7 @@
 from cloudant.document import Document
 from cloudant.error import CloudantReplicatorException, CloudantClientException
 
-from .unit_t_db_base import UnitTestDbBase
+from .unit_t_db_base import skip_for_iam, UnitTestDbBase
 from .. import unicode_
 
 class CloudantReplicatorExceptionTests(unittest.TestCase):
@@ -157,6 +157,7 @@ def test_replication_with_generated_id(self):
         clone = Replicator(self.client)
         clone.create_replication(self.db, self.target_db)
 
+    @skip_for_iam
     @flaky(max_runs=3)
     def test_create_replication(self):
         """
@@ -300,6 +301,7 @@ def test_list_replications(self):
         match = [repl_id for repl_id in all_repl_ids if repl_id in repl_ids]
         self.assertEqual(set(repl_ids), set(match))
 
+    @skip_for_iam
     def test_retrieve_replication_state(self):
         """
         Test that the replication state can be retrieved for a replication
@@ -341,6 +343,7 @@ def test_retrieve_replication_state_using_invalid_id(self):
             )
             self.assertIsNone(repl_state)
 
+    @skip_for_iam
     def test_stop_replication(self):
         """
         Test that a replication can be stopped.
@@ -376,6 +379,7 @@ def test_stop_replication_using_invalid_id(self):
                 'Replication with id {} not found.'.format(repl_id)
             )
 
+    @skip_for_iam
     def test_follow_replication(self):
         """
         Test that follow_replication(...) properly iterates updated