impr(VLTCLT-68): Add getAccountLimitsByCanonicalIds wrapper for getAccounts

lib/IAMClient.d.ts

@@ -135,6 +135,20 @@ declare class VaultClient {
      * @returns {undefined}
      */
     getAccountLimits(accountName: string, callback: any): undefined;
+    /**
+     * A getter for account rate limit configuration given a list of canonicalIDs
+     * @param {String[]} canonicalIds - list of canonicalIDs
+     * @param {Object} options - additional arguments
+     * @param {string} options.reqUid - the request UID
+     * @param {werelogs.RequestLogger} [options.logger] - Logger instance
+     * @param {Function} callback - the callback handling the response object
+     * and the error, if there is one
+     * @returns {undefined}
+     */
+    getAccountLimitsByCanonicalIds(canonicalIds: string[], options: {
+        reqUid: string;
+        logger?: werelogs.RequestLogger;
+    }, callback: Function): undefined;
     /**
      * Get Quota of an account
      *

lib/IAMClient.js

@@ -348,12 +348,10 @@ class VaultClient {
             limits: JSON.stringify(limits),
         };
         assert(!this.parameterValidation || (limits && typeof limits === 'object'),
-            'Limits must be an object');
-        if (accountName) {
-            assert(!this.parameterValidation || typeof accountName === 'string',
-                'the account name, if set, should be a string');
-            data.AccountName = accountName;
-        }
+            'limits must be an object');
+        assert(!this.parameterValidation || typeof accountName === 'string',
+            'the account name should be a string');
+        data.AccountName = accountName;
         this.request('POST', '/', true, callback, data);
     }
 
@@ -370,11 +368,9 @@ class VaultClient {
             Version: '2010-05-08',
         };
 
-        if (accountName) {
-            assert(!this.parameterValidation || typeof accountName === 'string',
-                'the account name, if set, should be a string');
-            data.AccountName = accountName;
-        }
+        assert(!this.parameterValidation || typeof accountName === 'string',
+            'the account name should be a string');
+        data.AccountName = accountName;
         this.request('POST', '/', true, callback, data);
     }
 
@@ -391,14 +387,43 @@ class VaultClient {
             Version: '2010-05-08',
         };
 
-        if (accountName) {
-            assert(!this.parameterValidation || typeof accountName === 'string',
-                'the account name, if set, should be a string');
-            data.AccountName = accountName;
-        }
+        assert(!this.parameterValidation || typeof accountName === 'string',
+            'the account name should be a string');
+        data.AccountName = accountName;
         this.request('POST', '/', true, callback, data);
     }
 
+    /**
+     * A getter for account rate limit configuration given a list of canonicalIDs
+     * @param {String[]} canonicalIds - list of canonicalIDs
+     * @param {Object} options - additional arguments
+     * @param {string} options.reqUid - the request UID
+     * @param {werelogs.RequestLogger} [options.logger] - Logger instance
+     * @param {Function} callback - the callback handling the response object
+     * and the error, if there is one
+     * @returns {undefined}
+     */
+    getAccountLimitsByCanonicalIds(canonicalIds, options, callback) {
+        this.getAccounts(null, null, canonicalIds, options, (err, res, code) => {
+            if (err) {
+                return callback(err);
+            }
+            const body = res.reduce((accounts, account) => {
+                // eslint-disable-next-line no-param-reassign
+                accounts[account.canId] = account.limits;
+                return accounts;
+            }, {});
+
+            return callback(null, {
+                message: {
+                    body,
+                    code,
+                    message: 'Attributes retrieved',
+                },
+            });
+        });
+    }
+
     /**
      * Get Quota of an account
      *

tests/unit/deleteAccountLimits.js

@@ -31,25 +31,19 @@ describe('IAMClient - deleteAccountLimits', () => {
         });
     });
 
-    it('should call the request method with the correct parameters when accountName is not provided', () => {
+    it('should throw an error when accountName is not provided', () => {
         client = createClient(true);
-        client.deleteAccountLimits(undefined, () => {});
-
-        assert.strictEqual(lastRequestData.method, 'POST');
-        assert.strictEqual(lastRequestData.path, '/');
-        assert.strictEqual(lastRequestData.iamAuthenticate, true);
-        assert.deepStrictEqual(lastRequestData.data, {
-            Action: 'DeleteAccountLimits',
-            Version: '2010-05-08',
-        });
+        assert.throws(() => {
+            client.deleteAccountLimits(undefined, () => {});
+        }, /the account name should be a string/);
     });
 
     it('should throw an error if accountName is not a string', () => {
         client = createClient(true);
         const accountName = 123;
         assert.throws(() => {
             client.deleteAccountLimits(accountName, () => {});
-        }, /the account name, if set, should be a string/);
+        }, /the account name should be a string/);
     });
 
     it('should call the request method when wrong options are provided and parameterValidation is false', () => {

tests/unit/getAccountLimits.js

@@ -32,18 +32,12 @@ describe('GetAccountLimits', () => {
         assert.deepStrictEqual(lastRequestData.data, expectedData);
     });
 
-    it('should call the request method with default parameters when accountName is not provided', () => {
+    it('should throw an error when accountName is not provided', () => {
         client = createClient(true);
         const callback = () => {};
-        client.getAccountLimits(undefined, callback);
-        const expectedData = {
-            Action: 'GetAccountLimits',
-            Version: '2010-05-08',
-        };
-        assert.strictEqual(lastRequestData.method, 'POST');
-        assert.strictEqual(lastRequestData.path, '/');
-        assert.strictEqual(lastRequestData.iamAuthenticate, true);
-        assert.deepStrictEqual(lastRequestData.data, expectedData);
+        assert.throws(() => {
+            client.getAccountLimits(undefined, callback);
+        }, /the account name should be a string/);
     });
 
     it('should throw an error if accountName is not a string', () => {
@@ -52,7 +46,7 @@ describe('GetAccountLimits', () => {
         const callback = () => {};
         assert.throws(() => {
             client.getAccountLimits(accountName, callback);
-        }, /the account name, if set, should be a string/);
+        }, /the account name should be a string/);
     });
 
     it('should not throw an error if accountName is not a string and parameterValidation is false', () => {

tests/unit/getAccountLimitsByCanonicalId.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const assert = require('assert');
+const IAMClient = require('../../lib/IAMClient');
+
+const canonicalIds = ['canId1', 'canId2'];
+const opt = { reqUid: 'test.getAccounts.reqUid' };
+const mockCB = () => {};
+
+const expectedData = {
+    Action: 'GetAccounts',
+    Version: '2010-05-08',
+};
+
+describe('getAccountLimitsByCanonicalIds', () => {
+    let client;
+    let spyArg = null;
+
+    beforeEach('spy on request', done => {
+        client = new IAMClient('127.0.0.1', 8500);
+        client.request = function spy(...args) {
+            spyArg = args;
+        };
+        done();
+    });
+
+    afterEach('reset spyArg', () => { spyArg = null; });
+
+    it('should send request with correct arguments', () => {
+        client.getAccountLimitsByCanonicalIds(canonicalIds, opt, mockCB);
+        const [method, path, auth, cb, data, reqUid, contentType] = spyArg;
+        assert.strictEqual(method, 'GET');
+        assert.strictEqual(path, '/');
+        assert.strictEqual(auth, false);
+        assert.strictEqual(typeof cb, 'function');
+        assert.strictEqual(reqUid, opt.reqUid);
+        assert.strictEqual(contentType, null);
+        assert.deepStrictEqual(
+            data,
+            { ...expectedData, canonicalIds },
+        );
+    });
+
+
+    it('should throw with invalid arguments', () => {
+        assert.throws(() => client.getAccountLimitsByCanonicalIds('foobar', opt, mockCB),
+            assert.AssertionError);
+    });
+});

tests/unit/updateAccountLimits.js

@@ -35,21 +35,13 @@ describe('updateAccountLimits', () => {
         assert.deepStrictEqual(lastRequestData.data, expectedData);
     });
 
-    it('should call the request method with the correct parameters when accountName is not provided', () => {
+    it('should throw when accountName is not provided', () => {
         client = createClient(true);
         const limits = { rateLimit: 1000 };
-
-        const expectedData = {
-            Action: 'UpdateAccountLimits',
-            Version: '2010-05-08',
-            limits: JSON.stringify(limits),
-        };
-
-        client.updateAccountLimits(undefined, limits, () => {});
-        assert.strictEqual(lastRequestData.method, 'POST');
-        assert.strictEqual(lastRequestData.path, '/');
-        assert.strictEqual(lastRequestData.iamAuthenticate, true);
-        assert.deepStrictEqual(lastRequestData.data, expectedData);
+        assert.throws(
+            () => client.updateAccountLimits(undefined, limits, () => {})
+            , /the account name should be a string/
+        );
     });
 
     it('should handle complex limits object correctly', () => {
@@ -82,7 +74,7 @@ describe('updateAccountLimits', () => {
 
         assert.throws(() => {
             client.updateAccountLimits(accountName, limits, () => {});
-        }, /Limits must be an object/);
+        }, /limits must be an object/);
     });
 
     it('should throw an error if limits is null', () => {
@@ -92,7 +84,7 @@ describe('updateAccountLimits', () => {
 
         assert.throws(() => {
             client.updateAccountLimits(accountName, limits, () => {});
-        }, /Limits must be an object/);
+        }, /limits must be an object/);
     });
 
     it('should not throw an error if limits is not an object and parameterValidation is false', () => {
@@ -121,7 +113,7 @@ describe('updateAccountLimits', () => {
 
         assert.throws(() => {
             client.updateAccountLimits(accountName, limits, () => {});
-        }, /the account name, if set, should be a string/);
+        }, /the account name should be a string/);
     });
 
     it('should not throw an error if accountName is not a string and parameterValidation is false', () => {