@itentialopensource/adapter-alkira 0.1.1

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

@@ -0,0 +1,32 @@
+#!/bin/sh
+# @copyright Itential, LLC 2019
+
+#exit on any failure in the pipeline
+set -e
+
+# --------------------------------------------------
+# pre-commit
+# --------------------------------------------------
+# Contains the standard set of tasks to runbefore
+# committing changes to the repo. If any tasks fail
+# then the commit will be aborted.
+# --------------------------------------------------
+
+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 report/adapterInfo.json
+
+# security audit on the code
+npm audit --registry=https://registry.npmjs.org --audit-level=moderate
+
+# lint the code
+npm run lint
+
+# test the code
+npm run test

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/setup.js

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+/* @copyright Itential, LLC 2019 */
+
+const fs = require('fs');
+
+/**
+ * This script will execute before an npm install command. The purpose is to
+ * write out some standard git hooks that will enable folks working on this
+ * project to benefit from the protections that the hooks provide.
+ */
+
+const precommit = fs.readFileSync('utils/pre-commit.sh', 'utf8');
+
+fs.stat('.git', (err) => {
+  if (err == null) {
+    // git repo, not an npm repo.
+    // add pre-commit hook if it doesn't exist
+    fs.stat('.git/hooks/pre-commit', (statErr) => {
+      if (statErr == null || statErr.code === 'ENOENT') {
+        fs.writeFile('.git/hooks/pre-commit', precommit, {
+          mode: 0o755
+        }, (writeErr) => {
+          if (writeErr) {
+            return console.log(writeErr.message);
+          }
+          return null;
+        });
+      } else {
+        console.log(statErr.message);
+      }
+    });
+  }
+});

package/utils/tbScript.js

@@ -0,0 +1,246 @@
+/* eslint-disable no-console */
+/* eslint import/no-unresolved: warn */
+/* eslint global-require: warn */
+
+// suppress eslint rule in adapter
+/* eslint arrow-parens: warn */
+/* eslint import/no-extraneous-dependencies: warn */
+/* eslint import/no-dynamic-require: warn */
+
+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');
+  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}`);
+      utils.runConnectivity(host);
+      break;
+    }
+    case 'healthcheck': {
+      const a = basicGet.getAdapterInstance({ properties: sampleProperties });
+      await utils.healthCheck(a);
+      break;
+    }
+    case 'basicget': {
+      utils.runBasicGet();
+      break;
+    }
+    default: {
+      if (rls.keyInYN('Troubleshooting without IAP?')) {
+        await offline();
+      }
+    }
+  }
+  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')
+  .description('networking diagnostics')
+  .action(() => {
+    main('connectivity');
+  });
+
+program
+  .command('install')
+  .alias('i')
+  .description('install current adapter')
+  .action(() => {
+    main('install');
+  });
+
+program
+  .command('healthcheck')
+  .alias('hc')
+  .description('perfom none interative healthcheck with current setting')
+  .action(() => {
+    main('healthcheck');
+  });
+
+program
+  .command('basicget')
+  .alias('bg')
+  .description('perfom basicget')
+  .action(() => {
+    main('basicget');
+  });
+
+program
+  .command('troubleshoot')
+  .alias('tb')
+  .description('perfom troubleshooting')
+  .action(() => {
+    main('troubleshoot');
+  });
+
+// Allow commander to parse `process.argv`
+program.parse(process.argv);
+
+if (process.argv.length < 3) {
+  main();
+}
+const allowedParams = ['install', '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...');
+  process.exit(0);
+}