@itentialopensource/adapter-oracle_cloud 0.1.1 → 0.3.0

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 path = require('path');
+const fs = require('fs-extra');
+
+/**
+ * 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/addAuth.js

@@ -2,9 +2,9 @@
 /* eslint global-require: warn */
 /* eslint import/no-dynamic-require: warn */
 
-const rls = require('readline-sync');
 const path = require('path');
 const fs = require('fs');
+const rls = require('readline-sync');
 
 function getQuestions(props, obj) {
   const questions = props.map((p) => `${p}: ${(obj[p] !== undefined) ? `(${obj[p]})` : ''} `);

package/utils/artifactize.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 /* @copyright Itential, LLC 2019 */
 
-const fs = require('fs-extra');
 const path = require('path');
+const fs = require('fs-extra');
 
 async function createBundle(adapterOldDir) {
   // set directories

package/utils/checkMigrate.js

@@ -1,7 +1,7 @@
 const { execSync } = require('child_process');
+const fs = require('fs');
 const semver = require('semver');
 const axios = require('axios');
-const fs = require('fs');
 const packageJson = require('../package.json');
 
 const localEngineVer = packageJson.engineVersion;

package/utils/entitiesToDB.js

@@ -7,6 +7,7 @@
 /* eslint global-require: warn */
 /* eslint no-unused-vars: warn */
 /* eslint import/no-unresolved: warn */
+/* eslint no-promise-executor-return: warn */
 
 /**
  *  This script is used to read through an adapter's entities files
@@ -14,10 +15,8 @@
  */
 
 const fs = require('fs');
-const { MongoClient } = require('mongodb');
 const path = require('path');
-// const { argv } = require('process');
-// const { string } = require('yargs');
+const utils = require('./tbUtils');
 
 // get the pronghorn database information
 const getPronghornProps = async (iapDir) => {
@@ -99,7 +98,7 @@ const optionsHandler = (options) => {
 /**
  *  Function used to put the adapter configuration into the provided database
  */
-const moveEntitiesToDB = (targetPath, options) => {
+const moveEntitiesToDB = async (targetPath, options) => {
   // set local variables
   let myOpts = options;
   let myPath = targetPath;
@@ -120,25 +119,7 @@ const moveEntitiesToDB = (targetPath, options) => {
   }
 
   // get the pronghorn database properties
-  optionsHandler(options).then((currentProps) => {
-    let mongoUrl;
-    let dbName;
-
-    // find the mongo properties so we can connect
-    if (currentProps.mongoProps) {
-      mongoUrl = currentProps.mongoProps.url;
-      dbName = currentProps.mongoProps.db;
-    } else if (currentProps.mongo) {
-      if (currentProps.mongo.url) {
-        mongoUrl = currentProps.mongo.url;
-      } else {
-        mongoUrl = `mongodb://${currentProps.mongo.host}:${currentProps.mongo.port}`;
-      }
-      dbName = currentProps.mongo.database;
-    } else {
-      throw new Error('Mongo properties are not specified in adapter preferences!');
-    }
-
+  return optionsHandler(options).then(async (currentProps) => {
     // Check valid filepath provided
     if (!myPath) {
       // if no path use the current directory without the utils
@@ -184,41 +165,15 @@ const moveEntitiesToDB = (targetPath, options) => {
     });
 
     // Upload documents to db collection
-    MongoClient.connect(mongoUrl, (err, db) => {
-      if (err) {
-        log.error(JSON.stringify(err));
-        throw err;
-      }
-
-      // get the proper collection
-      const collection = db.db(dbName).collection(myOpts.targetCollection);
-      // insert the documents into the collection
-      collection.insertMany(docs, { checkKeys: false }, (error, res) => {
-        if (error) {
-          log.error(JSON.stringify(error));
-          throw error;
-        }
-        // log the insertion, close the database and return
-        log.debug(`Inserted ${docs.length} documents to ${dbName}.${myOpts.targetCollection} with response ${JSON.stringify(res)}`);
-        db.close();
-        return res;
-      });
-    });
+    const db = await utils.connect(currentProps).catch((err) => { console.error(err); throw err; });
+    if (!db) {
+      console.error('Error occured when connectiong to database', currentProps);
+      throw new Error('Database not found');
+    }
+    const collection = db.collection(myOpts.targetCollection);
+    const res = await collection.insertMany(docs, { checkKeys: false }).catch((err) => { console.error(err); throw err; });
+    return res;
   });
 };
 
-// const args = process.argv.slice(2);
-
-// throw new SyntaxError(args[0]);
-
-// if (args.length === 0) {
-//   console.error('ERROR: target path not specified!');
-// } else if (args[0] === 'help') {
-//   log.trace('node ./entitiesToDB <target path> <options object: {iapDir: string, pronghornProps: string, targetCollection: string}>');
-// } else if (args.length === 1) {
-//   console.error('ERROR: IAP directory not specified');
-// } else {
-//   moveEntitiesToDB(args[0], args[1]);
-// }
-
 module.exports = { moveEntitiesToDB };

package/utils/findPath.js

@@ -4,8 +4,8 @@
 /* eslint import/no-dynamic-require:warn */
 /* eslint prefer-destructuring:warn */
 
-const fs = require('fs-extra');
 const path = require('path');
+const fs = require('fs-extra');
 const rls = require('readline-sync');
 
 /**

package/utils/methodDocumentor.js

@@ -0,0 +1,273 @@
+/* eslint global-require:warn */
+/* eslint import/no-dynamic-require:warn */
+/* eslint no-param-reassign:warn */
+
+const fs = require('fs-extra');
+const acorn = require('acorn');
+
+// 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) {
+        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 = acorn.parse(aFile, { ecmaVersion: 2020 });
+
+  let callName = 'identifyRequest';
+  // 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 if (param.type === 'RestElement') {
+            funcArgs.push(`...${param.argument.name}`);
+          } else {
+            const args = `${param.left.name} = ${param.right.raw}`;
+            funcArgs.push(args);
+          }
+        });
+
+        // Getting the entity for the method:
+        const callList = [];
+        method.value.body.body.forEach((statement) => {
+          recurseCallExpressions(statement, callList);
+        });
+        const requests = [];
+        for (let i = 0; i < callList.length; i += 1) {
+          if (callList[i].callee.property && callList[i].callee.property.name === callName) {
+            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')) {
+            const param1 = method.value.params[0];
+            const param2 = method.value.params[1];
+            if (param1.type !== 'Identifier' || param2.type !== 'Identifier'
+                || expr.arguments[0].type !== 'Identifier' || expr.arguments[1].type !== 'Identifier'
+                || param1.name !== expr.arguments[0].name || param2.name !== expr.arguments[1].name) {
+              throw new Error(`identifyRequest proxy method ${funcName} unknown format`);
+            } else if (callName !== 'identifyRequest') {
+              throw new Error(`MethodDocumentor not yet programmed to handle multiple helper methods: 1) ${callName}, 2) ${funcName}`);
+            }
+            callName = 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]
+              )
+            );
+          }
+        }
+      });
+    }
+  });
+}
+
+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.summary ? methodName.summary : 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();