@itentialopensource/adapter-checkpoint_management 0.2.3 → 0.2.6

package/propertiesSchema.json

@@ -46,8 +46,16 @@
         "none"
       ]
     },
-    "save_metric": {
+    "encode_pathvars": {
       "type": "boolean",
+      "description": "When true the path variables are encoded in the url",
+      "default": true
+    },
+    "save_metric": {
+      "type": [
+        "boolean",
+        "string"
+      ],
       "description": "When true the metrics collected by the adapter will be stored in mongo or on the filesystem",
       "default": false
     },
@@ -104,6 +112,7 @@
           "enum": [
             "basic user_password",
             "static_token",
+            "jwt_token",
             "request_token",
             "no_authentication"
           ]
@@ -190,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": [
@@ -202,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": [
@@ -212,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": [
@@ -311,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": [
@@ -370,7 +409,7 @@
           "type": "integer",
           "description": "defines the number of request that Pronghorn can send checkpoint_management at one time",
           "default": 1,
-          "minimum": 1,
+          "minimum": 0,
           "maximum": 1000
         },
         "expire_timeout": {
@@ -386,6 +425,23 @@
           "default": 200,
           "minimum": 50,
           "maximum": 60000
+        },
+        "priorities": {
+          "type": "array",
+          "description": "define your priorities here",
+          "items": {
+            "type": "object",
+            "properties": {
+              "value": {
+                "type": "number",
+                "description": "Defines a priority - this number is what is passed in on a priority request"
+              },
+              "percent": {
+                "type": "number",
+                "description": "this is the percent of the queue that comes before the priority request (0 is front of queue, 100 is last in queue)"
+              }
+            }
+          }
         }
       },
       "required": [
@@ -433,11 +489,12 @@
           "maximum": 20
         },
         "limit_retry_error": {
-          "type": "integer",
-          "description": "http error status number which defines that no capacity was available and thus after waiting a short interval the adapter can retry the request",
-          "default": 0,
-          "minimum": 0,
-          "maximum": 1000
+          "type": [
+            "integer",
+            "array"
+          ],
+          "description": "http error status number which defines that no capacity was available and thus after waiting a short interval the adapter can retry the request. Supports an array of numbers or strings including a range provided as '###-###'",
+          "default": 0
         },
         "failover_codes": {
           "type": "array",
@@ -489,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": [
@@ -529,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": [
@@ -582,7 +655,7 @@
           "description": "The fully qualified path name to the CA file used for SSL",
           "default": "",
           "examples": [
-            "keys/key.pem"
+            "security/ca.pem"
           ]
         },
         "key_file": {

package/report/updateReport1594060676288.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": 9298
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 619
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 10256
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 300
+    },
+    {
+      "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": 20305
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 919
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/report/updateReport1614705421970.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.1"
+    },
+    {
+      "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": 9305
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 619
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 10263
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 300
+    },
+    {
+      "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": 20575
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 919
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/report/updateReport1646177180887.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": 9922
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 645
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 10273
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 300
+    },
+    {
+      "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": 21224
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 945
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -2,28 +2,38 @@
   "id": "Adapter-checkpoint_management",
   "type": "CheckpointManagement",
   "properties": {
-    "host": "localhost",
+    "host": "INSERT CHECKPOINT HOST HERE",
     "port": 443,
     "base_path": "/web_api",
     "version": "",
     "cache_location": "none",
+    "encode_pathvars": true,
     "save_metric": true,
-    "stub": true,
+    "stub": false,
     "protocol": "https",
     "authentication": {
       "auth_method": "request_token",
-      "username": "username",
-      "password": "password",
+      "username": "INSERT USER NAME HERE",
+      "password": "INSERT PASSWORD HERE",
       "token": "",
-      "token_timeout": 600000,
+      "token_user_field": "user",
+      "token_password_field": "password",
+      "token_result_field": "sid",
+      "token_URI_path": "/login",
+      "invalid_token_error": 400,
+      "token_timeout": 300000,
       "token_cache": "local",
-      "invalid_token_error": 401,
-      "auth_field": "header.headers.X-chkp-sid",
-      "auth_field_format": "{token}"
+      "auth_field": "header.headers.x-chkp-sid",
+      "auth_field_format": "{token}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
     },
     "healthcheck": {
       "type": "startup",
-      "frequency": 60000
+      "frequency": 60000,
+      "query_object": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -32,7 +42,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 +64,16 @@
       },
       "healthcheck_on_timeout": true,
       "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));
+    });
+  });
+});