@itentialopensource/adapter-viptela 0.12.0 → 0.12.2

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.12.2 [09-11-2023]
+
+* more migration & metadata changes
+
+See merge request itentialopensource/adapters/sd-wan/adapter-viptela!33
+
+---
+
+## 0.12.1 [09-11-2023]
+
+* Revert "More migration changes"
+
+See merge request itentialopensource/adapters/sd-wan/adapter-viptela!32
+
+---
+
 ## 0.12.0 [08-16-2023]
 
 * migration changes

package/README.md

@@ -14,6 +14,7 @@ Some of the page links in this document and links to other GitLab files do not w
   - [Testing](#testing)
 - [Configuration](./PROPERTIES.md)
 - [Using this Adapter](./CALLS.md)
+  - [Authentication](./AUTH.md)
 - [Additional Information](#additional-information)
   - [Enhancements](./ENHANCE.md)
   - [Contributing](./CONTRIBUTING.md)
@@ -47,17 +48,20 @@ These instructions will help you get a copy of the project on your local machine
 
 ### Helpful Background Information
 
-There is adapter documentation available on the Itential Developer Site <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">HERE</a>. This documentation includes information and examples that are helpful for:
+There is <a href="https://docs.itential.com/opensource/docs/adapters" target="_blank">Adapter documentation available on the Itential Documentation Site</a>. This documentation includes information and examples that are helpful for:
 
 ```text
 Authentication
-Properties
+IAP Service Instance Configuration
 Code Files
-Action Files
-Schema Files
-Mock Data Files
+Endpoint Configuration (Action & Schema)
+Mock Data
+Adapter Generic Methods
+Headers
+Security
 Linting and Testing
-Troubleshooting
+Build an Adapter
+Troubleshooting an Adapter
 ```
 
 Others will be added over time.

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

@@ -1,5 +1,6 @@
 {
   "name": "adapter-viptela",
+  "webName": "Adapter for Integration to Cisco Viptela",
   "vendor": "Cisco",
   "product": "Viptela",
   "osVersion": [
@@ -12,14 +13,19 @@
     "2022.1.x",
     "2023.1.x"
   ],
-  "method": "REST API",
+  "method": "REST",
   "type": "Adapter",
-  "example": "",
   "domains": [
     "Inventory",
-    "SD-WAN/SASE"
+    "SD-WAN (SASE)"
+  ],
+  "tags": [
+    "Configuration Management"
+  ],
+  "useCases": [
+    "Device Onboarding",
+    "Reboot Device"
   ],
-  "tags": [],
   "deprecated": {
     "isDeprecated": false
   },
@@ -29,6 +35,10 @@
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-viptela",
     "repoLink": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-viptela",
     "docLink": "https://docs.itential.com/opensource/docs/cisco-viptela",
+    "demoLinks": [
+      "https://www.itential.com/industries/communications-service-providers/sdwan-network-automation/",
+      "https://www.itential.com/solutions/sdwan-automation-orchestration/"
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
@@ -39,12 +49,13 @@
       "https://developer.cisco.com/docs/sdwan/#!sd-wan-vmanage-v20-12"
     ]
   },
+  "assets": [],
   "relatedItems": {
     "adapters": [],
     "integrations": [],
     "ecosystemApplications": [],
-    "automations": [],
-    "transformations": [],
-    "useCases": []
+    "workflowProjects": [],
+    "transformationProjects": [],
+    "exampleProjects": []
   }
 }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-viptela",
-  "version": "0.12.0",
+  "version": "0.12.2",
   "description": "This adapter integrates with system Viptela",
   "main": "adapter.js",
   "systemName": "Viptela",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.0",
+  "engineVersion": "1.67.8",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,12 +54,12 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/sd-wan/adapter-viptela#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": "0.10.8",
-  "configLines": 21480,
+  "version": "0.12.1",
+  "configLines": 21544,
   "scriptLines": 1783,
-  "codeLines": 45518,
-  "testLines": 28249,
+  "codeLines": 45621,
+  "testLines": 28255,
   "testCases": 1486,
-  "totalCodeLines": 75550,
+  "totalCodeLines": 75659,
   "wfTasks": 589
 }

package/report/updateReport1694453336318.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": 12106
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 854
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 14897
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 562
+    },
+    {
+      "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": 28456
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1416
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -144,6 +144,12 @@
         {
           "path": "/device",
           "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
           "query": {},
           "body": {},
           "headers": {},
@@ -221,6 +227,12 @@
             {
               "path": "/device",
               "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] Viptela 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,10 @@ describe('[unit] Viptela Adapter Test', () => {
         try {
           const metadataDotJson = require('../../metadata.json');
           assert.equal('adapter-viptela', metadataDotJson.name);
+          assert.notEqual(undefined, metadataDotJson.webName);
+          assert.notEqual(null, metadataDotJson.webName);
+          assert.notEqual('', metadataDotJson.webName);
+          assert.equal('Adapter', metadataDotJson.type);
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1480,9 +1486,9 @@ describe('[unit] Viptela Adapter Test', () => {
           assert.notEqual(undefined, metadataDotJson.relatedItems.adapters);
           assert.notEqual(undefined, metadataDotJson.relatedItems.integrations);
           assert.notEqual(undefined, metadataDotJson.relatedItems.ecosystemApplications);
-          assert.notEqual(undefined, metadataDotJson.relatedItems.automations);
-          assert.notEqual(undefined, metadataDotJson.relatedItems.transformations);
-          assert.notEqual(undefined, metadataDotJson.relatedItems.useCases);
+          assert.notEqual(undefined, metadataDotJson.relatedItems.workflowProjects);
+          assert.notEqual(undefined, metadataDotJson.relatedItems.transformationProjects);
+          assert.notEqual(undefined, metadataDotJson.relatedItems.exampleProjects);
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);