@itentialopensource/adapter-bluecat_ipam 0.1.1

package/sampleProperties.json

@@ -0,0 +1,264 @@
+{
+  "id": "Adapter-bluecat_ipam",
+  "type": "BluecatIpam",
+  "properties": {
+    "host": "localhost",
+    "port": 80,
+    "choosepath": "",
+    "base_path": "/",
+    "version": "",
+    "cache_location": "none",
+    "encode_pathvars": true,
+    "encode_queryvars": true,
+    "save_metric": false,
+    "stub": true,
+    "protocol": "http",
+    "authentication": {
+      "auth_method": "request_token",
+      "username": "username",
+      "password": "password",
+      "token": "token",
+      "token_timeout": 1800000,
+      "token_cache": "local",
+      "invalid_token_error": 401,
+      "auth_field": "header.headers.Authorization",
+      "auth_field_format": "Basic {token}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": "",
+      "auth_request_datatype": "",
+      "auth_response_datatype": "",
+      "token_response_placement": "",
+      "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,
+      "keep_alive_interval": 0
+    },
+    "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": {
+      "url": "",
+      "host": "",
+      "port": 0,
+      "database": "",
+      "dbAuth": false,
+      "username": "",
+      "password": "",
+      "replSet": "",
+      "addSrv": false,
+      "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,117 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe it log 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 */
+/* eslint no-loop-func: warn */
+
+/* This performs a number of GET calls (defaults to 5 calls) which do not reuire an input, to test connectivity and functionality.
+The number of calls can be modified if running from CLI. */
+
+const assert = require('assert');
+
+const log = require('../../utils/logger');
+const { id } = require('../../package.json');
+const { methods } = require('../../pronghorn.json');
+const { parseArgs } = require('../../utils/argParser');
+
+const {
+  properties, maxCalls
+} = parseArgs();
+
+// require the adapter that we are going to be using
+const TestAdapter = require('../../adapter');
+
+if (!properties) {
+  log.warn('No properties provided. Exiting process.');
+  process.exit(1);
+}
+
+let successCount = 0;
+let calls = 0;
+let attemptTimeout = 60000;
+if (properties.request && properties.request.attempt_timeout) {
+  attemptTimeout = properties.request.attempt_timeout;
+}
+
+// turn off stub mode - basic get should not be run in stub mode
+properties.stub = false;
+
+describe('[integration] Adapter BasicGET Test', () => {
+  describe('Class Tests', () => {
+    const testAdapter = new TestAdapter(
+      id,
+      properties
+    );
+
+    after((done) => {
+      if (successCount === calls) {
+        log.info('\x1b[32m%s\x1b[0m', `\n\nSUCCESS: ${successCount} test(s) passed of ${calls} executed!`);
+      } else if (successCount > 0) {
+        log.error('\x1b[32m%s\x1b[0m', `\n\nPARTIAL SUCCESS: ${successCount} test(s) passed of ${calls} executed!`);
+      } else {
+        log.error('\x1b[31m%s\x1b[0m', '\n\nFAILURE: All tests failed.');
+      }
+      done();
+    });
+
+    const basicGets = methods.filter((method) => {
+      // ignore iapMetadata as the input since its optional and all functions will have it
+      const inputKeys = (method.input || [])
+        .map((param) => param.name)
+        .filter((name) => name !== 'iapMetadata');
+      return method.route.verb === 'GET' && inputKeys.length === 0 && !method.name.startsWith('iap');
+    });
+
+    if (basicGets.length === 0) {
+      log.warn('No non-parameter GET calls found.');
+      process.exitCode = 0;
+      return;
+    }
+
+    const functionNames = basicGets.map((g) => g.name);
+    calls = functionNames.length;
+    if (calls > maxCalls) {
+      calls = maxCalls;
+    }
+
+    // test up to the first 5 get calls without parameters
+    for (let f = 0; f < calls; f += 1) {
+      const fnName = functionNames[f];
+      const method = basicGets.find((m) => m.name === fnName);
+      const hasIapMetadata = Array.isArray(method.input) && method.input.some((param) => param.name === 'iapMetadata');
+      describe(`#${functionNames[f]}`, () => {
+        it('should return valid response without error', (done) => {
+          const callback = (data, error) => {
+            try {
+              assert.equal(undefined, error);
+              assert.notEqual(undefined, data);
+              assert.notEqual(null, data);
+              assert.notEqual(undefined, data.response);
+              assert.notEqual(null, data.response);
+              successCount += 1;
+              done();
+            } catch (err) {
+              log.error(`Test Failure in ${fnName}: ${err}`);
+              done(err);
+            }
+          };
+
+          try {
+            if (hasIapMetadata) {
+              testAdapter[fnName](null, callback);
+            } else {
+              testAdapter[fnName](callback);
+            }
+          } catch (err) {
+            log.error(`Unexpected error in test for ${fnName}: ${err}`);
+            done(err);
+          }
+        }).timeout(attemptTimeout);
+      });
+    }
+  });
+});

package/test/integration/adapterTestConnectivity.js

@@ -0,0 +1,117 @@
+/* @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 dns = require('dns');
+const { parseArgs } = require('../../utils/argParser');
+
+const dnsPromises = dns.promises;
+const { host } = parseArgs();
+
+describe('[integration] Adapter Test', () => {
+  context(`Testing network connection on ${host}`, () => {
+    after((done) => {
+      done();
+    });
+
+    it('DNS resolve', (done) => {
+      dnsPromises.lookup(host, { all: true })
+        .then((result) => {
+          try {
+            assert.ok(result.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: dns.ADDRCONFIG
+      };
+
+      dnsPromises.lookup(host, options)
+        .then((result) => {
+          try {
+            const { address, family } = result;
+            assert.ok(address !== null && family === 4);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
+    });
+
+    it('Support IPv6', (done) => {
+      const options = {
+        family: 6,
+        hints: dns.ADDRCONFIG
+      };
+
+      dnsPromises.lookup(host, options)
+        .then((result) => {
+          try {
+            const { address, family } = result;
+            assert.ok(address !== null && family === 6);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
+    });
+  });
+});