Adding support for IAM keys with Cloudant event source.

Author: jthomas

README.md

@@ -1153,13 +1153,19 @@ functions:
     index:
         handler: users.main
         events:
-            - cloudant:
+            - cloudant: // basic auth example
                 host: xxx-yyy-zzz-bluemix.cloudant.com
                 username: USERNAME
                 password: PASSWORD
                 db: db_name
+			- cloudant: // iam auth example
+                host: xxx-yyy-zzz-bluemix.cloudant.com
+                iam_api_key: IAM_API_KEY
+                db: db_name
 ```
 
+ `username` and `password` or `iam_api_key` parameters can be used for authentication.
+
 ### Adding Optional Parameters
 
 The following optional feed parameters are also supported:

compile/cloudant/index.js

@@ -2,8 +2,6 @@
 
 const BbPromise = require('bluebird');
 
-const config_properties = ['db', 'password', 'username', 'host']
-
 class OpenWhiskCompileCloudant {
   constructor(serverless, options) {
     this.serverless = serverless;
@@ -40,13 +38,28 @@ class OpenWhiskCompileCloudant {
     }
 
     if (!config.package) {
-      config_properties.forEach(prop => {
-        if (!config[prop]) {
-          throw new this.serverless.classes.Error(
-            `Cloudant event property (${prop}) missing on function: ${fnName}`
-          )
-        }
-      })
+      const config_properties = ['db', 'password', 'username', 'host']
+
+      if (!config.db) {
+        throw new this.serverless.classes.Error(
+          `Cloudant event property (db) missing on function: ${fnName}`
+        )
+      }
+
+      if (!config.host) {
+        throw new this.serverless.classes.Error(
+          `Cloudant event property (host) missing on function: ${fnName}`
+        )
+      }
+
+      const has_manual_auth = !!config.username && !!config.password
+      const has_iam_auth = !!config.iam_api_key
+      if (!has_manual_auth && !has_iam_auth) {
+        throw new this.serverless.classes.Error(
+          `Cloudant event authentication property (username & password or iam_api_key) missing on function: ${fnName}`
+        )
+      }
+
     }
   }
 
@@ -60,8 +73,12 @@ class OpenWhiskCompileCloudant {
     }
 
     if (!config.package) {
-      feed_parameters.username = config.username
-      feed_parameters.password = config.password
+      if (config.iam_api_key) {
+        feed_parameters.iamApiKey = config.iam_api_key
+      } else {
+        feed_parameters.username = config.username
+        feed_parameters.password = config.password
+      }
       feed_parameters.host = config.host
     }
 

compile/cloudant/tests/index.js

@@ -82,15 +82,32 @@ describe('OpenWhiskCompileCloudant', () => {
         .to.throw(Error, 'Cloudant event property (db) missing on function: testing');
     })
 
-    it('should throw errors for missing mandatory parameters without package', () => {
-      const config = { db: 'dbname', username: 'user', password: 'password', host: 'hostname' }
+    it('should throw errors for missing host parameters without package', () => {
+      const config = { db: 'dbname', username: 'user', password: 'password' }
 
-      Object.keys(config).forEach(key => {
-        const cloned = Object.assign({}, config)
-        cloned[key] = ''
-        expect(() => openwhiskCompileCloudant.compileCloudantTrigger('testing', cloned))
-          .to.throw(Error, `Cloudant event property (${key}) missing on function: testing`);
-      })
+      expect(() => openwhiskCompileCloudant.compileCloudantTrigger('testing', config))
+        .to.throw(Error, `Cloudant event property (host) missing on function: testing`);
+    })
+
+    it('should throw errors for missing username parameter without package', () => {
+      const config = { db: 'dbname', host: 'host.com', password: 'password' }
+
+      expect(() => openwhiskCompileCloudant.compileCloudantTrigger('testing', config))
+        .to.throw(Error, `Cloudant event authentication property (username & password or iam_api_key) missing on function: testing`);
+    })
+
+    it('should throw errors for missing password parameter without package', () => {
+      const config = { db: 'dbname', host: 'host.com', username: 'username' }
+
+      expect(() => openwhiskCompileCloudant.compileCloudantTrigger('testing', config))
+        .to.throw(Error, `Cloudant event authentication property (username & password or iam_api_key) missing on function: testing`);
+    })
+
+    it('should throw errors for missing authentication parameters without package', () => {
+      const config = { db: 'dbname', host: 'host.com' }
+
+      expect(() => openwhiskCompileCloudant.compileCloudantTrigger('testing', config))
+        .to.throw(Error, `Cloudant event authentication property (username & password or iam_api_key) missing on function: testing`);
     })
 
     it('should return trigger for cloudant provider using package.', () => {
@@ -107,7 +124,7 @@ describe('OpenWhiskCompileCloudant', () => {
       })
     })
 
-    it('should return trigger for cloudant provider with manual configuration.', () => {
+    it('should return trigger for cloudant provider with manual username & password configuration.', () => {
       const config = { db: 'dbname', username: 'user', password: 'password', host: 'hostname' }
       const trigger = openwhiskCompileCloudant.compileCloudantTrigger('testing', config) 
       expect(trigger).to.be.deep.equal({
@@ -124,6 +141,22 @@ describe('OpenWhiskCompileCloudant', () => {
       })
     })
 
+    it('should return trigger for cloudant provider with manual iam api key configuration.', () => {
+      const config = { db: 'dbname', iam_api_key: 'api_key', host: 'hostname' }
+      const trigger = openwhiskCompileCloudant.compileCloudantTrigger('testing', config) 
+      expect(trigger).to.be.deep.equal({
+        name: `${serverless.service.service}_testing_cloudant_${config.db}`,
+        content: {
+          feed: `/whisk.system/cloudant/changes`,
+          feed_parameters: {
+            iamApiKey: config.iam_api_key,
+            host: config.host,
+            dbname: config.db
+          }
+        }
+      })
+    })
+
     it('should return trigger with optional configuration parameters.', () => {
       const config = { db: 'dbname', username: 'user', password: 'password', host: 'hostname', max: 10000, query: { key: 'value' }, filter: 'some/view' }
       const trigger = openwhiskCompileCloudant.compileCloudantTrigger('testing', config)