@itentialopensource/adapter-jira 1.7.4 → 1.7.6

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

@@ -3,7 +3,7 @@ const Ajv = require('ajv');
 const rls = require('readline-sync');
 const { execSync } = require('child_process');
 const { existsSync } = require('fs-extra');
-const { getAdapterConfig } = require('./troubleshootingAdapter');
+const { getAdapterConfig } = require('./tbUtils');
 const { name } = require('../package.json');
 const propertiesSchema = require('../propertiesSchema.json');
 

package/utils/packModificationScript.js

@@ -4,7 +4,7 @@
 const fs = require('fs-extra');
 const path = require('path');
 const { spawnSync } = require('child_process');
-const { createBundle } = require('./artifactize.js');
+const { createBundle } = require('./artifactize');
 
 const nodeEntryPath = path.resolve('.');
 createBundle(nodeEntryPath).then((pathObj) => {

package/utils/patches2bundledDeps.js

@@ -0,0 +1,90 @@
+const fs = require('fs');
+const semverSatisfies = require('semver/functions/satisfies');
+const packageJson = require('../package.json');
+
+try {
+  // pattern supplied by semver.org via https://regex101.com/r/vkijKf/1/ but removed gm from end to only match a single semver
+  // const semverPat = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+  // pattern supplied by semver.org via https://regex101.com/r/Ly7O1x/3/ with following changes
+  // removed P's from before capturing group names and
+  // removed  gm from end to only match a single semver
+  // const semverPat = /^(?<major>0|[1-9]\d*)\.(?<minor>0|[1-9]\d*)\.(?<patch>0|[1-9]\d*)(?:-(?<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+
+  const patches = (fs.existsSync('./patches')) ? fs.readdirSync('./patches', { withFileTypes: true }) : [];
+  if (!patches.length) {
+    console.error('\nno patches - nothing to do\n');
+    process.exitCode = 1;
+  }
+
+  const dependencies = packageJson.dependencies || {};
+  if (!Object.keys(dependencies).length) {
+    console.error('\nno dependencies - nothing to do\n');
+    process.exitCode = 1;
+  }
+
+  let changed = false;
+  console.error('\nprocessing patches');
+  const bundledDependencies = packageJson.bundledDependencies || packageJson.bundleDependencies || [];
+
+  patches.forEach((patch) => {
+    if (!patch.isFile()) {
+      console.error(`${patch.name} skipped, is not a regular file`);
+      return;
+    }
+    if (!patch.name.endsWith('.patch')) {
+      console.error(`${patch.name} skipped, does not end with .patch`);
+      return;
+    }
+    const splits = patch.name.slice(0, -6).split('+');
+    if (splits.length > 4) {
+      console.error(`${patch.name} skipped, does not follow the naming convention (cannot use '+' other than to separate scope/package/semver and at most once within semver)`);
+      return;
+    }
+    const scope = splits[0][0] === '@' ? splits.shift() : null;
+    const packageName = splits.shift();
+    const semver = splits.join('+');
+    // const { groups } = semver.match(semverPat);
+    const file = scope ? `${scope}/${packageName}` : packageName;
+    if (dependencies[file] && semverSatisfies(semver, dependencies[file])) {
+      if (!bundledDependencies.includes(file)) {
+        bundledDependencies.push(file);
+        console.error(`added ${file} to bundledDependencies`);
+        changed = true;
+      } else {
+        console.error(`bundledDependencies already has ${file}`);
+      }
+    } else {
+      const depmsg = dependencies[file] ? `version mismatch (${dependencies[file]}) in dependencies` : 'not found in dependencies';
+      console.error(`patch ${patch.name} ${depmsg}`);
+    }
+  });
+
+  if (!packageJson.bundledDependencies && bundledDependencies.length) {
+    delete packageJson.bundleDependencies;
+    packageJson.bundledDependencies = bundledDependencies;
+    console.error('renaming bundleDependencies to bundledDependencies');
+    changed = true;
+  }
+  if (changed) {
+    fs.writeFileSync('./package.json.new', JSON.stringify(packageJson, null, 2));
+    console.error('wrote package.json.new');
+    fs.renameSync('./package.json', './package.json.old');
+    console.error('moved package.json to package.json.old');
+    fs.renameSync('./package.json.new', './package.json');
+    console.error('moved package.json.new to package.json');
+  } else {
+    console.error('no changes\n');
+    process.exitCode = 1;
+  }
+} catch (e) {
+  if (e) {
+    // caught error, exit with status 2 to signify abject failure
+    console.error(`\ncaught exception - ${e}\n`);
+    process.exitCode = 2;
+  } else {
+    // caught false, exit with status 1 to signify nothing done
+    process.exitCode = 1;
+  }
+} finally {
+  console.error('done\n');
+}

package/utils/pre-commit.sh

@@ -17,6 +17,11 @@ printf "%b" "Running pre-commit hooks...\\n"
 # verify testing script is stubbed and no credentials
 node utils/testRunner.js -r
 
+# update the adapter information file
+node utils/adapterInfo.js
+node utils/methodDocumentor.js
+git add CALLS.md utils/methodDocumentor.js
+
 # security audit on the code
 npm audit --registry=https://registry.npmjs.org --audit-level=moderate
 

package/utils/removeHooks.js

@@ -0,0 +1,20 @@
+const fs = require('fs');
+
+/**
+ * This script will uninstall pre-commit or pre-push hooks in case there's ever a need to
+ * commit/push something that has issues
+ */
+
+const precommitPath = '.git/hooks/pre-commit';
+const prepushPath = '.git/hooks/pre-push';
+fs.unlink(precommitPath, (err) => {
+  if (err && err.code !== 'ENOENT') {
+    console.log(`${err.message}`);
+  }
+});
+
+fs.unlink(prepushPath, (err) => {
+  if (err && err.code !== 'ENOENT') {
+    console.log(`${err.message}`);
+  }
+});

package/utils/tbScript.js

@@ -1,4 +1,4 @@
-/* eslint no-console: warn */
+/* eslint-disable no-console */
 /* eslint import/no-unresolved: warn */
 /* eslint global-require: warn */
 
@@ -7,7 +7,6 @@
 /* eslint import/no-extraneous-dependencies: warn */
 /* eslint import/no-dynamic-require: warn */
 
-const path = require('path');
 const program = require('commander');
 const rls = require('readline-sync');
 const utils = require('./tbUtils');
@@ -15,35 +14,47 @@ 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, getAdapterConfig, offline } = require('./troubleshootingAdapter');
+const { troubleshoot, offline } = require('./troubleshootingAdapter');
 
-const main = async (command) => {
-  const iapDir = path.join(__dirname, '../../../../');
-  if (!utils.withinIAP(iapDir)) {
-    if (command === 'connectivity') {
+const executeInStandaloneMode = async (command) => {
+  console.info('\n> Executing the script outside of IAP installation directory');
+  console.info('> Using sampleProperties.json configuration');
+  switch (command) {
+    case 'install': {
+      console.error('Not currently in IAP directory - installation not possible');
+      break;
+    }
+    case 'connectivity': {
       const { host } = sampleProperties.properties;
       console.log(`perform networking diagnositics to ${host}`);
-      await utils.runConnectivity(host);
-      process.exit(0);
-    } else if (command === 'healthcheck') {
+      utils.runConnectivity(host);
+      break;
+    }
+    case 'healthcheck': {
       const a = basicGet.getAdapterInstance({ properties: sampleProperties });
       await utils.healthCheck(a);
-      process.exit(0);
-    } else if (command === 'basicget') {
-      await utils.runBasicGet();
-      process.exit(0);
+      break;
+    }
+    case 'basicget': {
+      utils.runBasicGet();
+      break;
     }
-    if (rls.keyInYN('Troubleshooting without IAP?')) {
-      await offline();
+    default: {
+      if (rls.keyInYN('Troubleshooting without IAP?')) {
+        await offline();
+      }
     }
-    process.exit(0);
   }
+  process.exit(0);
+};
 
+const executeUnderIAPInstallationDirectory = async (command) => {
   if (command === undefined) {
     await troubleshoot({}, true, true);
   } else if (command === 'install') {
-    const { database, serviceItem, pronghornProps } = await getAdapterConfig();
+    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) {
@@ -74,14 +85,17 @@ const main = async (command) => {
         process.exit(0);
       }
     } else {
-      utils.verifyInstallationDir(__dirname, name);
-      utils.npmInstall();
+      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 } };
@@ -94,7 +108,7 @@ const main = async (command) => {
       process.exit(0);
     }
   } else if (['healthcheck', 'basicget', 'connectivity'].includes(command)) {
-    const { serviceItem } = await getAdapterConfig();
+    const { serviceItem } = await utils.getAdapterConfig();
     if (serviceItem) {
       const adapter = serviceItem;
       const a = basicGet.getAdapterInstance(adapter);
@@ -116,6 +130,14 @@ const main = async (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')
@@ -154,7 +176,6 @@ program.parse(process.argv);
 if (process.argv.length < 3) {
   main();
 }
-
 const allowedParams = ['install', 'healthcheck', 'basicget', 'connectivity'];
 if (process.argv.length === 3 && !allowedParams.includes(process.argv[2])) {
   console.log(`unknown parameter ${process.argv[2]}`);