@itentialopensource/adapter-meraki 0.8.3 → 0.8.4

package/propertiesSchema.json

@@ -53,7 +53,7 @@
     },
     "encode_queryvars": {
       "type": "boolean",
-      "description": "When true the path variables are encoded in the url",
+      "description": "When true the query parameters are encoded in the url",
       "default": true
     },
     "save_metric": {
@@ -900,6 +900,11 @@
                 },
                 "properties": {}
               },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getDevice",
@@ -927,7 +932,7 @@
                     "description": "The field in response to getDevice that contains the port of the device",
                     "default": ""
                   },
-                  "ip": {
+                  "ipaddress": {
                     "type": "string",
                     "description": "The field in response to getDevice that contains the ip address of the device",
                     "default": ""
@@ -990,6 +995,11 @@
                 },
                 "properties": {}
               },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getDevicesFiltered",
@@ -1012,12 +1022,12 @@
                     "description": "Any prefix that should be added to the ostype of the device (e.g. aws-)",
                     "default": ""
                   },
-                  "port_field": {
+                  "port": {
                     "type": "string",
                     "description": "The field in response to getDevicesFiltered that contains the port of the device",
                     "default": ""
                   },
-                  "ip_field": {
+                  "ipaddress": {
                     "type": "string",
                     "description": "The field in response to getDevicesFiltered that contains the ip address of the device",
                     "default": ""
@@ -1072,11 +1082,6 @@
                 "description": "return failure or ignore isAlive",
                 "default": "ignore"
               },
-              "statusValue": {
-                "type": "string",
-                "description": "The expected value in the status field",
-                "default": "true"
-              },
               "requestFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getDevice",
@@ -1085,6 +1090,11 @@
                 },
                 "properties": {}
               },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to isAlive",
@@ -1096,6 +1106,11 @@
                     "type": "string",
                     "description": "The field in response to isAlive that contains the status of the device",
                     "default": "name"
+                  },
+                  "statusValue": {
+                    "type": "string",
+                    "description": "The expected value in the status field",
+                    "default": "true"
                   }
                 }
               }
@@ -1155,6 +1170,11 @@
                 },
                 "properties": {}
               },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
               "responseFields": {
                 "type": "object",
                 "description": "The json object with response fields of the call to getConfig",
@@ -1210,6 +1230,27 @@
                 ],
                 "description": "return failure or ignore getCount",
                 "default": "ignore"
+              },
+              "requestFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getDevice",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
+              },
+              "responseDatakey": {
+                "type": "string",
+                "description": "place in the response where the data is - supports jsonquery",
+                "default": ""
+              },
+              "responseFields": {
+                "type": "object",
+                "description": "The json object with response fields of the call to getConfig",
+                "additionalProperties": {
+                  "type": "string"
+                },
+                "properties": {}
               }
             }
           }

package/report/adapterInfo.json

@@ -0,0 +1,10 @@
+{
+  "version": "0.8.3",
+  "configLines": 18012,
+  "scriptLines": 1707,
+  "codeLines": 28175,
+  "testLines": 23912,
+  "testCases": 1243,
+  "totalCodeLines": 53794,
+  "wfTasks": 346
+}

package/report/updateReport1652488414759.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": 14
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.45.4"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 338
+    },
+    {
+      "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": 13187
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 851
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 9595
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 334
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1783
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 24565
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1185
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -3,13 +3,13 @@
   "type": "Meraki",
   "properties": {
     "host": "api.meraki.com",
-    "port": 80,
+    "port": 443,
     "base_path": "/api",
-    "version": "v0",
+    "version": "v1",
     "cache_location": "none",
     "encode_pathvars": true,
     "encode_queryvars": true,
-    "save_metric": true,
+    "save_metric": false,
     "stub": true,
     "protocol": "https",
     "authentication": {
@@ -97,84 +97,131 @@
         "cert_file": ""
       }
     },
-    "deviceBroker": {
+    "devicebroker": {
       "getDevice": [
         {
-          "path": "/get/devices/{id}",
+          "path": "/organizations/{orgID}/devices",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "networkID": "port",
+            "serial": "name",
+            "orgID": "orgID"
           },
+          "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": 443
+            "name": "serial",
+            "ostype": "model",
+            "ostypePrefix": "meraki-",
+            "port": "networkId",
+            "ipaddress": "mac"
           }
         }
       ],
       "getDevicesFiltered": [
         {
-          "path": "/get/devices",
+          "path": "/organizations/{orgID}/devices",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
-          "requestFields": {},
+          "requestFields": {
+            "orgID": "549236"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "serial",
+            "ostype": "model",
+            "ostypePrefix": "meraki-",
+            "port": "networkId",
+            "ipaddress": "mac",
+            "orgID": "549236"
+          }
+        },
+        {
+          "path": "/organizations/{orgID}/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "orgID": "681155"
+          },
+          "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": 443
+            "name": "serial",
+            "ostype": "model",
+            "ostypePrefix": "meraki-",
+            "port": "networkId",
+            "ipaddress": "mac",
+            "orgID": "681155"
           }
         }
       ],
       "isAlive": [
         {
-          "path": "/get/devices/{id}/status",
+          "path": "/organizations/{orgID}/networks/{networkID}/devices/{serial}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
-          "statusValue": "online",
           "requestFields": {
-            "id": "name"
+            "networkID": "port",
+            "serial": "name",
+            "orgID": "orgID"
           },
+          "responseDatakey": "",
           "responseFields": {
-            "status": "status"
+            "status": "return2xx",
+            "statusValue": "AD.200"
           }
         }
       ],
       "getConfig": [
         {
-          "path": "/get/devices/{id}/configPart1",
+          "path": "/organizations/{orgID}/networks/{networkID}/devices/{serial}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "networkID": "port",
+            "serial": "name",
+            "orgID": "orgID"
           },
+          "responseDatakey": "",
           "responseFields": {}
         }
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/organizations/549236/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        },
+        {
+          "path": "/organizations/681155/devices",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
-          "handleFailure": "ignore"
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
         }
       ]
     }

