@itentialopensource/adapter-meraki 1.0.3 → 1.1.0

package/utils/tbScript.js

@@ -9,6 +9,7 @@
 
 const program = require('commander');
 const rls = require('readline-sync');
+const prompts = require('prompts');
 const utils = require('./tbUtils');
 const basicGet = require('./basicGet');
 const { name } = require('../package.json');
@@ -50,10 +51,81 @@ const executeInStandaloneMode = async (command) => {
   process.exit(0);
 };
 
+const getAdapterInstanceConfig = async (command) => {
+  const instances = await utils.getAllAdapterInstances();
+  if (!instances || instances.length === 0) {
+    return console.log('None adapter instances found!');
+  }
+
+  let instance;
+  if (instances.length === 1) {
+    [instance] = instances;
+  } else {
+    const choices = instances.map((item) => ({ title: item.name }));
+    const menu = {
+      type: 'select',
+      name: 'index',
+      message: `Pick an adapter for ${command} check`,
+      choices
+    };
+
+    console.log('\n');
+    const selected = await prompts(menu);
+    console.log('\n');
+    instance = instances[selected.index];
+  }
+
+  if (!instance) {
+    console.error('No adapter instance selected');
+    return null;
+  }
+
+  const { serviceItem: adapterConfig } = await utils.getAdapterConfig(instance._id); /* eslint-disable-line no-underscore-dangle */
+
+  console.log('\nAdapter instance configuration =>');
+  console.log('======================================');
+  console.log(adapterConfig);
+  console.log('======================================');
+
+  return adapterConfig;
+};
+
+const executeCommandOnInstance = async (command) => {
+  const adapterConfig = await getAdapterInstanceConfig(command);
+  if (!adapterConfig) {
+    process.exit(0);
+  }
+
+  switch (command) {
+    case 'connectivity': {
+      const { host } = adapterConfig.properties.properties;
+      console.log(`perform networking diagnositics to ${host}`);
+      utils.runConnectivity(host, true);
+      break;
+    }
+    case 'healthcheck': {
+      const adapterInstance = basicGet.getAdapterInstance(adapterConfig);
+      await utils.healthCheck(adapterInstance);
+      break;
+    }
+    case 'basicget': {
+      utils.runBasicGet(true);
+      break;
+    }
+    case 'troubleshoot': {
+      const adapter = { properties: adapterConfig };
+      await troubleshoot({}, true, true, adapter);
+      break;
+    }
+    default: {
+      console.error(`Unknown command: ${command}`);
+    }
+  }
+  return process.exit(0);
+};
+
 const executeUnderIAPInstallationDirectory = async (command) => {
-  if (command === undefined) {
-    await troubleshoot({}, true, true);
-  } else if (command === 'install') {
+  if (command === 'install') {
     const { database, serviceItem, pronghornProps } = await utils.getAdapterConfig();
     const filter = { id: pronghornProps.id };
     const profileItem = await database.collection(utils.IAP_PROFILES_COLLECTION).findOne(filter);
@@ -71,9 +143,7 @@ const executeUnderIAPInstallationDirectory = async (command) => {
           const serviceIndex = profileItem.services.indexOf(serviceItem.name);
           profileItem.services.splice(serviceIndex, 1);
           const update = { $set: { services: profileItem.services } };
-          await database.collection(utils.IAP_PROFILES_COLLECTION).updateOne(
-            { id: pronghornProps.id }, update
-          );
+          await database.collection(utils.IAP_PROFILES_COLLECTION).updateOne({ id: pronghornProps.id }, update);
           console.log(`${serviceItem.name} removed from profileItem.services.`);
           console.log(`Rerun the script to reinstall ${serviceItem.name}.`);
           process.exit(0);
@@ -90,43 +160,20 @@ const executeUnderIAPInstallationDirectory = async (command) => {
       utils.runTest();
       if (rls.keyInYN(`Do you want to install ${name} to IAP?`)) {
         console.log('Creating database entries...');
-        const adapter = utils.createAdapter(
-          pronghornProps, profileItem, sampleProperties, adapterPronghorn
-        );
-
+        const adapter = utils.createAdapter(pronghornProps, profileItem, sampleProperties, adapterPronghorn);
         adapter.properties.properties = await addAuthInfo(adapter.properties.properties);
 
         await database.collection(utils.SERVICE_CONFIGS_COLLECTION).insertOne(adapter);
         profileItem.services.push(adapter.name);
         const update = { $set: { services: profileItem.services } };
-        await database.collection(utils.IAP_PROFILES_COLLECTION).updateOne(
-          { id: pronghornProps.id }, update
-        );
+        await database.collection(utils.IAP_PROFILES_COLLECTION).updateOne({ id: pronghornProps.id }, update);
         console.log('Database entry creation complete.');
       }
       console.log('Exiting...');
       process.exit(0);
     }
-  } else if (['healthcheck', 'basicget', 'connectivity'].includes(command)) {
-    const { serviceItem } = await utils.getAdapterConfig();
-    if (serviceItem) {
-      const adapter = serviceItem;
-      const a = basicGet.getAdapterInstance(adapter);
-      if (command === 'healthcheck') {
-        await utils.healthCheck(a);
-        process.exit(0);
-      } else if (command === 'basicget') {
-        await utils.runBasicGet(true);
-      } else if (command === 'connectivity') {
-        const { host } = adapter.properties.properties;
-        console.log(`perform networking diagnositics to ${host}`);
-        await utils.runConnectivity(host, true);
-        process.exit(0);
-      }
-    } else {
-      console.log(`${name} not installed. Run npm \`run install:adapter\` to install.`);
-      process.exit(0);
-    }
+  } else if (['healthcheck', 'basicget', 'connectivity', 'troubleshoot'].includes(command)) {
+    await executeCommandOnInstance(command);
   }
 };
 
@@ -170,13 +217,21 @@ program
     main('basicget');
   });
 
