@itentialopensource/adapter-meraki 1.0.3 → 1.1.0

package/utils/methodDocumentor.js

@@ -0,0 +1,225 @@
+/* eslint global-require:warn */
+/* eslint import/no-dynamic-require:warn */
+/* eslint no-param-reassign:warn */
+
+const fs = require('fs-extra');
+const esprima = require('esprima');
+
+// Getting the base directory:
+let adaptdir = __dirname;
+if (adaptdir.endsWith('/utils')) {
+  adaptdir = adaptdir.substring(0, adaptdir.length - 6);
+}
+
+function createObjectForFunction(
+  funcName,
+  funcArgs,
+  entityPath,
+  description,
+  workflow
+) {
+  const funcObject = {};
+  // if the entity path is not set, then the object is not created.
+  if (entityPath !== undefined) {
+    funcObject.method_signature = `${funcName}(${funcArgs.join(', ')})`;
+    funcObject.path = entityPath;
+    if (description === undefined) {
+      funcObject.description = '';
+      funcObject.workflow = 'No';
+    } else {
+      funcObject.description = description;
+      funcObject.workflow = workflow;
+    }
+  }
+  return funcObject;
+}
+
+function getPathFromEntity(entity, funcName) {
+  let epath;
+  if (entity === undefined || entity === '.generic') {
+    epath = undefined;
+  } else {
+    // Access the action.js file for the certain entity to get the path
+    const entityPath = `${adaptdir}/entities/${entity}/action.json`;
+    const actionJSON = require(entityPath);
+    actionJSON.actions.forEach((action) => {
+      if (action.name === funcName) {
+        epath = action.entitypath;
+      }
+    });
+  }
+  return epath;
+}
+
+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);
+
+  // Looping through all the declarations parsed:
+  aFileFuncArgs.body.forEach((e) => {
+    // Getting only the class declaration as it has our required functions.
+    if (e.type === 'ClassDeclaration') {
+      const methodDefinition = e.body;
+      methodDefinition.body.forEach((method) => {
+        // Getting method name and its params in the class.
+        const funcName = method.key.name;
+        const funcArgs = [];
+        method.value.params.forEach((param) => {
+          if (param.type === 'Identifier') {
+            funcArgs.push(param.name);
+          } else {
+            const args = `${param.left.name} = ${param.right.value}`;
+            funcArgs.push(args);
+          }
+        });
+
+        // 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 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]
+            )
+          );
+        }
+      });
+    }
+  });
+}
+
+function readJSONFile(filename, descriptionObj, workflowObj) {
+  // Accessing the JSON file.
+  const phJSON = require(filename);
+  // Getting the methods array.
+  const methodArray = phJSON.methods;
+  methodArray.forEach((methodName) => {
+    // Getting the method description and workflow:
+    const funcName = methodName.name;
+    descriptionObj[funcName] = methodName.description;
+    workflowObj[funcName] = methodName.task ? 'Yes' : 'No';
+  });
+}
+
+function readMDFile(filename, functionList) {
+  // Reading in the .md file and creating an array with each line as an element.
+  const mdFile = fs.readFileSync(filename, 'utf-8');
+  const fileSplit = mdFile.split('\n');
+  // Storing the data that should added later to the updated data.
+  const linesToAddLater = [];
+  let index = fileSplit.length - 1;
+
+  // Removing all the blank lines at the end of the file.
+  if (fileSplit[index] === '') {
+    while (fileSplit[index] === '') {
+      linesToAddLater.push(fileSplit.pop());
+      index -= 1;
+    }
+  }
+
+  // Checking if the last 2 lines are <br> and </table>. If not, the file is corrupted and the
+  // data at the end of the file should be fixed.
+  if (fileSplit[index] === '<br>' || fileSplit[index - 1] === '</table>') {
+    // Storing <br> and </table> to add later.
+    linesToAddLater.push(fileSplit.pop());
+    linesToAddLater.push(fileSplit.pop());
+    index -= 2;
+  } else {
+    console.log('The file has bad content at the end.');
+    return;
+  }
+  // if (fileSplit[index] !== '<br>' && fileSplit[index - 1] !== '</table>') {
+  //   console.log('The file has bad content at the end.');
+  //   return;
+  // } else {
+  //   // Storing <br> and </table> to add later.
+  //   linesToAddLater.push(fileSplit.pop());
+  //   linesToAddLater.push(fileSplit.pop());
+  //   index -= 2;
+  // }
+
+  // Removing all the lines until the header tags are reached.
+  while (!fileSplit[index].includes('<th')) {
+    fileSplit.pop();
+    index -= 1;
+  }
+  // Adding </tr> for the header row, because it got removed in the above loop.
+  fileSplit.push('  </tr>');
+
+  // Creating the tags for each method to be appended to the file.
+  const tdBeginTag = '    <td style="padding:15px">';
+  const tdEndTag = '</td>';
+  functionList.forEach((func) => {
+    const signCommand = `${tdBeginTag}${func.method_signature}${tdEndTag}`;
+    const descCommand = `${tdBeginTag}${func.description}${tdEndTag}`;
+    const pathCommand = `${tdBeginTag}${func.path}${tdEndTag}`;
+    const workflowCommand = `${tdBeginTag}${func.workflow}${tdEndTag}`;
+    fileSplit.push('  <tr>');
+    fileSplit.push(signCommand);
+    fileSplit.push(descCommand);
+    fileSplit.push(pathCommand);
+    fileSplit.push(workflowCommand);
+    fileSplit.push('  </tr>');
+  });
+
+  // Adding </table> and <br> at the end of the file to complete the table and the file.
+  while (linesToAddLater.length > 0) {
+    fileSplit.push(linesToAddLater.pop());
+  }
+
+  // Writing all the content back into the file.
+  fs.writeFileSync(filename, fileSplit.join('\n'), {
+    encoding: 'utf-8',
+    flag: 'w'
+  });
+}
+
+function getFileInfo() {
+  // If files don't exist:
+  if (!fs.existsSync(`${adaptdir}/adapter.js`)) {
+    console.log('Missing - utils/adapter.js');
+    return;
+  }
+  if (!fs.existsSync(`${adaptdir}/pronghorn.json`)) {
+    console.log('Missing - pronghorn.json');
+    return;
+  }
+  if (!fs.existsSync(`${adaptdir}/CALLS.md`)) {
+    console.log('Missing - CALLS.md');
+    return;
+  }
+
+  const descriptionObj = {};
+  const workflowObj = {};
+
+  // Get the method descriptions and the workflow values from pronghorn.json file.
+  readJSONFile(`${adaptdir}/pronghorn.json`, descriptionObj, workflowObj);
+
+  // Get the method signature, entity path and create an object that contains all the info regarding
+  // the method and push it to the functionList array.
+  const functionList = [];
+  readFileUsingLib(
+    `${adaptdir}/adapter.js`,
+    descriptionObj,
+    workflowObj,
+    functionList
+  );
+
+  // createMarkDown(functionList);
+  readMDFile(`${adaptdir}/CALLS.md`, functionList);
+}
+
+getFileInfo();

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/pre-commit.sh

@@ -19,6 +19,8 @@ node utils/testRunner.js -r
 
 # update the adapter information file
 node utils/adapterInfo.js
+node utils/methodDocumentor.js
+git add CALLS.md report/adapterInfo.json
 
 # security audit on the code
 npm audit --registry=https://registry.npmjs.org --audit-level=moderate

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
+};