@itentialopensource/adapter-netbox_v33 0.1.1

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

@@ -0,0 +1,94 @@
+/* eslint-disable no-plusplus */
+/* eslint global-require: warn */
+/* eslint import/no-dynamic-require: warn */
+
+const rls = require('readline-sync');
+const path = require('path');
+const fs = require('fs');
+
+function getQuestions(props, obj) {
+  const questions = props.map((p) => `${p}: ${(obj[p] !== undefined) ? `(${obj[p]})` : ''} `);
+  return questions;
+}
+
+// function outputs each property for user to edit/confirm
+// props are the fields that need to be changed depending on what the user selects
+// obj is the JSON object that's being updated
+function confirm(props, obj) {
+  // create array of questions
+  const updatedObj = obj;
+  getQuestions(props, obj).forEach((q) => {
+    const answer = rls.question(q);
+    // only update the field if the answer is NOT and empty string
+    if (answer) {
+      updatedObj[q.split(':')[0].trim()] = answer;
+    }
+  });
+  return updatedObj;
+}
+
+const updateBasicAuth = (auth) => {
+  const propsToUpdate = ['username', 'password', 'auth_field', 'auth_field_format'];
+  return confirm(propsToUpdate, auth);
+};
+
+const updateStaticTokenAuth = (auth) => {
+  const propsToUpdate = ['token', 'auth_field', 'auth_field_format'];
+  return confirm(propsToUpdate, auth);
+};
+
+function updateTokenSchemas(user, pw, token) {
+  let schemaPath = path.join(__dirname, '..', 'entities/.system/schemaTokenReq.json');
+  const reqSchema = require(schemaPath);
+  reqSchema.properties.username.external_name = user;
+  reqSchema.properties.password.external_name = pw;
+  fs.writeFileSync(schemaPath, JSON.stringify(reqSchema, null, 2));
+  schemaPath = path.join(__dirname, '..', 'entities/.system/schemaTokenResp.json');
+  const respSchema = require(schemaPath);
+  respSchema.properties.token.external_name = token;
+  fs.writeFileSync(schemaPath, JSON.stringify(respSchema, null, 2));
+}
+
+function updateRequestToken(auth) {
+  const propsToUpdate = [
+    'username',
+    'password',
+    'auth_field',
+    'auth_field_format',
+    'token_user_field',
+    'token_password_field',
+    'token_result_field',
+    'token_URI_path'
+  ];
+  const newAuth = confirm(propsToUpdate, auth);
+  updateTokenSchemas(newAuth.token_user_field, newAuth.token_password_field, newAuth.token_result_field);
+
+  return newAuth;
+}
+
+// prompt users to pick an auth method from the list above
+const addAuthInfo = (props) => {
+  const authOptions = [
+    'basic user_password',
+    'static_token',
+    'request_token',
+    'no_authentication'
+  ];
+  const newProps = confirm(['host', 'port', 'base_path'], props);
+
+  const newAuthMethod = authOptions[rls.keyInSelect(authOptions, 'Which authentication method?')];
+  newProps.authentication.auth_method = newAuthMethod;
+
+  if (newAuthMethod === 'basic user_password') {
+    newProps.authentication = updateBasicAuth(newProps.authentication);
+  } else if (newAuthMethod === 'static_token') {
+    newProps.authentication = updateStaticTokenAuth(newProps.authentication);
+  } else if (newAuthMethod === 'request_token') {
+    newProps.authentication = updateRequestToken(newProps.authentication);
+  }
+  console.log('Connectivity and authentication properties have been configured');
+  console.log('If you want to make changes, rerun this script to reinstall the adapter');
+  return newProps;
+};
+
+module.exports = { addAuthInfo };

package/utils/artifactize.js

