@itentialopensource/adapter-gcp_compute 1.8.6 → 1.10.0

package/package.json

@@ -1,14 +1,13 @@
 {
   "name": "@itentialopensource/adapter-gcp_compute",
-  "version": "1.8.6",
+  "version": "1.10.0",
   "description": "This adapter integrates with system described as: computeEngineApi.",
   "main": "adapter.js",
   "systemName": "Google Cloud Platform Compute",
   "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",
     "Cloud",
     "Google",
@@ -55,31 +52,30 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-gcp_compute#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",
-    "gtoken": "^5.2.1",
-    "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",
+    "gtoken": "5.3.2",
+    "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",

package/propertiesSchema.json

@@ -810,6 +810,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",
@@ -899,32 +907,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"
@@ -932,7 +956,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"
@@ -940,12 +964,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",
@@ -986,6 +1015,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": "1.8.2",
-  "configLines": 77498,
-  "scriptLines": 1783,
-  "codeLines": 57391,
-  "testLines": 61704,
-  "testCases": 2509,
-  "totalCodeLines": 120878,
+  "version": "1.8.6",
+  "configLines": 92449,
+  "scriptLines": 2498,
+  "codeLines": 57427,
+  "testLines": 62273,
+  "testCases": 2522,
+  "totalCodeLines": 122198,
   "wfTasks": 583
 }

package/report/updateReport1748555599881.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 15
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 19
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "5.10.16"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 80
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 345
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 662
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 57
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 29137
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1865
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 31273
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 567
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1489
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 37
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 61899
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 2432
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -104,18 +104,22 @@
       "enabled": false,
       "accept_invalid_cert": false,
       "ca_file": "",
