@itentialopensource/adapter-vmware_vcenter 0.5.3 → 0.7.0

package/propertiesSchema.json

@@ -46,6 +46,11 @@
         "none"
       ]
     },
+    "encode_pathvars": {
+      "type": "boolean",
+      "description": "When true the path variables are encoded in the url",
+      "default": true
+    },
     "save_metric": {
       "type": [
         "boolean",
@@ -88,11 +93,6 @@
     },
     "mongo": {
       "$ref": "#/definitions/mongo"
-    },
-    "encode_pathvars": {
-      "type": "boolean",
-      "description": "When true the path variables are encoded in the url",
-      "default": true
     }
   },
   "required": [
@@ -112,6 +112,7 @@
           "enum": [
             "basic user_password",
             "static_token",
+            "jwt_token",
             "request_token",
             "no_authentication"
           ]
@@ -198,7 +199,10 @@
           ]
         },
         "auth_field": {
-          "type": "string",
+          "type": [
+            "string",
+            "array"
+          ],
           "description": "The field in which to pass the token",
           "default": "header.headers.X-AUTH-TOKEN",
           "examples": [
@@ -210,7 +214,10 @@
           ]
         },
         "auth_field_format": {
-          "type": "string",
+          "type": [
+            "string",
+            "array"
+          ],
           "description": "The format used to pass the authentication -- variables {token}, {username}, {password} will be replaced with the proper values. {b64}...{/b64} will base64 encode everything between the start and end tag.",
           "default": "{token}",
           "examples": [
@@ -220,6 +227,26 @@
             "Basic {b64}{username}:{password}{/b64}",
             "token={token}"
           ]
+        },
+        "auth_logging": {
+          "type": "boolean",
+          "description": "This property turns on logging of Authentication Information and should only be true when debugging authentication and connectivity",
+          "default": false
+        },
+        "client_id": {
+          "type": "string",
+          "description": "The client id for OAuth requests - can also use username depending on schema",
+          "default": ""
+        },
+        "client_secret": {
+          "type": "string",
+          "description": "The client secret for OAuth requests - can also use password depending on schema",
+          "default": ""
+        },
+        "grant_type": {
+          "type": "string",
+          "description": "The grant type for OAuth requests - can also provide in schema",
+          "default": ""
         }
       },
       "required": [
@@ -319,6 +346,10 @@
           "examples": [
             "/api/version/ping"
           ]
+        },
+        "query_object": {
+          "type": "object",
+          "description": "Query object { device: xxxxx } to be placed into the healthcheck, will be converted to query string by the adapter"
         }
       },
       "required": [
@@ -378,7 +409,7 @@
           "type": "integer",
           "description": "defines the number of request that Pronghorn can send vmware_vcenter at one time",
           "default": 1,
-          "minimum": 1,
+          "minimum": 0,
           "maximum": 1000
         },
         "expire_timeout": {
@@ -515,6 +546,11 @@
           "type": "boolean",
           "description": "Archives each request/response and corresponding metrics",
           "default": false
+        },
+        "return_request": {
+          "type": "boolean",
+          "description": "This property turns on returning the response information - need to be carefull in case credentials are in the path",
+          "default": false
         }
       },
       "required": [
@@ -555,8 +591,19 @@
             "http",
             "https",
             "socks4",
-            "socks5"
+            "socks5",
+            "tls"
           ]