@@ -0,0 +1,146 @@
+#!/usr/bin/env node
+/* @copyright Itential, LLC 2019 */
+
+const fs = require('fs-extra');
+const path = require('path');
+
+async function createBundle(adapterOldDir) {
+  // set directories
+  const artifactDir = path.join(adapterOldDir, '../artifactTemp');
+  const workflowsDir = path.join(adapterOldDir, 'workflows');
+
+  // read adapter's package and set names
+  const adapterPackage = fs.readJSONSync(path.join(adapterOldDir, 'package.json'));
+  const originalName = adapterPackage.name.substring(adapterPackage.name.lastIndexOf('/') + 1);
+  const shortenedName = originalName.replace('adapter-', '');
+  const artifactName = originalName.replace('adapter', 'bundled-adapter');
+
+  const adapterNewDir = path.join(artifactDir, 'bundles', 'adapters', originalName);
+  fs.ensureDirSync(adapterNewDir);
+
+  const ops = [];
+
+  // copy old adapterDir to bundled hierarchy location
+  ops.push(() => fs.copySync(adapterOldDir, adapterNewDir));
+
+  // copy readme
+  ops.push(() => fs.copySync(path.join(adapterOldDir, 'README.md'), path.join(artifactDir, 'README.md')));
+
+  // copy changelog
+  if (fs.existsSync(path.join(adapterOldDir, 'CHANGELOG.md'))) {
+    ops.push(() => fs.copySync(path.join(adapterOldDir, 'CHANGELOG.md'), path.join(artifactDir, 'CHANGELOG.md')));
+  }
+
+  // copy license
+  if (fs.existsSync(path.join(adapterOldDir, 'LICENSE'))) {
+    ops.push(() => fs.copySync(path.join(adapterOldDir, 'LICENSE'), path.join(artifactDir, 'LICENSE')));
+  }
+
+  // create package
+  const artifactPackage = {
+    name: artifactName,
+    version: adapterPackage.version,
+    description: `A bundled version of the ${originalName} to be used in adapter-artifacts for easy installation`,
+    scripts: {
+      test: 'echo "Error: no test specified" && exit 1',
+      deploy: 'npm publish --registry=http://registry.npmjs.org'
+    },
+    keywords: [
+      'IAP',
+      'artifacts',
+      'Itential',
+      'Pronghorn',
+      'Adapter',
+      'Adapter-Artifacts',
+      shortenedName
+    ],
+    author: 'Itential Artifacts',
+    license: 'Apache-2.0',
+    repository: adapterPackage.repository,
+    private: false,
+    devDependencies: {
+      r2: '^2.0.1',
+      ajv: '6.10.0',
+      'better-ajv-errors': '^0.6.1',
+      'fs-extra': '^7.0.1'
+    }
+  };
+
+  ops.push(() => fs.writeJSONSync(path.join(artifactDir, 'package.json'), artifactPackage, { spaces: 2 }));
+
+  // create manifest
+  const manifest = {
+    bundleName: originalName,
+    version: adapterPackage.version,
+    fingerprint: 'Some verifiable token',
+    createdEpoch: '1554836984020',
+    artifacts: [
+      {
+        id: `${shortenedName}-adapter`,
+        name: `${shortenedName}-adapter`,
+        type: 'adapter',
+        location: `/bundles/adapters/${originalName}`,
+        description: artifactPackage.description,
+        properties: {
+          entryPoint: false
+        }
+      }
+    ]
+  };
+
+  // add workflows into artifact
+  if (fs.existsSync(workflowsDir)) {
+    const workflowFileNames = fs.readdirSync(workflowsDir);
+
+    // if folder isnt empty and only file is not readme
+    if (workflowFileNames.length !== 0 && (!(workflowFileNames.length === 1 && workflowFileNames[0].split('.')[1] === 'md'))) {
+      // add workflows to correct location in bundle
+      ops.push(() => fs.copySync(workflowsDir, path.join(artifactDir, 'bundles', 'workflows')));
+
+      // add workflows to manifest
+      workflowFileNames.forEach((filename) => {
+        const [filenameNoExt, ext] = filename.split('.');
+        if (ext === 'json') {
+          manifest.artifacts.push({
+            id: `workflow-${filenameNoExt}`,
+            name: filenameNoExt,
+            type: 'workflow',
+            location: `/bundles/workflows/${filename}`,
+            description: 'Main entry point to artifact',
+            properties: {
+              entryPoint: false
+            }
+          });
+        }
+      });
+    }
+  }
+
+  ops.push(() => fs.writeJSONSync(path.join(artifactDir, 'manifest.json'), manifest, { spaces: 2 }));
+
+  // Run the commands in parallel
+  try {
+    await Promise.all(ops.map(async (op) => op()));
+  } catch (e) {
+    throw new Error(e);
+  }
+
+  const pathObj = {
+    bundlePath: artifactDir,
+    bundledAdapterPath: path.join(artifactDir, 'bundles', 'adapters', originalName)
+  };
+  return pathObj;
+}
+
+async function artifactize(entryPathToAdapter) {
+  const truePath = path.resolve(entryPathToAdapter);
+  const packagePath = path.join(truePath, 'package');
+  // remove adapter from package and move bundle in
+  const pathObj = await createBundle(packagePath);
+  const { bundlePath } = pathObj;
+  fs.removeSync(packagePath);
+  fs.moveSync(bundlePath, packagePath);
+  return 'Bundle successfully created and old folder system removed';
+}
+
+module.exports = { createBundle, artifactize };

