@itentialopensource/adapter-git 0.3.10 → 0.4.1

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@itentialopensource/adapter-git",
-  "version": "0.3.10",
+  "version": "0.4.1",
   "description": "Itential adapter to run git commands",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.14",
+  "engineVersion": "1.69.14",
   "adapterType": "library",
   "scripts": {
-    "artifactize": "npm i && node utils/packModificationScript.js",
     "preinstall": "node utils/setup.js",
     "deinstall": "node utils/removeHooks.js",
     "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
@@ -20,10 +19,9 @@
   },
   "keywords": [
     "Itential",
-    "IAP",
+    "Itential Platform",
     "Automation",
     "Integration",
-    "App-Artifacts",
     "Adapter",
     "DevOps",
     "NetOps",
@@ -41,23 +39,23 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-git#readme",
   "dependencies": {
-    "ajv": "^8.17.1",
-    "avsc": "^5.4.21",
-    "fs-extra": "^11.2.0",
-    "isomorphic-git": "^1.21.0",
-    "json-query": "^2.2.2",
-    "readline-sync": "^1.4.10",
-    "uuid": "^3.0.1"
+    "ajv": "8.17.1",
+    "avsc": "5.4.21",
+    "fs-extra": "11.3.0",
+    "isomorphic-git": "1.21.0",
+    "json-query": "2.2.2",
+    "readline-sync": "1.4.10",
+    "uuid": "3.0.1",
+    "mocha": "10.8.2",
+    "winston": "3.17.0"
   },
   "devDependencies": {
-    "chai": "^4.3.7",
-    "eslint": "^8.44.0",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-json": "^3.1.0",
-    "mocha": "^10.7.0",
-    "testdouble": "^3.18.0",
-    "winston": "^3.13.1"
+    "chai": "4.5.0",
+    "eslint": "8.57.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-json": "3.1.0",
+    "testdouble": "3.18.0"
   },
   "private": false
 }

package/test/integration/adapterTestIntegration.js

@@ -14,11 +14,11 @@ const winston = require('winston');
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
+const log = require('../../utils/logger');
 
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
-let logLevel = 'none';
 const stub = true;
 const isRapidFail = false;
 const isSaveMockData = false;