+        },
+        "username": {
+          "type": "string",
+          "description": "username for proxy authentication",
+          "default": ""
+        },
+        "password": {
+          "type": "string",
+          "description": "password for proxy authentication",
+          "default": ""
         }
       },
       "required": [

package/report/updateReport1594310791028.json

@@ -0,0 +1,95 @@
+{
+  "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": 29
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 5
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 9
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 10
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.34.4"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 56
+    },
+    {
+      "owner": "readmeMd",
+      "description": "Number of lines in the README.md",
+      "value": 530
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 4229
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 262
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 3512
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 100
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 751
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 18
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 8492
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 362
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/report/updateReport1615860501665.json

@@ -0,0 +1,95 @@
+{
+  "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": 29
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 12
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.39.2"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 61
+    },
+    {
+      "owner": "readmeMd",
+      "description": "Number of lines in the README.md",
+      "value": 615
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 4366
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 272
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 3519
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 100
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1007
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 30
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 8892
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 372
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/report/updateReport1643047821981.json

@@ -0,0 +1,95 @@
+{
+  "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": 30
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 13
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 23
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.44.11"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 64
+    },
+    {
+      "owner": "readmeMd",
+      "description": "Number of lines in the README.md",
+      "value": 688
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 4899
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 291
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 3562
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 101
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1029
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 34
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 9490
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 392
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -7,6 +7,7 @@
     "base_path": "/rest",
     "version": "",
     "cache_location": "none",
+    "encode_pathvars": true,
     "save_metric": true,
     "stub": true,
     "protocol": "http",
@@ -19,11 +20,16 @@
       "token_cache": "local",
       "invalid_token_error": 401,
       "auth_field": "header.headers.Cookie",
-      "auth_field_format": "vmware-api-session-id={token}"
+      "auth_field_format": "vmware-api-session-id={token}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
     },
     "healthcheck": {
       "type": "none",
-      "frequency": 60000
+      "frequency": 60000,
+      "query_object": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -32,7 +38,13 @@
       "max_in_queue": 1000,
       "concurrent_max": 1,
       "expire_timeout": 0,
-      "avg_runtime": 200
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
     },
     "request": {
       "number_redirects": 0,
@@ -48,13 +60,16 @@
       },
       "healthcheck_on_timeout": false,
       "return_raw": false,
-      "archiving": false
+      "archiving": false,
+      "return_request": false
     },
     "proxy": {
       "enabled": false,
       "host": "",
       "port": 1,
-      "protocol": "http"
+      "protocol": "http",
+      "username": "",
+      "password": ""
     },
     "ssl": {
       "ecdhCurve": "",

package/test/integration/adapterTestBasicGet.js

@@ -0,0 +1,85 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe context 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 */
+
+const mocha = require('mocha');
+const path = require('path');
+const assert = require('assert');
+const itParam = require('mocha-param');
+
+const utils = require('../../utils/tbUtils');
+const basicGet = require('../../utils/basicGet');
+const { name } = require('../../package.json');
+const { methods } = require('../../pronghorn.json');
+
+const getPronghornProps = (iapDir) => {
+  const { Discovery } = require('@itential/itential-utils');
+  console.log('Retrieving properties.json file...');
+  const rawProps = require(path.join(iapDir, 'properties.json'));
+  console.log('Decrypting properties...');
+  const discovery = new Discovery();
+  const pronghornProps = utils.decryptProperties(rawProps, path.join(__dirname, '..'), discovery);
+  console.log('Found properties.\n');
+  return pronghornProps;
+};
+
+let a;
+
+describe('[integration] Adapter BasicGET Test', () => {
+  context('Testing GET calls without query parameters', () => {
+    before(async () => {
+      const iapDir = path.join(__dirname, '../../../../../');
+      if (!utils.withinIAP(iapDir)) {
+        const sampleProperties = require('../../sampleProperties.json');
+        const adapter = { properties: sampleProperties };
+        a = basicGet.getAdapterInstance(adapter);
+      } 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);
+      }
+    });
+
+    after((done) => {
+      done();
+    });
+
+    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);
+    }
+    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}`);
+            }
+            resolve(resp.metrics.code);
+          } else {
+            console.log('\x1b[31m', `call ${f} results in failure`);
+            reject(new Error(`${f} failed`));
+          }
+        };
+        ad[f](getRespCode, console.log);
+      });
+    };
+
+    itParam('GET call should return 200', functionNames, (fname) => {
+      console.log(`\t ${fname}`);
+      return request(fname, a).then((result) => assert.equal(result, 200));
+    });
+  });
+});

package/test/integration/adapterTestConnectivity.js

@@ -0,0 +1,93 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe it context before after */
+/* eslint no-unused-vars: warn */
+
+const mocha = require('mocha');
+const assert = require('assert');
+const diagnostics = require('network-diagnostics');
+
+let host;
+process.argv.forEach((val) => {
+  if (val.indexOf('--HOST') === 0) {
+    [, host] = val.split('=');
+  }
+});
+
+describe('[integration] Adapter Test', () => {
+  context(`Testing network connection on ${host}`, () => {
+    before(() => {
+      diagnostics.setTestURL(host);
+    });
+
+    after((done) => {
+      done();
+    });
+
+    it('DNS resolve', (done) => {
+      diagnostics.haveDNS((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Responds to ping', (done) => {
+      diagnostics.havePing((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support HTTP on port 80', (done) => {
+      diagnostics.haveHTTP((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support HTTPS on port 443', (done) => {
+      diagnostics.haveHTTPS((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support IPv4', (done) => {
+      diagnostics.haveIPv4Async((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support IPv6', (done) => {
+      diagnostics.haveIPv6Async((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+  });
+});