package/utils/basicGet.js

@@ -0,0 +1,50 @@
+/* @copyright Itential, LLC 2020 */
+
+/* eslint object-shorthand: warn */
+/* eslint import/no-extraneous-dependencies: warn */
+/* eslint global-require: warn */
+/* eslint import/no-unresolved: warn */
+/* eslint import/no-dynamic-require: warn */
+
+const winston = require('winston');
+
+const logLevel = 'none';
+const myCustomLevels = {
+  levels: {
+    spam: 6,
+    trace: 5,
+    debug: 4,
+    info: 3,
+    warn: 2,
+    error: 1,
+    none: 0
+  }
+};
+
+const basicGet = {
+  /**
+   * @summary create Adapter instance
+   *
+   * @function getAdapterInstance
+   * @param {Object} adapter - adaper configuration object required by IAP
+   */
+  getAdapterInstance: (adapter) => {
+    const Adapter = require('../adapter');
+    const adapterProps = JSON.parse(JSON.stringify(adapter.properties.properties));
+    adapterProps.stub = false;
+    // need to set global logging
+    global.log = winston.createLogger({
+      level: logLevel,
+      levels: myCustomLevels.levels,
+      transports: [
+        new winston.transports.Console()
+      ]
+    });
+    return new Adapter(
+      adapter.id,
+      adapterProps
+    );
+  }
+};
+
+module.exports = basicGet;

package/utils/checkMigrate.js

@@ -0,0 +1,63 @@
+const { execSync } = require('child_process');
+const semver = require('semver');
+const axios = require('axios');
+const fs = require('fs');
+const packageJson = require('../package.json');
+
+const localEngineVer = packageJson.engineVersion;
+const localUtils = execSync('npm list @itentialopensource/adapter-utils', { encoding: 'utf-8' });
+const localUtilsVer = localUtils.split('@').pop().replace(/(\r\n|\n|\r| )/gm, '');
+
+/**
+ * @summary Makes a GET call using axios
+ *
+ * @function get
+ * @param {String} url - url to make the call to
+ */
+function get(url) {
+  const config = {
+    method: 'get',
+    url
+  };
+  return axios(config);
+}
+
+/**
+ * @summary Checks if adapter can be migrated using migration package
+ *
+ * @function migratePossible
+ */
+function migratePossible() {
+  const adapterTestUnit = fs.readFileSync('./test/unit/adapterTestUnit.js', { encoding: 'utf-8' });
+  const readme = fs.readFileSync('./README.md', { encoding: 'utf-8' });
+  return packageJson.keywords !== null && adapterTestUnit.indexOf('DO NOT REMOVE THIS COMMENT BLOCK') !== -1
+  && readme.indexOf('available at ') !== -1 && readme.indexOf('You will need to change the credentials and possibly the host information below.') !== -1;
+}
+
+/**
+ * @summary Checks if adapter is up-to-date or if migration is needed
+ *
+ * @function migrateNeeded
+ */
+async function migrateNeeded() {
+  const engineUrl = 'https://adapters.itential.io/engineVersion';
+  const utilsUrl = 'https://registry.npmjs.org/@itentialopensource/adapter-utils';
+  const latestEngineVer = (await get(engineUrl)).data;
+  const latestUtilsVer = (await get(utilsUrl)).data['dist-tags'].latest;
+  return semver.lt(localEngineVer, latestEngineVer) || semver.lt(localUtilsVer, latestUtilsVer);
+}
+
+// Main Script
+if (migratePossible()) {
+  migrateNeeded().then((needed) => {
+    if (needed) {
+      console.log('Migration is needed and possible -- go to dev site to download migration package');
+    } else {
+      console.log('Migration is possible but not needed at the current time.');
+    }
+  }).catch((error) => {
+    console.log('Could not get latest engine or utils version.', error.message);
+  });
+} else {
+  console.log('Migration is not possible. Please contact Itential support for assistance');
+}