@itentialopensource/adapter-robustel 0.1.1 → 0.2.0

package/sampleProperties.json

@@ -8,7 +8,8 @@
     "version": "",
     "cache_location": "none",
     "encode_pathvars": true,
-    "save_metric": true,
+    "encode_queryvars": true,
+    "save_metric": false,
     "stub": false,
     "protocol": "https",
     "authentication": {
@@ -22,9 +23,13 @@
       "auth_field": "header.headers.Authorization",
       "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
       "auth_logging": false,
-      "client_id": "",
-      "client_secret": "",
-      "grant_type": ""
+      "client_id": "id",
+      "client_secret": "secret",
+      "grant_type": "",
+      "api_version": "1.0",
+      "signature_version": "1.0",
+      "unique_code": "unique_code"
+
     },
     "healthcheck": {
       "type": "none",
@@ -97,6 +102,94 @@
         "key_file": "",
         "cert_file": ""
       }
+    },
+    "devicebroker": {
+      "getDevice": [
+        {
+          "path": "/get/devices/{id}",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "name": "host",
+            "ostype": "os",
+            "ostypePrefix": "system-",
+            "ipaddress": "attributes.ipaddr",
+            "port": "443"
+          }
+        }
+      ],
+      "getDevicesFiltered": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "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": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {
+            "status": "status",
+            "statusValue": "online"
+          }
+        }
+      ],
+      "getConfig": [
+        {
+          "path": "/get/devices/{id}/configPart1",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {
+            "id": "name"
+          },
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ],
+      "getCount": [
+        {
+          "path": "/get/devices",
+          "method": "GET",
+          "query": {},
+          "body": {},
+          "headers": {},
+          "handleFailure": "ignore",
+          "requestFields": {},
+          "responseDatakey": "",
+          "responseFields": {}
+        }
+      ]
     }
   },
   "groups": [],

package/test/integration/adapterTestBasicGet.js