+program
+  .command('troubleshoot')
+  .alias('tb')
+  .description('perfom troubleshooting')
+  .action(() => {
+    main('troubleshoot');
+  });
+
 // Allow commander to parse `process.argv`
 program.parse(process.argv);
 
 if (process.argv.length < 3) {
   main();
 }
-const allowedParams = ['install', 'healthcheck', 'basicget', 'connectivity'];
+const allowedParams = ['install', 'healthcheck', 'basicget', 'connectivity', 'troubleshoot'];
 if (process.argv.length === 3 && !allowedParams.includes(process.argv[2])) {
   console.log(`unknown parameter ${process.argv[2]}`);
   console.log('try `node troubleshootingAdapter.js -h` to see allowed parameters. Exiting...');

package/utils/tbUtils.js

@@ -6,8 +6,8 @@
 /* eslint-disable no-console */
 
 const path = require('path');
-const fs = require('fs-extra');
 const cp = require('child_process');
+const fs = require('fs-extra');
 
 module.exports = {
   SERVICE_CONFIGS_COLLECTION: 'service_configs',
@@ -101,10 +101,8 @@ module.exports = {
    *
    * @function decryptProperties
    */
-  decryptProperties: (props, iapDir, discovery) => {
-    const propertyEncryptionClassPath = path.join(iapDir, 'node_modules/@itential/pronghorn-core/core/PropertyEncryption.js');
-    const isEncrypted = props.pathProps.encrypted;
-    const PropertyEncryption = discovery.require(propertyEncryptionClassPath, isEncrypted);
+  decryptProperties: (props, iapDir) => {
+    const { PropertyEncryption } = require(path.join(iapDir, 'node_modules/@itential/itential-utils'));
     const propertyEncryption = new PropertyEncryption({
       algorithm: 'aes-256-ctr',
       key: 'TG9uZ0Rpc3RhbmNlUnVubmVyUHJvbmdob3JuCg==',
@@ -160,8 +158,7 @@ module.exports = {
    * @param {Object} healthcheck - {Object} healthcheck - ./entities/.system/action.json object
    */
   getHealthCheckEndpoint: (healthcheck) => {
-    const endpoint = healthcheck.actions[1].entitypath.slice(21,
-      healthcheck.actions[1].entitypath.length - 8);
+    const endpoint = healthcheck.actions[1].entitypath.slice(21, healthcheck.actions[1].entitypath.length - 8);
     return { healthCheckEndpoint: endpoint };
   },
 
@@ -203,6 +200,7 @@ module.exports = {
       try {
         stdout = cp.execSync(cmd).toString();
       } catch (error) {
+        console.log('execute command error', error.stdout.toString(), error.stderr.toString());
         stdout = error.stdout.toString();
       }
       const output = this.getTestCount(stdout);
@@ -290,10 +288,12 @@ module.exports = {
    */
   runConnectivity: function runConnectivity(host, scriptFlag) {
     let testPath = 'test/integration/adapterTestConnectivity.js';
+    let executable = 'mocha';
     if (!scriptFlag) {
       testPath = path.resolve(__dirname, '..', testPath);
+      executable = path.join(__dirname, '..', 'node_modules/mocha/bin/mocha');
     }
-    return this.systemSync(`mocha ${testPath} --HOST=${host} --timeout 10000 --exit`, !scriptFlag);
+    return this.systemSync(`${executable} ${testPath} --HOST=${host} --timeout 10000 --exit`, !scriptFlag);
   },
 
   /**
@@ -340,28 +340,42 @@ module.exports = {
     return adapter;
   },
 
-  getPronghornProps: function getPronghornProps(iapDir) {
+  getPronghornProps: function getPronghornProps() {
+    const iapDir = this.getIAPHome();
     console.log('Retrieving properties.json file...');
     const rawProps = require(path.join(iapDir, 'properties.json'));
     console.log('Decrypting properties...');
-    const { Discovery } = require(path.join(iapDir, 'node_modules/@itential/itential-utils'));
-    const discovery = new Discovery();
-    const pronghornProps = this.decryptProperties(rawProps, iapDir, discovery);
+    const pronghornProps = this.decryptProperties(rawProps, iapDir);
     console.log('Found properties.\n');
     return pronghornProps;
   },
 
+  getAllAdapterInstances: async function getAllAdapterInstances() {
+    const database = await this.getIAPDatabaseConnection();
+    const { name } = require(path.join(__dirname, '..', 'package.json'));
+    const query = { model: name };
+    const options = { projection: { name: 1 } };
+    const adapterInstancesNames = await database.collection(this.SERVICE_CONFIGS_COLLECTION).find(
+      query,
+      options
+    ).toArray();
+    return adapterInstancesNames;
+  },
+
   // get database connection and existing adapter config
-  getAdapterConfig: async function getAdapterConfig() {
-    const iapDir = this.getIAPHome();
-    const pronghornProps = this.getPronghornProps(iapDir);
-    console.log('Connecting to Database...');
-    const database = await this.connect(iapDir, pronghornProps);
-    console.log('Connection established.');
+  getAdapterConfig: async function getAdapterConfig(adapterId) {
+    const database = await this.getIAPDatabaseConnection();
     const { name } = require(path.join(__dirname, '..', 'package.json'));
+    let query = {};
+    if (!adapterId) {
+      query = { model: name };
+    } else {
+      query = { _id: adapterId };
+    }
     const serviceItem = await database.collection(this.SERVICE_CONFIGS_COLLECTION).findOne(
-      { model: name }
+      query
     );
+    const pronghornProps = await this.getPronghornProps();
     return { database, serviceItem, pronghornProps };
   },
 
@@ -438,13 +452,19 @@ module.exports = {
     return path.join(this.getCurrentExecutionPath(), '../../..') === this.getIAPHome();
   },
 
+  getIAPDatabaseConnection: async function getIAPDatabaseConnection() {
+    const pronghornProps = await this.getPronghornProps();
+    const database = await this.connect(pronghornProps);
+    return database;
+  },
+
   /**
    * @summary connect to mongodb
    *
    * @function connect
    * @param {Object} properties - pronghornProps
    */
-  connect: async function connect(iapDir, properties) {
+  connect: async function connect(properties) {
     let dbConnectionProperties = {};
     if (properties.mongoProps) {
       dbConnectionProperties = properties.mongoProps;
@@ -459,7 +479,7 @@ module.exports = {
     if (!dbConnectionProperties.url || !dbConnectionProperties.db) {
       throw new Error('Mongo properties are not specified in IAP configuration!');
     }
-
+    const iapDir = this.getIAPHome();
     const { MongoDBConnection } = require(path.join(iapDir, 'node_modules/@itential/database'));
     const connection = new MongoDBConnection(dbConnectionProperties);
     const database = await connection.connect(true);

package/utils/testRunner.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 /* @copyright Itential, LLC 2019 */
 
+const execute = require('child_process').exec;
 const fs = require('fs-extra');
 const rl = require('readline-sync');
-const execute = require('child_process').exec;
 
 /**
  * This script will determine the type of integration test to run

package/utils/troubleshootingAdapter.js

@@ -134,9 +134,13 @@ const offline = async () => {
 };
 
 const troubleshoot = async (props, scriptFlag, persistFlag, adapter) => {
-  // get database connection and existing adapter config
-  const { database, serviceItem } = await utils.getAdapterConfig();
-  // where troubleshoot should start
+  let serviceItem;
+  if (adapter && adapter.allProps) {
+    serviceItem = { properties: { properties: adapter.allProps } };
+  }
+  if (adapter && adapter.properties && adapter.properties.properties) {
+    serviceItem = adapter.properties;
+  }
   if (serviceItem) {
     if (!scriptFlag || rls.keyInYN(`Start verifying the connection and authentication properties for ${name}?`)) {
       const { result, updatedAdapter } = VerifyHealthCheckEndpoint(serviceItem, props, scriptFlag);
@@ -154,10 +158,9 @@ const troubleshoot = async (props, scriptFlag, persistFlag, adapter) => {
       }
 
       if (persistFlag && healthRes) {
+        const { database } = await utils.getIAPDatabaseConnection();
         const update = { $set: { properties: updatedAdapter.properties } };
-        await database.collection(utils.SERVICE_CONFIGS_COLLECTION).updateOne(
-          { model: name }, update
-        );
+        await database.collection(utils.SERVICE_CONFIGS_COLLECTION).updateOne({ model: name }, update);
         if (scriptFlag) {
           console.log(`${name} updated.`);
         }