@itentialopensource/adapter-meraki 0.8.0 → 0.8.3

package/test/unit/adapterBaseTestUnit.js

@@ -317,8 +317,10 @@ 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', 'moveEntitiesToDB',
-          'refreshProperties', 'runBasicGet', 'runConnectivity', 'runHealthcheck', 'suspend', 'troubleshoot', 'unsuspend', 'updateAdapterConfiguration', 'addListener',
+          'entityInList', 'getAllCapabilities', 'getAllFunctions', 'getConfig', 'getDevice', 'getDevicesFiltered', 'hasDevices', 'hasEntities',
+          'healthCheck', 'iapFindAdapterPath', 'iapGetAdapterQueue', 'iapGetAdapterWorkflowFunctions', 'iapGetDeviceCount', 'iapMakeBrokerCall',
+          'iapMoveAdapterEntitiesToDB', 'iapRunAdapterBasicGet', 'iapRunAdapterConnectivity', 'iapRunAdapterHealthcheck', 'iapSuspendAdapter',
+          'iapTroubleshootAdapter', 'iapUnsuspendAdapter', 'iapUpdateAdapterConfiguration', 'isAlive', 'refreshProperties', 'addListener',
           'emit', 'eventNames', 'getMaxListeners', 'listenerCount', 'listeners', 'off', 'on', 'once', 'prependListener',
           'prependOnceListener', 'rawListeners', 'removeAllListeners', 'removeListener', 'setMaxListeners'];
         try {
@@ -337,10 +339,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}`);
@@ -349,7 +351,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();
@@ -426,10 +428,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}`);
@@ -438,7 +440,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();
@@ -817,12 +819,17 @@ describe('[unit] Adapter Base Test', () => {
           try {
             assert.notEqual(0, expectedCapabilities.length);
             assert.equal('.generic', expectedCapabilities[0].entity);
-            assert.equal(5, expectedCapabilities[0].actions.length);
+            assert.equal(10, expectedCapabilities[0].actions.length);
             assert.equal('getGenerics', expectedCapabilities[0].actions[0]);
             assert.equal('createGeneric', expectedCapabilities[0].actions[1]);
             assert.equal('updateGeneric', expectedCapabilities[0].actions[2]);
             assert.equal('patchGeneric', expectedCapabilities[0].actions[3]);
             assert.equal('deleteGeneric', expectedCapabilities[0].actions[4]);
+            assert.equal('getGenericsNoBase', expectedCapabilities[0].actions[5]);
+            assert.equal('createGenericNoBase', expectedCapabilities[0].actions[6]);
+            assert.equal('updateGenericNoBase', expectedCapabilities[0].actions[7]);
+            assert.equal('patchGenericNoBase', expectedCapabilities[0].actions[8]);
+            assert.equal('deleteGenericNoBase', expectedCapabilities[0].actions[9]);
             assert.equal('.system', expectedCapabilities[1].entity);
             assert.equal(2, expectedCapabilities[1].actions.length);
             assert.equal('getToken', expectedCapabilities[1].actions[0]);
@@ -843,12 +850,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}`);
@@ -857,7 +862,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();
@@ -873,10 +878,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}`);
@@ -890,10 +895,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}`);
@@ -907,10 +912,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}`);
@@ -924,10 +929,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}`);

package/test/unit/adapterTestUnit.js

@@ -271,10 +271,10 @@ describe('[unit] Meraki Adapter Test', () => {
     });
 
     let wffunctions = [];
-    describe('#getWorkflowFunctions', () => {
+    describe('#iapGetAdapterWorkflowFunctions', () => {
       it('should retrieve workflow functions', (done) => {
         try {
-          wffunctions = a.getWorkflowFunctions([]);
+          wffunctions = a.iapGetAdapterWorkflowFunctions([]);
 
           try {
             assert.notEqual(0, wffunctions.length);
@@ -465,16 +465,17 @@ describe('[unit] Meraki Adapter Test', () => {
           assert.notEqual('', pronghornDotJson.methods);
           assert.equal(true, Array.isArray(pronghornDotJson.methods));
           assert.notEqual(0, pronghornDotJson.methods.length);
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'updateAdapterConfiguration'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'findPath'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'troubleshoot'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'runHealthcheck'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'runConnectivity'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'runBasicGet'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'suspend'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'unsuspend'));
-          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'getQueue'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapUpdateAdapterConfiguration'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapFindAdapterPath'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapTroubleshootAdapter'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapRunAdapterHealthcheck'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapRunAdapterConnectivity'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapRunAdapterBasicGet'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapSuspendAdapter'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapUnsuspendAdapter'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'iapGetAdapterQueue'));
           assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'genericAdapterRequest'));
+          assert.notEqual(undefined, pronghornDotJson.methods.find((e) => e.name === 'genericAdapterRequestNoBasePath'));
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -646,6 +647,8 @@ describe('[unit] Meraki Adapter Test', () => {
           assert.equal('string', propertiesDotJson.definitions.authentication.properties.client_id.type);
           assert.equal('string', propertiesDotJson.definitions.authentication.properties.client_secret.type);
           assert.equal('string', propertiesDotJson.definitions.authentication.properties.grant_type.type);
+          assert.notEqual(undefined, propertiesDotJson.definitions.ssl);
+          assert.notEqual(null, propertiesDotJson.definitions.ssl);
           assert.notEqual('', propertiesDotJson.definitions.ssl);
           assert.equal('string', propertiesDotJson.definitions.ssl.properties.ecdhCurve.type);
           assert.equal('boolean', propertiesDotJson.definitions.ssl.properties.enabled.type);
@@ -659,6 +662,7 @@ describe('[unit] Meraki Adapter Test', () => {
           assert.equal('string', propertiesDotJson.properties.version.type);
           assert.equal('string', propertiesDotJson.properties.cache_location.type);
           assert.equal('boolean', propertiesDotJson.properties.encode_pathvars.type);
+          assert.equal('boolean', propertiesDotJson.properties.encode_queryvars.type);
           assert.equal(true, Array.isArray(propertiesDotJson.properties.save_metric.type));
           assert.equal('string', propertiesDotJson.properties.protocol.type);
           assert.notEqual(undefined, propertiesDotJson.definitions);
@@ -707,8 +711,6 @@ describe('[unit] Meraki Adapter Test', () => {
           assert.equal('string', propertiesDotJson.definitions.proxy.properties.protocol.type);
           assert.equal('string', propertiesDotJson.definitions.proxy.properties.username.type);
           assert.equal('string', propertiesDotJson.definitions.proxy.properties.password.type);
-          assert.notEqual(undefined, propertiesDotJson.definitions.ssl);
-          assert.notEqual(null, propertiesDotJson.definitions.ssl);
           assert.notEqual(undefined, propertiesDotJson.definitions.mongo);
           assert.notEqual(null, propertiesDotJson.definitions.mongo);
           assert.notEqual('', propertiesDotJson.definitions.mongo);
@@ -724,6 +726,12 @@ describe('[unit] Meraki Adapter Test', () => {
           assert.equal('string', propertiesDotJson.definitions.mongo.properties.db_ssl.properties.ca_file.type);
           assert.equal('string', propertiesDotJson.definitions.mongo.properties.db_ssl.properties.key_file.type);
           assert.equal('string', propertiesDotJson.definitions.mongo.properties.db_ssl.properties.cert_file.type);
+          assert.notEqual('', propertiesDotJson.definitions.devicebroker);
+          assert.equal('array', propertiesDotJson.definitions.devicebroker.properties.getDevice.type);
+          assert.equal('array', propertiesDotJson.definitions.devicebroker.properties.getDevicesFiltered.type);
+          assert.equal('array', propertiesDotJson.definitions.devicebroker.properties.isAlive.type);
+          assert.equal('array', propertiesDotJson.definitions.devicebroker.properties.getConfig.type);
+          assert.equal('array', propertiesDotJson.definitions.devicebroker.properties.getCount.type);
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1002,10 +1010,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    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}`);
@@ -1014,19 +1022,19 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#findPath', () => {
-      it('should have a findPath function', (done) => {
+    describe('#iapFindAdapterPath', () => {
+      it('should have a iapFindAdapterPath function', (done) => {
         try {
-          assert.equal(true, typeof a.findPath === 'function');
+          assert.equal(true, typeof a.iapFindAdapterPath === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
           done(error);
         }
       });
-      it('findPath should find atleast one path that matches', (done) => {
+      it('iapFindAdapterPath should find atleast one path that matches', (done) => {
         try {
-          a.findPath('{base_path}/{version}', (data, error) => {
+          a.iapFindAdapterPath('{base_path}/{version}', (data, error) => {
             try {
               assert.equal(undefined, error);
               assert.notEqual(undefined, data);
@@ -1048,10 +1056,10 @@ describe('[unit] Meraki Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    describe('#suspend', () => {
-      it('should have a suspend function', (done) => {
+    describe('#iapSuspendAdapter', () => {
+      it('should have a iapSuspendAdapter function', (done) => {
         try {
-          assert.equal(true, typeof a.suspend === 'function');
+          assert.equal(true, typeof a.iapSuspendAdapter === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1060,10 +1068,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#unsuspend', () => {
-      it('should have a unsuspend function', (done) => {
+    describe('#iapUnsuspendAdapter', () => {
+      it('should have a iapUnsuspendAdapter function', (done) => {
         try {
-          assert.equal(true, typeof a.unsuspend === 'function');
+          assert.equal(true, typeof a.iapUnsuspendAdapter === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1072,10 +1080,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    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}`);
@@ -1084,10 +1092,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#troubleshoot', () => {
-      it('should have a troubleshoot function', (done) => {
+    describe('#iapTroubleshootAdapter', () => {
+      it('should have a iapTroubleshootAdapter function', (done) => {
         try {
-          assert.equal(true, typeof a.troubleshoot === 'function');
+          assert.equal(true, typeof a.iapTroubleshootAdapter === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1096,10 +1104,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#runHealthcheck', () => {
-      it('should have a runHealthcheck function', (done) => {
+    describe('#iapRunAdapterHealthcheck', () => {
+      it('should have a iapRunAdapterHealthcheck function', (done) => {
         try {
-          assert.equal(true, typeof a.runHealthcheck === 'function');
+          assert.equal(true, typeof a.iapRunAdapterHealthcheck === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1108,10 +1116,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#runConnectivity', () => {
-      it('should have a runConnectivity function', (done) => {
+    describe('#iapRunAdapterConnectivity', () => {
+      it('should have a iapRunAdapterConnectivity function', (done) => {
         try {
-          assert.equal(true, typeof a.runConnectivity === 'function');
+          assert.equal(true, typeof a.iapRunAdapterConnectivity === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1120,10 +1128,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#runBasicGet', () => {
-      it('should have a runBasicGet function', (done) => {
+    describe('#iapRunAdapterBasicGet', () => {
+      it('should have a iapRunAdapterBasicGet function', (done) => {
         try {
-          assert.equal(true, typeof a.runBasicGet === 'function');
+          assert.equal(true, typeof a.iapRunAdapterBasicGet === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1132,10 +1140,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#moveEntitiesToDB', () => {
-      it('should have a moveEntitiesToDB function', (done) => {
+    describe('#iapMoveAdapterEntitiesToDB', () => {
+      it('should have a iapMoveAdapterEntitiesToDB function', (done) => {
         try {
-          assert.equal(true, typeof a.moveEntitiesToDB === 'function');
+          assert.equal(true, typeof a.iapMoveAdapterEntitiesToDB === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);
@@ -1229,10 +1237,10 @@ describe('[unit] Meraki Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
-    // describe('#hasEntity', () => {
-    //   it('should have a hasEntity function', (done) => {
+    // describe('#iapHasAdapterEntity', () => {
+    //   it('should have a iapHasAdapterEntity function', (done) => {
     //     try {
-    //       assert.equal(true, typeof a.hasEntity === 'function');
+    //       assert.equal(true, typeof a.iapHasAdapterEntity === 'function');
     //       done();
     //     } catch (error) {
     //       log.error(`Test Failure: ${error}`);
@@ -1241,7 +1249,7 @@ describe('[unit] Meraki Adapter Test', () => {
     //   });
     //   it('should find entity', (done) => {
     //     try {
-    //       a.hasEntity('template_entity', // 'a9e9c33dc61122760072455df62663d2', (data) => {
+    //       a.iapHasAdapterEntity('template_entity', // 'a9e9c33dc61122760072455df62663d2', (data) => {
     //         try {
     //           assert.equal(true, data[0]);
     //           done();
@@ -1257,7 +1265,7 @@ describe('[unit] Meraki Adapter Test', () => {
     //   }).timeout(attemptTimeout);
     //   it('should not find entity', (done) => {
     //     try {
-    //       a.hasEntity('template_entity', 'blah', (data) => {
+    //       a.iapHasAdapterEntity('template_entity', 'blah', (data) => {
     //         try {
     //           assert.equal(false, data[0]);
     //           done();
@@ -1285,18 +1293,6 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#hasDevices', () => {
-      it('should have a hasDevices function', (done) => {
-        try {
-          assert.equal(true, typeof a.hasDevices === 'function');
-          done();
-        } catch (error) {
-          log.error(`Test Failure: ${error}`);
-          done(error);
-        }
-      });
-    });
-
     describe('#getDevice', () => {
       it('should have a getDevice function', (done) => {
         try {
@@ -1345,10 +1341,10 @@ describe('[unit] Meraki Adapter Test', () => {
       });
     });
 
-    describe('#getCount', () => {
-      it('should have a getCount function', (done) => {
+    describe('#iapGetDeviceCount', () => {
+      it('should have a iapGetDeviceCount function', (done) => {
         try {
-          assert.equal(true, typeof a.getCount === 'function');
+          assert.equal(true, typeof a.iapGetDeviceCount === 'function');
           done();
         } catch (error) {
           log.error(`Test Failure: ${error}`);

package/utils/adapterInfo.js

@@ -0,0 +1,206 @@
+#!/usr/bin/env node
+/* @copyright Itential, LLC 2019 */
+/* eslint global-require:warn */
+/* eslint import/no-dynamic-require:warn */
+/* eslint prefer-destructuring:warn */
+
+const fs = require('fs-extra');
+const path = require('path');
+
+/**
+ * This script will determine the information about the adapter and store
+ * it into a file in the adapter.
+ */
+
+/**
+ * get adapter information
+ */
+function adapterInfo() {
+  // set the base pase of the adapter - tool shoud be one level up in utils
+  let adaptdir = __dirname;
+  const infoRes = {};
+
+  if (adaptdir.endsWith('/utils')) {
+    adaptdir = adaptdir.substring(0, adaptdir.length - 6);
+  }
+  const pack = require(`${adaptdir}/package.json`);
+  infoRes.version = pack.version;
+
+  let configCount = 0;
+  if (fs.existsSync(`${adaptdir}/pronghorn.json`)) {
+    const cFile = fs.readFileSync(`${adaptdir}/pronghorn.json`, 'utf8');
+    configCount += cFile.split('\n').length;
+  } else {
+    console.log('Missing - pronghorn.json');
+  }
+  if (fs.existsSync(`${adaptdir}/propertiesSchema.json`)) {
+    const cFile = fs.readFileSync(`${adaptdir}/propertiesSchema.json`, 'utf8');
+    configCount += cFile.split('\n').length;
+  } else {
+    console.log('Missing - propertiesSchema.json');
+  }
+  if (fs.existsSync(`${adaptdir}/error.json`)) {
+    const cFile = fs.readFileSync(`${adaptdir}/error.json`, 'utf8');
+    configCount += cFile.split('\n').length;
+  } else {
+    console.log('Missing - error.json');
+  }
+  const entitydir = path.join(adaptdir, '/entities');
+  if (fs.existsSync(entitydir) && fs.statSync(entitydir).isDirectory()) {
+    const entities = fs.readdirSync(entitydir);
+    // need to go through each entity in the entities directory
+    for (let e = 0; e < entities.length; e += 1) {
+      if (fs.statSync(`${entitydir}/${entities[e]}`).isDirectory()) {
+        const cfiles = fs.readdirSync(entitydir);
+        for (let c = 0; c < cfiles.length; c += 1) {
+          if (cfiles[c].endsWith('.json')) {
+            const ccFile = fs.readFileSync(`${entitydir}/${entities[e]}/${cfiles[c]}`, 'utf8');
+            configCount += ccFile.split('\n').length;
+          }
+        }
+      }
+    }
+  } else {
+    console.log('Could not find the entities directory');
+  }
+  infoRes.configLines = configCount;
+
+  let scodeCount = 0;
+  if (fs.existsSync(`${adaptdir}/utils/artifactize.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/artifactize.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/artifactize.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/basicGet.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/basicGet.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/basicGet.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/checkMigrate.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/checkMigrate.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/checkMigrate.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/findPath.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/findPath.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/findPath.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/modify.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/modify.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/modify.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/packModificationScript.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/packModificationScript.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/packModificationScript.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/setup.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/setup.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/setup.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/tbScript.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/tbScript.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/tbScript.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/tbUtils.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/tbUtils.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/tbUtils.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/testRunner.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/testRunner.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/testRunner.js');
+  }
+  if (fs.existsSync(`${adaptdir}/utils/troubleshootingAdapter.js`)) {
+    const sFile = fs.readFileSync(`${adaptdir}/utils/troubleshootingAdapter.js`, 'utf8');
+    scodeCount += sFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/troubleshootingAdapter.js');
+  }
+  infoRes.scriptLines = scodeCount;
+
+  let codeCount = 0;
+  if (fs.existsSync(`${adaptdir}/adapter.js`)) {
+    const aFile = fs.readFileSync(`${adaptdir}/adapter.js`, 'utf8');
+    codeCount += aFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/adapter.js');
+  }
+  if (fs.existsSync(`${adaptdir}/adapterBase.js`)) {
+    const aFile = fs.readFileSync(`${adaptdir}/adapterBase.js`, 'utf8');
+    codeCount += aFile.split('\n').length;
+  } else {
+    console.log('Missing - utils/adapterBase.js');
+  }
+  infoRes.codeLines = codeCount;
+
+  let tcodeCount = 0;
+  let ttestCount = 0;
+  if (fs.existsSync(`${adaptdir}/test/integration/adapterTestBasicGet.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/integration/adapterTestBasicGet.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/integration/adapterTestBasicGet.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/integration/adapterTestConnectivity.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/integration/adapterTestConnectivity.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/integration/adapterTestConnectivity.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/integration/adapterTestIntegration.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/integration/adapterTestIntegration.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/integration/adapterTestIntegration.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/unit/adapterBaseTestUnit.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/unit/adapterBaseTestUnit.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/unit/adapterBaseTestUnit.js');
+  }
+  if (fs.existsSync(`${adaptdir}/test/unit/adapterTestUnit.js`)) {
+    const tFile = fs.readFileSync(`${adaptdir}/test/unit/adapterTestUnit.js`, 'utf8');
+    tcodeCount += tFile.split('\n').length;
+    ttestCount += tFile.split('it(\'').length;
+  } else {
+    console.log('Missing - test/unit/adapterTestUnit.js');
+  }
+  infoRes.testLines = tcodeCount;
+  infoRes.testCases = ttestCount;
+  infoRes.totalCodeLines = scodeCount + codeCount + tcodeCount;
+
+  if (fs.existsSync(`${adaptdir}/pronghorn.json`)) {
+    // Read the entity schema from the file system
+    const phFile = path.join(adaptdir, '/pronghorn.json');
+    const prong = require(phFile);
+    infoRes.wfTasks = prong.methods.length;
+  } else {
+    console.log('Missing - pronghorn.json');
+  }
+
+  console.log(JSON.stringify(infoRes));
+  fs.writeFileSync(`${adaptdir}/report/adapterInfo.json`, JSON.stringify(infoRes, null, 2));
+}
+
+adapterInfo();

package/utils/pre-commit.sh

@@ -17,6 +17,9 @@ printf "%b" "Running pre-commit hooks...\\n"
 # verify testing script is stubbed and no credentials
 node utils/testRunner.js -r
 
+# update the adapter information file
+node utils/adapterInfo.js
+
 # security audit on the code
 npm audit --registry=https://registry.npmjs.org --audit-level=moderate