@itentialopensource/adapter-microsoft_graph 1.0.1 → 1.1.0

package/utils/methodDocumentor.js

@@ -3,7 +3,7 @@
 /* eslint no-param-reassign:warn */
 
 const fs = require('fs-extra');
-const esprima = require('esprima');
+const acorn = require('acorn');
 
 // Getting the base directory:
 let adaptdir = __dirname;
@@ -44,18 +44,38 @@ function getPathFromEntity(entity, funcName) {
     const actionJSON = require(entityPath);
     actionJSON.actions.forEach((action) => {
       if (action.name === funcName) {
-        epath = action.entitypath;
+        if (typeof action.entitypath === 'object') {
+          epath = '';
+          const keys = Object.keys(action.entitypath);
+          for (let k = 0; k < keys.length; k += 1) {
+            epath += `${keys[k]}:${action.entitypath[keys[k]]} <br /> `;
+          }
+          epath = epath.substring(0, epath.length - 8);
+        } else {
+          epath = action.entitypath;
+        }
       }
     });
   }
   return epath;
 }
 
+function recurseCallExpressions(statement, callList) {
+  // Recursively finds all CallExpressions in the syntax tree
+  if (statement.type === 'CallExpression') callList.push(statement);
+  const keys = Object.keys(statement);
+  for (let k = 0; k < keys.length; k += 1) {
+    if (typeof statement[keys[k]] === 'object' && statement[keys[k]] !== null) {
+      recurseCallExpressions(statement[keys[k]], callList);
+    }
+  }
+}
+
 function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
   // read the file
   const aFile = fs.readFileSync(filename, 'utf8');
   // parsing the file to get the function and class declarations.
-  const aFileFuncArgs = esprima.parseScript(aFile);
+  const aFileFuncArgs = acorn.parse(aFile, { ecmaVersion: 2020 });
 
   // Looping through all the declarations parsed:
   aFileFuncArgs.body.forEach((e) => {
@@ -76,25 +96,40 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         });
 
         // Getting the entity for the method:
-        let entity;
-        method.value.body.body.forEach((statementType) => {
-          if (statementType.type === 'TryStatement') {
-            entity = statementType.block.body[0].argument.arguments[0].value;
-          }
+        const callList = [];
+        method.value.body.body.forEach((statement) => {
+          recurseCallExpressions(statement, callList);
         });
-        const entityPath = getPathFromEntity(entity, funcName);
-
-        // Creating and storing the object for the method.
-        if (entityPath !== undefined) {
-          functionList.push(
-            createObjectForFunction(
-              funcName,
-              funcArgs,
-              entityPath,
-              descriptionObj[funcName],
-              workflowObj[funcName]
-            )
-          );
+        const requests = [];
+        for (let i = 0; i < callList.length; i += 1) {
+          if (callList[i].callee.property && callList[i].callee.property.name === 'identifyRequest') {
+            requests.push(callList[i]);
+          }
+        }
+        if (requests.length > 0) {
+          const expr = requests[0];
+          if (expr.arguments.length < 2) {
+            throw new Error(`Bad inputs in method ${funcName}`);
+          }
+          const entity = expr.arguments[0].value;
+          const actionName = expr.arguments[1].value;
+          if (expr !== undefined && (expr.arguments[0].type !== 'Literal' || expr.arguments[1].type !== 'Literal')) {
+            throw new Error(`Bad inputs in method ${funcName}`);
+          }
+          const entityPath = getPathFromEntity(entity, actionName);
+
+          // Creating and storing the object for the method.
+          if (entityPath !== undefined) {
+            functionList.push(
+              createObjectForFunction(
+                funcName,
+                funcArgs,
+                entityPath,
+                descriptionObj[funcName],
+                workflowObj[funcName]
+              )
+            );
+          }
         }
       });
     }
