@itentialopensource/adapter-att_mobility 0.1.2 → 0.2.2

package/sampleProperties.json

@@ -1,9 +1,10 @@
 {
   "id": "Adapter-att_mobility",
-  "type": "att_mobility",
+  "type": "AttMobility",
   "properties": {
     "host": "apsapi.att.com",
     "port": 8082,
+    "choosepath": "",
     "base_path": "/",
     "version": "",
     "cache_location": "none",
@@ -25,12 +26,27 @@
       "auth_logging": false,
       "client_id": "",
       "client_secret": "",
-      "grant_type": ""
+      "grant_type": "",
+      "sensitive": [],
+      "sso": {
+        "protocol": "",
+        "host": "",
+        "port": 0
+      },
+      "multiStepAuthCalls": [
+        {
+          "name": "",
+          "requestFields": {},
+          "responseFields": {},
+          "successfullResponseCode": 200
+        }
+      ]
     },
     "healthcheck": {
       "type": "none",
       "frequency": 60000,
-      "query_object": {}
+      "query_object": {},
+      "addlHeaders": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -125,6 +141,12 @@
         {
           "path": "/get/devices",
           "method": "GET",
+          "pagination": {
+            "offsetVar": "",
+            "limitVar": "",
+            "incrementBy": "limit",
+            "requestLocation": "query"
+          },
           "query": {},
           "body": {},
           "headers": {},
@@ -186,6 +208,45 @@
           "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": [],

package/test/integration/adapterTestBasicGet.js

@@ -7,9 +7,9 @@
 /* eslint import/no-dynamic-require: warn */
 /* eslint import/no-unresolved: warn */
 
-const mocha = require('mocha');
 const path = require('path');
 const assert = require('assert');
+const mocha = require('mocha');
 const itParam = require('mocha-param');
 
 const utils = require('../../utils/tbUtils');

package/test/integration/adapterTestConnectivity.js

@@ -3,9 +3,12 @@
 /* global describe it context before after */
 /* eslint no-unused-vars: warn */
 
-const mocha = require('mocha');
 const assert = require('assert');
-const diagnostics = require('network-diagnostics');
+const http = require('http');
+const https = require('https');
+const mocha = require('mocha');
+const ping = require('ping');
+const dnsLookup = require('dns-lookup-promise');
 
 let host;
 process.argv.forEach((val) => {
@@ -16,78 +19,124 @@ process.argv.forEach((val) => {
 
 describe('[integration] Adapter Test', () => {
   context(`Testing network connection on ${host}`, () => {
-    before(() => {
-      diagnostics.setTestURL(host);
-    });
-
     after((done) => {
       done();
     });
 
     it('DNS resolve', (done) => {
-      diagnostics.haveDNS((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      dnsLookup(host)
+        .then((addresses) => {
+          try {
+            assert.ok(addresses.length > 0);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Responds to ping', (done) => {
-      diagnostics.havePing((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      ping.promise.probe(host)
+        .then((result) => {
+          try {
+            assert.ok(result.alive);
+            done();
+          } catch (error) {
+            done(error);
+          }
+        })
+        .catch((err) => {
+          done(err);
+        });
     });
 
     it('Support HTTP on port 80', (done) => {
-      diagnostics.haveHTTP((result) => {
+      const requestOptions = {
+        host,
+        port: 80,
+        method: 'HEAD'
+      };
+
+      const req = http.request(requestOptions, (res) => {
         try {
-          assert.equal(result, true);
+          assert.ok(res.statusCode >= 200 && res.statusCode < 400);
           done();
         } catch (error) {
           done(error);
         }
       });
+
+      req.on('error', (err) => {
+        done(err);
+      });
+
+      req.end();
     });
 
     it('Support HTTPS on port 443', (done) => {
-      diagnostics.haveHTTPS((result) => {
+      const requestOptions = {
+        host,
+        port: 443,
+        method: 'HEAD'
+      };
+
+      const req = https.request(requestOptions, (res) => {
         try {
-          assert.equal(result, true);
+          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) => {
-      diagnostics.haveIPv4Async((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      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) => {
-      diagnostics.haveIPv6Async((result) => {
-        try {
-          assert.equal(result, true);
-          done();
-        } catch (error) {
-          done(error);
-        }
-      });
+      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);
+        });
     });
   });
 });

package/test/integration/adapterTestIntegration.js

@@ -1,6 +1,3 @@
-/* eslint-disable import/no-dynamic-require */
-/* eslint-disable no-unused-vars */
-/* eslint-disable max-len */
 /* @copyright Itential, LLC 2019 (pre-modifications) */
 
 // Set globals
@@ -12,13 +9,13 @@
 // include required items for testing & logging
 const assert = require('assert');
 const fs = require('fs');
-const mocha = require('mocha');
 const path = require('path');
+const util = require('util');
+const mocha = require('mocha');
 const winston = require('winston');
 const { expect } = require('chai');
 const { use } = require('chai');
 const td = require('testdouble');
-const util = require('util');
 
 const anything = td.matchers.anything();
 
@@ -60,8 +57,8 @@ global.pronghornProps = {
   },
   adapterProps: {
     adapters: [{
-      id: 'Test-attmobility',
-      type: 'Attmobility',
+      id: 'Test-att_mobility',
+      type: 'AttMobility',
       properties: samProps
     }]
   }
@@ -237,12 +234,12 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
 }
 
 // require the adapter that we are going to be using
-const Attmobility = require('../../adapter');
+const AttMobility = require('../../adapter');
 
 // begin the testing - these should be pretty well defined between the describe and the it!
-describe('[integration] Attmobility Adapter Test', () => {
-  describe('Attmobility Class Tests', () => {
-    const a = new Attmobility(
+describe('[integration] AttMobility Adapter Test', () => {
+  describe('AttMobility Class Tests', () => {
+    const a = new AttMobility(
       pronghornProps.adapterProps.adapters[0].id,
       pronghornProps.adapterProps.adapters[0].properties
     );
@@ -338,6 +335,134 @@ describe('[integration] Attmobility Adapter Test', () => {
       }).timeout(attemptTimeout);
     });
 
+    // broker tests
+    describe('#getDevicesFiltered - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          const opts = {
+            filter: {
+              name: 'deviceName'
+            }
+          };
+          a.getDevicesFiltered(opts, (data, error) => {
+            try {
+              if (stub) {
+                if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
+                  assert.equal(null, error);
+                  assert.notEqual(undefined, data);
+                  assert.notEqual(null, data);
+                  assert.equal(0, data.total);
+                  assert.equal(0, data.list.length);
+                } else {
+                  const displayE = 'Error 400 received on request';
+                  runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
+                }
+              } else {
+                runCommonAsserts(data, error);
+              }
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#iapGetDeviceCount - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          const opts = {
+            filter: {
+              name: 'deviceName'
+            }
+          };
+          a.iapGetDeviceCount((data, error) => {
+            try {
+              if (stub) {
+                if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
+                  assert.equal(null, error);
+                  assert.notEqual(undefined, data);
+                  assert.notEqual(null, data);
+                  assert.equal(0, data.count);
+                } else {
+                  const displayE = 'Error 400 received on request';
+                  runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
+                }
+              } else {
+                runCommonAsserts(data, error);
+              }
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    // exposed cache tests
+    describe('#iapPopulateEntityCache - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.iapPopulateEntityCache('Device', (data, error) => {
+            try {
+              if (stub) {
+                assert.equal(null, data);
+                assert.notEqual(undefined, error);
+                assert.notEqual(null, error);
+                done();
+              } else {
+                assert.equal(undefined, error);
+                assert.equal('success', data[0]);
+                done();
+              }
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
+
+    describe('#iapRetrieveEntitiesCache - errors', () => {
+      it('should work if integrated but since no mockdata should error when run standalone', (done) => {
+        try {
+          a.iapRetrieveEntitiesCache('Device', {}, (data, error) => {
+            try {
+              if (stub) {
+                assert.equal(null, data);
+                assert.notEqual(null, error);
+                assert.notEqual(undefined, error);
+              } else {
+                assert.equal(undefined, error);
+                assert.notEqual(null, data);
+                assert.notEqual(undefined, data);
+              }
+              done();
+            } catch (err) {
+              log.error(`Test Failure: ${err}`);
+              done(err);
+            }
+          });
+        } catch (error) {
+          log.error(`Adapter Exception: ${error}`);
+          done(error);
+        }
+      }).timeout(attemptTimeout);
+    });
     /*
     -----------------------------------------------------------------------
     -----------------------------------------------------------------------
@@ -355,7 +480,7 @@ describe('[integration] Attmobility Adapter Test', () => {
             try {
               if (stub) {
                 const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-attmobility-connectorRest-handleEndResponse', displayE);
+                runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
               } else {
                 runCommonAsserts(data, error);
               }
@@ -381,7 +506,7 @@ describe('[integration] Attmobility Adapter Test', () => {
             try {
               if (stub) {
                 const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-attmobility-connectorRest-handleEndResponse', displayE);
+                runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
               } else {
                 runCommonAsserts(data, error);
               }
@@ -408,7 +533,7 @@ describe('[integration] Attmobility Adapter Test', () => {
             try {
               if (stub) {
                 const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-attmobility-connectorRest-handleEndResponse', displayE);
+                runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
               } else {
                 runCommonAsserts(data, error);
               }
@@ -434,7 +559,7 @@ describe('[integration] Attmobility Adapter Test', () => {
             try {
               if (stub) {
                 const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-attmobility-connectorRest-handleEndResponse', displayE);
+                runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
               } else {
                 runCommonAsserts(data, error);
               }
@@ -460,7 +585,7 @@ describe('[integration] Attmobility Adapter Test', () => {
             try {
               if (stub) {
                 const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-attmobility-connectorRest-handleEndResponse', displayE);
+                runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
               } else {
                 runCommonAsserts(data, error);
               }
@@ -486,7 +611,7 @@ describe('[integration] Attmobility Adapter Test', () => {
             try {
               if (stub) {
                 const displayE = 'Error 400 received on request';
-                runErrorAsserts(data, error, 'AD.500', 'Test-attmobility-connectorRest-handleEndResponse', displayE);
+                runErrorAsserts(data, error, 'AD.500', 'Test-att_mobility-connectorRest-handleEndResponse', displayE);
               } else {
                 runCommonAsserts(data, error);
               }