@@ -34,7 +34,7 @@ describe('[integration] Adapter BasicGET Test', () => {
   context('Testing GET calls without query parameters', () => {
     before(async () => {
       const iapDir = path.join(__dirname, '../../../../../');
-      if (!utils.withinIAP(iapDir)) {
+      if (!utils.areWeUnderIAPinstallationDirectory()) {
         const sampleProperties = require('../../sampleProperties.json');
         const adapter = { properties: sampleProperties };
         a = basicGet.getAdapterInstance(adapter);

package/test/integration/adapterTestIntegration.js

@@ -3,6 +3,8 @@
 // Set globals
 /* global describe it log pronghornProps */
 /* eslint no-unused-vars: warn */
+/* eslint no-underscore-dangle: warn  */
+/* eslint import/no-dynamic-require:warn */
 
 // include required items for testing & logging
 const assert = require('assert');
@@ -14,27 +16,38 @@ const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
 const util = require('util');
-const pronghorn = require('../../pronghorn.json');
 
-pronghorn.methodsByName = pronghorn.methods.reduce((result, meth) => ({ ...result, [meth.name]: meth }), {});
 const anything = td.matchers.anything();
 
 // stub and attemptTimeout are used throughout the code so set them here
 let logLevel = 'none';
-const stub = true;
 const isRapidFail = false;
 const isSaveMockData = false;
-const attemptTimeout = 5000;
+
+// read in the properties from the sampleProperties files
+let adaptdir = __dirname;
+if (adaptdir.endsWith('/test/integration')) {
+  adaptdir = adaptdir.substring(0, adaptdir.length - 17);
+} else if (adaptdir.endsWith('/test/unit')) {
+  adaptdir = adaptdir.substring(0, adaptdir.length - 10);
+}
+const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
 
 // these variables can be changed to run in integrated mode so easier to set them here
 // always check these in with bogus data!!!
-const host = 'replace.hostorip.here';
-const username = 'username';
-const password = 'password';
-const protocol = 'http';
-const port = 80;
-const sslenable = false;
-const sslinvalid = false;
+samProps.stub = true;
+samProps.host = 'replace.hostorip.here';
+samProps.authentication.username = 'username';
+samProps.authentication.password = 'password';
+samProps.protocol = 'http';
+samProps.port = 80;
+samProps.ssl.enabled = false;
+samProps.ssl.accept_invalid_cert = false;
+if (samProps.request.attempt_timeout < 30000) {
+  samProps.request.attempt_timeout = 30000;
+}
+const attemptTimeout = samProps.request.attempt_timeout;
+const { stub } = samProps;
 
 // these are the adapter properties. You generally should not need to alter
 // any of these after they are initially set up
@@ -46,105 +59,7 @@ global.pronghornProps = {
     adapters: [{
       id: 'Test-robustel',
       type: 'Robustel',
-      properties: {
-        host,
-        port,
-        base_path: '/api/link',
-        version: '',
-        cache_location: 'none',
-        encode_pathvars: true,
-        save_metric: false,
-        stub,
-        protocol,
-        authentication: {
-          auth_method: 'no_authentication',
-          username,
-          password,
-          token: '',
-          invalid_token_error: 401,
-          token_timeout: -1,
-          token_cache: 'local',
-          auth_field: 'header.headers.Authorization',
-          auth_field_format: 'Basic {b64}{username}:{password}{/b64}',
-          auth_logging: false,
-          client_id: 'client_id',
-          client_secret: 'client_secret',
-          grant_type: '',
-          api_version: '1.0',
-          signature_version: '1.0',
-          unique_code: 'unique_code'
-        },
-        healthcheck: {
-          type: 'none',
-          frequency: 60000,
-          query_object: {}
-        },
-        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: attemptTimeout,
-          global_request: {
-            payload: {},
-            uriOptions: {},
-            addlHeaders: {},
-            authData: {}
-          },
-          healthcheck_on_timeout: true,
-          return_raw: true,
-          archiving: false,
-          return_request: false
-        },
-        proxy: {
-          enabled: false,
-          host: '',
-          port: 1,
-          protocol: 'http',
-          username: '',
-          password: ''
-        },
-        ssl: {
-          ecdhCurve: '',
-          enabled: sslenable,
-          accept_invalid_cert: sslinvalid,
-          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: ''
-          }
-        }
-      }
+      properties: samProps
     }]
   }
 };
@@ -428,202 +343,157 @@ describe('[integration] Robustel Adapter Test', () => {
     -----------------------------------------------------------------------
     -----------------------------------------------------------------------
     */
-    let skipCount = 0;
-
     describe('#getDeviceTotal - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        if (pronghorn.methodsByName.getDeviceTotal.task) {
-          try {
-            a.getDeviceTotal((data, error) => {
-              try {
-                if (stub) {
-                  const displayE = 'Error 400 received on request';
-                  runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
-                } else {
-                  runCommonAsserts(data, error);
-                }
-                saveMockData('Dashboard', 'getDeviceTotal', 'default', data);
-                done();
-              } catch (err) {
-                log.error(`Test Failure: ${err}`);
-                done(err);
+        try {
+          a.getDeviceTotal((data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
               }
-            });
-          } catch (error) {
-            log.error(`Adapter Exception: ${error}`);
-            done(error);
-          }
-        } else {
-          log.error('getDeviceTotal task is false, skipping test');
-          skipCount += 1;
-          done();
-        }// end if task
+              saveMockData('Dashboard', 'getDeviceTotal', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
       }).timeout(attemptTimeout);
     });
 
     describe('#getNetworkTotal - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        if (pronghorn.methodsByName.getNetworkTotal.task) {
-          try {
-            a.getNetworkTotal((data, error) => {
-              try {
-                if (stub) {
-                  const displayE = 'Error 400 received on request';
-                  runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
-                } else {
-                  runCommonAsserts(data, error);
-                }
-                saveMockData('Dashboard', 'getNetworkTotal', 'default', data);
-                done();
-              } catch (err) {
-                log.error(`Test Failure: ${err}`);
-                done(err);
+        try {
+          a.getNetworkTotal((data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
               }
-            });
-          } catch (error) {
-            log.error(`Adapter Exception: ${error}`);
-            done(error);
-          }
-        } else {
-          log.error('getNetworkTotal task is false, skipping test');
-          skipCount += 1;
-          done();
-        }// end if task
+              saveMockData('Dashboard', 'getNetworkTotal', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
       }).timeout(attemptTimeout);
     });
 
     const deviceCommandId = 'fakedata';
     describe('#getFirmwareUpdateResult - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        if (pronghorn.methodsByName.getFirmwareUpdateResult.task) {
-          try {
-            a.getFirmwareUpdateResult(deviceCommandId, (data, error) => {
-              try {
-                if (stub) {
-                  const displayE = 'Error 400 received on request';
-                  runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
-                } else {
-                  runCommonAsserts(data, error);
-                }
-                saveMockData('Device', 'getFirmwareUpdateResult', 'default', data);
-                done();
-              } catch (err) {
-                log.error(`Test Failure: ${err}`);
-                done(err);
+        try {
+          a.getFirmwareUpdateResult(deviceCommandId, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
               }
-            });
-          } catch (error) {
-            log.error(`Adapter Exception: ${error}`);
-            done(error);
-          }
-        } else {
-          log.error('getFirmwareUpdateResult task is false, skipping test');
-          skipCount += 1;
-          done();
-        }// end if task
+              saveMockData('Device', 'getFirmwareUpdateResult', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
       }).timeout(attemptTimeout);
     });
 
     const deviceSerialNumber = 'fakedata';
     describe('#getDeviceDetails - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        if (pronghorn.methodsByName.getDeviceDetails.task) {
-          try {
-            a.getDeviceDetails(deviceSerialNumber, (data, error) => {
-              try {
-                if (stub) {
-                  const displayE = 'Error 400 received on request';
-                  runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
-                } else {
-                  runCommonAsserts(data, error);
-                }
-                saveMockData('Device', 'getDeviceDetails', 'default', data);
-                done();
-              } catch (err) {
-                log.error(`Test Failure: ${err}`);
-                done(err);
+        try {
+          a.getDeviceDetails(deviceSerialNumber, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
               }
-            });
-          } catch (error) {
-            log.error(`Adapter Exception: ${error}`);
-            done(error);
-          }
-        } else {
-          log.error('getDeviceDetails task is false, skipping test');
-          skipCount += 1;
-          done();
-        }// end if task
+              saveMockData('Device', 'getDeviceDetails', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
       }).timeout(attemptTimeout);
     });
 
     const deviceRunCommandOnDeviceBodyParam = {};
     describe('#runCommandOnDevice - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        if (pronghorn.methodsByName.runCommandOnDevice.task) {
-          try {
-            a.runCommandOnDevice(deviceSerialNumber, deviceRunCommandOnDeviceBodyParam, (data, error) => {
-              try {
-                if (stub) {
-                  const displayE = 'Error 400 received on request';
-                  runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
-                } else {
-                  runCommonAsserts(data, error);
-                }
-                saveMockData('Device', 'runCommandOnDevice', 'default', data);
-                done();
-              } catch (err) {
-                log.error(`Test Failure: ${err}`);
-                done(err);
+        try {
+          a.runCommandOnDevice(deviceSerialNumber, deviceRunCommandOnDeviceBodyParam, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
               }
-            });
-          } catch (error) {
-            log.error(`Adapter Exception: ${error}`);
-            done(error);
-          }
-        } else {
-          log.error('runCommandOnDevice task is false, skipping test');
-          skipCount += 1;
-          done();
-        }// end if task
+              saveMockData('Device', 'runCommandOnDevice', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
       }).timeout(attemptTimeout);
     });
 
     describe('#getDeviceFirmwareList - errors', () => {
       it('should work if integrated but since no mockdata should error when run standalone', (done) => {
-        if (pronghorn.methodsByName.getDeviceFirmwareList.task) {
-          try {
-            a.getDeviceFirmwareList(deviceSerialNumber, (data, error) => {
-              try {
-                if (stub) {
-                  const displayE = 'Error 400 received on request';
-                  runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
-                } else {
-                  runCommonAsserts(data, error);
-                }
-                saveMockData('Device', 'getDeviceFirmwareList', 'default', data);
-                done();
-              } catch (err) {
-                log.error(`Test Failure: ${err}`);
-                done(err);
+        try {
+          a.getDeviceFirmwareList(deviceSerialNumber, (data, error) => {
+            try {
+              if (stub) {
+                const displayE = 'Error 400 received on request';
+                runErrorAsserts(data, error, 'AD.500', 'Test-robustel-connectorRest-handleEndResponse', displayE);
+              } else {
+                runCommonAsserts(data, error);
               }
-            });
-          } catch (error) {
-            log.error(`Adapter Exception: ${error}`);
-            done(error);
-          }
-        } else {
-          log.error('getDeviceFirmwareList task is false, skipping test');
-          skipCount += 1;
-          done();
-        }// end if task
+              saveMockData('Device', 'getDeviceFirmwareList', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
       }).timeout(attemptTimeout);
     });
-
-    describe('#Skipped test count', () => {
-      it('count skipped tests', (done) => {
-        console.log(`skipped ${skipCount} tests because \x1b[33mtask: false\x1b[0m`);
-        done();
-      });
-    });
   });
 });