@itentialopensource/adapter-aruba_airwave 0.2.1 → 0.3.0

package/adapterBase.js

@@ -8,23 +8,33 @@
 /* eslint no-cond-assign: warn */
 /* eslint global-require: warn */
 /* eslint no-unused-vars: warn */
+/* eslint prefer-destructuring: warn */
 
 /* Required libraries.  */
-const fs = require('fs-extra');
 const path = require('path');
-const EventEmitterCl = require('events').EventEmitter;
 const { execSync } = require('child_process');
+const { spawnSync } = require('child_process');
+const EventEmitterCl = require('events').EventEmitter;
+const fs = require('fs-extra');
+const jsonQuery = require('json-query');
+
+const sampleProperties = require(`${__dirname}/sampleProperties.json`).properties;
 
 /* The schema validator */
 const AjvCl = require('ajv');
+const { Test } = require('mocha');
 
 /* Fetch in the other needed components for the this Adaptor */
 const PropUtilCl = require('@itentialopensource/adapter-utils').PropertyUtility;
 const RequestHandlerCl = require('@itentialopensource/adapter-utils').RequestHandler;
-const troubleshootingAdapter = require('./utils/troubleshootingAdapter');
-const tbUtils = require('./utils/tbUtils');
+
+const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
+const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
+const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
+const taskMover = require(path.join(__dirname, 'utils/taskMover'));
 
 let propUtil = null;
+let choosepath = null;
 
 /*
  * INTERNAL FUNCTION: force fail the adapter - generally done to cause restart
@@ -97,7 +107,7 @@ function updateSchema(entityPath, configFile, changes) {
 /*
  * INTERNAL FUNCTION: update the mock data file
  */
