@itentialopensource/adapter-salesforce 0.7.4 → 0.8.0

package/sampleProperties.json

@@ -8,7 +8,8 @@
     "version": "",
     "cache_location": "none",
     "encode_pathvars": true,
-    "save_metric": true,
+    "encode_queryvars": true,
+    "save_metric": false,
     "stub": true,
     "protocol": "https",
     "authentication": {
@@ -21,7 +22,10 @@
       "invalid_token_error": 401,
       "auth_field": "header.headers.X-AUTH-TOKEN",
       "auth_field_format": "{token}",
-      "auth_logging": false
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
     },
     "healthcheck": {
       "type": "startup",
@@ -92,6 +96,94 @@
         "key_file": "",
         "cert_file": ""
       }
+    },
+    "devicebroker": {
+      "getDevice": [
+        {
+          "path": "/get/devices/{id}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/get/devices/{id}/status",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "status",
+            "statusValue": "online"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/get/devices/{id}/configPart1",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
     }
   },
   "groups": [],

package/test/integration/adapterTestBasicGet.js

@@ -14,7 +14,7 @@ const itParam = require('mocha-param');
 
 const utils = require('../../utils/tbUtils');
 const basicGet = require('../../utils/basicGet');
-const { name } = require('../../package');
+const { name } = require('../../package.json');
 const { methods } = require('../../pronghorn.json');
 
 const getPronghornProps = (iapDir) => {
@@ -34,7 +34,7 @@ describe('[integration] Adapter BasicGET Test', () => {
   context('Testing GET calls without query parameters', () => {
     before(async () => {
       const iapDir = path.join(__dirname, '../../../../../');
-      if (!utils.withinIAP(iapDir)) {
+      if (!utils.areWeUnderIAPinstallationDirectory()) {
         const sampleProperties = require('../../sampleProperties.json');
         const adapter = { properties: sampleProperties };
         a = basicGet.getAdapterInstance(adapter);

package/test/integration/adapterTestIntegration.js

@@ -3,6 +3,8 @@
 // Set globals
 /* global describe it log pronghornProps */
 /* eslint no-unused-vars: warn */
+/* eslint no-underscore-dangle: warn  */
+/* eslint import/no-dynamic-require:warn */
 
 // include required items for testing & logging
 const assert = require('assert');
@@ -13,25 +15,39 @@ const winston = require('winston');
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const util = require('util');
 
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
 let logLevel = 'none';
-const stub = true;
 const isRapidFail = false;
 const isSaveMockData = false;
-const attemptTimeout = 5000;
+
+// read in the properties from the sampleProperties files
+let adaptdir = __dirname;
+if (adaptdir.endsWith('/test/integration')) {
+  adaptdir = adaptdir.substring(0, adaptdir.length - 17);
+} else if (adaptdir.endsWith('/test/unit')) {
+  adaptdir = adaptdir.substring(0, adaptdir.length - 10);
+}
+const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
 
 // these variables can be changed to run in integrated mode so easier to set them here
 // always check these in with bogus data!!!
-const host = 'replace.hostorip.here';
-const username = 'username';
-const password = 'password';
-const protocol = 'http';
-const port = 80;
-const sslenable = false;
-const sslinvalid = false;
+samProps.stub = true;
+samProps.host = 'replace.hostorip.here';
+samProps.authentication.username = 'username';
+samProps.authentication.password = 'password';
+samProps.protocol = 'http';
+samProps.port = 80;
+samProps.ssl.enabled = false;
+samProps.ssl.accept_invalid_cert = false;
+if (samProps.request.attempt_timeout < 30000) {
+  samProps.request.attempt_timeout = 30000;
+}
+const attemptTimeout = samProps.request.attempt_timeout;
+const { stub } = samProps;
 
 // these are the adapter properties. You generally should not need to alter
 // any of these after they are initially set up
@@ -43,99 +59,7 @@ global.pronghornProps = {
     adapters: [{
       id: 'Test-salesforce',
       type: 'Salesforce',
-      properties: {
-        host,
-        port,
-        base_path: '//api',
-        version: 'v1',
-        cache_location: 'none',
-        encode_pathvars: true,
-        save_metric: false,
-        protocol,
-        stub,
-        authentication: {
-          auth_method: 'no_authentication',
-          username,
-          password,
-          token: '',
-          token_timeout: 1800000,
-          token_cache: 'local',
-          invalid_token_error: 401,
-          auth_field: 'header.headers.X-AUTH-TOKEN',
-          auth_field_format: '{token}',
-          auth_logging: false
-        },
-        healthcheck: {
-          type: 'startup',
-          frequency: 60000,
-          query_object: {}
-        },
-        throttle: {
-          throttle_enabled: false,
-          number_pronghorns: 1,
-          sync_async: 'sync',
-          max_in_queue: 1000,
-          concurrent_max: 1,
-          expire_timeout: 0,
-          avg_runtime: 200,
-          priorities: [
-            {
-              value: 0,
-              percent: 100
-            }
-          ]
-        },
-        request: {
-          number_redirects: 0,
-          number_retries: 3,
-          limit_retry_error: 0,
-          failover_codes: [],
-          attempt_timeout: attemptTimeout,
-          global_request: {
-            payload: {},
-            uriOptions: {},
-            addlHeaders: {},
-            authData: {}
-          },
-          healthcheck_on_timeout: true,
-          raw_return: true,
-          archiving: false,
-          return_request: false
-        },
-        proxy: {
-          enabled: false,
-          host: '',
-          port: 1,
-          protocol: 'http',
-          username: '',
-          password: ''
-        },
-        ssl: {
-          ecdhCurve: '',
-          enabled: sslenable,
-          accept_invalid_cert: sslinvalid,
-          ca_file: '',
-          key_file: '',
-          cert_file: '',
-          secure_protocol: '',
-          ciphers: ''
-        },
-        mongo: {
-          host: '',
-          port: 0,
-          database: '',
-          username: '',
-          password: '',
-          replSet: '',
-          db_ssl: {
-            enabled: false,
-            accept_invalid_cert: false,
-            ca_file: '',
-            key_file: '',
-            cert_file: ''
-          }
-        }
-      }
+      properties: samProps
     }]
   }
 };
@@ -310,7 +234,7 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
 }
 
 // require the adapter that we are going to be using
-const Salesforce = require('../../adapter.js');
+const Salesforce = require('../../adapter');
 
 // begin the testing - these should be pretty well defined between the describe and the it!
 describe('[integration] Salesforce Adapter Test', () => {
@@ -341,6 +265,8 @@ describe('[integration] Salesforce Adapter Test', () => {
         try {
           assert.notEqual(null, a);
           assert.notEqual(undefined, a);
+          const checkId = global.pronghornProps.adapterProps.adapters[0].id;
+          assert.equal(checkId, a.id);
           assert.notEqual(null, a.allProps);
           const check = global.pronghornProps.adapterProps.adapters[0].properties.healthcheck.type;
           assert.equal(check, a.healthcheckType);

package/test/unit/adapterBaseTestUnit.js

@@ -61,7 +61,10 @@ global.pronghornProps = {
           token_cache: 'local',
           auth_field: 'header.headers.Authorization',
           auth_field_format: 'Basic {b64}{username}:{password}{/b64}',
-          auth_logging: false
+          auth_logging: false,
+          client_id: '',
+          client_secret: '',
+          grant_type: ''
         },
         healthcheck: {
           type: 'none',
@@ -194,7 +197,7 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
 }
 
 // require the adapter that we are going to be using
-const AdapterBase = require('../../adapterBase.js');
+const AdapterBase = require('../../adapterBase');
 
 // delete the .DS_Store directory in entities -- otherwise this will cause errors
 const dirPath = path.join(__dirname, '../../entities/.DS_Store');
@@ -314,8 +317,10 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should return a list of functions', (done) => {
         const returnedFunctions = ['addEntityCache', 'capabilityResults', 'checkActionFiles', 'checkProperties', 'connect', 'encryptProperty',
-          'entityInList', 'findPath', 'getAllCapabilities', 'getAllFunctions', 'getQueue', 'getWorkflowFunctions', 'healthCheck',
-          'refreshProperties', 'runBasicGet', 'runConnectivity', 'runHealthcheck', 'suspend', 'troubleshoot', 'unsuspend', 'updateAdapterConfiguration', 'addListener',
+          'entityInList', 'getAllCapabilities', 'getAllFunctions', 'getConfig', 'getDevice', 'getDevicesFiltered', 'hasDevices', 'hasEntities',
+          'healthCheck', 'iapFindAdapterPath', 'iapGetAdapterQueue', 'iapGetAdapterWorkflowFunctions', 'iapGetDeviceCount', 'iapMakeBrokerCall',
+          'iapMoveAdapterEntitiesToDB', 'iapRunAdapterBasicGet', 'iapRunAdapterConnectivity', 'iapRunAdapterHealthcheck', 'iapSuspendAdapter',
+          'iapTroubleshootAdapter', 'iapUnsuspendAdapter', 'iapUpdateAdapterConfiguration', 'isAlive', 'refreshProperties', 'addListener',
           'emit', 'eventNames', 'getMaxListeners', 'listenerCount', 'listeners', 'off', 'on', 'once', 'prependListener',
           'prependOnceListener', 'rawListeners', 'removeAllListeners', 'removeListener', 'setMaxListeners'];
         try {
@@ -334,10 +339,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    describe('#getWorkflowFunctions', () => {
-      it('should have a getWorkflowFunctions function', (done) => {
+    describe('#iapGetAdapterWorkflowFunctions', () => {
+      it('should have a iapGetAdapterWorkflowFunctions function', (done) => {
         try {
-          assert.equal(true, typeof a.getWorkflowFunctions === 'function');
+          assert.equal(true, typeof a.iapGetAdapterWorkflowFunctions === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -346,7 +351,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should retrieve workflow functions', (done) => {
         try {
-          const expectedFunctions = a.getWorkflowFunctions([]);
+          const expectedFunctions = a.iapGetAdapterWorkflowFunctions([]);
           try {
             assert.equal(0, expectedFunctions.length);
             done();
@@ -423,10 +428,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    describe('#getQueue', () => {
-      it('should have a getQueue function', (done) => {
+    describe('#iapGetAdapterQueue', () => {
+      it('should have a iapGetAdapterQueue function', (done) => {
         try {
-          assert.equal(true, typeof a.getQueue === 'function');
+          assert.equal(true, typeof a.iapGetAdapterQueue === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -435,7 +440,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should get information for all of the requests currently in the queue', (done) => {
         try {
-          const expectedFunctions = a.getQueue();
+          const expectedFunctions = a.iapGetAdapterQueue();
           try {
             assert.equal(0, expectedFunctions.length);
             done();
@@ -814,12 +819,17 @@ describe('[unit] Adapter Base Test', () => {
           try {
             assert.notEqual(0, expectedCapabilities.length);
             assert.equal('.generic', expectedCapabilities[0].entity);
-            assert.equal(5, expectedCapabilities[0].actions.length);
+            assert.equal(10, expectedCapabilities[0].actions.length);
             assert.equal('getGenerics', expectedCapabilities[0].actions[0]);
             assert.equal('createGeneric', expectedCapabilities[0].actions[1]);
             assert.equal('updateGeneric', expectedCapabilities[0].actions[2]);
             assert.equal('patchGeneric', expectedCapabilities[0].actions[3]);
             assert.equal('deleteGeneric', expectedCapabilities[0].actions[4]);
+            assert.equal('getGenericsNoBase', expectedCapabilities[0].actions[5]);
+            assert.equal('createGenericNoBase', expectedCapabilities[0].actions[6]);
+            assert.equal('updateGenericNoBase', expectedCapabilities[0].actions[7]);
+            assert.equal('patchGenericNoBase', expectedCapabilities[0].actions[8]);
+            assert.equal('deleteGenericNoBase', expectedCapabilities[0].actions[9]);
             assert.equal('.system', expectedCapabilities[1].entity);
             assert.equal(2, expectedCapabilities[1].actions.length);
             assert.equal('getToken', expectedCapabilities[1].actions[0]);
@@ -840,12 +850,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    // const returnedFunctions = ['updateAdapterConfiguration'];
-
-    describe('#updateAdapterConfiguration', () => {
-      it('should have a updateAdapterConfiguration function', (done) => {
+    describe('#iapUpdateAdapterConfiguration', () => {
+      it('should have a iapUpdateAdapterConfiguration function', (done) => {
         try {
-          assert.equal(true, typeof a.updateAdapterConfiguration === 'function');
+          assert.equal(true, typeof a.iapUpdateAdapterConfiguration === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -854,7 +862,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should return no updated if no changes are provided', (done) => {
         try {
-          a.updateAdapterConfiguration(null, null, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration(null, null, null, null, null, (data, error) => {
             try {
               assert.equal('No configuration updates to make', data.response);
               done();
@@ -870,10 +878,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('should throw an error if missing configuration file', (done) => {
         try {
-          a.updateAdapterConfiguration(null, { name: 'fakeChange' }, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration(null, { name: 'fakeChange' }, null, null, null, (data, error) => {
             try {
               const displayE = 'configFile is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -887,10 +895,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, entity is required', (done) => {
         try {
-          a.updateAdapterConfiguration('notPackage', { name: 'fakeChange' }, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, null, null, null, (data, error) => {
             try {
               const displayE = 'Unsupported Configuration Change or Missing Entity';
-              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -904,10 +912,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, type is required', (done) => {
         try {
-          a.updateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'entity', null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'entity', null, null, (data, error) => {
             try {
               const displayE = 'type is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -921,10 +929,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, entity must be valid', (done) => {
         try {
-          a.updateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'fakeEntity', 'fakeType', null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'fakeEntity', 'fakeType', null, (data, error) => {
             try {
               const displayE = 'Incomplete Configuration Change: Invalid Entity - fakeEntity';
-              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);