@itentialopensource/adapter-robustel 0.1.1

package/test/integration/adapterTestIntegration.js

@@ -0,0 +1,629 @@
+/* @copyright Itential, LLC 2019 (pre-modifications) */
+
+// Set globals
+/* global describe it log pronghornProps */
+/* eslint no-unused-vars: warn */
+
+// include required items for testing & logging
+const assert = require('assert');
+const fs = require('fs');
+const mocha = require('mocha');
+const path = require('path');
+const winston = require('winston');
+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;
+
+// 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;
+
+// these are the adapter properties. You generally should not need to alter
+// any of these after they are initially set up
+global.pronghornProps = {
+  pathProps: {
+    encrypted: false
+  },
+  adapterProps: {
+    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: ''
+          }
+        }
+      }
+    }]
+  }
+};
+
+global.$HOME = `${__dirname}/../..`;
+
+// set the log levels that Pronghorn uses, spam and trace are not defaulted in so without
+// this you may error on log.trace calls.
+const myCustomLevels = {
+  levels: {
+    spam: 6,
+    trace: 5,
+    debug: 4,
+    info: 3,
+    warn: 2,
+    error: 1,
+    none: 0
+  }
+};
+
+// need to see if there is a log level passed in
+process.argv.forEach((val) => {
+  // is there a log level defined to be passed in?
+  if (val.indexOf('--LOG') === 0) {
+    // get the desired log level
+    const inputVal = val.split('=')[1];
+
+    // validate the log level is supported, if so set it
+    if (Object.hasOwnProperty.call(myCustomLevels.levels, inputVal)) {
+      logLevel = inputVal;
+    }
+  }
+});
+
+// need to set global logging
+global.log = winston.createLogger({
+  level: logLevel,
+  levels: myCustomLevels.levels,
+  transports: [
+    new winston.transports.Console()
+  ]
+});
+
+/**
+ * Runs the common asserts for test
+ */
+function runCommonAsserts(data, error) {
+  assert.equal(undefined, error);
+  assert.notEqual(undefined, data);
+  assert.notEqual(null, data);
+  assert.notEqual(undefined, data.response);
+  assert.notEqual(null, data.response);
+}
+
+/**
+ * Runs the error asserts for the test
+ */
+function runErrorAsserts(data, error, code, origin, displayStr) {
+  assert.equal(null, data);
+  assert.notEqual(undefined, error);
+  assert.notEqual(null, error);
+  assert.notEqual(undefined, error.IAPerror);
+  assert.notEqual(null, error.IAPerror);
+  assert.notEqual(undefined, error.IAPerror.displayString);
+  assert.notEqual(null, error.IAPerror.displayString);
+  assert.equal(code, error.icode);
+  assert.equal(origin, error.IAPerror.origin);
+  assert.equal(displayStr, error.IAPerror.displayString);
+}
+
+/**
+ * @function saveMockData
+ * Attempts to take data from responses and place them in MockDataFiles to help create Mockdata.
+ * Note, this was built based on entity file structure for Adapter-Engine 1.6.x
+ * @param {string} entityName - Name of the entity saving mock data for
+ * @param {string} actionName -  Name of the action saving mock data for
+ * @param {string} descriptor -  Something to describe this test (used as a type)
+ * @param {string or object} responseData - The data to put in the mock file.
+ */
+function saveMockData(entityName, actionName, descriptor, responseData) {
+  // do not need to save mockdata if we are running in stub mode (already has mock data) or if told not to save
+  if (stub || !isSaveMockData) {
+    return false;
+  }
+
+  // must have a response in order to store the response
+  if (responseData && responseData.response) {
+    let data = responseData.response;
+
+    // if there was a raw response that one is better as it is untranslated
+    if (responseData.raw) {
+      data = responseData.raw;
+
+      try {
+        const temp = JSON.parse(data);
+        data = temp;
+      } catch (pex) {
+        // do not care if it did not parse as we will just use data
+      }
+    }
+
+    try {
+      const base = path.join(__dirname, `../../entities/${entityName}/`);
+      const mockdatafolder = 'mockdatafiles';
+      const filename = `mockdatafiles/${actionName}-${descriptor}.json`;
+
+      if (!fs.existsSync(base + mockdatafolder)) {
+        fs.mkdirSync(base + mockdatafolder);
+      }
+
+      // write the data we retrieved
+      fs.writeFile(base + filename, JSON.stringify(data, null, 2), 'utf8', (errWritingMock) => {
+        if (errWritingMock) throw errWritingMock;
+
+        // update the action file to reflect the changes. Note: We're replacing the default object for now!
+        fs.readFile(`${base}action.json`, (errRead, content) => {
+          if (errRead) throw errRead;
+
+          // parse the action file into JSON
+          const parsedJson = JSON.parse(content);
+
+          // The object update we'll write in.
+          const responseObj = {
+            type: descriptor,
+            key: '',
+            mockFile: filename
+          };
+
+          // get the object for method we're trying to change.
+          const currentMethodAction = parsedJson.actions.find((obj) => obj.name === actionName);
+
+          // if the method was not found - should never happen but...
+          if (!currentMethodAction) {
+            throw Error('Can\'t find an action for this method in the provided entity.');
+          }
+
+          // if there is a response object, we want to replace the Response object. Otherwise we'll create one.
+          const actionResponseObj = currentMethodAction.responseObjects.find((obj) => obj.type === descriptor);
+
+          // Add the action responseObj back into the array of response objects.
+          if (!actionResponseObj) {
+            // if there is a default response object, we want to get the key.
+            const defaultResponseObj = currentMethodAction.responseObjects.find((obj) => obj.type === 'default');
+
+            // save the default key into the new response object
+            if (defaultResponseObj) {
+              responseObj.key = defaultResponseObj.key;
+            }
+
+            // save the new response object
+            currentMethodAction.responseObjects = [responseObj];
+          } else {
+            // update the location of the mock data file
+            actionResponseObj.mockFile = responseObj.mockFile;
+          }
+
+          // Save results
+          fs.writeFile(`${base}action.json`, JSON.stringify(parsedJson, null, 2), (err) => {
+            if (err) throw err;
+          });
+        });
+      });
+    } catch (e) {
+      log.debug(`Failed to save mock data for ${actionName}. ${e.message}`);
+      return false;
+    }
+  }
+
+  // no response to save
+  log.debug(`No data passed to save into mockdata for ${actionName}`);
+  return false;
+}
+
+// require the adapter that we are going to be using
+const Robustel = require('../../adapter');
+
+// begin the testing - these should be pretty well defined between the describe and the it!
+describe('[integration] Robustel Adapter Test', () => {
+  describe('Robustel Class Tests', () => {
+    const a = new Robustel(
+      pronghornProps.adapterProps.adapters[0].id,
+      pronghornProps.adapterProps.adapters[0].properties
+    );
+
+    if (isRapidFail) {
+      const state = {};
+      state.passed = true;
+
+      mocha.afterEach(function x() {
+        state.passed = state.passed
+        && (this.currentTest.state === 'passed');
+      });
+      mocha.beforeEach(function x() {
+        if (!state.passed) {
+          return this.currentTest.skip();
+        }
+        return true;
+      });
+    }
+
+    describe('#class instance created', () => {
+      it('should be a class with properties', (done) => {
+        try {
+          assert.notEqual(null, a);
+          assert.notEqual(undefined, a);
+          const checkId = global.pronghornProps.adapterProps.adapters[0].id;
+          assert.equal(checkId, a.id);
+          assert.notEqual(null, a.allProps);
+          const check = global.pronghornProps.adapterProps.adapters[0].properties.healthcheck.type;
+          assert.equal(check, a.healthcheckType);
+          done();
+        } catch (error) {
+          log.error(`Test Failure: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#connect', () => {
+      it('should get connected - no healthcheck', (done) => {
+        try {
+          a.healthcheckType = 'none';
+          a.connect();
+
+          try {
+            assert.equal(true, a.alive);
+            done();
+          } catch (error) {
+            log.error(`Test Failure: ${error}`);
+            done(error);
+          }
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      });
+      it('should get connected - startup healthcheck', (done) => {
+        try {
+          a.healthcheckType = 'startup';
+          a.connect();
+
+          try {
+            assert.equal(true, a.alive);
+            done();
+          } catch (error) {
+            log.error(`Test Failure: ${error}`);
+            done(error);
+          }
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      });
+    });
+
+    describe('#healthCheck', () => {
+      it('should be healthy', (done) => {
+        try {
+          a.healthCheck(null, (data) => {
+            try {
+              assert.equal(true, a.healthy);
+              saveMockData('system', 'healthcheck', 'default', data);
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    /*
+    -----------------------------------------------------------------------
+    -----------------------------------------------------------------------
+    *** All code above this comment will be replaced during a migration ***
+    ******************* DO NOT REMOVE THIS COMMENT BLOCK ******************
+    -----------------------------------------------------------------------
+    -----------------------------------------------------------------------
+    */
+    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);
+              }
+            });
+          } catch (error) {
+            log.error(`Adapter Exception: ${error}`);
+            done(error);
+          }
+        } else {
+          log.error('getDeviceTotal task is false, skipping test');
+          skipCount += 1;
+          done();
+        }// end if task
+      }).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);
+              }
+            });
+          } catch (error) {
+            log.error(`Adapter Exception: ${error}`);
+            done(error);
+          }
+        } else {
+          log.error('getNetworkTotal task is false, skipping test');
+          skipCount += 1;
+          done();
+        }// end if task
+      }).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);
+              }
+            });
+          } catch (error) {
+            log.error(`Adapter Exception: ${error}`);
+            done(error);
+          }
+        } else {
+          log.error('getFirmwareUpdateResult task is false, skipping test');
+          skipCount += 1;
+          done();
+        }// end if task
+      }).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);
+              }
+            });
+          } catch (error) {
+            log.error(`Adapter Exception: ${error}`);
+            done(error);
+          }
+        } else {
+          log.error('getDeviceDetails task is false, skipping test');
+          skipCount += 1;
+          done();
+        }// end if task
+      }).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);
+              }
+            });
+          } catch (error) {
+            log.error(`Adapter Exception: ${error}`);
+            done(error);
+          }
+        } else {
+          log.error('runCommandOnDevice task is false, skipping test');
+          skipCount += 1;
+          done();
+        }// end if task
+      }).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);
+              }
+            });
+          } catch (error) {
+            log.error(`Adapter Exception: ${error}`);
+            done(error);
+          }
+        } else {
+          log.error('getDeviceFirmwareList task is false, skipping test');
+          skipCount += 1;
+          done();
+        }// end if task
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#Skipped test count', () => {
+      it('count skipped tests', (done) => {
+        console.log(`skipped ${skipCount} tests because \x1b[33mtask: false\x1b[0m`);
+        done();
+      });
+    });
+  });
+});