package/test/integration/adapterTestBasicGet.js

@@ -34,7 +34,7 @@ describe('[integration] Adapter BasicGET Test', () => {
   context('Testing GET calls without query parameters', () => {
     before(async () => {
       const iapDir = path.join(__dirname, '../../../../../');
-      if (!utils.withinIAP(iapDir)) {
+      if (!utils.areWeUnderIAPinstallationDirectory()) {
         const sampleProperties = require('../../sampleProperties.json');
         const adapter = { properties: sampleProperties };
         a = basicGet.getAdapterInstance(adapter);

package/test/integration/adapterTestIntegration.js

@@ -4,6 +4,7 @@
 /* global describe it log pronghornProps */
 /* eslint no-unused-vars: warn */
 /* eslint no-underscore-dangle: warn  */
+/* eslint import/no-dynamic-require:warn */
 
 // include required items for testing & logging
 const assert = require('assert');
@@ -15,27 +16,38 @@ 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
 let logLevel = 'none';
-const stub = true;
 const isRapidFail = false;
 const isSaveMockData = false;
-const attemptTimeout = 5000;
+
+// read in the properties from the sampleProperties files
+let adaptdir = __dirname;
+if (adaptdir.endsWith('/test/integration')) {
+  adaptdir = adaptdir.substring(0, adaptdir.length - 17);
+} else if (adaptdir.endsWith('/test/unit')) {
+  adaptdir = adaptdir.substring(0, adaptdir.length - 10);
+}
+const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
 
 // these variables can be changed to run in integrated mode so easier to set them here
 // always check these in with bogus data!!!
-const host = 'replace.hostorip.here';
-const username = 'username';
-const password = 'password';
-const protocol = 'http';
-const port = 80;
-const sslenable = false;
-const sslinvalid = false;
+samProps.stub = true;
+samProps.host = 'replace.hostorip.here';
+samProps.authentication.username = 'username';
+samProps.authentication.password = 'password';
+samProps.protocol = 'http';
+samProps.port = 80;
+samProps.ssl.enabled = false;
+samProps.ssl.accept_invalid_cert = false;
+if (samProps.request.attempt_timeout < 30000) {
+  samProps.request.attempt_timeout = 30000;
+}
+const attemptTimeout = samProps.request.attempt_timeout;
+const { stub } = samProps;
 
 // these are the adapter properties. You generally should not need to alter
 // any of these after they are initially set up
@@ -47,102 +59,7 @@ global.pronghornProps = {
     adapters: [{
       id: 'Test-meraki',
       type: 'Meraki',
-      properties: {
-        host,
-        port,
-        base_path: '//api',
-        version: 'v0',
-        cache_location: 'none',
-        encode_pathvars: true,
-        save_metric: false,
-        protocol,
-        stub,
-        authentication: {
-          auth_method: 'basic user_password',
-          username,
-          password,
-          token: '',
-          token_timeout: -1,
-          token_cache: 'local',
-          invalid_token_error: 401,
-          auth_field: 'header.headers.Authorization',
-          auth_field_format: 'Basic {b64}{username}:{password}{/b64}',
-          auth_logging: false,
-          client_id: '',
-          client_secret: '',
-          grant_type: ''
-        },
-        healthcheck: {
-          type: 'none',
-          frequency: 60000,
-          query_object: {}
-        },
-        throttle: {
-          throttle_enabled: false,
-          number_pronghorns: 1,
-          sync_async: 'sync',
-          max_in_queue: 1000,
-          concurrent_max: 1,
-          expire_timeout: 0,
-          avg_runtime: 200,
-          priorities: [
-            {
-              value: 0,
-              percent: 100
-            }
-          ]
-        },
-        request: {
-          number_redirects: 0,
-          number_retries: 3,
-          limit_retry_error: 0,
-          failover_codes: [],
-          attempt_timeout: attemptTimeout,
-          global_request: {
-            payload: {},
-            uriOptions: {},
-            addlHeaders: {},
-            authData: {}
-          },
-          healthcheck_on_timeout: true,
-          return_raw: true,
-          archiving: false,
-          return_request: false
-        },
-        proxy: {
-          enabled: false,
-          host: '',
-          port: 1,
-          protocol: 'http',
-          username: '',
-          password: ''
-        },
-        ssl: {
-          ecdhCurve: '',
-          enabled: sslenable,
-          accept_invalid_cert: sslinvalid,
-          ca_file: '',
-          key_file: '',
-          cert_file: '',
-          secure_protocol: '',
-          ciphers: ''
-        },
-        mongo: {
-          host: '',
-          port: 0,
-          database: '',
-          username,
-          password: '',
-          replSet: '',
-          db_ssl: {
-            enabled: false,
-            accept_invalid_cert: false,
-            ca_file: '',
-            key_file: '',
-            cert_file: ''
-          }
-        }
-      }
+      properties: samProps
     }]
   }
 };