@itentialopensource/adapter-meraki 0.7.2 → 0.8.1

package/propertiesSchema.json

@@ -93,6 +93,9 @@
     },
     "mongo": {
       "$ref": "#/definitions/mongo"
+    },
+    "devicebroker": {
+      "$ref": "#/definitions/devicebroker"
     }
   },
   "required": [
@@ -232,6 +235,21 @@
           "type": "boolean",
           "description": "This property turns on logging of Authentication Information and should only be true when debugging authentication and connectivity",
           "default": false
+        },
+        "client_id": {
+          "type": "string",
+          "description": "The client id for OAuth requests - can also use username depending on schema",
+          "default": ""
+        },
+        "client_secret": {
+          "type": "string",
+          "description": "The client secret for OAuth requests - can also use password depending on schema",
+          "default": ""
+        },
+        "grant_type": {
+          "type": "string",
+          "description": "The grant type for OAuth requests - can also provide in schema",
+          "default": ""
         }
       },
       "required": [
@@ -820,6 +838,226 @@
           }
         }
       }
+    },
+    "devicebroker": {
+      "type": "object",
+      "properties": {
+        "getDevice": {
+          "type": "object",
+          "description": "Broker call to getDevice",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getDevice",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getDevice",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getDevice",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getDevice",
+              "default": "{}"
+            },
+            "name_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the name of the device",
+              "default": "name"
+            },
+            "ostype_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the ostype of the device",
+              "default": "ostype"
+            },
+            "ostypePrefix": {
+              "type": "string",
+              "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+              "default": ""
+            },
+            "port_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the port of the device",
+              "default": "port"
+            },
+            "ip_field": {
+              "type": "string",
+              "description": "The field in response to getDevice that contains the ip address of the device",
+              "default": "ipaddress"
+            }
+          }
+        },
+        "getDevicesFiltered": {
+          "type": "object",
+          "description": "Broker call to getDevicesFiltered",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getDevicesFiltered (e.g. /rest/api/devices)",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getDevicesFiltered",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getDevicesFiltered",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getDevicesFiltered",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getDevicesFiltered",
+              "default": "{}"
+            },
+            "name_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the name of the device",
+              "default": "name"
+            },
+            "ostype_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the ostype of the device",
+              "default": "ostype"
+            },
+            "ostypePrefix": {
+              "type": "string",
+              "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
+              "default": ""
+            },
+            "port_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the port of the device",
+              "default": "port"
+            },
+            "ip_field": {
+              "type": "string",
+              "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
+              "default": "ipaddress"
+            }
+          }
+        },
+        "isAlive": {
+          "type": "object",
+          "description": "Broker call to isAlive",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to isAlive (e.g. /rest/api/device/{deviceid})",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to isAlive",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to isAlive",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to isAlive",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to isAlive",
+              "default": "{}"
+            },
+            "status_field": {
+              "type": "string",
+              "description": "The field in response to isAlive that contains the status of the device",
+              "default": "status"
+            },
+            "status_value": {
+              "type": "string",
+              "description": "The status of the device that says it is alive",
+              "default": "true"
+            }
+          }
+        },
+        "getConfig": {
+          "type": "object",
+          "description": "Broker call to getConfig",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getConfig (e.g. /rest/api/device/{deviceid})",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getConfig",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getConfig",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getConfig",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getConfig",
+              "default": "{}"
+            }
+          }
+        },
+        "getCount": {
+          "type": "object",
+          "description": "Broker call to getCount",
+          "properties": {
+            "path": {
+              "type": "string",
+              "description": "The fully qualified path of the call to getCount (e.g. /rest/api/device)",
+              "default": ""
+            },
+            "method": {
+              "type": "string",
+              "description": "The method of the call to getCount",
+              "default": "GET"
+            },
+            "query": {
+              "type": "string",
+              "description": "The stringified json object with query parameters of the call to getCount",
+              "default": "{}"
+            },
+            "body": {
+              "type": "string",
+              "description": "The stringified json object with body of the call to getCount",
+              "default": "{}"
+            },
+            "headers": {
+              "type": "string",
+              "description": "The stringified json object with headers of the call to getCount",
+              "default": "{}"
+            }
+          }
+        }
+      }
     }
   }
 }

package/report/updateReport1642739939352.json

