@itentialopensource/adapter-servicenow 2.6.1 → 2.6.2

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 2.6.2 [09-11-2023]
+
+* more meta changes
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-servicenow!25
+
+---
+
 ## 2.6.1 [09-05-2023]
 
 * metadata changes

package/adapterBase.js

@@ -1027,6 +1027,24 @@ class AdapterBase extends EventEmitterCl {
     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
    *
@@ -1043,6 +1061,23 @@ class AdapterBase extends EventEmitterCl {
     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
    *
@@ -1059,6 +1094,23 @@ class AdapterBase extends EventEmitterCl {
     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
    *
@@ -1075,6 +1127,23 @@ class AdapterBase extends EventEmitterCl {
     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
    *
@@ -1092,6 +1161,24 @@ class AdapterBase extends EventEmitterCl {
     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
    *
@@ -1107,6 +1194,22 @@ class AdapterBase extends EventEmitterCl {
     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               */

package/metadata.json

@@ -32,14 +32,13 @@
   "type": "Adapter",
   "domains": [
     "Inventory",
-    "Discovery",
+    "Discovery & Topology",
     "ITSM"
   ],
   "tags": [
     "Change Management",
-    "ITSM",
     "Incidents",
-    "Request"
+    "Service Request"
   ],
   "useCases": [
     "Create Change Management Request",
@@ -98,6 +97,7 @@
         "name": "ServiceNow - Now Platform - REST",
         "webName": "Project with workflows for the Now Platform from ServiceNow",
         "overview": "Project with workflows for the Now Platform from ServiceNow",
+        "isDependency": false,
         "versions": [
           "^0.0.5"
         ],

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-servicenow",
-  "version": "2.6.1",
+  "version": "2.6.2",
   "description": "This adapter integrates with system described as: servicenowMadrid.",
   "main": "adapter.js",
   "systemName": "ServiceNow",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.5",
+  "engineVersion": "1.67.7",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -55,12 +55,12 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-servicenow#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.0",
+    "@itentialopensource/adapter-utils": "^5.1.7",
+    "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
-    "esprima": "^4.0.1",
     "fs-extra": "^11.1.1",
     "json-query": "^2.2.2",
     "mocha": "^10.2.0",

package/propertiesSchema.json

@@ -1063,6 +1063,38 @@
                 "description": "The method of the call to getDevicesFiltered",
                 "default": "GET"
               },
+              "pagination": {
+                "type": "object",
+                "description": "todo",
+                "properties": {
+                  "offsetVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines how to go to next set of results"
+                  },
+                  "limitVar": {
+                    "type": "string",
+                    "description": "Name of variable that defines the max results returned in a request"
+                  },
+                  "incrementBy": {
+                    "type": "string",
+                    "enum": [
+                      "limit",
+                      "page"
+                    ],
+                    "description": "How to incremenet offset. Default limit",
+                    "default": "limit"
+                  },
+                  "requestLocation": {
+                    "type": "string",
+                    "enum": [
+                      "query",
+                      "body"
+                    ],
+                    "description": "Where in request the pagination data goes",
+                    "default": "query"
+                  }
+                }
+              },
               "query": {
                 "type": "object",
                 "description": "The json object with query parameters of the call to getDevicesFiltered",
@@ -1487,6 +1519,38 @@
                       "description": "The method of the call to getDevice",
                       "default": "GET"
                     },
+                    "pagination": {
+                      "type": "object",
+                      "description": "todo",
+                      "properties": {
+                        "offsetVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines how to go to next set of results"
+                        },
+                        "limitVar": {
+                          "type": "string",
+                          "description": "Name of variable that defines the max results returned in a request"
+                        },
+                        "incrementBy": {
+                          "type": "string",
+                          "enum": [
+                            "limit",
+                            "page"
+                          ],
+                          "description": "How to incremenet offset. Default limit",
+                          "default": "limit"
+                        },
+                        "requestLocation": {
+                          "type": "string",
+                          "enum": [
+                            "query",
+                            "body"
+                          ],
+                          "description": "Where in request the pagination data goes",
+                          "default": "query"
+                        }
+                      }
+                    },
                     "query": {
                       "type": "object",
                       "description": "The json object with query parameters of the call to getDevice",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "2.6.0",
-  "configLines": 8328,
+  "version": "2.6.1",
+  "configLines": 8392,
   "scriptLines": 1783,
-  "codeLines": 12818,
-  "testLines": 11854,
+  "codeLines": 12921,
+  "testLines": 11859,
   "testCases": 613,
-  "totalCodeLines": 26455,
+  "totalCodeLines": 26563,
   "wfTasks": 165
 }

package/report/updateReport1694433477793.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.1.7"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 76
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 347
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 6378
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 395
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 4229
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 148
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 12060
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 543
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -142,6 +142,12 @@
         {
           "path": "/get/devices",
           "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
           "query": {},
           "body": {},
           "headers": {},
@@ -218,6 +224,12 @@
             {
               "path": "",
               "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
               "query": {},
               "body": {},
               "headers": {},

package/test/unit/adapterBaseTestUnit.js

@@ -391,12 +391,12 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should return a list of functions', (done) => {
         const returnedFunctions = ['checkActionFiles', 'checkProperties', 'connect', 'encryptProperty', 'genericAdapterRequest', 'genericAdapterRequestNoBasePath',
-          'getAllFunctions', 'getConfig', 'getDevice', 'getDevicesFiltered', 'hasEntities', 'healthCheck', 'iapActivateTasks', 'iapDeactivateTasks',
-          'iapExpandedGenericAdapterRequest', 'iapFindAdapterPath', 'iapGetAdapterInventory', 'iapGetAdapterQueue', 'iapGetAdapterWorkflowFunctions', 'iapGetDeviceCount',
-          'iapMoveAdapterEntitiesToDB', 'iapPopulateEntityCache', 'iapRetrieveEntitiesCache', 'iapRunAdapterBasicGet', 'iapRunAdapterConnectivity', 'iapRunAdapterHealthcheck',
-          'iapRunAdapterLint', 'iapRunAdapterTests', 'iapSuspendAdapter', 'iapTroubleshootAdapter', 'iapUnsuspendAdapter', 'iapUpdateAdapterConfiguration',
-          'isAlive', 'refreshProperties', 'addListener', 'emit', 'eventNames', 'getMaxListeners', 'listenerCount', 'listeners', 'off', 'on', 'once',
-          'prependListener', 'prependOnceListener', 'rawListeners', 'removeAllListeners', 'removeListener', 'setMaxListeners'];
+          'getAllFunctions', 'getConfig', 'getConfigAuth', 'getDevice', 'getDeviceAuth', 'getDevicesFiltered', 'getDevicesFilteredAuth', 'hasEntities', 'hasEntitiesAuth',
+          'healthCheck', 'iapActivateTasks', 'iapDeactivateTasks', 'iapExpandedGenericAdapterRequest', 'iapFindAdapterPath', 'iapGetAdapterInventory', 'iapGetAdapterQueue',
+          'iapGetAdapterWorkflowFunctions', 'iapGetDeviceCount', 'iapGetDeviceCountAuth', 'iapMoveAdapterEntitiesToDB', 'iapPopulateEntityCache', 'iapRetrieveEntitiesCache',
+          'iapRunAdapterBasicGet', 'iapRunAdapterConnectivity', 'iapRunAdapterHealthcheck', 'iapRunAdapterLint', 'iapRunAdapterTests', 'iapSuspendAdapter', 'iapTroubleshootAdapter',
+          'iapUnsuspendAdapter', 'iapUpdateAdapterConfiguration', 'isAlive', 'isAliveAuth', 'refreshProperties', 'addListener', 'emit', 'eventNames', 'getMaxListeners',
+          'listenerCount', 'listeners', 'off', 'on', 'once', 'prependListener', 'prependOnceListener', 'rawListeners', 'removeAllListeners', 'removeListener', 'setMaxListeners'];
         try {
           const expectedFunctions = a.getAllFunctions();
           try {

package/test/unit/adapterTestUnit.js

@@ -887,6 +887,8 @@ describe('[unit] Servicenow Adapter Test', () => {
           assert.notEqual(undefined, sampleDotJson.properties.devicebroker.isAlive);
           assert.notEqual(undefined, sampleDotJson.properties.devicebroker.getConfig);
           assert.notEqual(undefined, sampleDotJson.properties.devicebroker.getCount);
+          assert.notEqual(undefined, sampleDotJson.properties.cache);
+          assert.notEqual(undefined, sampleDotJson.properties.cache.entities);
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1453,6 +1455,9 @@ describe('[unit] Servicenow Adapter Test', () => {
         try {
           const metadataDotJson = require('../../metadata.json');
           assert.equal('adapter-servicenow', metadataDotJson.name);
+          assert.notEqual(undefined, metadataDotJson.webName);
+          assert.notEqual(null, metadataDotJson.webName);
+          assert.notEqual('', metadataDotJson.webName);
           assert.equal('Adapter', metadataDotJson.type);
           done();
         } catch (error) {

package/utils/methodDocumentor.js

@@ -3,7 +3,7 @@
 /* eslint no-param-reassign:warn */
 
 const fs = require('fs-extra');
-const esprima = require('esprima');
+const acorn = require('acorn');
 
 // Getting the base directory:
 let adaptdir = __dirname;
@@ -44,18 +44,38 @@ function getPathFromEntity(entity, funcName) {
     const actionJSON = require(entityPath);
     actionJSON.actions.forEach((action) => {
       if (action.name === funcName) {
-        epath = action.entitypath;
+        if (typeof action.entitypath === 'object') {
+          epath = '';
+          const keys = Object.keys(action.entitypath);
+          for (let k = 0; k < keys.length; k += 1) {
+            epath += `${keys[k]}:${action.entitypath[keys[k]]} <br /> `;
+          }
+          epath = epath.substring(0, epath.length - 8);
+        } else {
+          epath = action.entitypath;
+        }
       }
     });
   }
   return epath;
 }
 
+function recurseCallExpressions(statement, callList) {
+  // Recursively finds all CallExpressions in the syntax tree
+  if (statement.type === 'CallExpression') callList.push(statement);
+  const keys = Object.keys(statement);
+  for (let k = 0; k < keys.length; k += 1) {
+    if (typeof statement[keys[k]] === 'object' && statement[keys[k]] !== null) {
+      recurseCallExpressions(statement[keys[k]], callList);
+    }
+  }
+}
+
 function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
   // read the file
   const aFile = fs.readFileSync(filename, 'utf8');
   // parsing the file to get the function and class declarations.
-  const aFileFuncArgs = esprima.parseScript(aFile);
+  const aFileFuncArgs = acorn.parse(aFile, { ecmaVersion: 2020 });
 
   // Looping through all the declarations parsed:
   aFileFuncArgs.body.forEach((e) => {
@@ -76,25 +96,40 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         });
 
         // Getting the entity for the method:
-        let entity;
-        method.value.body.body.forEach((statementType) => {
-          if (statementType.type === 'TryStatement') {
-            entity = statementType.block.body[0].argument.arguments[0].value;
-          }
+        const callList = [];
+        method.value.body.body.forEach((statement) => {
+          recurseCallExpressions(statement, callList);
         });
-        const entityPath = getPathFromEntity(entity, funcName);
-
-        // Creating and storing the object for the method.
-        if (entityPath !== undefined) {
-          functionList.push(
-            createObjectForFunction(
-              funcName,
-              funcArgs,
-              entityPath,
-              descriptionObj[funcName],
-              workflowObj[funcName]
-            )
-          );
+        const requests = [];
+        for (let i = 0; i < callList.length; i += 1) {
+          if (callList[i].callee.property && callList[i].callee.property.name === 'identifyRequest') {
+            requests.push(callList[i]);
+          }
+        }
+        if (requests.length > 0) {
+          const expr = requests[0];
+          if (expr.arguments.length < 2) {
+            throw new Error(`Bad inputs in method ${funcName}`);
+          }
+          const entity = expr.arguments[0].value;
+          const actionName = expr.arguments[1].value;
+          if (expr !== undefined && (expr.arguments[0].type !== 'Literal' || expr.arguments[1].type !== 'Literal')) {
+            throw new Error(`Bad inputs in method ${funcName}`);
+          }
+          const entityPath = getPathFromEntity(entity, actionName);
+
+          // Creating and storing the object for the method.
+          if (entityPath !== undefined) {
+            functionList.push(
+              createObjectForFunction(
+                funcName,
+                funcArgs,
+                entityPath,
+                descriptionObj[funcName],
+                workflowObj[funcName]
+              )
+            );
+          }
         }
       });
     }
@@ -109,7 +144,7 @@ function readJSONFile(filename, descriptionObj, workflowObj) {
   methodArray.forEach((methodName) => {
     // Getting the method description and workflow:
     const funcName = methodName.name;
-    descriptionObj[funcName] = methodName.description;
+    descriptionObj[funcName] = methodName.summary ? methodName.summary : methodName.description;
     workflowObj[funcName] = methodName.task ? 'Yes' : 'No';
   });
 }