@itentialopensource/adapter-meraki 1.0.3 → 1.1.0

package/report/updateReport1690417926405.json

@@ -0,0 +1,119 @@
+{
+  "errors": [
+    {
+      "propertiesSchemaJson": "propertiesSchema.json owner reporting - Create propertiesSchema caught: SyntaxError: Unexpected token } in JSON at position 2262"
+    }
+  ],
+  "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": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.0.5"
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 343
+    },
+    {
+      "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": 24024
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1565
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 18150
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 595
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1357
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 38
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 43531
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 2160
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -4,6 +4,7 @@
   "properties": {
     "host": "api.meraki.com",
     "port": 443,
+    "choosepath": "",
     "base_path": "/api",
     "version": "v1",
     "cache_location": "none",
@@ -13,24 +14,39 @@
     "stub": true,
     "protocol": "https",
     "authentication": {
-      "auth_method": "basic user_password",
+      "auth_method": "static_token",
       "username": "username",
       "password": "password",
-      "token": "",
+      "token": "<token>",
       "token_timeout": 1800000,
       "token_cache": "local",
       "invalid_token_error": 401,
-      "auth_field": "header.headers.Authorization",
-      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_field": "header.headers.X-Cisco-Meraki-API-Key",
+      "auth_field_format": "{token}",
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",
-      "grant_type": ""
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ]
     },
     "healthcheck": {
       "type": "none",
       "frequency": 300000,
-      "query_object": {}
+      "query_object": {},
+      "addlHeaders": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -102,14 +118,17 @@
         {
           "path": "/organizations/{orgID}/devices",
           "method": "GET",
-          "query": {},
+          "query": {
+            "networkID": "networkID",
+            "serial": "serial"
+          },
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "networkID": "627126248111459727",
-            "serial": "Q4AB-J4J8-6BJR",
-            "orgID": "1076949"
+            "networkID": "port",
+            "serial": "name",
+            "orgID": "orgID"
           },
           "responseDatakey": "",
           "responseFields": {
@@ -139,7 +158,7 @@
             "ostypePrefix": "meraki-",
             "port": "networkId",
             "ipaddress": "mac",
-            "orgID": "1076949"
+            "orgID": "orgID"
           }
         }
       ],
@@ -153,8 +172,8 @@
           "handleFailure": "ignore",
           "requestFields": {
             "networkID": "port",
-            "serial": "Q4AB-J4J8-6BJR",
-            "orgID": "1076949"
+            "serial": "name",
+            "orgID": "orgID"
           },
           "responseDatakey": "",
           "responseFields": {
@@ -173,8 +192,8 @@
           "handleFailure": "ignore",
           "requestFields": {
             "networkID": "port",
-            "serial": "Q4AB-J4J8-6BJR",
-            "orgID": "1076949"
+            "serial": "name",
+            "orgID": "orgID"
           },
           "responseDatakey": "",
           "responseFields": {}
@@ -193,19 +212,47 @@
           },
           "responseDatakey": "",
           "responseFields": {}
-        },
+        }
+      ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
         {
-          "path": "/organizations/{orgID}/devices",
-          "method": "GET",
-          "query": {},
-          "body": {},
-          "headers": {},
-          "handleFailure": "ignore",
-          "requestFields": {
-            "orgID": "1076949"
-          },
-          "responseDatakey": "",
-          "responseFields": {}
+          "entityType": "device",
+          "frequency": 3600,
+          "flushOnFail": false,
+          "limit": 10000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "/organizations/{orgID}/devices",
+              "method": "GET",
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {
+                "orgID": "1076949"
+              },
+              "responseDatakey": "",
+              "responseFields": {
+                "serial": "serial",
+                "model": "model",
+                "networkId": "networkId",
+                "mac": "mac",
+                "orgID": "orgID"
+              }
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
         }
       ]
     }

package/test/integration/adapterTestBasicGet.js

@@ -7,9 +7,9 @@
 /* eslint import/no-dynamic-require: warn */
 /* eslint import/no-unresolved: warn */
 
-const mocha = require('mocha');
 const path = require('path');
 const assert = require('assert');
+const mocha = require('mocha');
 const itParam = require('mocha-param');
 
 const utils = require('../../utils/tbUtils');
@@ -18,12 +18,10 @@ const { name } = require('../../package.json');
 const { methods } = require('../../pronghorn.json');
 
 const getPronghornProps = (iapDir) => {
-  const { Discovery } = require('@itential/itential-utils');
   console.log('Retrieving properties.json file...');
   const rawProps = require(path.join(iapDir, 'properties.json'));
   console.log('Decrypting properties...');
-  const discovery = new Discovery();
-  const pronghornProps = utils.decryptProperties(rawProps, path.join(__dirname, '..'), discovery);
+  const pronghornProps = utils.decryptProperties(rawProps, iapDir);
   console.log('Found properties.\n');
   return pronghornProps;
 };

package/test/integration/adapterTestConnectivity.js

@@ -3,9 +3,12 @@
 /* global describe it context before after */
 /* eslint no-unused-vars: warn */
 
-const mocha = require('mocha');
 const assert = require('assert');
