@itentialopensource/adapter-meraki 0.7.0 → 0.8.0

package/report/updateReport1594225126093.json

@@ -0,0 +1,95 @@
+{
+  "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": 29
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 5
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 9
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 10
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.34.4"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 56
+    },
+    {
+      "owner": "readmeMd",
+      "description": "Number of lines in the README.md",
+      "value": 530
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 12647
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 826
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 9657
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 334
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 751
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 18
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 23055
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1160
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/report/updateReport1615384306128.json

@@ -0,0 +1,95 @@
+{
+  "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": 29
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 12
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.39.1"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 61
+    },
+    {
+      "owner": "readmeMd",
+      "description": "Number of lines in the README.md",
+      "value": 615
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 12654
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 826
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 9664
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 334
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1007
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 30
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 23325
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1160
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

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

@@ -7,6 +7,7 @@
     "base_path": "/api",
     "version": "v0",
     "cache_location": "none",
+    "encode_pathvars": true,
     "save_metric": true,
     "stub": true,
     "protocol": "https",
@@ -19,11 +20,16 @@
       "token_cache": "local",
       "invalid_token_error": 401,
       "auth_field": "header.headers.Authorization",
-      "auth_field_format": "Basic {b64}{username}:{password}{/b64}"
+      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
     },
     "healthcheck": {
       "type": "none",
-      "frequency": 300000
+      "frequency": 300000,
+      "query_object": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -32,7 +38,13 @@
       "max_in_queue": 1000,
       "concurrent_max": 1,
       "expire_timeout": 0,
-      "avg_runtime": 200
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
     },
     "request": {
       "number_redirects": 0,
@@ -48,13 +60,16 @@
       },
       "healthcheck_on_timeout": true,
       "return_raw": false,
-      "archiving": false
+      "archiving": false,
+      "return_request": false
     },
     "proxy": {
       "enabled": false,
       "host": "",
       "port": 1,
-      "protocol": "http"
+      "protocol": "http",
+      "username": "",
+      "password": ""
     },
     "ssl": {
       "ecdhCurve": "",

package/test/integration/adapterTestBasicGet.js

@@ -0,0 +1,85 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe context before after */
+/* eslint global-require: warn */
+/* eslint no-unused-vars: warn */
+/* eslint import/no-extraneous-dependencies: warn */
+/* eslint import/no-dynamic-require: warn */
+/* eslint import/no-unresolved: warn */
+
+const mocha = require('mocha');
+const path = require('path');
+const assert = require('assert');
+const itParam = require('mocha-param');
+
+const utils = require('../../utils/tbUtils');
+const basicGet = require('../../utils/basicGet');
+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);
+  console.log('Found properties.\n');
+  return pronghornProps;
+};
+
+let a;
+
+describe('[integration] Adapter BasicGET Test', () => {
+  context('Testing GET calls without query parameters', () => {
+    before(async () => {
+      const iapDir = path.join(__dirname, '../../../../../');
+      if (!utils.withinIAP(iapDir)) {
+        const sampleProperties = require('../../sampleProperties.json');
+        const adapter = { properties: sampleProperties };
+        a = basicGet.getAdapterInstance(adapter);
+      } else {
+        const pronghornProps = getPronghornProps(iapDir);
+        console.log('Connecting to Database...');
+        const database = await basicGet.connect(pronghornProps);
+        console.log('Connection established.');
+        const adapter = await database.collection(utils.SERVICE_CONFIGS_COLLECTION).findOne(
+          { model: name }
+        );
+        a = basicGet.getAdapterInstance(adapter);
+      }
+    });
+
+    after((done) => {
+      done();
+    });
+
+    const basicGets = methods.filter((method) => (method.route.verb === 'GET' && method.input.length === 0));
+    if (basicGets.length === 0) {
+      console.log('No non-parameter GET calls found.');
+      process.exit(0);
+    }
+    const functionNames = basicGets.map((g) => g.name);
+    const request = function request(f, ad) {
+      return new Promise((resolve, reject) => {
+        const getRespCode = (resp) => {
+          if (resp) {
+            if (resp.metrics.code !== 200) {
+              console.log('\x1b[31m', `Testing ${f} \nResponseCode: ${resp.metrics.code}`);
+            }
+            resolve(resp.metrics.code);
+          } else {
+            console.log('\x1b[31m', `call ${f} results in failure`);
+            reject(new Error(`${f} failed`));
+          }
+        };
+        ad[f](getRespCode, console.log);
+      });
+    };
+
+    itParam('GET call should return 200', functionNames, (fname) => {
+      console.log(`\t ${fname}`);
+      return request(fname, a).then((result) => assert.equal(result, 200));
+    });
+  });
+});