@@ -55,43 +55,6 @@ global.pronghornProps = {
 
 global.$HOME = `${__dirname}/../..`;
 
-// set the log levels that Pronghorn uses, spam and trace are not defaulted in so without
-// this you may error on log.trace calls.
-const myCustomLevels = {
-  levels: {
-    spam: 6,
-    trace: 5,
-    debug: 4,
-    info: 3,
-    warn: 2,
-    error: 1,
-    none: 0
-  }
-};
-
-// need to see if there is a log level passed in
-process.argv.forEach((val) => {
-  // is there a log level defined to be passed in?
-  if (val.indexOf('--LOG') === 0) {
-    // get the desired log level
-    const inputVal = val.split('=')[1];
-
-    // validate the log level is supported, if so set it
-    if (Object.hasOwnProperty.call(myCustomLevels.levels, inputVal)) {
-      logLevel = inputVal;
-    }
-  }
-});
-
-// need to set global logging
-global.log = winston.createLogger({
-  level: logLevel,
-  levels: myCustomLevels.levels,
-  transports: [
-    new winston.transports.Console()
-  ]
-});
-
 /**
  * Runs the common asserts for test
  */

package/test/unit/adapterTestUnit.js

@@ -17,13 +17,13 @@ const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
 const Ajv = require('ajv');
+const log = require('../../utils/logger');
 
 const ajv = new Ajv({ strictSchema: false, allErrors: true, allowUnionTypes: true });
 
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
-let logLevel = 'none';
 const stub = true;
 const isRapidFail = false;
 const attemptTimeout = 120000;
@@ -56,43 +56,6 @@ global.pronghornProps = {
 
 global.$HOME = `${__dirname}/../..`;
 
-// set the log levels that Pronghorn uses, spam and trace are not defaulted in so without
-// this you may error on log.trace calls.
-const myCustomLevels = {
-  levels: {
-    spam: 6,
-    trace: 5,
-    debug: 4,
-    info: 3,
-    warn: 2,
-    error: 1,
-    none: 0
-  }
-};
-
-// need to see if there is a log level passed in
-process.argv.forEach((val) => {
-  // is there a log level defined to be passed in?
-  if (val.indexOf('--LOG') === 0) {
-    // get the desired log level
-    const inputVal = val.split('=')[1];
-
-    // validate the log level is supported, if so set it
-    if (Object.hasOwnProperty.call(myCustomLevels.levels, inputVal)) {
-      logLevel = inputVal;
-    }
-  }
-});
-
-// need to set global logging
-global.log = winston.createLogger({
-  level: logLevel,
-  levels: myCustomLevels.levels,
-  transports: [
-    new winston.transports.Console()
-  ]
-});
-
 /**
  * Runs the error asserts for the test
  */

package/utils/adapterInfo.js

@@ -1,20 +1,94 @@
 #!/usr/bin/env node
-/* @copyright Itential, LLC 2019 */
+/* @copyright Itential, LLC 2025 */
+
 /* eslint global-require:warn */
 /* eslint import/no-dynamic-require:warn */
 /* eslint prefer-destructuring:warn */
 
+/**
+ * This script will determine the information about the adapter and store
+ * it into a file in the adapter. This is self contained and only depends on
+ * finding files within the adapter to gather information.
+ *
+ * This utility is used when adapters are committed and pushed. It is not used by
+ * any customers nor is it references in any scripts.
+ */
+
 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.
+ * @summary Count the number of lines in a file
+ * @param {string} filePath - The path to the file
+ * @returns {number} The total number of lines in the file
+ */
+function countLinesInFile(filePath) {
+  if (fs.existsSync(filePath)) {
+    const cFile = fs.readFileSync(filePath, 'utf8');
+    return cFile.split('\n').length;
+  }
+  console.log(`Missing - ${path.basename(filePath)}`);
+  return 0;
+}
+
+/**
+ * @summary Count the number of lines across multiple files
+ * @param {array} filePaths - An array of file paths
+ * @returns {number} The total number of lines across all files
+ */
+function countLinesInFiles(filePaths) {
+  return filePaths.reduce((total, filePath) => total + countLinesInFile(filePath), 0);
+}
+
+/**
+ * @summary Count the number of lines in all json files within an entity directory
+ * @param {string} entityDir - The entity directory
+ * @returns {number} The total number of lines across all JSON files in the entity directory
+ */
+function countEntityLines(entityDir) {
+  let totalLines = 0;
+
+  if (!fs.existsSync(entityDir)) {
+    console.log('Could not find the entities directory');
+    return totalLines;
+  }
+  const entities = fs.readdirSync(entityDir);
+  for (let e = 0; e < entities.length; e += 1) {
+    const entityPath = path.join(entityDir, entities[e]);
+    if (fs.statSync(entityPath).isDirectory()) {
+      const jsonFiles = fs.readdirSync(entityPath).filter((f) => f.endsWith('.json'));
+      for (let j = 0; j < jsonFiles.length; j += 1) {
+        totalLines += countLinesInFile(path.join(entityPath, jsonFiles[j]));
+      }
+    }
+  }
+  return totalLines;
+}
+
+/**
+ * @summary Count the number of test cases in a file
+ * @param {string} filePath - The path to the test file
+ * @returns {number} The total number of test cases in the file
  */
+function countTestsInFile(filePath) {
+  if (fs.existsSync(filePath)) {
+    const tFile = fs.readFileSync(filePath, 'utf8');
+    const ttestCount = tFile.split('it(\'').length;
+    return ttestCount;
+  }
+  console.log(`Missing - ${path.basename(filePath)}`);
+  return 0;
+}
 
 /**
- * get adapter information
+ * @summary Count the number of test cases across multiple files
+ * @param {array} filePaths - An array of test file paths
+ * @returns {number} The total number of test cases across all files
  */
+function countTestsInFiles(filePaths) {
+  return filePaths.reduce((total, filePath) => total + countTestsInFile(filePath), 0);
+}
+
 function adapterInfo() {
   // set the base pase of the adapter - tool shoud be one level up in utils
   let adaptdir = __dirname;
@@ -23,172 +97,43 @@ function adapterInfo() {
   if (adaptdir.endsWith('/utils')) {
     adaptdir = adaptdir.substring(0, adaptdir.length - 6);
   }
+
+  // if no package.json then not in right place - end with error
+  if (!fs.existsSync(`${adaptdir}/package.json`)) {
+    throw new Error('Missing - package.json');
+  }
   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');
-  }
+  const configFiles = ['pronghorn.json', 'propertiesSchema.json', 'error.json'].map((f) => path.join(adaptdir, f));
+  configCount = countLinesInFiles(configFiles);
+
+  const entityDir = path.join(adaptdir, '/entities');
+  configCount += countEntityLines(entityDir);
+
   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;
+  const utilFiles = ['argParser', 'checkMigrate.js', 'entitiesToDB.js', 'findPath.js', 'logger.js', 'methodDocumentor.js', 'modify.js', 'mongoDbConnection.js',
+    'mongoUtils.js', 'setup.js', 'taskMover.js', 'tbScript.js', 'tbUtils.js', 'testRunner.js', 'troubleshootingAdapter.js', 'updateAdapterConfig.js'
+  ].map((f) => path.join(adaptdir, 'utils', f));
 
-  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;
+  infoRes.scriptLines = countLinesInFiles(utilFiles);
+
+  const adapterFiles = ['adapter.js', 'adapterBase.js'].map((f) => path.join(adaptdir, f));
+  infoRes.codeLines = countLinesInFiles(adapterFiles);
+
+  const testFiles = [
+    'test/integration/adapterTestBasicGet.js',
+    'test/integration/adapterTestConnectivity.js',
+    'test/integration/adapterTestIntegration.js',
+    'test/unit/adapterBaseTestUnit.js',
+    'test/unit/adapterTestUnit.js'
+  ].map((f) => path.join(adaptdir, f));
+  infoRes.testLines = countLinesInFiles(testFiles);
+  infoRes.testCases = countTestsInFiles(testFiles);
+
+  infoRes.totalCodeLines = infoRes.scriptLines + infoRes.codeLines + infoRes.testLines;
 
   if (fs.existsSync(`${adaptdir}/pronghorn.json`)) {
     // Read the entity schema from the file system
@@ -203,4 +148,9 @@ function adapterInfo() {
   fs.writeFileSync(`${adaptdir}/report/adapterInfo.json`, JSON.stringify(infoRes, null, 2));
 }
 
-adapterInfo();
+try {
+  adapterInfo();
+} catch (err) {
+  console.error(err.message);
+  process.exit();
+}

package/utils/argParser.js

@@ -0,0 +1,44 @@
+const customLevels = {
+  spam: 6,
+  trace: 5,
+  debug: 4,
+  info: 3,
+  warn: 2,
+  error: 1,
+  none: 0
+};
+
+function parseArgs(argv = process.argv) {
+  let properties = null;
+  let logLevel = 'none';
+  let maxCalls = 5;
+  let host = null;
+
+  argv.forEach((val) => {
+    if (val.startsWith('--PROPS=')) {
+      // get the properties
+      const inputVal = val.split('=')[1];
+      properties = JSON.parse(inputVal);
+    } else if (val.startsWith('--LOG=')) {
+      // get the desired log level
+      const level = val.split('=')[1];
+      // validate the log level is supported, if so set it
+      if (Object.hasOwnProperty.call(customLevels, level)) {
+        logLevel = level;
+      }
+    } else if (val.startsWith('--MAXCALLS=')) {
+      const override = parseInt(val.split('=')[1], 10);
+      if (!Number.isNaN(override) && override > 0) {
+        maxCalls = override;
+      }
+    } else if (val.startsWith('--HOST=')) {
+      [, host] = val.split('=');
+    }
+  });
+
+  return {
+    properties, logLevel, maxCalls, host
+  };
+}
+
+module.exports = { parseArgs };

package/utils/logger.js

@@ -0,0 +1,26 @@
+// utils/logger.js
+const winston = require('winston');
+const { parseArgs } = require('./argParser');
+
+const customLevels = {
+  spam: 6,
+  trace: 5,
+  debug: 4,
+  info: 3,
+  warn: 2,
+  error: 1,
+  none: 0
+};
+
+// Only set global logger if it doesn't already exist (i.e., not provided by app)
+if (!global.log) {
+  const { logLevel = 'info' } = parseArgs();
+
+  global.log = winston.createLogger({
+    level: logLevel,
+    levels: customLevels,
+    transports: [new winston.transports.Console()]
+  });
+}
+
+module.exports = global.log;