@@ -109,7 +144,7 @@ function readJSONFile(filename, descriptionObj, workflowObj) {
   methodArray.forEach((methodName) => {
     // Getting the method description and workflow:
     const funcName = methodName.name;
-    descriptionObj[funcName] = methodName.description;
+    descriptionObj[funcName] = methodName.summary ? methodName.summary : methodName.description;
     workflowObj[funcName] = methodName.task ? 'Yes' : 'No';
   });
 }

package/utils/modify.js

@@ -1,7 +1,7 @@
+const { execSync } = require('child_process');
 const fs = require('fs-extra');
 const Ajv = require('ajv');
 const rls = require('readline-sync');
-const { execSync } = require('child_process');
 const { existsSync } = require('fs-extra');
 const { getAdapterConfig } = require('./tbUtils');
 const { name } = require('../package.json');
@@ -21,9 +21,7 @@ async function updateServiceItem() {
   const validate = ajv.compile(propertiesSchema);
   validate(currentProps);
   console.log('Updating Properties...');
-  await database.collection('service_configs').updateOne(
-    { model: name }, { $set: serviceItem }
-  );
+  await database.collection('service_configs').updateOne({ model: name }, { $set: serviceItem });
   console.log('Properties Updated');
 }
 
@@ -35,7 +33,7 @@ async function updateServiceItem() {
 function backup() {
   // zip all files except node_modules and package-lock
   const backupCmd = 'zip -r previousVersion.zip .';
-  execSync(backupCmd, { encoding: 'utf-8' });
+  execSync(backupCmd, { encoding: 'utf-8', maxBuffer: 1024 * 1024 * 2 });
 }
 
 /**
@@ -53,9 +51,9 @@ function archiveMod(modType) {
   const archiveName = `${modType}-${now.toISOString()}`;
   execSync(`mkdir adapter_modifications/archive/${archiveName}`);
   const archiveCmd = 'mv adapter_modifications/archive .'
-  + ` && mv adapter_modifications/* archive/${archiveName}`
-  + ' && mv archive adapter_modifications'
-  + ` && rm ${zipFile}`;
+    + ` && mv adapter_modifications/* archive/${archiveName}`
+    + ' && mv archive adapter_modifications'
+    + ` && rm ${zipFile}`;
   execSync(archiveCmd, { encoding: 'utf-8' });
 }
 
@@ -73,7 +71,7 @@ function revertMod() {
     }
   });
   // // unzip previousVersion, reinstall dependencies and delete zipfile
-  execSync('unzip -o previousVersion.zip && rm -rf node_modules && rm package-lock.json && npm install');
+  execSync('unzip -o previousVersion.zip && rm -rf node_modules && rm package-lock.json && npm install', { maxBuffer: 1024 * 1024 * 2 });
   execSync('rm previousVersion.zip');
   console.log('Changes have been reverted');
 }
@@ -90,12 +88,12 @@ if (flags === '-m') {
   backup();
   console.log('Migrating adapter and running tests...');
   const migrateCmd = 'unzip -o migrationPackage.zip'
-  + ' && cd adapter_modifications'
-  + ' && node migrate';
+    + ' && cd adapter_modifications'
+    + ' && node migrate';
   const migrateOutput = execSync(migrateCmd, { encoding: 'utf-8' });
   console.log(migrateOutput);
   if (migrateOutput.indexOf('Lint exited with code 1') >= 0
-  || migrateOutput.indexOf('Tests exited with code 1') >= 0) {
+    || migrateOutput.indexOf('Tests exited with code 1') >= 0) {
     if (rls.keyInYN('Adapter failed tests or lint after migrating. Would you like to revert the changes?')) {
       console.log('Reverting changes...');
       revertMod();
@@ -125,12 +123,12 @@ if (flags === '-u') {
   // Backup current adapter
   backup();
   const updateCmd = 'unzip -o updatePackage.zip'
-  + ' && cd adapter_modifications'
-  + ' && node update.js updateFiles';
+    + ' && cd adapter_modifications'
+    + ' && node update.js updateFiles';
   execSync(updateCmd, { encoding: 'utf-8' });
   const updateOutput = execSync(updateCmd, { encoding: 'utf-8' });
   if (updateOutput.indexOf('Lint exited with code 1') >= 0
-  || updateOutput.indexOf('Tests exited with code 1') >= 0) {
+    || updateOutput.indexOf('Tests exited with code 1') >= 0) {
     if (rls.keyInYN('Adapter failed tests or lint after updating. Would you like to revert the changes?')) {
       console.log('Reverting changes...');
       revertMod();

package/utils/packModificationScript.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 /* @copyright Itential, LLC 2019 */
 
-const fs = require('fs-extra');
 const path = require('path');
 const { spawnSync } = require('child_process');
+const fs = require('fs-extra');
 const { createBundle } = require('./artifactize');
 
 const nodeEntryPath = path.resolve('.');

package/utils/taskMover.js

@@ -0,0 +1,309 @@
+/* eslint-disable */
+const fs = require('fs');
+
+const blacklistTasks = [
+  'genericAdapterRequest',
+  'genericAdapterRequestNoBasePath',
+  'hasEntities',
+  'healthcheck'
+];
+
+const adapterBaseTasks = [
+    'getDevicesFiltered',
+    'isAlive',
+    'getConfig',
+    'getDevice',
+    'iapUpdateAdapterConfiguration',
+    'iapFindAdapterPath',
+    'iapSuspendAdapter',
+    'iapUnsuspendAdapter',
+    'iapGetAdapterQueue',
+    'iapTroubleshootAdapter',
+    'iapRunAdapterHealthcheck',
+    'iapRunAdapterConnectivity',
+    'iapRunAdapterBasicGet',
+    'iapMoveAdapterEntitiesToDB',
+    'getDevice',
+    'getDevicesFiltered',
+    'isAlive',
+    'getConfig',
+    'iapGetDeviceCount',
+    'iapRunAdapterLint',
+    'iapRunAdapterTests',
+    'iapGetAdapterInventory'
+];
+
+function updatePronghorn(tasks, original, updated) {
+  const originalFile = require(original);
+  const unusedMethods = [];
+  const usedMethods = originalFile.methods.filter((method) => {
+    if (tasks.includes(method.name)) {
+      unusedMethods.push(method);
+      return false;
+    }
+    return true;
+  });
+  //write used and unused to new files
+  let updatedFile;
+  if (!fs.existsSync(updated)) {
+    updatedFile = { ...originalFile, methods: [], src: 'adapter-inactive.js' };
+  } else {
+    updatedFile = require(updated);
+  }
+  updatedFile.methods = updatedFile.methods.concat(unusedMethods);
+  originalFile.methods = usedMethods;
+  fs.writeFileSync(updated, JSON.stringify(updatedFile, null, 2));
+  fs.writeFileSync(original, JSON.stringify(originalFile, null, 2));
+  return 'Done';
+}
+
+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 = [
+    'adapter.js',
+    'pronghorn.json',
+    'test/integration/adapterTestIntegration.js',
+    'test/unit/adapterTestUnit.js',
+    'adapter-inactive.js',
+    'pronghorn-inactive.json',
+  ];
+  filePaths.forEach((file) => {
+    paths.push(`${currentAdapter}/${file}`);
+  });
+  return paths;
+}
+
+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');
+  let updatedFile;
+  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');
+  }
+
+  tasks.forEach((method) => {
+    //accounting for different js docs format
+    const comment = originalFile.indexOf(`* @function ${method}`);
+    const start = originalFile.slice(0, comment).lastIndexOf('/**');
+    if (start !== -1) {
+      //next comment block
+      const end = originalFile.indexOf('/**\n', start + 1);
+      let func = end === -1
+        ? originalFile.substring(start - 3, originalFile.lastIndexOf('}'))
+        : originalFile.substring(start, end);
+      originalFile = originalFile.replace(func, '');
+      func = '\n  ' + func.trim() + '\n';
+      updatedFile = insert(updatedFile, updatedFile.lastIndexOf('}'), func);
+    } else {
+      console.log(`Task ${method} wasn't found in original file. Skipping.`);
+    }
+  });
+  fs.writeFileSync(original, originalFile, 'utf8');
+  fs.writeFileSync(updated, updatedFile, 'utf8');
+  return 'done';
+}
+
+//Update test file for when we deactivate a task
+function deactivateTest(adapterPath, testPath, tasks) {
+  let unitTest = fs.readFileSync(`${adapterPath}/${testPath}`, 'utf8');
+  tasks.forEach((task) => {
+    const searchStr = `describe('#${task}`;
+    unitTest = unitTest.replace(searchStr, `describe.skip('#${task}`);
+  });
+  fs.writeFileSync(`${adapterPath}/${testPath}`, unitTest, 'utf8');
+}
+
+//Update test file when we activate tasks
+function activateTest(adapterPath, testPath, tasks) {
+  let unitTest = fs.readFileSync(`${adapterPath}/${testPath}`, 'utf8');
+  //tasks ==> toMove
+  tasks.forEach((task) => {
+    const searchStr = `describe.skip('#${task}`;
+    unitTest = unitTest.replace(searchStr, `describe('#${task}`);
+  });
+  fs.writeFileSync(`${adapterPath}/${testPath}`, unitTest, 'utf8');
+}
+
+//backups are not actually being written back
+function rollbackChanges(adapterPath) {
+  const backups = fs.readdirSync(`${adapterPath}/temp`); //this is an array of file names not the full path
+  const filePaths = createPaths(adapterPath);
+  for (let i = 0; i < backups.length; i++) {
+    const file = fs.readFileSync(`${adapterPath}/temp/${backups[i]}`, 'utf8'); //make sure this is getting the file
+    const currentFile = filePaths.find((path) => {
+      const index = path.split('/').length - 1;
+      const fileName = path.split('/')[index];
+      return fileName === backups[i].replace('temp-', '');
+    }); //returns undefined if no match
+
+    if (currentFile) {
+      fs.writeFileSync(currentFile, file, 'utf8');
+    }
+  }
+  //inactive didn't exist before script
+  if (!backups.includes('temp-adapter-inactive.js')) {
+    fs.unlinkSync(`${adapterPath}/pronghorn-inactive.json`);
+    fs.unlinkSync(`${adapterPath}/adapter-inactive.js`);
+  }
+  deleteBackups(adapterPath);
+}
+
+function deleteBackups(adapterPath) {
+  fs.rmSync(`${adapterPath}/temp`, { recursive: true });
+}
+
+function activateTasks(adapterDir, tasks) {
+  const toDelete = [];
+  const backupFiles = [];
+  const filePaths = createPaths(adapterDir);
+  try {
+    //take backup of each file here
+    if (!fs.existsSync(`${adapterDir}/temp`)) {
+      fs.mkdirSync(`${adapterDir}/temp`);
+    }
+    filePaths.forEach((filePath) => {
+      if (fs.existsSync(filePath)) {
+        const index = filePath.split('/').length - 1;
+        const backupName = `temp-${filePath.split('/')[index]}`;
+        backupFiles.push(`${adapterDir}/temp/${backupName}`);
+        fs.copyFileSync(filePath, `${adapterDir}/temp/${backupName}`);
+      } else {
+        //File doesn't exist before script
+        toDelete.push(filePath);
+      }
+    });
+    tasks = tasks.filter((task) => {
+      if (adapterBaseTasks.includes(task)) {
+        flipTaskFlag(task, `${adapterDir}/pronghorn.json`, true);
+        return false;
+      } else {
+        return true;
+      }
+    });
+    updateAdapterJs(
+      tasks,
+      `${adapterDir}/adapter-inactive.js`,
+      `${adapterDir}/adapter.js`,
+      adapterDir
+    );
+    updatePronghorn(
+      tasks,
+      `${adapterDir}/pronghorn-inactive.json`,
+      `${adapterDir}/pronghorn.json`
+    );
+    activateTest(
+      adapterDir,
+      '/test/integration/adapterTestIntegration.js',
+      tasks
+    );
+    activateTest(adapterDir, '/test/unit/adapterTestUnit.js', tasks);
+    return 'success';
+  } catch (e) {
+    console.log(`Error: ${e} ocurred during execution. Rolling back changes.`);
+    for (let i = 0; i < backupFiles.length; i++) {
+      const file = fs.readFileSync(backupFiles[i], 'utf8');
+      fs.writeFileSync(filePaths[i], file, 'utf8');
+    }
+    toDelete.forEach((filePath) => {
+      if (fs.existsSync(filePath)) {
+        fs.unlinkSync(filePath);
+      }
+    });
+    deleteBackups(adapterDir);
+    process.exit(1);
+  }
+}
+
+//moving from adapter.js to adapter-inactive.js
+function deactivateTasks(adapterDir, tasks) {
+  const toDelete = [];
+  const backupFiles = [];
+  const filePaths = createPaths(adapterDir);
+  try {
+    //take backup of each file here
+    if (!fs.existsSync(`${adapterDir}/temp`)) {
+      fs.mkdirSync(`${adapterDir}/temp`);
+    }
+    filePaths.forEach((filePath) => {
+      if (fs.existsSync(filePath)) {
+        const index = filePath.split('/').length - 1;
+        const backupName = `temp-${filePath.split('/')[index]}`;
+        backupFiles.push(`${adapterDir}/temp/${backupName}`);
+        fs.copyFileSync(filePath, `${adapterDir}/temp/${backupName}`);
+      } else {
+        //File doesn't exist before script
+        toDelete.push(filePath);
+      }
+    });
+    //filter tasks for blacklisted tasks or IAP tasks
+    tasks = tasks.filter((task) => {
+      if (blacklistTasks.includes(task)) {
+        console.log(`${task} cannot be deactivated.`);
+        return false;
+      } else if (adapterBaseTasks.includes(task)) {
+        flipTaskFlag(task, `${adapterDir}/pronghorn.json`, false);
+        return false;
+      } else {
+        return true;
+      }
+    });
+    updateAdapterJs(
+      tasks,
+      `${adapterDir}/adapter.js`,
+      `${adapterDir}/adapter-inactive.js`,
+      adapterDir
+    );
+    updatePronghorn(
+      tasks,
+      `${adapterDir}/pronghorn.json`,
+      `${adapterDir}/pronghorn-inactive.json`
+    );
+    deactivateTest(
+      adapterDir,
+      '/test/integration/adapterTestIntegration.js',
+      tasks
+    );
+    deactivateTest(adapterDir, '/test/unit/adapterTestUnit.js', tasks);
+    return 'success';
+  } catch (e) {
+    console.log(`Error: ${e} ocurred during execution. Rolling back changes.`);
+    for (let i = 0; i < backupFiles.length; i++) {
+      const file = fs.readFileSync(backupFiles[i], 'utf8');
+      fs.writeFileSync(filePaths[i], file, 'utf8');
+    }
+    toDelete.forEach((filePath) => {
+      if (fs.existsSync(filePath)) {
+        fs.unlinkSync(filePath);
+      }
+    });
+    deleteBackups(adapterDir);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  activateTasks, deactivateTasks, rollbackChanges, deleteBackups
+};

package/utils/tbScript.js

@@ -143,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);
@@ -162,18 +160,13 @@ 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...');

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',
@@ -158,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 };
   },
 

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

@@ -160,9 +160,7 @@ 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.`);
         }

package/workflows/README.md

@@ -1,3 +0,0 @@
-# Adapter Workflows
-
-This directory contains workflows that support the adapter use cases. These workflows can be imported into IAP. If the adapter is installed using App-Artifact the workflows should be automatically imported.