-const diagnostics = require('network-diagnostics');
+const http = require('http');
+const https = require('https');
+const mocha = require('mocha');
+const ping = require('ping');
+const dnsLookup = require('dns-lookup-promise');
 
 let host;
 process.argv.forEach((val) => {
@@ -16,78 +19,124 @@ process.argv.forEach((val) => {
 
 describe('[integration] Adapter Test', () => {
   context(`Testing network connection on ${host}`, () => {
-    before(() => {
-      diagnostics.setTestURL(host);
-    });
-
     after((done) => {
       done();
     });
 
     it('DNS resolve', (done) => {
-      diagnostics.haveDNS((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      dnsLookup(host)
+        .then((addresses) => {
+          try {
+            assert.ok(addresses.length > 0);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Responds to ping', (done) => {
-      diagnostics.havePing((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      ping.promise.probe(host)
+        .then((result) => {
+          try {
+            assert.ok(result.alive);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Support HTTP on port 80', (done) => {
-      diagnostics.haveHTTP((result) => {
+      const requestOptions = {
+        host,
+        port: 80,
+        method: 'HEAD'
+      };
+
+      const req = http.request(requestOptions, (res) => {
         try {
-          assert.equal(result, true);
+          assert.ok(res.statusCode >= 200 && res.statusCode < 400);
           done();
         } catch (error) {
           done(error);
         }
       });
+
+      req.on('error', (err) => {
+        done(err);
+      });
+
+      req.end();
     });
 
     it('Support HTTPS on port 443', (done) => {
-      diagnostics.haveHTTPS((result) => {
+      const requestOptions = {
+        host,
+        port: 443,
+        method: 'HEAD'
+      };
+
+      const req = https.request(requestOptions, (res) => {
         try {
-          assert.equal(result, true);
+          assert.ok(res.statusCode >= 200 && res.statusCode < 400);
           done();
         } catch (error) {
           done(error);
         }
       });
+
+      req.on('error', (err) => {
+        done(err);
+      });
+
+      req.end();
     });
 
     it('Support IPv4', (done) => {
-      diagnostics.haveIPv4Async((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      const options = {
+        family: 4,
+        hints: dnsLookup.ADDRCONFIG
+      };
+
+      dnsLookup.lookup(host, options)
+        .then((address, family) => {
+          try {
+            assert.ok(address !== null && family === 4);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Support IPv6', (done) => {
-      diagnostics.haveIPv6Async((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      const options = {
+        family: 6,
+        hints: dnsLookup.ADDRCONFIG
+      };
+
+      dnsLookup.lookup(host, options)
+        .then((address, family) => {
+          try {
+            assert.ok(address !== null && family === 6);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
   });
 });

package/test/integration/adapterTestIntegration.js

@@ -9,13 +9,13 @@
 // include required items for testing & logging
 const assert = require('assert');
 const fs = require('fs');
-const mocha = require('mocha');
 const path = require('path');
+const util = require('util');
+const mocha = require('mocha');
 const winston = require('winston');
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
-const util = require('util');
 
 const anything = td.matchers.anything();
 
@@ -335,6 +335,134 @@ describe('[integration] Meraki Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    // broker tests
+    describe('#getDevicesFiltered - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          const opts = {
+            filter: {
+              name: 'deviceName'
+            }
+          };
+          a.getDevicesFiltered(opts, (data, error) => {
+            try {
+              if (stub) {
+                if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
+                  assert.equal(null, error);
+                  assert.notEqual(undefined, data);
+                  assert.notEqual(null, data);
+                  assert.equal(0, data.total);
+                  assert.equal(0, data.list.length);
+                } else {
+                  const displayE = 'Error 400 received on request';
+                  runErrorAsserts(data, error, 'AD.500', 'Test-meraki-connectorRest-handleEndResponse', displayE);
+                }
+              } else {
+                runCommonAsserts(data, error);
+              }
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#iapGetDeviceCount - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          const opts = {
+            filter: {
+              name: 'deviceName'
+            }
+          };
+          a.iapGetDeviceCount((data, error) => {
+            try {
+              if (stub) {
+                if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
+                  assert.equal(null, error);
+                  assert.notEqual(undefined, data);
+                  assert.notEqual(null, data);
+                  assert.equal(0, data.count);
+                } else {
+                  const displayE = 'Error 400 received on request';
+                  runErrorAsserts(data, error, 'AD.500', 'Test-meraki-connectorRest-handleEndResponse', displayE);
+                }
+              } else {
+                runCommonAsserts(data, error);
+              }
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    // exposed cache tests
+    describe('#iapPopulateEntityCache - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.iapPopulateEntityCache('Device', (data, error) => {
+            try {
+              if (stub) {
+                assert.equal(null, data);
+                assert.notEqual(undefined, error);
+                assert.notEqual(null, error);
+                done();
+              } else {
+                assert.equal(undefined, error);
+                assert.equal('success', data[0]);
+                done();
+              }
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#iapRetrieveEntitiesCache - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.iapRetrieveEntitiesCache('Device', {}, (data, error) => {
+            try {
+              if (stub) {
+                assert.equal(null, data);
+                assert.notEqual(null, error);
+                assert.notEqual(undefined, error);
+              } else {
+                assert.equal(undefined, error);
+                assert.notEqual(null, data);
+                assert.notEqual(undefined, data);
+              }
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
     /*
     -----------------------------------------------------------------------
     -----------------------------------------------------------------------