@itentialopensource/adapter-checkpoint_management 0.4.0 → 0.6.0

package/report/updateReport1691152555900.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.0.5"
+    },
+    {
+      "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": 10059
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 658
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 10322
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 304
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1350
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 38
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 21731
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 962
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -4,13 +4,14 @@
   "properties": {
     "host": "INSERT CHECKPOINT HOST HERE",
     "port": 443,
+    "choosepath": "",
     "base_path": "/web_api",
     "version": "",
     "cache_location": "none",
     "encode_pathvars": true,
     "encode_queryvars": true,
     "save_metric": false,
-    "stub": false,
+    "stub": true,
     "protocol": "https",
     "authentication": {
       "auth_method": "request_token",
@@ -21,20 +22,35 @@
       "token_password_field": "password",
       "token_result_field": "sid",
       "token_URI_path": "/login",
-      "invalid_token_error": 400,
       "token_timeout": 3600000,
       "token_cache": "local",
+      "invalid_token_error": 400,
       "auth_field": "header.headers.x-chkp-sid",
       "auth_field_format": "{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": 60000,
-      "query_object": {}
+      "query_object": {},
+      "addlHeaders": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -107,72 +123,136 @@
     "devicebroker": {
       "getDevice": [
         {
-          "path": "/get/devices/{id}",
-          "method": "GET",
+          "path": "/show-simple-gateway",
+          "method": "POST",
           "query": {},
-          "body": {},
+          "body": {
+            "uid": "uid"
+          },
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "uid": "uid"
           },
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "name",
+            "ostype": "type",
+            "ostypePrefix": "chkpt-",
+            "ipaddress": "ipv4-address",
+            "port": "n/a"
+          }
+        },
+        {
+          "path": "/show-lsm-gateway",
+          "method": "POST",
+          "query": {},
+          "body": {
+            "uid": "uid"
+          },
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "uid": "uid"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "name",
+            "ostype": "type",
+            "ostypePrefix": "chkpt-",
+            "ipaddress": "ipv4-address",
+            "port": "n/a"
           }
         }
       ],
       "getDevicesFiltered": [
         {
-          "path": "/get/devices",
-          "method": "GET",
+          "path": "/show-gateways-and-servers",
+          "method": "POST",
           "query": {},
-          "body": {},
+          "body": {
+            "offset": "0",
+            "limit": "500"
+          },
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {},
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "name",
+            "ostype": "type",
+            "ostypePrefix": "chkpt-",
+            "ipaddress": "n/a",
+            "port": "n/a",
+            "uid": "uid"
           }
         }
       ],
       "isAlive": [
         {
-          "path": "/get/devices/{id}/status",
-          "method": "GET",
+          "path": "/show-simple-gateway",
+          "method": "POST",
+          "query": {},
+          "body": {
+            "uid": "uid"
+          },
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "uid": "uid"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "meta-info.validation-state",
+            "statusValue": "ok"
+          }
+        },
+        {
+          "path": "/show-lsm-gateway",
+          "method": "POST",
           "query": {},
-          "body": {},
+          "body": {
+            "uid": "uid"
+          },
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "uid": "uid"
           },
           "responseDatakey": "",
           "responseFields": {
-            "status": "status",
-            "statusValue": "online"
+            "status": "meta-info.validation-state",
+            "statusValue": "ok"
           }
         }
       ],
       "getConfig": [
         {
-          "path": "/get/devices/{id}/configPart1",
-          "method": "GET",
+          "path": "/show-simple-gateway",
+          "method": "POST",
           "query": {},
-          "body": {},
+          "body": {
+            "uid": "uid"
+          },
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "uid": "uid"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        },
+        {
+          "path": "/show-lsm-gateway",
+          "method": "POST",
+          "query": {},
+          "body": {
+            "uid": "uid"
+          },
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "uid": "uid"
           },
           "responseDatakey": "",
           "responseFields": {}
@@ -180,10 +260,13 @@
       ],
       "getCount": [
         {
-          "path": "/get/devices",
-          "method": "GET",
+          "path": "/show-gateways-and-servers",
+          "method": "POST",
           "query": {},
-          "body": {},
+          "body": {
+            "offset": "0",
+            "limit": "500"
+          },
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {},
@@ -191,6 +274,42 @@
           "responseFields": {}
         }
       ]
+    },
+    "cache": {
+      "enabled": false,
+      "entities": [
+        {
+          "entityType": "device",
+          "frequency": 3600,
+          "flushOnFail": false,
+          "limit": 1000,
+          "retryAttempts": 5,
+          "sort": true,
+          "populate": [
+            {
+              "path": "/show-gateways-and-servers",
+              "method": "POST",
+              "query": {},
+              "body": {
+                "offset": "0",
+                "limit": "500"
+              },
+              "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);
+        });
     });
   });
 });