-function updateMock(mockPath, configFile, changes) {
+function updateMock(mockPath, configFile, changes, replace) {
   // if the mock file does not exist - create it
   const mockFile = path.join(mockPath, `/${configFile}`);
   if (!fs.existsSync(mockFile)) {
@@ -109,7 +119,11 @@ function updateMock(mockPath, configFile, changes) {
   let mock = require(path.resolve(mockPath, configFile));
 
   // merge the changes into the mock file
-  mock = propUtil.mergeProperties(changes, mock);
+  if (replace === true) {
+    mock = changes;
+  } else {
+    mock = propUtil.mergeProperties(changes, mock);
+  }
 
   fs.writeFileSync(mockFile, JSON.stringify(mock, null, 2));
   return null;
@@ -152,6 +166,9 @@ class AdapterBase extends EventEmitterCl {
     // Instantiate the EventEmitter super class
     super();
 
+    // IAP home directory injected by core when running the adapter within IAP
+    [, , , process.env.iap_home] = process.argv;
+
     try {
       // Capture the adapter id
       this.id = prongid;
@@ -227,7 +244,7 @@ class AdapterBase extends EventEmitterCl {
       this.allProps = this.propUtilInst.mergeProperties(properties, defProps);
 
       // validate the entity against the schema
-      const ajvInst = new AjvCl();
+      const ajvInst = new AjvCl({ strictSchema: false, allowUnionTypes: true });
       const validate = ajvInst.compile(propertiesSchema);
       const result = validate(this.allProps);
 
@@ -246,6 +263,7 @@ class AdapterBase extends EventEmitterCl {
       // properties that this code cares about
       this.healthcheckType = this.allProps.healthcheck.type;
       this.healthcheckInterval = this.allProps.healthcheck.frequency;
+      this.healthcheckQuery = this.allProps.healthcheck.query_object;
 
       // set the failover codes from properties
       if (this.allProps.request.failover_codes) {
@@ -274,129 +292,6 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
-  /**
-   * updateAdapterConfiguration is used to update any of the adapter configuration files. This
-   * allows customers to make changes to adapter configuration without having to be on the
-   * file system.
-   *
-   * @function updateAdapterConfiguration
-   * @param {string} configFile - the name of the file being updated (required)
-   * @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
-   * @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
-   * @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
-   * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
-   * @param {Callback} callback - The results of the call
-   */
-  updateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
-    const meth = 'adapterBase-updateAdapterConfiguration';
-    const origin = `${this.id}-${meth}`;
-    log.trace(origin);
-
-    // verify the parameters are valid
-    if (changes === undefined || changes === null || typeof changes !== 'object'
-        || Object.keys(changes).length === 0) {
-      const result = {
-        response: 'No configuration updates to make'
-      };
-      log.info(result.response);
-      return callback(result, null);
-    }
-    if (configFile === undefined || configFile === null || configFile === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['configFile'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // take action based on configFile being changed
-    if (configFile === 'package.json') {
-      const pres = updatePackage(changes);
-      if (pres) {
-        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${pres}`, [], null, null, null);
-        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-        return callback(null, errorObj);
-      }
-      const result = {
-        response: 'Package updates completed - restarting adapter'
-      };
-      log.info(result.response);
-      forceFail(true);
-      return callback(result, null);
-    }
-    if (entity === undefined || entity === null || entity === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unsupported Configuration Change or Missing Entity', [], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // this means we are changing an entity file so type is required
-    if (type === undefined || type === null || type === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['type'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // if the entity does not exist - error
-    const epath = `${__dirname}/entities/${entity}`;
-    if (!fs.existsSync(epath)) {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Invalid Entity - ${entity}`, [], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-
-    // take action based on type of file being changed
-    if (type === 'action') {
-      // BACKUP???
-      const ares = updateAction(epath, action, changes);
-      if (ares) {
-        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
-        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-        return callback(null, errorObj);
-      }
-      // AJV CHECK???
-      // RESTORE IF NEEDED???
-      const result = {
-        response: `Action updates completed to entity: ${entity} - ${action}`
-      };
-      log.info(result.response);
-      return callback(result, null);
-    }
-    if (type === 'schema') {
-      const sres = updateSchema(epath, configFile, changes);
-      if (sres) {
-        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${sres}`, [], null, null, null);
-        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-        return callback(null, errorObj);
-      }
-      const result = {
-        response: `Schema updates completed to entity: ${entity} - ${configFile}`
-      };
-      log.info(result.response);
-      return callback(result, null);
-    }
-    if (type === 'mock') {
-      // if the mock directory does not exist - error
-      const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
-      if (!fs.existsSync(mpath)) {
-        fs.mkdirSync(mpath);
-      }
-
-      const mres = updateMock(mpath, configFile, changes);
-      if (mres) {
-        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
-        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-        return callback(null, errorObj);
-      }
-      const result = {
-        response: `Mock data updates completed to entity: ${entity} - ${configFile}`
-      };
-      log.info(result.response);
-      return callback(result, null);
-    }
-    const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
-    log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-    return callback(null, errorObj);
-  }
-
   /**
    * @summary Connect function is used during Pronghorn startup to provide instantiation feedback.
    *
@@ -441,67 +336,6 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
-  /**
-   * @summary Suspends the adapter
-   * @param {Callback} callback - The adapater suspension status
-   * @function suspend
-   */
-  suspend(mode, callback) {
-    const origin = `${this.id}-adapterBase-suspend`;
-    if (this.suspended) {
-      throw new Error(`${origin}: Adapter is already suspended`);
-    }
-    try {
-      this.suspended = true;
-      this.suspendMode = mode;
-      if (this.suspendMode === 'pause') {
-        const props = JSON.parse(JSON.stringify(this.initProps));
-        // To suspend adapter, enable throttling and set concurrent max to 0
-        props.throttle.throttle_enabled = true;
-        props.throttle.concurrent_max = 0;
-        this.refreshProperties(props);
-      }
-      return callback({ suspended: true });
-    } catch (error) {
-      return callback(null, error);
-    }
-  }
-
-  /**
-   * @summary Unsuspends the adapter
-   * @param {Callback} callback - The adapater suspension status
-   *
-   * @function unsuspend
-   */
-  unsuspend(callback) {
-    const origin = `${this.id}-adapterBase-unsuspend`;
-    if (!this.suspended) {
-      throw new Error(`${origin}: Adapter is not suspended`);
-    }
-    if (this.suspendMode === 'pause') {
-      const props = JSON.parse(JSON.stringify(this.initProps));
-      // To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
-      props.throttle.throttle_enabled = true;
-      props.throttle.concurrent_max = 1;
-      this.refreshProperties(props);
-      setTimeout(() => {
-        this.getQueue((q, error) => {
-          // console.log("Items in queue: " + String(q.length))
-          if (q.length === 0) {
-            // if queue is empty, return to initial properties state
-            this.refreshProperties(this.initProps);
-            this.suspended = false;
-            return callback({ suspended: false });
-          }
-          // recursive call to check queue again every second
-          return this.unsuspend(callback);
-        });
-      }, 1000);
-    } else {
-      this.suspended = false;
-    }
-  }
-
   /**
    * @summary HealthCheck function is used to provide Pronghorn the status of this adapter.
    *
@@ -511,8 +345,22 @@ class AdapterBase extends EventEmitterCl {
     const origin = `${this.id}-adapterBase-healthCheck`;
     log.trace(origin);
 
+    // if there is healthcheck query_object property, it needs to be added to the adapter
+    let myRequest = reqObj;
+    if (this.healthcheckQuery && Object.keys(this.healthcheckQuery).length > 0) {
+      if (myRequest && myRequest.uriQuery) {
+        myRequest.uriQuery = { ...myRequest.uriQuery, ...this.healthcheckQuery };
+      } else if (myRequest) {
+        myRequest.uriQuery = this.healthcheckQuery;
+      } else {
+        myRequest = {
+          uriQuery: this.healthcheckQuery
+        };
+      }
+    }
+
     // call to the healthcheck in connector
-    return this.requestHandlerInst.identifyHealthcheck(reqObj, (res, error) => {
+    return this.requestHandlerInst.identifyHealthcheck(myRequest, (res, error) => {
       // unhealthy
       if (error) {
         // if we were healthy, toggle health
@@ -520,9 +368,15 @@ class AdapterBase extends EventEmitterCl {
           this.emit('OFFLINE', { id: this.id });
           this.emit('DEGRADED', { id: this.id });
           this.healthy = false;
-          log.error(`${origin}: HEALTH CHECK - Error ${error}`);
-        } else {
+          if (typeof error === 'object') {
+            log.error(`${origin}: HEALTH CHECK - Error ${JSON.stringify(error)}`);
+          } else {
+            log.error(`${origin}: HEALTH CHECK - Error ${error}`);
+          }
+        } else if (typeof error === 'object') {
           // still log but set the level to trace
+          log.trace(`${origin}: HEALTH CHECK - Still Errors ${JSON.stringify(error)}`);
+        } else {
           log.trace(`${origin}: HEALTH CHECK - Still Errors ${error}`);
         }
 
@@ -569,24 +423,22 @@ class AdapterBase extends EventEmitterCl {
   }
 
   /**
-   * getWorkflowFunctions is used to get all of the workflow function in the adapter
+   * iapGetAdapterWorkflowFunctions is used to get all of the workflow function in the adapter
    * @param {array} ignoreThese - additional methods to ignore (optional)
    *
-   * @function getWorkflowFunctions
+   * @function iapGetAdapterWorkflowFunctions
    */
-  getWorkflowFunctions(ignoreThese) {
+  iapGetAdapterWorkflowFunctions(ignoreThese) {
     const myfunctions = this.getAllFunctions();
     const wffunctions = [];
 
     // remove the functions that should not be in a Workflow
     for (let m = 0; m < myfunctions.length; m += 1) {
-      if (myfunctions[m] === 'addEntityCache') {
+      if (myfunctions[m] === 'checkActionFiles') {
         // got to the second tier (adapterBase)
         break;
       }
-      if (myfunctions[m] !== 'hasEntity' && myfunctions[m] !== 'verifyCapability' && myfunctions[m] !== 'updateEntityCache'
-          && myfunctions[m] !== 'healthCheck' && myfunctions[m] !== 'getWorkflowFunctions'
-          && !(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
+      if (!(myfunctions[m].endsWith('Emit') || myfunctions[m].match(/Emit__v[0-9]+/))) {
         let found = false;
         if (ignoreThese && Array.isArray(ignoreThese)) {
           for (let i = 0; i < ignoreThese.length; i += 1) {
@@ -639,19 +491,6 @@ class AdapterBase extends EventEmitterCl {
     }
   }
 
-  /**
-   * getQueue is used to get information for all of the requests currently in the queue.
-   *
-   * @function getQueue
-   * @param {Callback} callback - a callback function to return the result (Queue) or the error
-   */
-  getQueue(callback) {
-    const origin = `${this.id}-adapterBase-getQueue`;
-    log.trace(origin);
-
-    return this.requestHandlerInst.getQueue(callback);
-  }
-
   /**
    * @summary Takes in property text and an encoding/encryption and returns the resulting
    * encoded/encrypted string
@@ -673,89 +512,330 @@ class AdapterBase extends EventEmitterCl {
   }
 
   /**
-   * @summary take the entities and add them to the cache
-   *
-   * @function addEntityCache
-   * @param {String} entityType - the type of the entities
-   * @param {Array} data - the list of entities
-   * @param {String} key - unique key for the entities
+   * iapUpdateAdapterConfiguration is used to update any of the adapter configuration files. This
+   * allows customers to make changes to adapter configuration without having to be on the
+   * file system.
    *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
+   * @function iapUpdateAdapterConfiguration
+   * @param {string} configFile - the name of the file being updated (required)
+   * @param {Object} changes - an object containing all of the changes = formatted like the configuration file (required)
+   * @param {string} entity - the entity to be changed, if an action, schema or mock data file (optional)
+   * @param {string} type - the type of entity file to change, (action, schema, mock) (optional)
+   * @param {string} action - the action to be changed, if an action, schema or mock data file (optional)
+   * @param {boolean} replace - true to replace entire mock data, false to merge/append (optional)
+   * @param {Callback} callback - The results of the call
    */
-  addEntityCache(entityType, entities, key, callback) {
-    const meth = 'adapterBase-addEntityCache';
+  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, replace, callback) {
+    const meth = 'adapterBase-iapUpdateAdapterConfiguration';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // list containing the items to add to the cache
-    const entityIds = [];
-
-    if (entities && Object.hasOwnProperty.call(entities, 'response')
-        && Array.isArray(entities.response)) {
-      for (let e = 0; e < entities.response.length; e += 1) {
-        entityIds.push(entities.response[e][key]);
-      }
+    // verify the parameters are valid
+    if (changes === undefined || changes === null || typeof changes !== 'object'
+      || Object.keys(changes).length === 0) {
+      const result = {
+        response: 'No configuration updates to make'
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    if (configFile === undefined || configFile === null || configFile === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['configFile'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
     }
 
-    // add the entities to the cache
-    return this.requestHandlerInst.addEntityCache(entityType, entityIds, (loaded, error) => {
-      if (error) {
-        return callback(null, error);
-      }
-      if (!loaded) {
-        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Entity Cache Not Loading', [entityType], null, null, null);
+    // take action based on configFile being changed
+    if (configFile === 'package.json') {
+      const pres = updatePackage(changes);
+      if (pres) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${pres}`, [], null, null, null);
         log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
         return callback(null, errorObj);
       }
-
-      return callback(loaded);
-    });
-  }
-
-  /**
-   * @summary sees if the entity is in the entity list or not
-   *
-   * @function entityInList
-   * @param {String/Array} entityId - the specific entity we are looking for
-   * @param {Array} data - the list of entities
-   *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
-   */
-  entityInList(entityId, data) {
-    const origin = `${this.id}-adapterBase-entityInList`;
-    log.trace(origin);
-
-    // need to check on the entities that were passed in
-    if (Array.isArray(entityId)) {
-      const resEntity = [];
-
-      for (let e = 0; e < entityId.length; e += 1) {
-        if (data.includes(entityId[e])) {
-          resEntity.push(true);
-        } else {
-          resEntity.push(false);
-        }
-      }
-
-      return resEntity;
+      const result = {
+        response: 'Package updates completed - restarting adapter'
+      };
+      log.info(result.response);
+      forceFail(true);
+      return callback(result, null);
+    }
+    if (entity === undefined || entity === null || entity === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Unsupported Configuration Change or Missing Entity', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
     }
 
-    // does the entity list include the specific entity
-    return [data.includes(entityId)];
-  }
-
-  /**
-   * @summary runs troubleshoot scripts for adapter
+    // this means we are changing an entity file so type is required
+    if (type === undefined || type === null || type === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['type'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // if the entity does not exist - error
+    const epath = `${__dirname}/entities/${entity}`;
+    if (!fs.existsSync(epath)) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Invalid Entity - ${entity}`, [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    // take action based on type of file being changed
+    if (type === 'action') {
+      // BACKUP???
+      const ares = updateAction(epath, action, changes);
+      if (ares) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      // AJV CHECK???
+      // RESTORE IF NEEDED???
+      const result = {
+        response: `Action updates completed to entity: ${entity} - ${action}`
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    if (type === 'schema') {
+      const sres = updateSchema(epath, configFile, changes);
+      if (sres) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${sres}`, [], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      const result = {
+        response: `Schema updates completed to entity: ${entity} - ${configFile}`
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    if (type === 'mock') {
+      // if the mock directory does not exist - error
+      const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
+      if (!fs.existsSync(mpath)) {
+        fs.mkdirSync(mpath);
+      }
+      // this means we are changing a mock data file so replace is required
+      if (replace === undefined || replace === null || replace === '') {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['replace'], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      const mres = updateMock(mpath, configFile, changes, replace);
+
+      if (mres) {
+        const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
+        log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+        return callback(null, errorObj);
+      }
+      const result = {
+        response: `Mock data updates completed to entity: ${entity} - ${configFile}`
+      };
+      log.info(result.response);
+      return callback(result, null);
+    }
+    const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
+    log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+    return callback(null, errorObj);
+  }
+
+  /**
+   * @summary Suspends the adapter
+   * @param {Callback} callback - The adapater suspension status
+   * @function iapSuspendAdapter
+   */
+  iapSuspendAdapter(mode, callback) {
+    const origin = `${this.id}-adapterBase-iapSuspendAdapter`;
+    if (this.suspended) {
+      throw new Error(`${origin}: Adapter is already suspended`);
+    }
+    try {
+      this.suspended = true;
+      this.suspendMode = mode;
+      if (this.suspendMode === 'pause') {
+        const props = JSON.parse(JSON.stringify(this.initProps));
+        // To suspend adapter, enable throttling and set concurrent max to 0
+        props.throttle.throttle_enabled = true;
+        props.throttle.concurrent_max = 0;
+        this.refreshProperties(props);
+      }
+      return callback({ suspended: true });
+    } catch (error) {
+      return callback(null, error);
+    }
+  }
+
+  /**
+   * @summary Unsuspends the adapter
+   * @param {Callback} callback - The adapater suspension status
+   *
+   * @function iapUnsuspendAdapter
+   */
+  iapUnsuspendAdapter(callback) {
+    const origin = `${this.id}-adapterBase-iapUnsuspendAdapter`;
+    if (!this.suspended) {
+      throw new Error(`${origin}: Adapter is not suspended`);
+    }
+    if (this.suspendMode === 'pause') {
+      const props = JSON.parse(JSON.stringify(this.initProps));
+      // To unsuspend adapter, keep throttling enabled and begin processing queued requests in order
+      props.throttle.throttle_enabled = true;
+      props.throttle.concurrent_max = 1;
+      this.refreshProperties(props);
+      setTimeout(() => {
+        this.getQueue((q, error) => {
+          // console.log("Items in queue: " + String(q.length))
+          if (q.length === 0) {
+            // if queue is empty, return to initial properties state
+            this.refreshProperties(this.initProps);
+            this.suspended = false;
+            return callback({ suspended: false });
+          }
+          // recursive call to check queue again every second
+          return this.iapUnsuspendAdapter(callback);
+        });
+      }, 1000);
+    } else {
+      this.suspended = false;
+      callback({ suspend: false });
+    }
+  }
+
+  /**
+   * iapGetAdapterQueue is used to get information for all of the requests currently in the queue.
+   *
+   * @function iapGetAdapterQueue
+   * @param {Callback} callback - a callback function to return the result (Queue) or the error
+   */
+  iapGetAdapterQueue(callback) {
+    const origin = `${this.id}-adapterBase-iapGetAdapterQueue`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getQueue(callback);
+  }
+
+  /* ********************************************** */
+  /*                                                */
+  /*          EXPOSES ADAPTER SCRIPTS               */
+  /*                                                */
+  /* ********************************************** */
+  /**
+   * See if the API path provided is found in this adapter
+   *
+   * @function iapFindAdapterPath
+   * @param {string} apiPath - the api path to check on
+   * @param {Callback} callback - The results of the call
+   */
+  iapFindAdapterPath(apiPath, callback) {
+    const result = {
+      apiPath
+    };
+
+    // verify the path was provided
+    if (!apiPath) {
+      log.error('NO API PATH PROVIDED!');
+      result.found = false;
+      result.message = 'NO PATH PROVIDED!';
+      return callback(null, result);
+    }
+
+    if (typeof this.allProps.choosepath === 'string') {
+      choosepath = this.allProps.choosepath;
+    }
+
+    // make sure the entities directory exists
+    const entitydir = path.join(__dirname, 'entities');
+    if (!fs.statSync(entitydir).isDirectory()) {
+      log.error('Could not find the entities directory');
+      result.found = false;
+      result.message = 'Could not find the entities directory';
+      return callback(null, result);
+    }
+
+    const entities = fs.readdirSync(entitydir);
+    const fitems = [];
+
+    // need to go through each entity in the entities directory
+    for (let e = 0; e < entities.length; e += 1) {
+      // make sure the entity is a directory - do not care about extra files
+      // only entities (dir)
+      if (fs.statSync(`${entitydir}/${entities[e]}`).isDirectory()) {
+        // see if the action file exists in the entity
+        if (fs.existsSync(`${entitydir}/${entities[e]}/action.json`)) {
+          // Read the entity actions from the file system
+          const actions = require(`${entitydir}/${entities[e]}/action.json`);
+
+          // go through all of the actions set the appropriate info in the newActions
+          for (let a = 0; a < actions.actions.length; a += 1) {
+            if (actions.actions[a].entitypath && typeof actions.actions[a].entitypath === 'object') {
+              const entityKeys = Object.keys(actions.actions[a].entitypath);
+              if (entityKeys.length > 0) {
+                for (let entityKey = 0; entityKey < entityKeys.length; entityKey += 1) {
+                  if (choosepath && entityKeys[entityKey] === choosepath && actions.actions[a].entitypath[entityKeys[entityKey]].indexOf(apiPath) >= 0) {
+                    log.info(`  Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
+                    log.info(`          method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath[entityKeys[entityKey]]}`);
+                    const fitem = {
+                      entity: entities[e],
+                      action: actions.actions[a].name,
+                      method: actions.actions[a].method,
+                      path: actions.actions[a].entitypath[entityKeys[entityKey]]
+                    };
+                    fitems.push(fitem);
+                    break;
+                  }
+                }
+              }
+            } else if (actions.actions[a].entitypath.indexOf(apiPath) >= 0) {
+              log.info(`  Found - entity: ${entities[e]} action: ${actions.actions[a].name}`);
+              log.info(`          method: ${actions.actions[a].method} path: ${actions.actions[a].entitypath}`);
+              const fitem = {
+                entity: entities[e],
+                action: actions.actions[a].name,
+                method: actions.actions[a].method,
+                path: actions.actions[a].entitypath
+              };
+              fitems.push(fitem);
+            }
+          }
+        } else {
+          log.error(`Could not find entities ${entities[e]} action.json file`);
+          result.found = false;
+          result.message = `Could not find entities ${entities[e]} action.json file`;
+          return callback(null, result);
+        }
+      } else {
+        log.error(`Could not find entities ${entities[e]} directory`);
+        result.found = false;
+        result.message = `Could not find entities ${entities[e]} directory`;
+        return callback(null, result);
+      }
+    }
+
+    if (fitems.length === 0) {
+      log.info('PATH NOT FOUND!');
+      result.found = false;
+      result.message = 'API PATH NOT FOUND!';
+      return callback(null, result);
+    }
+
+    result.foundIn = fitems;
+    result.found = true;
+    result.message = 'API PATH FOUND!';
+    return callback(result, null);
+  }
+
+  /**
+   * @summary runs troubleshoot scripts for adapter
    *
-   * @function troubleshoot
+   * @function iapTroubleshootAdapter
    * @param {Object} props - the connection, healthcheck and authentication properties
    * @param {boolean} persistFlag - whether the adapter properties should be updated
    * @param {Adapter} adapter - adapter instance to troubleshoot
    * @param {Callback} callback - callback function to return troubleshoot results
    */
-  async troubleshoot(props, persistFlag, adapter, callback) {
+  async iapTroubleshootAdapter(props, persistFlag, adapter, callback) {
     try {
       const result = await troubleshootingAdapter.troubleshoot(props, false, persistFlag, adapter);
       if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.failCount === 0) {
@@ -770,17 +850,17 @@ class AdapterBase extends EventEmitterCl {
   /**
    * @summary runs healthcheck script for adapter
    *
-   * @function runHealthcheck
+   * @function iapRunAdapterHealthcheck
    * @param {Adapter} adapter - adapter instance to troubleshoot
    * @param {Callback} callback - callback function to return healthcheck status
    */
-  async runHealthcheck(adapter, callback) {
+  async iapRunAdapterHealthcheck(adapter, callback) {
     try {
       const result = await tbUtils.healthCheck(adapter);
       if (result) {
         return callback(result);
       }
-      return callback(null, result);
+      return callback(null, 'Healthcheck failed');
     } catch (error) {
       return callback(null, error);
     }
@@ -789,14 +869,13 @@ class AdapterBase extends EventEmitterCl {
   /**
    * @summary runs connectivity check script for adapter
    *
-   * @function runConnectivity
+   * @function iapRunAdapterConnectivity
    * @param {Adapter} adapter - adapter instance to troubleshoot
    * @param {Callback} callback - callback function to return connectivity status
    */
-  async runConnectivity(callback) {
+  async iapRunAdapterConnectivity(callback) {
     try {
-      const { serviceItem } = await troubleshootingAdapter.getAdapterConfig();
-      const { host } = serviceItem.properties.properties;
+      const { host } = this.allProps;
       const result = tbUtils.runConnectivity(host, false);
       if (result.failCount > 0) {
         return callback(null, result);
@@ -810,10 +889,10 @@ class AdapterBase extends EventEmitterCl {
   /**
    * @summary runs basicGet script for adapter
    *
-   * @function runBasicGet
+   * @function iapRunAdapterBasicGet
    * @param {Callback} callback - callback function to return basicGet result
    */
-  runBasicGet(callback) {
+  iapRunAdapterBasicGet(callback) {
     try {
       const result = tbUtils.runBasicGet(false);
       if (result.failCount > 0) {
@@ -826,79 +905,546 @@ class AdapterBase extends EventEmitterCl {
   }
 
   /**
-   * @summary prepare results for verify capability so they are true/false
+   * @summary moves entities to mongo database
    *
-   * @function capabilityResults
-   * @param {Array} results - the results from the capability check
+   * @function iapMoveAdapterEntitiesToDB
    *
-   * @param {Callback} callback - An array of whether the adapter can has the
-   *                              desired capability or an error
+   * @return {Callback} - containing the response from the mongo transaction
    */
-  capabilityResults(results, callback) {
-    const meth = 'adapterBase-capabilityResults';
+  async iapMoveAdapterEntitiesToDB(callback) {
+    const meth = 'adapterBase-iapMoveAdapterEntitiesToDB';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
-    let locResults = results;
 
-    if (locResults && locResults[0] === 'needupdate') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Entity Cache Not Loading', ['unknown'], null, null, null);
+    try {
+      const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id });
+      return callback(result, null);
+    } catch (err) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, err);
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      this.repeatCacheCount += 1;
-      return callback(null, errorObj);
+      return callback(null, err.message);
     }
+  }
 
-    // if an error occured, return the error
-    if (locResults && locResults[0] === 'error') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Error Verifying Entity Cache', null, null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
+  /**
+   * @function iapDeactivateTasks
+   *
+   * @param {Array} tasks - List of tasks to deactivate
+   * @param {Callback} callback
+   */
+  iapDeactivateTasks(tasks, callback) {
+    const meth = 'adapterBase-iapDeactivateTasks';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+    let data;
+    try {
+      data = taskMover.deactivateTasks(__dirname, tasks);
+    } catch (ex) {
+      taskMover.rollbackChanges(__dirname);
+      taskMover.deleteBackups(__dirname);
+      return callback(null, ex);
     }
+    taskMover.deleteBackups(__dirname);
+    return callback(data, null);
+  }
 
-    // go through the response and change to true/false
-    if (locResults) {
-      // if not an array, just convert the return
-      if (!Array.isArray(locResults)) {
-        if (locResults === 'found') {
-          locResults = [true];
-        } else {
-          locResults = [false];
-        }
-      } else {
-        const temp = [];
+  /**
+   * @function iapActivateTasks
+   *
+   * @param {Array} tasks - List of tasks to deactivate
+   * @param {Callback} callback
+   */
+  iapActivateTasks(tasks, callback) {
+    const meth = 'adapterBase-iapActivateTasks';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+    let data;
+    try {
+      data = taskMover.activateTasks(__dirname, tasks);
+    } catch (ex) {
+      taskMover.rollbackChanges(__dirname);
+      taskMover.deleteBackups(__dirname);
+      return callback(null, ex);
+    }
+    taskMover.deleteBackups(__dirname);
+    return callback(data, null);
+  }
 
-        // go through each element in the array to convert
-        for (let r = 0; r < locResults.length; r += 1) {
-          if (locResults[r] === 'found') {
-            temp.push(true);
-          } else {
-            temp.push(false);
-          }
-        }
-        locResults = temp;
+  /* ********************************************** */
+  /*                                                */
+  /*            EXPOSES CACHE CALLS                 */
+  /*                                                */
+  /* ********************************************** */
+  /**
+   * @summary Populate the cache for the given entities
+   *
+   * @function iapPopulateEntityCache
+   * @param {String/Array of Strings} entityType - the entity type(s) to populate
+   * @param {Callback} callback - whether the cache was updated or not for each entity type
+   * @returns return of the callback
+   */
+  iapPopulateEntityCache(entityTypes, callback) {
+    const origin = `${this.myid}-adapterBase-iapPopulateEntityCache`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.populateEntityCache(entityTypes, callback);
+  }
+
+  /**
+   * @summary Retrieves data from cache for specified entity type
+   *
+   * @function iapRetrieveEntitiesCache
+   * @param {String} entityType - entity of which to retrieve
+   * @param {Object} options - settings of which data to return and how to return it
+   * @param {Callback} callback - the data if it was retrieved
+   */
+  iapRetrieveEntitiesCache(entityType, options, callback) {
+    const origin = `${this.myid}-adapterBase-iapRetrieveEntitiesCache`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.retrieveEntitiesCache(entityType, options, callback);
+  }
+
+  /* ********************************************** */
+  /*                                                */
+  /*           EXPOSES BROKER CALLS                 */
+  /*                                                */
+  /* ********************************************** */
+  /**
+   * @summary Determines if this adapter supports any in a list of entities
+   *
+   * @function hasEntities
+   * @param {String} entityType - the entity type to check for
+   * @param {Array} entityList - the list of entities we are looking for
+   *
+   * @param {Callback} callback - A map where the entity is the key and the
+   *                              value is true or false
+   */
+  hasEntities(entityType, entityList, callback) {
+    const origin = `${this.id}-adapterBase-hasEntities`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.hasEntities(entityType, entityList, callback);
+  }
+
+  /**
+   * @summary Determines if this adapter supports any in a list of entities
+   *
+   * @function hasEntitiesAuth
+   * @param {String} entityType - the entity type to check for
+   * @param {Array} entityList - the list of entities we are looking for
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {Callback} callback - A map where the entity is the key and the
+   *                              value is true or false
+   */
+  hasEntitiesAuth(entityType, entityList, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-hasEntitiesAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.hasEntitiesAuth(entityType, entityList, callOptions, callback);
+  }
+
+  /**
+   * @summary Get Appliance that match the deviceName
+   *
+   * @function getDevice
+   * @param {String} deviceName - the deviceName to find (required)
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
+   */
+  getDevice(deviceName, callback) {
+    const origin = `${this.id}-adapterBase-getDevice`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDevice(deviceName, callback);
+  }
+
+  /**
+   * @summary Get Appliance that match the deviceName
+   *
+   * @function getDeviceAuth
+   * @param {String} deviceName - the deviceName to find (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliance) or the error
+   */
+  getDeviceAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDeviceAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDeviceAuth(deviceName, callOptions, callback);
+  }
+
+  /**
+   * @summary Get Appliances that match the filter
+   *
+   * @function getDevicesFiltered
+   * @param {Object} options - the data to use to filter the appliances (optional)
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
+   */
+  getDevicesFiltered(options, callback) {
+    const origin = `${this.id}-adapterBase-getDevicesFiltered`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDevicesFiltered(options, callback);
+  }
+
+  /**
+   * @summary Get Appliances that match the filter
+   *
+   * @function getDevicesFilteredAuth
+   * @param {Object} options - the data to use to filter the appliances (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - a callback function to return the result
+   *                                 (appliances) or the error
+   */
+  getDevicesFilteredAuth(options, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getDevicesFilteredAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getDevicesFilteredAuth(options, callOptions, callback);
+  }
+
+  /**
+   * @summary Gets the status for the provided appliance
+   *
+   * @function isAlive
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAlive) or the error
+   */
+  isAlive(deviceName, callback) {
+    const origin = `${this.id}-adapterBase-isAlive`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.isAlive(deviceName, callback);
+  }
+
+  /**
+   * @summary Gets the status for the provided appliance
+   *
+   * @function isAliveAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance isAliveAuth) or the error
+   */
+  isAliveAuth(deviceName, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-isAliveAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.isAliveAuth(deviceName, callOptions, callback);
+  }
+
+  /**
+   * @summary Gets a config for the provided Appliance
+   *
+   * @function getConfig
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {String} format - the desired format of the config. (optional)
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance config) or the error
+   */
+  getConfig(deviceName, format, callback) {
+    const origin = `${this.id}-adapterBase-getConfig`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getConfig(deviceName, format, callback);
+  }
+
+  /**
+   * @summary Gets a config for the provided Appliance
+   *
+   * @function getConfigAuth
+   * @param {String} deviceName - the deviceName of the appliance. (required)
+   * @param {String} format - the desired format of the config. (optional)
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {configCallback} callback - callback function to return the result
+   *                                    (appliance config) or the error
+   */
+  getConfigAuth(deviceName, format, callOptions, callback) {
+    const origin = `${this.id}-adapterBase-getConfigAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.getConfigAuth(deviceName, format, callOptions, callback);
+  }
+
+  /**
+   * @summary Gets the device count from the system
+   *
+   * @function iapGetDeviceCount
+   *
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
+   */
+  iapGetDeviceCount(callback) {
+    const origin = `${this.id}-adapterBase-iapGetDeviceCount`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.iapGetDeviceCount(callback);
+  }
+
+  /**
+   * @summary Gets the device count from the system
+   *
+   * @function iapGetDeviceCountAuth
+   * @param {Object} callOptions - Additional options used to make request, including auth headers, AWS service, or datatypes
+   *
+   * @param {getCallback} callback - callback function to return the result
+   *                                    (count) or the error
+   */
+  iapGetDeviceCountAuth(callOptions, callback) {
+    const origin = `${this.id}-adapterBase-iapGetDeviceCountAuth`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.iapGetDeviceCountAuth(callOptions, callback);
+  }
+
+  /* ********************************************** */
+  /*                                                */
+  /*          EXPOSES GENERIC HANDLER               */
+  /*                                                */
+  /* ********************************************** */
+  /**
+   * Makes the requested generic call
+   *
+   * @function iapExpandedGenericAdapterRequest
+   * @param {Object} metadata - metadata for the call (optional).
+   *                 Can be a stringified Object.
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (optional)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (optional)
+   * @param {Object} pathVars - the parameters to be put within the url path (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback) {
+    const origin = `${this.myid}-adapterBase-iapExpandedGenericAdapterRequest`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.expandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback);
+  }
+
+  /**
+   * Makes the requested generic call
+   *
+   * @function genericAdapterRequest
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const origin = `${this.myid}-adapterBase-genericAdapterRequest`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
+  }
+
+  /**
+   * Makes the requested generic call with no base path or version
+   *
+   * @function genericAdapterRequestNoBasePath
+   * @param {String} uriPath - the path of the api call - do not include the host, port, base path or version (required)
+   * @param {String} restMethod - the rest method (GET, POST, PUT, PATCH, DELETE) (required)
+   * @param {Object} queryData - the parameters to be put on the url (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} requestBody - the body to add to the request (optional).
+   *                 Can be a stringified Object.
+   * @param {Object} addlHeaders - additional headers to be put on the call (optional).
+   *                 Can be a stringified Object.
+   * @param {getCallback} callback - a callback function to return the result (Generics)
+   *                 or the error
+   */
+  genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) {
+    const origin = `${this.myid}-adapterBase-genericAdapterRequestNoBasePath`;
+    log.trace(origin);
+
+    return this.requestHandlerInst.genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback);
+  }
+
+  /* ********************************************** */
+  /*                                                */
+  /*          EXPOSES INVENTORY CALLS               */
+  /*                                                */
+  /* ********************************************** */
+  /**
+   * @summary run the adapter lint script to return the results.
+   *
+   * @function iapRunAdapterLint
+   *
+   * @return {Object} - containing the results of the lint call.
+   */
+  iapRunAdapterLint(callback) {
+    const meth = 'adapterBase-iapRunAdapterLint';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+    let command = null;
+
+    if (fs.existsSync('package.json')) {
+      const packageData = require('./package.json');
+
+      // check if 'test', 'test:unit', 'test:integration' exists in package.json file
+      if (!packageData.scripts || !packageData.scripts['lint:errors']) {
+        log.error('The required script does not exist in the package.json file');
+        return callback(null, 'The required script does not exist in the package.json file');
+      }
+
+      // execute 'npm run lint:errors' command
+      command = spawnSync('npm', ['run', 'lint:errors'], { cwd: __dirname, encoding: 'utf-8' });
+
+      // analyze and format the response
+      const result = {
+        status: 'SUCCESS'
+      };
+      if (command.status !== 0) {
+        result.status = 'FAILED';
+        result.output = command.stdout;
+      }
+      return callback(result);
+    }
+
+    log.error('Package Not Found');
+    return callback(null, 'Package Not Found');
+  }
+
+  /**
+   * @summary run the adapter test scripts (baseunit and unit) to return the results.
+   *    can not run integration as there can be implications with that.
+   *
+   * @function iapRunAdapterTests
+   *
+   * @return {Object} - containing the results of the baseunit and unit tests.
+   */
+  iapRunAdapterTests(callback) {
+    const meth = 'adapterBase-iapRunAdapterTests';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+    let basecommand = null;
+    let command = null;
+
+    if (fs.existsSync('package.json')) {
+      const packageData = require('./package.json');
+
+      // check if 'test', 'test:unit', 'test:integration' exists in package.json file
+      if (!packageData.scripts || !packageData.scripts['test:baseunit'] || !packageData.scripts['test:unit']) {
+        log.error('The required scripts do not exist in the package.json file');
+        return callback(null, 'The required scripts do not exist in the package.json file');
+      }
+
+      // run baseunit test
+      basecommand = spawnSync('npm', ['run', 'test:baseunit'], { cwd: __dirname, encoding: 'utf-8' });
+
+      // analyze and format the response to baseunit
+      const baseresult = {
+        status: 'SUCCESS'
+      };
+      if (basecommand.status !== 0) {
+        baseresult.status = 'FAILED';
+        baseresult.output = basecommand.stdout;
+      }
+
+      // run unit test
+      command = spawnSync('npm', ['run', 'test:unit'], { cwd: __dirname, encoding: 'utf-8' });
+
+      // analyze and format the response to unit
+      const unitresult = {
+        status: 'SUCCESS'
+      };
+      if (command.status !== 0) {
+        unitresult.status = 'FAILED';
+        unitresult.output = command.stdout;
       }
+
+      // format the response and return it
+      const result = {
+        base: baseresult,
+        unit: unitresult
+      };
+      return callback(result);
     }
 
-    // return the results
-    return callback(locResults);
+    log.error('Package Not Found');
+    return callback(null, 'Package Not Found');
   }
 
   /**
-   * @summary Provides a way for the adapter to tell north bound integrations
-   * all of the capabilities for the current adapter
+   * @summary provide inventory information abbout the adapter
    *
-   * @function getAllCapabilities
+   * @function iapGetAdapterInventory
    *
-   * @return {Array} - containing the entities and the actions available on each entity
+   * @return {Object} - containing the adapter inventory information
    */
-  getAllCapabilities() {
-    const origin = `${this.id}-adapterBase-getAllCapabilities`;
+  iapGetAdapterInventory(callback) {
+    const meth = 'adapterBase-iapGetAdapterInventory';
+    const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
-    // validate the capabilities for the adapter
     try {
-      return this.requestHandlerInst.getAllCapabilities();
-    } catch (e) {
-      return [];
+      // call to the adapter utils to get inventory
+      return this.requestHandlerInst.getAdapterInventory((res, error) => {
+        const adapterInv = res;
+
+        // get all of the tasks
+        const allTasks = this.getAllFunctions();
+        adapterInv.totalTasks = allTasks.length;
+
+        // get all of the possible workflow tasks
+        const myIgnore = [
+          'healthCheck',
+          'iapGetAdapterWorkflowFunctions',
+          'hasEntities'
+        ];
+        adapterInv.totalWorkflowTasks = this.iapGetAdapterWorkflowFunctions(myIgnore).length;
+
+        // TODO: CACHE
+        // CONFIRM CACHE
+        // GET CACHE ENTITIES
+
+        // get the Device Count
+        return this.iapGetDeviceCount((devres, deverror) => {
+          // if call failed assume not broker integrated
+          if (deverror) {
+            adapterInv.brokerDefined = false;
+            adapterInv.deviceCount = -1;
+          } else {
+            // broker confirmed
+            adapterInv.brokerDefined = true;
+            adapterInv.deviceCount = 0;
+            if (devres && devres.count) {
+              adapterInv.deviceCount = devres.count;
+            }
+          }
+
+          return callback(adapterInv);
+        });
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
     }
   }
 }