@itentialopensource/adapter-sectigo_certification_manager 0.1.1

package/sampleProperties.json

@@ -0,0 +1,265 @@
+{
+  "id": "Adapter-sectigo_certification_manager",
+  "type": "SectigoCertificationManager",
+  "properties": {
+    "host": "localhost",
+    "port": 443,
+    "choosepath": "",
+    "base_path": "/",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "https",
+    "authentication": {
+      "auth_method": "static_token",
+      "username": "username",
+      "password": "password",
+      "token": "token",
+      "token_timeout": 600000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": [
+        "header.headers.login",
+        "header.headers.password",
+        "header.headers.customerUri"
+      ],
+      "auth_field_format": [
+        "{username}",
+        "{password}",
+        "{token}"
+      ],
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "",
+      "sensitive": [],
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      }
+    },
+    "healthcheck": {
+      "type": "none",
+      "frequency": 60000,
+      "query_object": {},
+      "addlHeaders": {}
+    },
+    "throttle": {
+      "throttle_enabled": false,
+      "number_pronghorns": 1,
+      "sync_async": "sync",
+      "max_in_queue": 1000,
+      "concurrent_max": 1,
+      "expire_timeout": 0,
+      "avg_runtime": 200,
+      "priorities": [
+        {
+          "value": 0,
+          "percent": 100
+        }
+      ]
+    },
+    "request": {
+      "number_redirects": 0,
+      "number_retries": 3,
+      "limit_retry_error": [
+        0
+      ],
+      "failover_codes": [],
+      "attempt_timeout": 5000,
+      "global_request": {
+        "payload": {},
+        "uriOptions": {},
+        "addlHeaders": {},
+        "authData": {}
+      },
+      "healthcheck_on_timeout": true,
+      "return_raw": false,
+      "archiving": false,
+      "return_request": false
+    },
+    "proxy": {
+      "enabled": false,
+      "host": "",
+      "port": 1,
+      "protocol": "http",
+      "username": "",
+      "password": ""
+    },
+    "ssl": {
+      "ecdhCurve": "",
+      "enabled": false,
+      "accept_invalid_cert": false,
+      "ca_file": "",
+      "key_file": "",
+      "cert_file": "",
+      "secure_protocol": "",
+      "ciphers": ""
+    },
+    "mongo": {
+      "host": "",
+      "port": 0,
+      "database": "",
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "db_ssl": {
+        "enabled": false,
+        "accept_invalid_cert": false,
+        "ca_file": "",
+        "key_file": "",
+        "cert_file": ""
+      }
+    },
+    "devicebroker": {
+      "enabled": false,
+      "getDevice": [
+        {
+          "path": "/get/devices/{id}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "fail",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "fail",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "isAlive": [
+        {
+          "path": "/get/devices/{id}/status",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "fail",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "status",
+            "statusValue": "online"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/get/devices/{id}/configPart1",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "fail",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "fail",
+          "requestFields": {},
+          "responseDatakey": "",
+          "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": [],
+  "brokers": [],
+  "logLevel": "none",
+  "timeout": 120000
+}

package/test/integration/adapterTestBasicGet.js

@@ -0,0 +1,83 @@
+/* @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 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 { methods } = require('../../pronghorn.json');
+
+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;
+};
+
+let a;
+
+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);
+      } 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,118 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe it context before after */
+/* eslint no-unused-vars: warn */
+
+const assert = require('assert');
+const https = require('https');
+const mocha = require('mocha');
+const ping = require('ping');
+const dnsLookup = require('dns-lookup-promise');
+
+let host;
+process.argv.forEach((val) => {
+  if (val.indexOf('--HOST') === 0) {
+    [, host] = val.split('=');
+  }
+});
+
+describe('[integration] Adapter Test', () => {
+  context(`Testing network connection on ${host}`, () => {
+    after((done) => {
+      done();
+    });
+
+    it('DNS resolve', (done) => {
+      dnsLookup(host)
+        .then((addresses) => {
+          try {
+            assert.ok(addresses.length > 0);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
+    });
+
+    it('Responds to ping', (done) => {
+      ping.promise.probe(host)
+        .then((result) => {
+          try {
+            assert.ok(result.alive);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
+    });
+
+    it('Support HTTPS on port 443', (done) => {
+      const requestOptions = {
+        host,
+        port: 443,
+        method: 'HEAD'
+      };
+
+      const req = https.request(requestOptions, (res) => {
+        try {
+          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) => {
+      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) => {
+      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);
+        });
+    });
+  });
+});