@itentialopensource/adapter-checkpoint_management 0.10.7 → 0.11.0

package/adapterBase.js

@@ -32,6 +32,7 @@ const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
 const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
 const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
 const taskMover = require(path.join(__dirname, 'utils/taskMover'));
+const { updateMongoDBConfig } = require(path.join(__dirname, 'utils/updateAdapterConfig'));
 
 let propUtil = null;
 let choosepath = null;
@@ -366,7 +367,6 @@ class AdapterBase extends EventEmitterCl {
         // if we were healthy, toggle health
         if (this.healthy) {
           this.emit('OFFLINE', { id: this.id });
-          this.emit('DEGRADED', { id: this.id });
           this.healthy = false;
           if (typeof error === 'object') {
             log.error(`${origin}: HEALTH CHECK - Error ${JSON.stringify(error)}`);
@@ -385,7 +385,6 @@ class AdapterBase extends EventEmitterCl {
 
       // if we were unhealthy, toggle health
       if (!this.healthy) {
-        this.emit('FIXED', { id: this.id });
         this.emit('ONLINE', { id: this.id });
         this.healthy = true;
         log.info(`${origin}: HEALTH CHECK SUCCESSFUL`);
@@ -583,21 +582,32 @@ class AdapterBase extends EventEmitterCl {
 
     // take action based on type of file being changed
     if (type === 'action') {
-      // BACKUP???
       const ares = updateAction(epath, action, changes);
       if (ares) {
         const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
         log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
         return callback(null, errorObj);
       }
-      // AJV CHECK???
-      // RESTORE IF NEEDED???
+      // Update MongoDB if possible
+      updateMongoDBConfig({
+        id: this.id,
+        mongoProps: this.allProps.mongo,
+        entity,
+        type,
+        configFile,
+        changes,
+        action,
+        replace
+      }).catch((error) => {
+        log.error(`${origin}: Error updating MongoDB configuration: ${error.message}`);
+      });
       const result = {
         response: `Action updates completed to entity: ${entity} - ${action}`
       };
       log.info(result.response);
       return callback(result, null);
     }
+
     if (type === 'schema') {
       const sres = updateSchema(epath, configFile, changes);
       if (sres) {
@@ -605,12 +615,26 @@ class AdapterBase extends EventEmitterCl {
         log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
         return callback(null, errorObj);
       }
+      // Update MongoDB if possible
+      updateMongoDBConfig({
+        id: this.id,
+        mongoProps: this.allProps.mongo,
+        entity,
+        type,
+        configFile,
+        changes,
+        action,
+        replace
+      }).catch((error) => {
+        log.error(`${origin}: Error updating MongoDB configuration: ${error.message}`);
+      });
       const result = {
         response: `Schema updates completed to entity: ${entity} - ${configFile}`
       };
       log.info(result.response);
       return callback(result, null);
     }
+
     if (type === 'mock') {
       // if the mock directory does not exist - error
       const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
@@ -624,18 +648,31 @@ class AdapterBase extends EventEmitterCl {
         return callback(null, errorObj);
       }
       const mres = updateMock(mpath, configFile, changes, replace);
-
       if (mres) {
         const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
         log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
         return callback(null, errorObj);
       }
+      // Update MongoDB if possible
+      updateMongoDBConfig({
+        id: this.id,
+        mongoProps: this.allProps.mongo,
+        entity,
+        type,
+        configFile,
+        changes,
+        action,
+        replace
+      }).catch((error) => {
+        log.error(`${origin}: Error updating MongoDB configuration: ${error.message}`);
+      });
       const result = {
         response: `Mock data updates completed to entity: ${entity} - ${configFile}`
       };
       log.info(result.response);
       return callback(result, null);
     }
+
     const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
     log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
     return callback(null, errorObj);
@@ -831,14 +868,13 @@ class AdapterBase extends EventEmitterCl {
    *
    * @function iapTroubleshootAdapter
    * @param {Object} props - the connection, healthcheck and authentication properties
-   * @param {boolean} persistFlag - whether the adapter properties should be updated
    * @param {Adapter} adapter - adapter instance to troubleshoot
    * @param {Callback} callback - callback function to return troubleshoot results
    */
-  async iapTroubleshootAdapter(props, persistFlag, adapter, callback) {
+  async iapTroubleshootAdapter(props, adapter, callback) {
     try {
-      const result = await troubleshootingAdapter.troubleshoot(props, false, persistFlag, adapter);
-      if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.failCount === 0) {
+      const result = await troubleshootingAdapter.troubleshoot(props, false, adapter);
+      if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.passCount !== 0) {
         return callback(result);
       }
       return callback(null, result);
@@ -875,8 +911,7 @@ class AdapterBase extends EventEmitterCl {
    */
   async iapRunAdapterConnectivity(callback) {
     try {
-      const { host } = this.allProps;
-      const result = tbUtils.runConnectivity(host, false);
+      const result = tbUtils.runConnectivity(this.allProps.host, false);
       if (result.failCount > 0) {
         return callback(null, result);
       }
@@ -890,12 +925,13 @@ class AdapterBase extends EventEmitterCl {
    * @summary runs basicGet script for adapter
    *
    * @function iapRunAdapterBasicGet
+   * @param {number} maxCalls  - how many GETs to run (optional)
    * @param {Callback} callback - callback function to return basicGet result
    */
-  iapRunAdapterBasicGet(callback) {
+  iapRunAdapterBasicGet(maxCalls, callback) {
     try {
-      const result = tbUtils.runBasicGet(false);
-      if (result.failCount > 0) {
+      const result = tbUtils.runBasicGet(this.allProps, false, maxCalls);
+      if (result.passCount === 0) {
         return callback(null, result);
       }
       return callback(result);
@@ -917,7 +953,7 @@ class AdapterBase extends EventEmitterCl {
     log.trace(origin);
 
     try {
-      const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id });
+      const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: { mongo: this.allProps && this.allProps.mongo }, id: this.id });
       return callback(result, null);
     } catch (err) {
       const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, err);

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@itentialopensource/adapter-checkpoint_management",
-  "version": "0.10.7",
+  "version": "0.11.0",
   "description": "This adapter integrates with system described as: checkpointManagementApi.",
   "main": "adapter.js",
   "systemName": "Checkpoint Management",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.68.2",
+  "engineVersion": "1.69.14",
   "adapterType": "http",
   "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",
@@ -17,7 +16,6 @@
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
-    "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
     "adapter:findPath": "node utils/findPath.js",
     "adapter:migrate": "node utils/modify.js -m",
@@ -32,10 +30,9 @@
   },
   "keywords": [
     "Itential",
-    "IAP",
+    "Itential Platform",
     "Automation",
     "Integration",
-    "App-Artifacts",
     "Adapter",
     "Security",
     "Checkpoint",
@@ -54,30 +51,29 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-checkpoint_management#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.10.1",
-    "acorn": "^8.14.0",
-    "ajv": "^8.17.1",
-    "axios": "^1.8.2",
-    "commander": "^11.0.0",
-    "dns-lookup-promise": "^1.0.4",
-    "fs-extra": "^11.2.0",
-    "json-query": "^2.2.2",
-    "mocha": "^10.8.2",
-    "mocha-param": "^2.0.1",
-    "mongodb": "^4.17.2",
-    "ping": "^0.4.4",
-    "prompts": "^2.4.2",
-    "readline-sync": "^1.4.10",
-    "semver": "^7.6.3",
-    "winston": "^3.17.0"
+    "@itentialopensource/adapter-utils": "5.10.16",
+    "acorn": "8.14.1",
+    "ajv": "8.17.1",
+    "axios": "1.9.0",
+    "commander": "11.1.0",
+    "fs-extra": "11.3.0",
+    "json-query": "2.2.2",
+    "mocha": "10.8.2",
+    "mocha-param": "2.0.1",
+    "mongodb": "4.17.2",
+    "ping": "0.4.4",
+    "prompts": "2.4.2",
+    "readline-sync": "1.4.10",
+    "semver": "7.7.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",
-    "testdouble": "^3.18.0"
+    "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/pronghorn.json

@@ -226,16 +226,6 @@
             "title": "props",
             "type": "object"
           }
-        },
-        {
-          "name": "persistFlag",
-          "type": "boolean",
-          "info": "Whether the input properties should be saved",
-          "required": true,
-          "schema": {
-            "title": "persistFlag",
-            "type": "boolean"
-          }
         }
       ],
       "output": {
@@ -306,7 +296,19 @@
       "name": "iapRunAdapterBasicGet",
       "summary": "Runs basicGet script for adapter",
       "description": "Runs basicGet script for adapter",
-      "input": [],
+      "input": [
+        {
+          "name": "maxCalls",
+          "required": false,
+          "type": "number", 
+          "info": "How many GET endpoints to test (defaults to 5)",
+          "schema": {
+            "title": "maxCalls",
+            "type": "number", 
+            "default": 5
+          }
+        }
+      ],
       "output": {
         "name": "result",
         "type": "object",
@@ -327,8 +329,8 @@
     },
     {
       "name": "iapMoveAdapterEntitiesToDB",
-      "summary": "Moves entities from an adapter into the IAP database",
-      "description": "Moves entities from an adapter into the IAP database",
+      "summary": "Moves entities from an adapter into the Itential Platform database",
+      "description": "Moves entities from an adapter into the Itential Platform database",
       "input": [],
       "output": {
         "name": "res",
@@ -24016,7 +24018,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24069,7 +24071,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24122,7 +24124,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24175,7 +24177,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24228,7 +24230,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24281,7 +24283,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24334,7 +24336,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24387,7 +24389,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",
@@ -24440,7 +24442,7 @@
         {
           "name": "iapMetadata",
           "type": "object",
-          "info": "IAP Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
+          "info": "Itential Platform Metadata object contains additional info needed for the request: payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, etc.",
           "required": false,
           "schema": {
             "title": "iapMetadata",

package/propertiesSchema.json

@@ -764,6 +764,14 @@
             "security/ca.pem"
           ]
         },
+        "ca_file_content": {
+          "type": "string",
+          "description": "The content of the CA file used for SSL",
+          "default": "",
+          "examples": [
+            "-----BEGIN CERTIFICATE-----"
+          ]
+        },
         "key_file": {
           "type": "string",
           "description": "The fully qualified path name to the key file used for SSL",
@@ -853,32 +861,48 @@
     "mongo": {
       "type": "object",
       "properties": {
+        "url": {
+          "type": "string",
+          "description": "Mongo's complete connection URL. This property overrides host, port, database, username, password and replSet settings.",
+          "examples": [
+            "mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]",
+            "mongodb+srv://[username:password@]cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]",
+            "mongodb+srv://cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]"
+          ]
+        },
         "host": {
           "type": "string",
-          "description": "host where mongo database can be found",
+          "description": "Host information for the Mongo server",
           "default": "",
           "examples": [
-            "localhost"
+            "localhost",
+            "cluster0.xxxxx.mongodb.net",
+            "my-cluster.example.com"
           ]
         },
         "port": {
           "type": "integer",
-          "description": "port on which to connect to the mongo database",
+          "description": "Port information for the Mongo server. Not used when using mongodb+srv:// protocol",
           "default": 443,
           "minimum": 0,
           "maximum": 65535
         },
         "database": {
           "type": "string",
-          "description": "The name of the database to store adapter information in",
+          "description": "The database for the adapter to use for its data.",
           "default": "",
           "examples": [
             "adapter-xyz"
           ]
         },
+        "dbAuth": {
+          "type": "boolean",
+          "description": "Whether to use authentication for MongoDB connection. Default is false.",
+          "default": false
+        },
         "username": {
           "type": "string",
-          "description": "The user to connect to the database with",
+          "description": "If credentials are required to access Mongo, this is the user to login as.",
           "default": "",
           "examples": [
             "username"
@@ -886,7 +910,7 @@
         },
         "password": {
           "type": "string",
-          "description": "The password to connect to the database with",
+          "description": "If credentials are required to access Mongo, this is the password to login with.",
           "default": "",
           "examples": [
             "password"
@@ -894,12 +918,17 @@
         },
         "replSet": {
           "type": "string",
-          "description": "The replica set for the database",
+          "description": "If the database is set up to use replica sets, define it here so it can be added to the database connection. Not used when using mongodb+srv:// protocol",
           "default": "",
           "examples": [
             "my_repolica_set"
           ]
         },
+        "addSrv": {
+          "type": "boolean",
+          "description": "Whether the connection requires the mongodb+srv:// protocol. If true, uses mongodb+srv:// protocol. Note: mongodb+srv:// can also be used for non-Atlas deployments that support DNS SRV records",
+          "default": false
+        },
         "db_ssl": {
           "type": "object",
           "description": "SSL for mongo database connection",
@@ -940,6 +969,38 @@
             }
           }
         }
+      },
+      "dependencies": {
+        "dbAuth": {
+          "oneOf": [
+            {
+              "properties": {
+                "dbAuth": {
+                  "const": false
+                }
+              }
+            },
+            {
+              "properties": {
+                "dbAuth": {
+                  "const": true
+                },
+                "username": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "password": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "username",
+                "password"
+              ]
+            }
+          ]
+        }
       }
     },
     "devicebroker": {

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.10.5",
-  "configLines": 26336,
-  "scriptLines": 1783,
-  "codeLines": 34764,
-  "testLines": 22108,
-  "testCases": 1058,
-  "totalCodeLines": 58655,
+  "version": "0.10.7",
+  "configLines": 34987,
+  "scriptLines": 2498,
+  "codeLines": 34800,
+  "testLines": 22677,
+  "testCases": 1071,
+  "totalCodeLines": 59975,
   "wfTasks": 624
 }