@itentialopensource/adapter-microsoft_graph 1.4.8 → 1.5.0

package/utils/taskMover.js

@@ -9,30 +9,32 @@ const blacklistTasks = [
 ];
 
 const adapterBaseTasks = [
-    'getDevicesFiltered',
-    'isAlive',
-    'getConfig',
-    'getDevice',
-    'iapUpdateAdapterConfiguration',
-    'iapFindAdapterPath',
-    'iapSuspendAdapter',
-    'iapUnsuspendAdapter',
-    'iapGetAdapterQueue',
-    'iapTroubleshootAdapter',
-    'iapRunAdapterHealthcheck',
-    'iapRunAdapterConnectivity',
-    'iapRunAdapterBasicGet',
-    'iapMoveAdapterEntitiesToDB',
-    'getDevice',
-    'getDevicesFiltered',
-    'isAlive',
-    'getConfig',
-    'iapGetDeviceCount',
-    'iapRunAdapterLint',
-    'iapRunAdapterTests',
-    'iapGetAdapterInventory'
+  'getDevicesFiltered',
+  'isAlive',
+  'getConfig',
+  'getDevice',
+  'iapUpdateAdapterConfiguration',
+  'iapFindAdapterPath',
+  'iapSuspendAdapter',
+  'iapUnsuspendAdapter',
+  'iapGetAdapterQueue',
+  'iapTroubleshootAdapter',
+  'iapRunAdapterHealthcheck',
+  'iapRunAdapterConnectivity',
+  'iapRunAdapterBasicGet',
+  'iapMoveAdapterEntitiesToDB',
+  'getDevice',
+  'getDevicesFiltered',
+  'isAlive',
+  'getConfig',
+  'iapGetDeviceCount',
+  'iapRunAdapterLint',
+  'iapRunAdapterTests',
+  'iapGetAdapterInventory'
 ];
 
