@itentialopensource/adapter-meraki 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 1.0.2 [05-10-2023]
+
+* Migrate adapter base to have broker changes
+
+See merge request itentialopensource/adapters/sd-wan/adapter-meraki!25
+
+---
+
 ## 1.0.1 [04-04-2023]
 
 * Utils version has been updated in package.json, and the changes are being migrated to the adapter

package/adapterBase.js

@@ -17,6 +17,8 @@ const jsonQuery = require('json-query');
 const EventEmitterCl = require('events').EventEmitter;
 const { execSync } = require('child_process');
 
+const sampleProperties = require(`${__dirname}/sampleProperties.json`).properties;
+
 /* The schema validator */
 const AjvCl = require('ajv');
 
@@ -24,11 +26,14 @@ const AjvCl = require('ajv');
 const PropUtilCl = require('@itentialopensource/adapter-utils').PropertyUtility;
 const RequestHandlerCl = require('@itentialopensource/adapter-utils').RequestHandler;
 
+const TransUtilCl = require(path.join(__dirname, 'node_modules/@itentialopensource/adapter-utils/lib/translatorUtil.js'));
+
 const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
 const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
 const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
 
 let propUtil = null;
+let transUtil = null;
 let choosepath = null;
 
 /*
@@ -102,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)) {
@@ -114,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;
@@ -167,6 +176,28 @@ function getDataFromSources(loopField, sources) {
   return fieldValue;
 }
 
+/*
+ * INTERNAL FUNCTION: update allprops device broker array with service config and sample props
+ */
+function getDeviceBrokerArray(sampleProps, allProps) {
+  const brokerCallsArr = ['getDevice', 'getDevicesFiltered', 'isAlive', 'getConfig', 'getCount'];
+  const deviceBroker = allProps.devicebroker;
+  for (let i = 0; i < brokerCallsArr.length; i += 1) {
+    if (!allProps.devicebroker || !allProps.devicebroker[brokerCallsArr[i]] || allProps.devicebroker[brokerCallsArr[i]].length === 0 || !allProps.devicebroker[brokerCallsArr[i]][0].path) {
+      // if not in service config check sample props
+      if (!sampleProps.devicebroker || !sampleProps.devicebroker[brokerCallsArr[i]] || sampleProps.devicebroker[brokerCallsArr[i]].length === 0 || !sampleProps.devicebroker[brokerCallsArr[i]][0].path) {
+        deviceBroker[brokerCallsArr[i]] = [];
+      } else {
+        log.info('Updating device broker with sample props');
+        deviceBroker[brokerCallsArr[i]] = sampleProps.devicebroker[brokerCallsArr[i]];
+      }
+    }
+  }
+
+  log.info('Device broker array', JSON.stringify(deviceBroker, null, 3));
+  return deviceBroker;
+}
+
 /* GENERAL ADAPTER FUNCTIONS THESE SHOULD NOT BE DIRECTLY MODIFIED */
 /* IF YOU NEED MODIFICATIONS, REDEFINE THEM IN adapter.js!!! */
 class AdapterBase extends EventEmitterCl {
@@ -186,6 +217,10 @@ class AdapterBase extends EventEmitterCl {
       this.id = prongid;
       this.propUtilInst = new PropUtilCl(prongid, __dirname);
       propUtil = this.propUtilInst;
+      this.transUtilInst = new TransUtilCl(prongid, this.propUtilInst);
+      transUtil = this.transUtilInst;
+      this.transUtilInst = new TransUtilCl(prongid, this.propUtilInst);
+      transUtil = this.transUtilInst;
       this.initProps = properties;
       this.alive = false;
       this.healthy = false;
@@ -198,6 +233,8 @@ class AdapterBase extends EventEmitterCl {
 
       // set up the properties I care about
       this.refreshProperties(properties);
+      // update deviceBroker based on service config and sample props
+      this.allProps.devicebroker = getDeviceBrokerArray(sampleProperties, this.allProps);
 
       // Instantiate the other components for this Adapter
       this.requestHandlerInst = new RequestHandlerCl(this.id, this.allProps, __dirname);
@@ -380,9 +417,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}`);
         }
 
@@ -528,16 +571,17 @@ class AdapterBase extends EventEmitterCl {
    * @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
    */
-  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) {
+  iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, replace, callback) {
     const meth = 'adapterBase-iapUpdateAdapterConfiguration';
     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) {
+      || Object.keys(changes).length === 0) {
       const result = {
         response: 'No configuration updates to make'
       };
@@ -622,8 +666,14 @@ class AdapterBase extends EventEmitterCl {
       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);
 
-      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}`);
@@ -854,7 +904,7 @@ class AdapterBase extends EventEmitterCl {
       if (result) {
         return callback(result);
       }
-      return callback(null, result);
+      return callback(null, 'Healthcheck failed');
     } catch (error) {
       return callback(null, error);
     }
@@ -869,8 +919,7 @@ class AdapterBase extends EventEmitterCl {
    */
   async iapRunAdapterConnectivity(callback) {
     try {
-      const { serviceItem } = await tbUtils.getAdapterConfig();
-      const { host } = serviceItem.properties.properties;
+      const { host } = this.allProps;
       const result = tbUtils.runConnectivity(host, false);
       if (result.failCount > 0) {
         return callback(null, result);
@@ -941,7 +990,7 @@ class AdapterBase extends EventEmitterCl {
     const entityIds = [];
 
     if (entities && Object.hasOwnProperty.call(entities, 'response')
-        && Array.isArray(entities.response)) {
+      && Array.isArray(entities.response)) {
       for (let e = 0; e < entities.response.length; e += 1) {
         entityIds.push(entities.response[e][key]);
       }
@@ -1178,75 +1227,73 @@ class AdapterBase extends EventEmitterCl {
         uriMethod = callProps.method;
       }
       if (callProps.query) {
-        callQuery = callProps.query;
-
+        callQuery = { ...callProps.query };
         // go through the query params to check for variable values
         const cpKeys = Object.keys(callQuery);
         for (let cp = 0; cp < cpKeys.length; cp += 1) {
-          if (callQuery[cpKeys[cp]].startsWith('{') && callQuery[cpKeys[cp]].endsWith('}')) {
-            // make any necessary changes to the query params
-            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
-              const rqKeys = Object.keys(callProps.requestFields);
-
-              // get the field from the provided device
-              for (let rq = 0; rq < rqKeys.length; rq += 1) {
-                if (cpKeys[cp] === rqKeys[rq]) {
-                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-                  // put the value into the query - if it has been specified in the query
-                  callQuery[cpKeys[cp]] = fieldValue;
-                }
+          // if (callQuery[cpKeys[cp]].startsWith('{') && callQuery[cpKeys[cp]].endsWith('}')) {
+          // make any necessary changes to the query params
+          if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
+            const rqKeys = Object.keys(callProps.requestFields);
+
+            // get the field from the provided device
+            for (let rq = 0; rq < rqKeys.length; rq += 1) {
+              if (callQuery[cpKeys[cp]] === rqKeys[rq]) {
+                const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
+                // put the value into the query - if it has been specified in the query
+                callQuery[cpKeys[cp]] = fieldValue;
               }
             }
           }
+          // }
         }
       }
       if (callProps.body) {
-        callBody = callProps.body;
+        callBody = { ...callProps.body };
 
         // go through the body fields to check for variable values
         const cbKeys = Object.keys(callBody);
         for (let cb = 0; cb < cbKeys.length; cb += 1) {
-          if (callBody[cbKeys[cb]].startsWith('{') && callBody[cbKeys[cb]].endsWith('}')) {
-            // make any necessary changes to the query params
-            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
-              const rqKeys = Object.keys(callProps.requestFields);
-
-              // get the field from the provided device
-              for (let rq = 0; rq < rqKeys.length; rq += 1) {
-                if (cbKeys[cb] === rqKeys[rq]) {
-                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-                  // put the value into the query - if it has been specified in the query
-                  callBody[cbKeys[cb]] = fieldValue;
-                }
+          // if (callBody[cbKeys[cb]].startsWith('{') && callBody[cbKeys[cb]].endsWith('}')) {
+          // make any necessary changes to the query params
+          if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
+            const rqKeys = Object.keys(callProps.requestFields);
+
+            // get the field from the provided device
+            for (let rq = 0; rq < rqKeys.length; rq += 1) {
+              if (callBody[cbKeys[cb]] === rqKeys[rq]) {
+                const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
+
+                // put the value into the query - if it has been specified in the query
+                callBody[cbKeys[cb]] = fieldValue;
               }
             }
           }
+          // }
         }
       }
       if (callProps.headers) {
-        callHeaders = callProps.headers;
+        callHeaders = { ...callProps.headers };
 
         // go through the body fields to check for variable values
         const chKeys = Object.keys(callHeaders);
         for (let ch = 0; ch < chKeys.length; ch += 1) {
-          if (callHeaders[chKeys[ch]].startsWith('{') && callHeaders[chKeys[ch]].endsWith('}')) {
-            // make any necessary changes to the query params
-            if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
-              const rqKeys = Object.keys(callProps.requestFields);
-
-              // get the field from the provided device
-              for (let rq = 0; rq < rqKeys.length; rq += 1) {
-                if (chKeys[ch] === rqKeys[rq]) {
-                  const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
-
-                  // put the value into the query - if it has been specified in the query
-                  callHeaders[chKeys[ch]] = fieldValue;
-                }
+          // if (callHeaders[chKeys[ch]].startsWith('{') && callHeaders[chKeys[ch]].endsWith('}')) {
+          // make any necessary changes to the query params
+          if (devResp !== null && callProps.requestFields && Object.keys(callProps.requestFields).length > 0) {
+            const rqKeys = Object.keys(callProps.requestFields);
+
+            // get the field from the provided device
+            for (let rq = 0; rq < rqKeys.length; rq += 1) {
+              if (callHeaders[chKeys[ch]] === rqKeys[rq]) {
+                const fieldValue = getDataFromSources(callProps.requestFields[rqKeys[rq]], devResp);
+
+                // put the value into the query - if it has been specified in the query
+                callHeaders[chKeys[ch]] = fieldValue;
               }
             }
           }
+          // }
         }
       }
       if (callProps.handleFailure) {
@@ -1445,7 +1492,7 @@ class AdapterBase extends EventEmitterCl {
           // Perform component calls here.
           callPromises.push(
             new Promise((resolve, reject) => {
-              this.iapMakeBrokerCall('getDevice', this.allProps.devicebroker.getDevice[i], [devs.list[0]], null, (callRet, callErr) => {
+              this.iapMakeBrokerCall('getDevice', this.allProps.devicebroker.getDevice[i], [devs.list[0]], [deviceName], (callRet, callErr) => {
                 // return an error
                 if (callErr) {
                   reject(callErr);
@@ -1726,7 +1773,13 @@ class AdapterBase extends EventEmitterCl {
         return Promise.all(callPromises).then((results) => {
           let myResult = {};
           results.forEach((result) => {
-            myResult = { ...myResult, ...result };
+            if (typeof result === 'string') {
+              myResult = { ...myResult, result };
+            } else if (Array.isArray(result)) {
+              myResult = result[0];
+            } else {
+              myResult = { ...myResult, ...result };
+            }
           });
 
           // return the result
@@ -1771,7 +1824,7 @@ class AdapterBase extends EventEmitterCl {
         // Perform component calls here.
         callPromises.push(
           new Promise((resolve, reject) => {
-            this.iapMakeBrokerCall('getCount', this.allProps.devicebroker.getCount[i], null, null, (callRet, callErr) => {
+            this.iapMakeBrokerCall('getCount', this.allProps.devicebroker.getCount[i], [{ fake: 'fakedata' }], null, (callRet, callErr) => {
               // return an error
               if (callErr) {
                 reject(callErr);
@@ -1792,7 +1845,7 @@ class AdapterBase extends EventEmitterCl {
         });
 
         // return the result
-        return callback({ count: myResult.length });
+        return callback({ count: Object.keys(myResult).length });
       });
     } catch (ex) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-meraki",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "This adapter integrates with system described as: merakiDashboardApi.",
   "main": "adapter.js",
   "systemName": "Meraki",

package/sampleProperties.json

@@ -107,9 +107,9 @@
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "networkID": "port",
-            "serial": "name",
-            "orgID": "orgID"
+            "networkID": "627126248111459727",
+            "serial": "Q4AB-J4J8-6BJR",
+            "orgID": "1076949"
           },
           "responseDatakey": "",
           "responseFields": {
@@ -130,7 +130,7 @@
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "orgID": "549236"
+            "orgID": "1076949"
           },
           "responseDatakey": "",
           "responseFields": {
@@ -139,27 +139,7 @@
             "ostypePrefix": "meraki-",
             "port": "networkId",
             "ipaddress": "mac",
-            "orgID": "549236"
-          }
-        },
-        {
-          "path": "/organizations/{orgID}/devices",
-          "method": "GET",
-          "query": {},
-          "body": {},
-          "headers": {},
-          "handleFailure": "ignore",
-          "requestFields": {
-            "orgID": "681155"
-          },
-          "responseDatakey": "",
-          "responseFields": {
-            "name": "serial",
-            "ostype": "model",
-            "ostypePrefix": "meraki-",
-            "port": "networkId",
-            "ipaddress": "mac",
-            "orgID": "681155"
+            "orgID": "1076949"
           }
         }
       ],
@@ -173,8 +153,8 @@
           "handleFailure": "ignore",
           "requestFields": {
             "networkID": "port",
-            "serial": "name",
-            "orgID": "orgID"
+            "serial": "Q4AB-J4J8-6BJR",
+            "orgID": "1076949"
           },
           "responseDatakey": "",
           "responseFields": {
@@ -193,8 +173,8 @@
           "handleFailure": "ignore",
           "requestFields": {
             "networkID": "port",
-            "serial": "name",
-            "orgID": "orgID"
+            "serial": "Q4AB-J4J8-6BJR",
+            "orgID": "1076949"
           },
           "responseDatakey": "",
           "responseFields": {}
@@ -202,24 +182,28 @@
       ],
       "getCount": [
         {
-          "path": "/organizations/549236/devices",
+          "path": "/organizations/{orgID}/devices",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
-          "requestFields": {},
+          "requestFields": {
+            "orgID": "1076949"
+          },
           "responseDatakey": "",
           "responseFields": {}
         },
         {
-          "path": "/organizations/681155/devices",
+          "path": "/organizations/{orgID}/devices",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
-          "requestFields": {},
+          "requestFields": {
+            "orgID": "1076949"
+          },
           "responseDatakey": "",
           "responseFields": {}
         }

package/test/unit/adapterBaseTestUnit.js

@@ -862,7 +862,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should return no updated if no changes are provided', (done) => {
         try {
-          a.iapUpdateAdapterConfiguration(null, null, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration(null, null, null, null, null, null, (data, error) => {
             try {
               assert.equal('No configuration updates to make', data.response);
               done();
@@ -878,7 +878,7 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('should throw an error if missing configuration file', (done) => {
         try {
-          a.iapUpdateAdapterConfiguration(null, { name: 'fakeChange' }, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration(null, { name: 'fakeChange' }, null, null, null, null, (data, error) => {
             try {
               const displayE = 'configFile is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
@@ -895,7 +895,7 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, entity is required', (done) => {
         try {
-          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, null, null, null, null, (data, error) => {
             try {
               const displayE = 'Unsupported Configuration Change or Missing Entity';
               runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
@@ -912,7 +912,7 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, type is required', (done) => {
         try {
-          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'entity', null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'entity', null, null, null, (data, error) => {
             try {
               const displayE = 'type is required';
               runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
@@ -929,7 +929,7 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, entity must be valid', (done) => {
         try {
-          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'fakeEntity', 'fakeType', null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'fakeEntity', 'fakeType', null, null, (data, error) => {
             try {
               const displayE = 'Incomplete Configuration Change: Invalid Entity - fakeEntity';
               runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);