package/test/integration/adapterTestConnectivity.js

@@ -0,0 +1,93 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe it context before after */
+/* eslint no-unused-vars: warn */
+
+const mocha = require('mocha');
+const assert = require('assert');
+const diagnostics = require('network-diagnostics');
+
+let host;
+process.argv.forEach((val) => {
+  if (val.indexOf('--HOST') === 0) {
+    [, host] = val.split('=');
+  }
+});
+
+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);
+        }
+      });
+    });
+
+    it('Responds to ping', (done) => {
+      diagnostics.havePing((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support HTTP on port 80', (done) => {
+      diagnostics.haveHTTP((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support HTTPS on port 443', (done) => {
+      diagnostics.haveHTTPS((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support IPv4', (done) => {
+      diagnostics.haveIPv4Async((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support IPv6', (done) => {
+      diagnostics.haveIPv6Async((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+  });
+});

package/test/integration/adapterTestIntegration.js

@@ -13,7 +13,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
@@ -49,6 +52,7 @@ global.pronghornProps = {
         base_path: '//api',
         version: 'v0',
         cache_location: 'none',
+        encode_pathvars: true,
         save_metric: false,
         protocol,
         stub,
@@ -61,11 +65,16 @@ global.pronghornProps = {
           token_cache: 'local',
           invalid_token_error: 401,
           auth_field: 'header.headers.Authorization',
-          auth_field_format: 'Basic {b64}{username}:{password}{/b64}'
+          auth_field_format: 'Basic {b64}{username}:{password}{/b64}',
+          auth_logging: false,
+          client_id: '',
+          client_secret: '',
+          grant_type: ''
         },
         healthcheck: {
           type: 'none',
-          frequency: 60000
+          frequency: 60000,
+          query_object: {}
         },
         throttle: {
           throttle_enabled: false,
@@ -74,7 +83,13 @@ global.pronghornProps = {
           max_in_queue: 1000,
           concurrent_max: 1,
           expire_timeout: 0,
-          avg_runtime: 200
+          avg_runtime: 200,
+          priorities: [
+            {
+              value: 0,
+              percent: 100
+            }
+          ]
         },
         request: {
           number_redirects: 0,
@@ -90,13 +105,16 @@ global.pronghornProps = {
           },
           healthcheck_on_timeout: true,
           return_raw: true,
-          archiving: false
+          archiving: false,
+          return_request: false
         },
         proxy: {
           enabled: false,
           host: '',
           port: 1,
-          protocol: 'http'
+          protocol: 'http',
+          username: '',
+          password: ''
         },
         ssl: {
           ecdhCurve: '',
@@ -159,7 +177,7 @@ process.argv.forEach((val) => {
 });
 
 // need to set global logging
-global.log = new (winston.Logger)({
+global.log = winston.createLogger({
   level: logLevel,
   levels: myCustomLevels.levels,
   transports: [
@@ -253,7 +271,7 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
           };
 
           // get the object for method we're trying to change.
-          const currentMethodAction = parsedJson.actions.find(obj => obj.name === actionName);
+          const currentMethodAction = parsedJson.actions.find((obj) => obj.name === actionName);
 
           // if the method was not found - should never happen but...
           if (!currentMethodAction) {
@@ -261,12 +279,12 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
           }
 
           // if there is a response object, we want to replace the Response object. Otherwise we'll create one.
-          const actionResponseObj = currentMethodAction.responseObjects.find(obj => obj.type === descriptor);
+          const actionResponseObj = currentMethodAction.responseObjects.find((obj) => obj.type === descriptor);
 
           // Add the action responseObj back into the array of response objects.
           if (!actionResponseObj) {
             // if there is a default response object, we want to get the key.
-            const defaultResponseObj = currentMethodAction.responseObjects.find(obj => obj.type === 'default');
+            const defaultResponseObj = currentMethodAction.responseObjects.find((obj) => obj.type === 'default');
 
             // save the default key into the new response object
             if (defaultResponseObj) {
@@ -297,9 +315,8 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
   return false;
 }
 
-
 // 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', () => {
@@ -330,6 +347,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);