@@ -0,0 +1,95 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 1
+    },
+    {
+      "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": 29
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 13
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 23
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.44.11"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 64
+    },
+    {
+      "owner": "readmeMd",
+      "description": "Number of lines in the README.md",
+      "value": 688
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 13271
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 852
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 9674
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 334
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1029
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 34
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 23974
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1186
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -21,7 +21,10 @@
       "invalid_token_error": 401,
       "auth_field": "header.headers.Authorization",
       "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
-      "auth_logging": false
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
     },
     "healthcheck": {
       "type": "none",

package/test/integration/adapterTestBasicGet.js

@@ -14,7 +14,7 @@ const itParam = require('mocha-param');
 
 const utils = require('../../utils/tbUtils');
 const basicGet = require('../../utils/basicGet');
-const { name } = require('../../package');
+const { name } = require('../../package.json');
 const { methods } = require('../../pronghorn.json');
 
 const getPronghornProps = (iapDir) => {

package/test/integration/adapterTestIntegration.js

@@ -3,6 +3,7 @@
 // Set globals
 /* global describe it log pronghornProps */
 /* eslint no-unused-vars: warn */
+/* eslint no-underscore-dangle: warn  */
 
 // include required items for testing & logging
 const assert = require('assert');
@@ -13,7 +14,10 @@ const winston = require('winston');
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const util = require('util');
+const pronghorn = require('../../pronghorn.json');
 
+pronghorn.methodsByName = pronghorn.methods.reduce((result, meth) => ({ ...result, [meth.name]: meth }), {});
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
@@ -63,7 +67,10 @@ global.pronghornProps = {
           invalid_token_error: 401,
           auth_field: 'header.headers.Authorization',
           auth_field_format: 'Basic {b64}{username}:{password}{/b64}',
-          auth_logging: false
+          auth_logging: false,
+          client_id: '',
+          client_secret: '',
+          grant_type: ''
         },
         healthcheck: {
           type: 'none',
@@ -310,7 +317,7 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
 }
 
 // require the adapter that we are going to be using
-const Meraki = require('../../adapter.js');
+const Meraki = require('../../adapter');
 
 // begin the testing - these should be pretty well defined between the describe and the it!
 describe('[integration] Meraki Adapter Test', () => {
@@ -341,6 +348,8 @@ describe('[integration] Meraki Adapter Test', () => {
         try {
           assert.notEqual(null, a);
           assert.notEqual(undefined, a);
+          const checkId = global.pronghornProps.adapterProps.adapters[0].id;
+          assert.equal(checkId, a.id);
           assert.notEqual(null, a.allProps);
           const check = global.pronghornProps.adapterProps.adapters[0].properties.healthcheck.type;
           assert.equal(check, a.healthcheckType);

package/test/unit/adapterBaseTestUnit.js

@@ -61,7 +61,10 @@ global.pronghornProps = {
           token_cache: 'local',
           auth_field: 'header.headers.Authorization',
           auth_field_format: 'Basic {b64}{username}:{password}{/b64}',
-          auth_logging: false
+          auth_logging: false,
+          client_id: '',
+          client_secret: '',
+          grant_type: ''
         },
         healthcheck: {
           type: 'none',
@@ -194,7 +197,7 @@ function runErrorAsserts(data, error, code, origin, displayStr) {
 }
 
 // require the adapter that we are going to be using
-const AdapterBase = require('../../adapterBase.js');
+const AdapterBase = require('../../adapterBase');
 
 // delete the .DS_Store directory in entities -- otherwise this will cause errors
 const dirPath = path.join(__dirname, '../../entities/.DS_Store');
@@ -314,8 +317,8 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should return a list of functions', (done) => {
         const returnedFunctions = ['addEntityCache', 'capabilityResults', 'checkActionFiles', 'checkProperties', 'connect', 'encryptProperty',
-          'entityInList', 'findPath', 'getAllCapabilities', 'getAllFunctions', 'getQueue', 'getWorkflowFunctions', 'healthCheck',
-          'refreshProperties', 'runBasicGet', 'runConnectivity', 'runHealthcheck', 'suspend', 'troubleshoot', 'unsuspend', 'updateAdapterConfiguration', 'addListener',
+          'entityInList', 'getAllCapabilities', 'getAllFunctions', 'healthCheck', 'iapFindAdapterPath', 'iapGetAdapterQueue', 'iapGetAdapterWorkflowFunctions', 'iapMoveAdapterEntitiesToDB',
+          'iapRunAdapterBasicGet', 'iapRunAdapterConnectivity', 'iapRunAdapterHealthcheck', 'iapSuspendAdapter', 'iapTroubleshootAdapter', 'iapUnsuspendAdapter', 'iapUpdateAdapterConfiguration', 'refreshProperties', 'addListener',
           'emit', 'eventNames', 'getMaxListeners', 'listenerCount', 'listeners', 'off', 'on', 'once', 'prependListener',
           'prependOnceListener', 'rawListeners', 'removeAllListeners', 'removeListener', 'setMaxListeners'];
         try {
@@ -334,10 +337,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    describe('#getWorkflowFunctions', () => {
-      it('should have a getWorkflowFunctions function', (done) => {
+    describe('#iapGetAdapterWorkflowFunctions', () => {
+      it('should have a iapGetAdapterWorkflowFunctions function', (done) => {
         try {
-          assert.equal(true, typeof a.getWorkflowFunctions === 'function');
+          assert.equal(true, typeof a.iapGetAdapterWorkflowFunctions === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -346,7 +349,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should retrieve workflow functions', (done) => {
         try {
-          const expectedFunctions = a.getWorkflowFunctions([]);
+          const expectedFunctions = a.iapGetAdapterWorkflowFunctions([]);
           try {
             assert.equal(0, expectedFunctions.length);
             done();
@@ -423,10 +426,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    describe('#getQueue', () => {
-      it('should have a getQueue function', (done) => {
+    describe('#iapGetAdapterQueue', () => {
+      it('should have a iapGetAdapterQueue function', (done) => {
         try {
-          assert.equal(true, typeof a.getQueue === 'function');
+          assert.equal(true, typeof a.iapGetAdapterQueue === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -435,7 +438,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should get information for all of the requests currently in the queue', (done) => {
         try {
-          const expectedFunctions = a.getQueue();
+          const expectedFunctions = a.iapGetAdapterQueue();
           try {
             assert.equal(0, expectedFunctions.length);
             done();
@@ -840,12 +843,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    // const returnedFunctions = ['updateAdapterConfiguration'];
-
-    describe('#updateAdapterConfiguration', () => {
-      it('should have a updateAdapterConfiguration function', (done) => {
+    describe('#iapUpdateAdapterConfiguration', () => {
+      it('should have a iapUpdateAdapterConfiguration function', (done) => {
         try {
-          assert.equal(true, typeof a.updateAdapterConfiguration === 'function');
+          assert.equal(true, typeof a.iapUpdateAdapterConfiguration === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -854,7 +855,7 @@ describe('[unit] Adapter Base Test', () => {
       });
       it('should return no updated if no changes are provided', (done) => {
         try {
-          a.updateAdapterConfiguration(null, null, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration(null, null, null, null, null, (data, error) => {
             try {
               assert.equal('No configuration updates to make', data.response);
               done();
@@ -870,10 +871,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('should throw an error if missing configuration file', (done) => {
         try {
-          a.updateAdapterConfiguration(null, { name: 'fakeChange' }, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration(null, { name: 'fakeChange' }, null, null, null, (data, error) => {
             try {
               const displayE = 'configFile is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -887,10 +888,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, entity is required', (done) => {
         try {
-          a.updateAdapterConfiguration('notPackage', { name: 'fakeChange' }, null, null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, null, null, null, (data, error) => {
             try {
               const displayE = 'Unsupported Configuration Change or Missing Entity';
-              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -904,10 +905,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, type is required', (done) => {
         try {
-          a.updateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'entity', null, null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'entity', null, null, (data, error) => {
             try {
               const displayE = 'type is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.300', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -921,10 +922,10 @@ describe('[unit] Adapter Base Test', () => {
       }).timeout(attemptTimeout);
       it('if not package.json, entity must be valid', (done) => {
         try {
-          a.updateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'fakeEntity', 'fakeType', null, (data, error) => {
+          a.iapUpdateAdapterConfiguration('notPackage', { name: 'fakeChange' }, 'fakeEntity', 'fakeType', null, (data, error) => {
             try {
               const displayE = 'Incomplete Configuration Change: Invalid Entity - fakeEntity';
-              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-updateAdapterConfiguration', displayE);
+              runErrorAsserts(data, error, 'AD.999', 'Test-Base-adapterBase-iapUpdateAdapterConfiguration', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);