+      "ca_file_content": "",
       "key_file": "",
       "cert_file": "",
       "secure_protocol": "",
       "ciphers": ""
     },
     "mongo": {
+      "url": "",
       "host": "",
       "port": 0,
       "database": "",
+      "dbAuth": false,
       "username": "",
       "password": "",
       "replSet": "",
+      "addSrv": false,
       "db_ssl": {
         "enabled": false,
         "accept_invalid_cert": false,

package/test/integration/adapterTestBasicGet.js

@@ -1,83 +1,117 @@
 /* @copyright Itential, LLC 2020 */
 
-/* global describe context before after */
+/* global describe it log before after */
 /* eslint global-require: warn */
 /* eslint no-unused-vars: warn */
 /* eslint import/no-extraneous-dependencies: warn */
 /* eslint import/no-dynamic-require: warn */
 /* eslint import/no-unresolved: warn */
+/* eslint no-loop-func: warn */
+
+/* This performs a number of GET calls (defaults to 5 calls) which do not reuire an input, to test connectivity and functionality.
+The number of calls can be modified if running from CLI. */
 
-const path = require('path');
 const assert = require('assert');
-const mocha = require('mocha');
-const itParam = require('mocha-param');
 
-const utils = require('../../utils/tbUtils');
-const basicGet = require('../../utils/basicGet');
-const { name } = require('../../package.json');
+const log = require('../../utils/logger');
+const { id } = require('../../package.json');
 const { methods } = require('../../pronghorn.json');
+const { parseArgs } = require('../../utils/argParser');
+
+const {
+  properties, maxCalls
+} = parseArgs();
+
+// require the adapter that we are going to be using
+const TestAdapter = require('../../adapter');
 
-const getPronghornProps = (iapDir) => {
-  console.log('Retrieving properties.json file...');
-  const rawProps = require(path.join(iapDir, 'properties.json'));
-  console.log('Decrypting properties...');
-  const pronghornProps = utils.decryptProperties(rawProps, iapDir);
-  console.log('Found properties.\n');
-  return pronghornProps;
-};
+if (!properties) {
+  log.warn('No properties provided. Exiting process.');
+  process.exit(1);
+}
 
-let a;
+let successCount = 0;
+let calls = 0;
+let attemptTimeout = 60000;
+if (properties.request && properties.request.attempt_timeout) {
+  attemptTimeout = properties.request.attempt_timeout;
+}
+
+// turn off stub mode - basic get should not be run in stub mode
+properties.stub = false;
 
 describe('[integration] Adapter BasicGET Test', () => {
-  context('Testing GET calls without query parameters', () => {
-    before(async () => {
-      const iapDir = path.join(__dirname, '../../../../../');
-      if (!utils.areWeUnderIAPinstallationDirectory()) {
-        const sampleProperties = require('../../sampleProperties.json');
-        const adapter = { properties: sampleProperties };
-        a = basicGet.getAdapterInstance(adapter);
+  describe('Class Tests', () => {
+    const testAdapter = new TestAdapter(
+      id,
+      properties
+    );
+
+    after((done) => {
+      if (successCount === calls) {
+        log.info('\x1b[32m%s\x1b[0m', `\n\nSUCCESS: ${successCount} test(s) passed of ${calls} executed!`);
+      } else if (successCount > 0) {
+        log.error('\x1b[32m%s\x1b[0m', `\n\nPARTIAL SUCCESS: ${successCount} test(s) passed of ${calls} executed!`);
       } else {
-        const pronghornProps = getPronghornProps(iapDir);
-        console.log('Connecting to Database...');
-        const database = await basicGet.connect(pronghornProps);
-        console.log('Connection established.');
-        const adapter = await database.collection(utils.SERVICE_CONFIGS_COLLECTION).findOne(
-          { model: name }
-        );
-        a = basicGet.getAdapterInstance(adapter);
+        log.error('\x1b[31m%s\x1b[0m', '\n\nFAILURE: All tests failed.');
       }
+      done();
     });
 
-    after((done) => {
-      done();
+    const basicGets = methods.filter((method) => {
+      // ignore iapMetadata as the input since its optional and all functions will have it
+      const inputKeys = (method.input || [])
+        .map((param) => param.name)
+        .filter((name) => name !== 'iapMetadata');
+      return method.route.verb === 'GET' && inputKeys.length === 0 && !method.name.startsWith('iap');
     });
 
-    const basicGets = methods.filter((method) => (method.route.verb === 'GET' && method.input.length === 0));
     if (basicGets.length === 0) {
-      console.log('No non-parameter GET calls found.');
-      process.exit(0);
+      log.warn('No non-parameter GET calls found.');
+      process.exitCode = 0;
+      return;
     }
+
     const functionNames = basicGets.map((g) => g.name);
-    const request = function request(f, ad) {
-      return new Promise((resolve, reject) => {
-        const getRespCode = (resp) => {
-          if (resp) {
-            if (resp.metrics.code !== 200) {
-              console.log('\x1b[31m', `Testing ${f} \nResponseCode: ${resp.metrics.code}`);
+    calls = functionNames.length;
+    if (calls > maxCalls) {
+      calls = maxCalls;
+    }
+
+    // test up to the first 5 get calls without parameters
+    for (let f = 0; f < calls; f += 1) {
+      const fnName = functionNames[f];
+      const method = basicGets.find((m) => m.name === fnName);
+      const hasIapMetadata = Array.isArray(method.input) && method.input.some((param) => param.name === 'iapMetadata');
+      describe(`#${functionNames[f]}`, () => {
+        it('should return valid response without error', (done) => {
+          const callback = (data, error) => {
+            try {
+              assert.equal(undefined, error);
+              assert.notEqual(undefined, data);
+              assert.notEqual(null, data);
+              assert.notEqual(undefined, data.response);
+              assert.notEqual(null, data.response);
+              successCount += 1;
+              done();
+            } catch (err) {
+              log.error(`Test Failure in ${fnName}: ${err}`);
+              done(err);
+            }
+          };
+
+          try {
+            if (hasIapMetadata) {
+              testAdapter[fnName](null, callback);
+            } else {
+              testAdapter[fnName](callback);
             }
-            resolve(resp.metrics.code);
-          } else {
-            console.log('\x1b[31m', `call ${f} results in failure`);
-            reject(new Error(`${f} failed`));
+          } catch (err) {
+            log.error(`Unexpected error in test for ${fnName}: ${err}`);
+            done(err);
           }
-        };
-        ad[f](getRespCode, console.log);
+        }).timeout(attemptTimeout);
       });
-    };
-
-    itParam('GET call should return 200', functionNames, (fname) => {
-      console.log(`\t ${fname}`);
-      return request(fname, a).then((result) => assert.equal(result, 200));
-    });
+    }
   });
 });