@itentialopensource/adapter-nokia_altiplano 0.5.1 → 0.5.2

package/BROKER.md

@@ -170,9 +170,11 @@ Below is an example of how you may set up the properties for this call.
 ```json
 "getDevice": [
   {
-    "path": "/{org}/get/devices/{id}",
+    "path": "/{org}/get/device",
     "method": "GET",
-    "query": {},
+    "query": {
+      "id": "{id}"
+    },
     "body": {},
     "headers": {},
     "handleFailure": "ignore",
@@ -192,4 +194,6 @@ Below is an example of how you may set up the properties for this call.
 ]
 ```
 
+In this example, we show a query parameter being used. Notice that the value is still provided via the requestFields and then like with the path, we use curly braces in the query to denote a variable. The body and header variables work in this same manner.
+
 You could have multiple calls here if needed but generally that will not be the case.

package/CHANGELOG.md

@@ -1,7 +1,15 @@
 
+## 0.5.2 [05-15-2022]
+
+* Migration to the latest Adapter Foundation
+
+See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!8
+
+---
+
 ## 0.5.1 [05-10-2022]
 
-* Fix issue with DeleteIbnIntent
+- Fix issue with DeleteIbnIntent
 
 See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!7
 
@@ -9,7 +17,7 @@ See merge request itentialopensource/adapters/controller-orchestrator/adapter-no
 
 ## 0.5.0 [05-02-2022]
 
-* Add calls for ema entity
+- Add calls for ema entity
 
 See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!6
 
@@ -17,7 +25,7 @@ See merge request itentialopensource/adapters/controller-orchestrator/adapter-no
 
 ## 0.4.0 [03-30-2022]
 
-* added ibn intent calls
+- added ibn intent calls
 
 See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!5
 
@@ -25,7 +33,7 @@ See merge request itentialopensource/adapters/controller-orchestrator/adapter-no
 
 ## 0.3.0 [03-25-2022]
 
-* add new call createOntWithQuery
+- add new call createOntWithQuery
 
 See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!4
 
@@ -33,7 +41,7 @@ See merge request itentialopensource/adapters/controller-orchestrator/adapter-no
 
 ## 0.2.0 [03-18-2022]
 
-* Migration and creation of md files
+- Migration and creation of md files
 
 See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!3
 
@@ -41,7 +49,7 @@ See merge request itentialopensource/adapters/controller-orchestrator/adapter-no
 
 ## 0.1.3 [10-24-2021]
 
-* Fix the registry url
+- Fix the registry url
 
 See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!2
 
@@ -49,7 +57,7 @@ See merge request itentialopensource/adapters/controller-orchestrator/adapter-no
 
 ## 0.1.2 [10-24-2021]
 
-* change paths and add headers
+- change paths and add headers
 
 See merge request itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano!1
 
@@ -57,7 +65,7 @@ See merge request itentialopensource/adapters/controller-orchestrator/adapter-no
 
 ## 0.1.1 [07-29-2021]
 
-* Bug fixes and performance improvements
+- Initial Commit
 
 See commit bff31d3
 

package/adapter.js