+let shouldExitWithFailure = false;
+
 function updatePronghorn(tasks, original, updated) {
   const originalFile = require(original);
   const unusedMethods = [];
@@ -57,15 +59,13 @@ function updatePronghorn(tasks, original, updated) {
   return 'Done';
 }
 
-function flipTaskFlag(task, pronghornPath, value)
-{
+function flipTaskFlag(task, pronghornPath, value) {
   const pronghorn = require(pronghornPath);
   const index = pronghorn.methods.findIndex((method) => method.name === task);
   pronghorn.methods[index] = { ...pronghorn.methods[index], task: value };
   fs.writeFileSync(pronghornPath, JSON.stringify(pronghorn, null, 2));
 }
 
-//Return array of relevant paths given adapter directory
 function createPaths(currentAdapter) {
   const paths = [];
   const filePaths = [
@@ -86,12 +86,8 @@ function insert(str, index, value) {
   return str.substr(0, index) + value + str.substr(index);
 }
 
-//modify adapter js
-//original - path to file containing tasks we want to remove
-// updated - path to file we want to move the tasks to
 function updateAdapterJs(tasks, original, updated, adapterDir) {
   if (!fs.existsSync(original)) {
-    //could do this or just let the error ocurr lower down and catch in warpper
     throw new Error(`Original file ${original} does not exist.`);
   }
   let originalFile = fs.readFileSync(original, 'utf8');
@@ -99,7 +95,6 @@ function updateAdapterJs(tasks, original, updated, adapterDir) {
   if (!fs.existsSync(updated)) {
     const adapterExport = require(`${adapterDir}/pronghorn.json`).export;
     updatedFile = `/* @copyright Itential, LLC 2019 */\n\n/* eslint import/no-dynamic-require: warn */\n/* eslint no-unused-vars: warn */\n/* global log */\n\nconst path = require('path');\n\nconst AdapterBaseCl = require(path.join(__dirname, 'adapterBase.js'));\n\nclass ${adapterExport}Inactive extends AdapterBaseCl {}\n`;
-    //To do handles backup files where og doesn't exist
   } else {
     updatedFile = fs.readFileSync(updated, 'utf8');
   }
@@ -223,6 +218,7 @@ function activateTasks(adapterDir, tasks) {
     return 'success';
   } catch (e) {
     console.log(`Error: ${e} ocurred during execution. Rolling back changes.`);
+    shouldExitWithFailure = true;
     for (let i = 0; i < backupFiles.length; i++) {
       const file = fs.readFileSync(backupFiles[i], 'utf8');
       fs.writeFileSync(filePaths[i], file, 'utf8');
@@ -233,7 +229,6 @@ function activateTasks(adapterDir, tasks) {
       }
     });
     deleteBackups(adapterDir);
-    process.exit(1);
   }
 }
 
@@ -290,6 +285,7 @@ function deactivateTasks(adapterDir, tasks) {
     return 'success';
   } catch (e) {
     console.log(`Error: ${e} ocurred during execution. Rolling back changes.`);
+    shouldExitWithFailure = true;
     for (let i = 0; i < backupFiles.length; i++) {
       const file = fs.readFileSync(backupFiles[i], 'utf8');
       fs.writeFileSync(filePaths[i], file, 'utf8');
@@ -300,10 +296,13 @@ function deactivateTasks(adapterDir, tasks) {
       }
     });
     deleteBackups(adapterDir);
-    process.exit(1);
   }
 }
 
+if (shouldExitWithFailure) {
+  process.exit(1);
+}
+
 module.exports = {
   activateTasks, deactivateTasks, rollbackChanges, deleteBackups
 };

package/utils/tbScript.js

@@ -1,190 +1,56 @@
-/* eslint-disable no-console */
-/* eslint import/no-unresolved: warn */
-/* eslint global-require: warn */
+/* @copyright Itential, LLC 2025 */
 
-// suppress eslint rule in adapter
-/* eslint arrow-parens: warn */
-/* eslint import/no-extraneous-dependencies: warn */
-/* eslint import/no-dynamic-require: warn */
+/**
+ * This script will determine which troubleshooting script the user is trying to run and then start the
+ * process to run it.
+ *
+ * This utility is executed from a script in the package.json by `node utils/tbScript.js <script>`. As a result,
+ * this utility is exposed and available to customers but exclusively through the CLI.
+ */
 
 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');
 const sampleProperties = require('../sampleProperties.json');
-const adapterPronghorn = require('../pronghorn.json');
-const { addAuthInfo } = require('./addAuth');
-
-const { troubleshoot, offline } = require('./troubleshootingAdapter');
-
-const executeInStandaloneMode = async (command) => {
-  console.info('\n> Executing the script outside of IAP installation directory');
+const { troubleshoot } = require('./troubleshootingAdapter');
+
+/**
+ * @summary tbScript is how many of the troubleshooting scripts are called from the command line (scripts in package.json)
+ *
+ *   execution:   node utils/tbScript.js healthcheck   (or one of the other supported scripts)
+ */
+const main = async (command, maxCalls) => {
   console.info('> Using sampleProperties.json configuration');
+  const samProps = sampleProperties.properties;
+
+  // perform the desired action
   switch (command) {
-    case 'install': {
-      console.error('Not currently in IAP directory - installation not possible');
-      break;
-    }
     case 'connectivity': {
-      const { host } = sampleProperties.properties;
+      const { host } = samProps;
       console.log(`perform networking diagnositics to ${host}`);
-      utils.runConnectivity(host);
+      utils.runConnectivity(host, true);
       break;
     }
     case 'healthcheck': {
-      const a = basicGet.getAdapterInstance({ properties: sampleProperties });
+      const a = utils.getAdapterInstance({ properties: sampleProperties });
+      console.log(`perform healthcheck on instantiated adapter with properties: ${sampleProperties.properties}`);
       await utils.healthCheck(a);
       break;
     }
     case 'basicget': {
-      utils.runBasicGet();
+      console.log(`perform basic get to ${samProps.host}`);
+      utils.runBasicGet(samProps, true, maxCalls);
       break;
     }
     default: {
       if (rls.keyInYN('Troubleshooting without IAP?')) {
-        await offline();
+        await troubleshoot(samProps, true, null);
       }
     }
   }
   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 === 'install') {
-    const { database, serviceItem, pronghornProps } = await utils.getAdapterConfig();
-    const filter = { id: pronghornProps.id };
-    const profileItem = await database.collection(utils.IAP_PROFILES_COLLECTION).findOne(filter);
-    if (!profileItem) {
-      console.log(`Could not find IAP profile for id ${pronghornProps.id}`);
-      process.exit(0);
-    }
-    if (serviceItem) {
-      console.log(`A service by the name ${name} already exits!`);
-      if (rls.keyInYN(`Do you want to completely remove ${name}?`)) {
-        console.log(`Removing ${name} from db...`);
-        await database.collection(utils.SERVICE_CONFIGS_COLLECTION).deleteOne({ model: name });
-        console.log(`${name} removed from db.`);
-        if (profileItem.services.includes(serviceItem.name)) {
-          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);
-          console.log(`${serviceItem.name} removed from profileItem.services.`);
-          console.log(`Rerun the script to reinstall ${serviceItem.name}.`);
-          process.exit(0);
-        } else {
-          process.exit(0);
-        }
-      } else {
-        console.log('Exiting...');
-        process.exit(0);
-      }
-    } else {
-      const dirname = utils.getCurrentExecutionPath();
-      utils.verifyInstallationDir(dirname, name);
-      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);
-        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);
-        console.log('Database entry creation complete.');
-      }
-      console.log('Exiting...');
-      process.exit(0);
-    }
-  } else if (['healthcheck', 'basicget', 'connectivity', 'troubleshoot'].includes(command)) {
-    await executeCommandOnInstance(command);
-  }
-};
-
-const main = async (command) => {
-  if (!utils.areWeUnderIAPinstallationDirectory()) {
-    executeInStandaloneMode(command); // configuration from sampleproperties.json
-  } else {
-    executeUnderIAPInstallationDirectory(command); // configuration from $IAP_HOME/properties.json
-  }
-};
-
 program
   .command('connectivity')
   .alias('c')
@@ -193,14 +59,6 @@ program
     main('connectivity');
   });
 
-program
-  .command('install')
-  .alias('i')
-  .description('install current adapter')
-  .action(() => {
-    main('install');
-  });
-
 program
   .command('healthcheck')
   .alias('hc')
@@ -213,8 +71,13 @@ program
   .command('basicget')
   .alias('bg')
   .description('perfom basicget')
-  .action(() => {
-    main('basicget');
+  .option(
+    '--maxcalls <n>',
+    'maximum number of GET calls (overrides default)',
+    parseInt
+  )
+  .action((cmd) => {
+    main('basicget', cmd.maxcalls);
   });
 
 program
@@ -225,13 +88,14 @@ program
     main('troubleshoot');
   });
 
-// Allow commander to parse `process.argv`
+// Allow commander to parse process.argv
+// tbScript is called with an argument of the desired script
 program.parse(process.argv);
 
 if (process.argv.length < 3) {
   main();
 }
-const allowedParams = ['install', 'healthcheck', 'basicget', 'connectivity', 'troubleshoot'];
+const allowedParams = ['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...');