@itentialopensource/adapter-netbox 0.9.0 → 0.11.0

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.8.0",
-  "configLines": 46191,
-  "scriptLines": 1707,
-  "codeLines": 35506,
-  "testLines": 27265,
-  "testCases": 1353,
-  "totalCodeLines": 64478,
-  "wfTasks": 411
+  "version": "0.9.0",
+  "configLines": 46914,
+  "scriptLines": 1783,
+  "codeLines": 35005,
+  "testLines": 27741,
+  "testCases": 1383,
+  "totalCodeLines": 64529,
+  "wfTasks": 419
 }

package/report/updateReport1691508495299.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": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.1.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 76
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 343
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "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": 13847
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 910
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 12636
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 403
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1350
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 27833
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1313
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/report/updateReport1692202980865.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": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.1.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 76
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 343
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "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": 13847
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 910
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 12636
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 403
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1350
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 27833
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1313
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/report/updateReport1694466470665.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": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.1.7"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 76
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 347
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "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": 13853
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 910
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 12636
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 403
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 27942
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1313
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -4,6 +4,7 @@
   "properties": {
     "host": "localhost",
     "port": 80,
+    "choosepath": "",
     "base_path": "/api",
     "version": "",
     "cache_location": "none",
@@ -13,7 +14,7 @@
     "stub": true,
     "protocol": "http",
     "authentication": {
-      "auth_method": "basic user_password",
+      "auth_method": "static_token",
       "username": "exampleUsername",
       "password": "examplePassword",
       "token": "",
@@ -21,16 +22,31 @@
       "token_cache": "local",
       "invalid_token_error": 401,
       "auth_field": "header.headers.Authorization",
-      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_field_format": "Token {token}",
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",
-      "grant_type": ""
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ]
     },
     "healthcheck": {
       "type": "startup",
       "frequency": 300000,
-      "query_object": {}
+      "query_object": {},
+      "addlHeaders": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -123,6 +139,12 @@
         {
           "path": "/get/devices",
           "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
           "query": {},
           "body": {},
           "headers": {},
@@ -184,6 +206,45 @@
           "responseFields": {}
         }
       ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "",
+          "frequency": 1440,
+          "flushOnFail": false,
+          "limit": 1000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "",
+              "method": "GET",
+              "pagination": {
+                "offsetVar": "",
+                "limitVar": "",
+                "incrementBy": "limit",
+                "requestLocation": "query"
+              },
+              "query": {},
+              "body": {},
+              "headers": {},
+              "handleFailure": "ignore",
+              "requestFields": {},
+              "responseDatakey": "",
+              "responseFields": {}
+            }
+          ],
+          "cachedTasks": [
+            {
+              "name": "",
+              "filterField": "",
+              "filterLoc": ""
+            }
+          ]
+        }
+      ]
     }
   },
   "groups": [],

package/test/integration/adapterTestBasicGet.js

@@ -7,9 +7,9 @@
 /* eslint import/no-dynamic-require: warn */
 /* eslint import/no-unresolved: warn */
 
-const mocha = require('mocha');
 const path = require('path');
 const assert = require('assert');
+const mocha = require('mocha');
 const itParam = require('mocha-param');
 
 const utils = require('../../utils/tbUtils');
@@ -18,12 +18,10 @@ 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);
+  const pronghornProps = utils.decryptProperties(rawProps, iapDir);
   console.log('Found properties.\n');
   return pronghornProps;
 };

package/test/integration/adapterTestConnectivity.js

@@ -3,9 +3,12 @@
 /* global describe it context before after */
 /* eslint no-unused-vars: warn */
 
-const mocha = require('mocha');
 const assert = require('assert');
-const diagnostics = require('network-diagnostics');
+const http = require('http');
+const https = require('https');
+const mocha = require('mocha');
+const ping = require('ping');
+const dnsLookup = require('dns-lookup-promise');
 
 let host;
 process.argv.forEach((val) => {
@@ -16,78 +19,124 @@ process.argv.forEach((val) => {
 
 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);
-        }
-      });
+      dnsLookup(host)
+        .then((addresses) => {
+          try {
+            assert.ok(addresses.length > 0);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Responds to ping', (done) => {
-      diagnostics.havePing((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      ping.promise.probe(host)
+        .then((result) => {
+          try {
+            assert.ok(result.alive);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Support HTTP on port 80', (done) => {
-      diagnostics.haveHTTP((result) => {
+      const requestOptions = {
+        host,
+        port: 80,
+        method: 'HEAD'
+      };
+
+      const req = http.request(requestOptions, (res) => {
         try {
-          assert.equal(result, true);
+          assert.ok(res.statusCode >= 200 && res.statusCode < 400);
           done();
         } catch (error) {
           done(error);
         }
       });
+
+      req.on('error', (err) => {
+        done(err);
+      });
+
+      req.end();
     });
 
     it('Support HTTPS on port 443', (done) => {
-      diagnostics.haveHTTPS((result) => {
+      const requestOptions = {
+        host,
+        port: 443,
+        method: 'HEAD'
+      };
+
+      const req = https.request(requestOptions, (res) => {
         try {
-          assert.equal(result, true);
+          assert.ok(res.statusCode >= 200 && res.statusCode < 400);
           done();
         } catch (error) {
           done(error);
         }
       });
+
+      req.on('error', (err) => {
+        done(err);
+      });
+
+      req.end();
     });
 
     it('Support IPv4', (done) => {
-      diagnostics.haveIPv4Async((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      const options = {
+        family: 4,
+        hints: dnsLookup.ADDRCONFIG
+      };
+
+      dnsLookup.lookup(host, options)
+        .then((address, family) => {
+          try {
+            assert.ok(address !== null && family === 4);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Support IPv6', (done) => {
-      diagnostics.haveIPv6Async((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      const options = {
+        family: 6,
+        hints: dnsLookup.ADDRCONFIG
+      };
+
+      dnsLookup.lookup(host, options)
+        .then((address, family) => {
+          try {
+            assert.ok(address !== null && family === 6);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
   });
 });