@itentialopensource/adapter-alkira 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.1.5 [05-02-2023]
+
+* Migrate adapter base with broker changes
+
+See merge request itentialopensource/adapters/cloud/adapter-alkira!4
+
+---
+
+## 0.1.4 [04-12-2023]
+
+* Patch/fixed get config and get count in adapterBase.json
+
+See merge request itentialopensource/adapters/cloud/adapter-alkira!3
+
+---
+
 ## 0.1.3 [04-06-2023]
 
 * bug fix for getConfig and iapGetDeviceCount in adapterBase.js

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,15 @@ 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;
 
 /*
  * INTERNAL FUNCTION: force fail the adapter - generally done to cause restart
@@ -101,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)) {
@@ -113,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;
@@ -166,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 {
@@ -185,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;
@@ -197,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);
@@ -533,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'
       };
@@ -627,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}`);
@@ -665,6 +710,10 @@ class AdapterBase extends EventEmitterCl {
       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()) {
@@ -689,7 +738,25 @@ class AdapterBase extends EventEmitterCl {
 
           // 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.indexOf(apiPath) >= 0) {
+            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 = {
@@ -923,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]);
       }
@@ -1161,10 +1228,10 @@ class AdapterBase extends EventEmitterCl {
       }
       if (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);
@@ -1178,6 +1245,7 @@ class AdapterBase extends EventEmitterCl {
               }
             }
           }
+          // }
         }
       }
       if (callProps.body) {
@@ -1186,6 +1254,7 @@ class AdapterBase extends EventEmitterCl {
         // 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);
@@ -1200,6 +1269,7 @@ class AdapterBase extends EventEmitterCl {
               }
             }
           }
+          // }
         }
       }
       if (callProps.headers) {
@@ -1208,6 +1278,7 @@ class AdapterBase extends EventEmitterCl {
         // 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);
@@ -1222,6 +1293,7 @@ class AdapterBase extends EventEmitterCl {
               }
             }
           }
+          // }
         }
       }
       if (callProps.handleFailure) {
@@ -1240,7 +1312,6 @@ class AdapterBase extends EventEmitterCl {
         // if we received an error or their is no response on the results return an error
         if (error) {
           if (handleFail === 'fail') {
-            // IT IS CRASHING RIGHT BELOW HERE
             return callback(null, error);
           }
           return callback({}, null);
@@ -1529,7 +1600,6 @@ class AdapterBase extends EventEmitterCl {
         let myResult = [];
         results.forEach((result) => {
           if (Array.isArray(result)) {
-            // myResult = myResult.concat(result);
             myResult = [...myResult, ...result];
           } else if (Object.keys(result).length > 0) {
             myResult.push(result);
@@ -1686,7 +1756,7 @@ class AdapterBase extends EventEmitterCl {
           // Perform component calls here.
           callPromises.push(
             new Promise((resolve, reject) => {
-              this.iapMakeBrokerCall('getConfig', this.allProps.devicebroker.getConfig[i], [devs.list[0]], [deviceName], (callRet, callErr) => {
+              this.iapMakeBrokerCall('getConfig', this.allProps.devicebroker.getConfig[i], [devs.list[0]], null, (callRet, callErr) => {
                 // return an error
                 if (callErr) {
                   reject(callErr);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-alkira",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "This adapter integrates with system described as: alkiraApi.",
   "main": "adapter.js",
   "wizardVersion": "2.44.15",
@@ -53,7 +53,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-alkira#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.48.0",
+    "@itentialopensource/adapter-utils": "^4.48.13",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.1.2",
+  "version": "0.1.4",
   "configLines": 46212,
   "scriptLines": 1795,
-  "codeLines": 40907,
+  "codeLines": 40946,
   "testLines": 32660,
   "testCases": 1735,
-  "totalCodeLines": 75362,
+  "totalCodeLines": 75401,
   "wfTasks": 457
 }

package/sampleProperties.json

@@ -102,87 +102,91 @@
     "devicebroker": {
       "getDevice": [
         {
-          "path": "/get/devices/{id}",
+          "path": "/tenantnetworks/{tenantNetworkId}/connectors",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "tenantNetworkId": "port"
           },
-          "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "name",
+            "ostype": "type",
+            "ostypePrefix": "connector-",
+            "port": "tenantNetworkId",
+            "ip": "id",
+            "ipaddress": "id"
           }
         }
       ],
       "getDevicesFiltered": [
         {
-          "path": "/get/devices",
+          "path": "/tenantnetworks/{tenantNetworkId}/connectors",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
-          "requestFields": {},
-          "responseDatakey": "",
+          "requestFields": {
+            "tenantNetworkId": "170"
+          },
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "name",
+            "ostype": "type",
+            "ostypePrefix": "connector-",
+            "port": "tenantNetworkId",
+            "ip": "id",
+            "ipaddress": "id",
+            "connectorId": "id"
           }
         }
       ],
       "isAlive": [
         {
-          "path": "/get/devices/{id}/status",
+          "path": "/tenantnetworks/{tenantNetworkId}/health/connector/{connectorId}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
-          "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "tenantNetworkId": "port",
+            "connectorId": "connectorId"
           },
-          "responseDatakey": "",
+          "handleFailure": "ignore",
           "responseFields": {
-            "status": "status",
-            "statusValue": "online"
+            "status": "connectivityStatus",
+            "statusValue": "100"
           }
         }
       ],
       "getConfig": [
         {
-          "path": "/get/devices/{id}/configPart1",
+          "path": "/tenantnetworks/{tenantNetworkId}/connectors/{connectorId}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
-          "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "tenantNetworkId": "port",
+            "connectorId": "connectorId"
           },
-          "responseDatakey": "",
+          "handleFailure": "ignore",
           "responseFields": {}
         }
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/tenantnetworks/{tenantNetworkId}/connectors",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
+          "requestFields": {
+            "tenantNetworkId": "170"
+          },
           "handleFailure": "ignore",
-          "requestFields": {},
-          "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);