@@ -89,7 +89,8 @@ class NokiaAltiplano extends AdapterBaseCl {
       'iapHasAdapterEntity',
       'iapVerifyAdapterCapability',
       'iapUpdateAdapterEntityCache',
-      'hasEntities'
+      'hasEntities',
+      'getAuthorization'
     ];
     if (!inIgnore && Array.isArray(inIgnore)) {
       myIgnore = inIgnore;

package/adapterBase.js

@@ -13,6 +13,7 @@
 /* Required libraries.  */
 const fs = require('fs-extra');
 const path = require('path');
+const jsonQuery = require('json-query');
 const EventEmitterCl = require('events').EventEmitter;
 const { execSync } = require('child_process');
 
@@ -148,32 +149,15 @@ function updatePackage(changes) {
  * INTERNAL FUNCTION: get data from source(s) - nested
  */
 function getDataFromSources(loopField, sources) {
-  const loopArray = loopField.split('.');
   let fieldValue = loopField;
 
   // go through the sources to find the field
   for (let s = 0; s < sources.length; s += 1) {
-    let nestedValue = sources[s];
-    let found = false;
-
-    // loops through incase the field is nested
-    for (let i = 0; i < loopArray.length; i += 1) {
-      // if not nested finds it first pass - otherwise set to new level and loop
-      if (Object.hasOwnProperty.call(nestedValue, loopArray[i])) {
-        nestedValue = nestedValue[loopArray[i]];
-
-        // set found if we are at the leaf (going to stop looping)
-        if (i + 1 === loopArray.length) {
-          found = true;
-        }
-      } else {
-        // not found in source - check next one
-        break;
-      }
-    }
+    // find the field value using jsonquery
+    const nestedValue = jsonQuery(loopField, { data: sources[s] }).value;
 
     // if we found in source - set and no need to check other sources
-    if (found) {
+    if (nestedValue) {
       fieldValue = nestedValue;
       break;
     }
@@ -194,7 +178,7 @@ class AdapterBase extends EventEmitterCl {
     super();
 
     // IAP home directory injected by core when running the adapter within IAP
-    process.env.iap_home = process.argv[3];
+    [, , , process.env.iap_home] = process.argv;
 
     try {
       // Capture the adapter id
@@ -899,17 +883,18 @@ class AdapterBase extends EventEmitterCl {
    *
    * @return {Callback} - containing the response from the mongo transaction
    */
-  iapMoveAdapterEntitiesToDB(callback) {
+  async iapMoveAdapterEntitiesToDB(callback) {
     const meth = 'adapterBase-iapMoveAdapterEntitiesToDB';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
     try {
-      return callback(entitiesToDB.iapMoveAdapterEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id }), null);
+      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}`);
-      return callback(null, errorObj);
+      return callback(null, err.message);
     }
   }
 
@@ -1195,9 +1180,51 @@ class AdapterBase extends EventEmitterCl {
       }
       if (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 (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 (callProps.handleFailure) {
         handleFail = callProps.handleFailure;
@@ -1228,6 +1255,12 @@ class AdapterBase extends EventEmitterCl {
           return callback({}, null);
         }
 
+        // get the response piece we care about from the response
+        const myResult = result;
+        if (callProps.responseDatakey) {
+          myResult.response = jsonQuery(callProps.responseDatakey, { data: myResult.response }).value;
+        }
+
         // get the keys for the response fields
         let rfKeys = [];
         if (callProps.responseFields && Object.keys(callProps.responseFields).length > 0) {
@@ -1235,10 +1268,10 @@ class AdapterBase extends EventEmitterCl {
         }
 
         // if we got an array returned (e.g. getDevicesFitered)
-        if (Array.isArray(result.response)) {
+        if (Array.isArray(myResult.response)) {
           const listDevices = [];
-          for (let a = 0; a < result.response.length; a += 1) {
-            const thisDevice = result.response[a];
+          for (let a = 0; a < myResult.response.length; a += 1) {
+            const thisDevice = myResult.response[a];
             for (let rf = 0; rf < rfKeys.length; rf += 1) {
               if (rfKeys[rf] !== 'ostypePrefix') {
                 let fieldValue = getDataFromSources(callProps.responseFields[rfKeys[rf]], [thisDevice, devResp, callProps.requestFields]);
@@ -1250,7 +1283,7 @@ class AdapterBase extends EventEmitterCl {
                 // if there is a status to set, set it
                 if (rfKeys[rf] === 'status') {
                   // if really looking for just a good response
-                  if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && result.icode === statusValue.toString()) {
+                  if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
                     thisDevice.isAlive = true;
                   } else if (fieldValue.toString() === statusValue.toString()) {
                     thisDevice.isAlive = true;
@@ -1287,7 +1320,7 @@ class AdapterBase extends EventEmitterCl {
         }
 
         // if this is not an array - just about everything else, just handle as a single object
-        let thisDevice = result.response;
+        let thisDevice = myResult.response;
         for (let rf = 0; rf < rfKeys.length; rf += 1) {
           // skip ostypePrefix since it is not a field
           if (rfKeys[rf] !== 'ostypePrefix') {
@@ -1300,7 +1333,7 @@ class AdapterBase extends EventEmitterCl {
             // if there is a status to set, set it
             if (rfKeys[rf] === 'status') {
               // if really looking for just a good response
-              if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && result.icode === statusValue.toString()) {
+              if (callProps.responseFields[rfKeys[rf]] === 'return2xx' && myResult.icode === statusValue.toString()) {
                 thisDevice.isAlive = true;
               } else if (fieldValue.toString() === statusValue.toString()) {
                 thisDevice.isAlive = true;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-nokia_altiplano",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "This adapter integrates with system described as: Nokia Altiplano.",
   "main": "adapter.js",
   "systemName": "Nokia Altiplano",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.61.4",
+  "engineVersion": "1.61.6",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -55,11 +55,12 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/controller-orchestrator/adapter-nokia_altiplano#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.45.4",
+    "@itentialopensource/adapter-utils": "^4.45.5",
     "ajv": "^6.12.0",
     "axios": "^0.21.0",
     "commander": "^2.20.0",
     "fs-extra": "^8.1.0",
+    "json-query": "^2.2.2",
     "mocha": "^9.0.1",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.1.0",