@itentialopensource/adapter-meraki 0.7.0 → 0.8.0

package/utils/modify.js

@@ -0,0 +1,154 @@
+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');
+const propertiesSchema = require('../propertiesSchema.json');
+
+const flags = process.argv[2];
+
+/**
+ * @summary Updates database instance with new adapter properties
+ *
+ * @function updateServiceItem
+ */
+async function updateServiceItem() {
+  const { database, serviceItem } = await getAdapterConfig();
+  const currentProps = serviceItem.properties.properties;
+  const ajv = new Ajv({ allErrors: true, useDefaults: true });
+  const validate = ajv.compile(propertiesSchema);
+  validate(currentProps);
+  console.log('Updating Properties...');
+  await database.collection('service_configs').updateOne(
+    { model: name }, { $set: serviceItem }
+  );
+  console.log('Properties Updated');
+}
+
+/**
+ * @summary Creates a backup zip file of current adapter
+ *
+ * @function backup
+ */
+function backup() {
+  // zip all files except node_modules and package-lock
+  const backupCmd = 'zip -r previousVersion.zip .';
+  execSync(backupCmd, { encoding: 'utf-8' });
+}
+
+/**
+ * @summary Archives previous modifications and removes the modification package
+ *
+ * @function archiveMod
+ * @param {String} modType - update(UPD) or migrate(MIG)
+ */
+function archiveMod(modType) {
+  if (!existsSync('./adapter_modifications/archive')) {
+    execSync('mkdir ./adapter_modifications/archive');
+  }
+  const zipFile = modType === 'UPD' ? 'updatePackage.zip' : 'migrationPackage.zip';
+  const now = new Date();
+  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}`;
+  execSync(archiveCmd, { encoding: 'utf-8' });
+}
+
+/**
+ * @summary Reverts modifications using backup zip file
+ *
+ * @function revertMod
+ */
+function revertMod() {
+  const files = fs.readdirSync('./');
+  // remove all files except previousVersion
+  files.forEach((file) => {
+    if (file !== 'previousVersion.zip') {
+      fs.removeSync(file);
+    }
+  });
+  // // unzip previousVersion, reinstall dependencies and delete zipfile
+  execSync('unzip -o previousVersion.zip && rm -rf node_modules && rm package-lock.json && npm install');
+  execSync('rm previousVersion.zip');
+  console.log('Changes have been reverted');
+}
+
+// Main Script
+
+// Migrate
+if (flags === '-m') {
+  if (!fs.existsSync('migrationPackage.zip')) {
+    console.log('Migration Package not found. Download and place migrationPackage in the adapter root directory');
+    process.exit();
+  }
+  // Backup current adapter
+  backup();
+  console.log('Migrating adapter and running tests...');
+  const migrateCmd = 'unzip -o migrationPackage.zip'
+  + ' && 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) {
+    if (rls.keyInYN('Adapter failed tests or lint after migrating. Would you like to revert the changes?')) {
+      console.log('Reverting changes...');
+      revertMod();
+      process.exit();
+    }
+    console.log('Adapter Migration will continue. If you want to revert the changes, run the command npm run adapter:revert');
+  }
+  console.log('Installing new dependencies..');
+  const updatePackageCmd = 'rm -rf node_modules && rm package-lock.json && npm install';
+  const updatePackageOutput = execSync(updatePackageCmd, { encoding: 'utf-8' });
+  console.log(updatePackageOutput);
+  console.log('New dependencies installed');
+  console.log('Updating adapter properties..');
+  updateServiceItem().then(() => {
+    console.log('Adapter Successfully Migrated. Restart adapter in IAP to apply the changes');
+    archiveMod('MIG');
+    process.exit();
+  });
+}
+
+// Update
+if (flags === '-u') {
+  if (!fs.existsSync('updatePackage.zip')) {
+    console.log('Update Package not found. Download and place updateAdapter.zip in the adapter root directory');
+    process.exit();
+  }
+  // Backup current adapter
+  backup();
+  const updateCmd = 'unzip -o updatePackage.zip'
+  + ' && 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) {
+    if (rls.keyInYN('Adapter failed tests or lint after updating. Would you like to revert the changes?')) {
+      console.log('Reverting changes...');
+      revertMod();
+      process.exit();
+    }
+    console.log('Adapter Update will continue. If you want to revert the changes, run the command npm run adapter:revert');
+  }
+  console.log(updateOutput);
+  console.log('Adapter Successfully Updated. Restart adapter in IAP to apply the changes');
+  archiveMod('UPD');
+  process.exit();
+}
+
+// Revert
+if (flags === '-r') {
+  if (!fs.existsSync('previousVersion.zip')) {
+    console.log('Previous adapter version not found. There are no changes to revert');
+    process.exit();
+  }
+  revertMod();
+}

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

@@ -18,7 +18,7 @@ printf "%b" "Running pre-commit hooks...\\n"
 node utils/testRunner.js -r
 
 # security audit on the code
-npm audit --registry=https://registry.npmjs.org
+npm audit --registry=https://registry.npmjs.org --audit-level=moderate
 
 # lint the code
 npm run lint

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

@@ -0,0 +1,169 @@
+/* eslint no-console: warn */
+/* 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 path = require('path');
+const program = require('commander');
+const rls = require('readline-sync');
+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 main = async (command) => {
+  const dirname = utils.getDirname();
+  const iapDir = path.join(dirname, '../../../');
+  if (!utils.withinIAP(iapDir)) {
+    if (command === 'install') {
+      console.log('Not currently in IAP directory - installation not possible');
+      process.exit(0);
+    } else if (command === 'connectivity') {
+      const { host } = sampleProperties.properties;
+      console.log(`perform networking diagnositics to ${host}`);
+      await utils.runConnectivity(host);
+      process.exit(0);
+    } else if (command === 'healthcheck') {
+      const a = basicGet.getAdapterInstance({ properties: sampleProperties });
+      await utils.healthCheck(a);
+      process.exit(0);
+    } else if (command === 'basicget') {
+      await utils.runBasicGet();
+      process.exit(0);
+    }
+    if (rls.keyInYN('Troubleshooting without IAP?')) {
+      await offline();
+    }
+    process.exit(0);
+  }
+
+  if (command === undefined) {
+    await troubleshoot({}, true, true);
+  } else 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 {
+      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'].includes(command)) {
+    const { serviceItem } = await utils.getAdapterConfig();
+    if (serviceItem) {
+      const adapter = serviceItem;
+      const a = basicGet.getAdapterInstance(adapter);
+      if (command === 'healthcheck') {
+        await utils.healthCheck(a);
+        process.exit(0);
+      } else if (command === 'basicget') {
+        await utils.runBasicGet(true);
+      } else if (command === 'connectivity') {
+        const { host } = adapter.properties.properties;
+        console.log(`perform networking diagnositics to ${host}`);
+        await utils.runConnectivity(host, true);
+        process.exit(0);
+      }
+    } else {
+      console.log(`${name} not installed. Run npm \`run install:adapter\` to install.`);
+      process.exit(0);
+    }
+  }
+};
+
+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');
+  });
+
+// Allow commander to parse `process.argv`
+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]}`);
+  console.log('try `node troubleshootingAdapter.js -h` to see allowed parameters. Exiting...');
+  process.exit(0);
+}