@itentialopensource/adapter-att_mobility 0.5.7 → 0.6.0

package/report/auto-adapter-openapi.json

@@ -0,0 +1,248 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/sp/mobilityactivations/api/v1/serviceactivation/{requestId}": {
+      "get": {
+        "tags": [
+          "Sp"
+        ],
+        "operationId": "getServiceActivationStatus",
+        "description": "The parameters and request body are for method: getServiceActivationStatus. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "requestId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "requestId",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    },
+    "/sp/mobility/billingmgmt/api/v1/billingaccount/{billingAccountNumber}": {
+      "get": {
+        "tags": [
+          "Sp"
+        ],
+        "operationId": "getBillingAccountDetails",
+        "description": "The parameters and request body are for method: getBillingAccountDetails. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "billingAccountNumber",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "billingAccountNumber",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    },
+    "/sp/mobility/lineconfig/api/v1/service/{subscriberLine}": {
+      "get": {
+        "tags": [
+          "Sp"
+        ],
+        "operationId": "getSubscriberLineDetails",
+        "description": "The parameters and request body are for method: getSubscriberLineDetails. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "subscriberLine",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "subscriberLine",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    },
+    "/sp/mobilityactivations/api/v1/serviceactivation": {
+      "post": {
+        "tags": [
+          "Sp"
+        ],
+        "operationId": "postServiceActivation",
+        "description": "The parameters and request body are for method: postServiceActivation. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "description": "indeterminate body object",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    },
+    "/sp/mobility/lineconfig/api/v1/service/{subsciberLine}": {
+      "patch": {
+        "tags": [
+          "Sp"
+        ],
+        "operationId": "editSubscriberLineDetails",
+        "description": "The parameters and request body are for method: editSubscriberLineDetails. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "subsciberLine",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "title": "subsciberLine",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "description": "indeterminate body object",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/mobility/lineDetails/imei": {
+      "post": {
+        "tags": [
+          "Mobility"
+        ],
+        "operationId": "queryDeviceByIMEI",
+        "description": "The parameters and request body are for method: queryDeviceByIMEI. Same endpoint also used in methods:",
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "result",
+                  "type": "object"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              },
+              "example": {}
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {}
+  }
+}

package/report/updateReport1748551931265.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 15
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 19
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "5.10.16"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 79
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 345
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 662
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 57
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 1648
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 80
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 601
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 15
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1489
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 37
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 3738
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 95
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -95,18 +95,22 @@
       "enabled": false,
       "accept_invalid_cert": false,
       "ca_file": "",
+      "ca_file_content": "",
       "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,

package/test/integration/adapterTestBasicGet.js

@@ -1,83 +1,117 @@
 /* @copyright Itential, LLC 2020 */
 
-/* global describe context before after */
+/* 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 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 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');
 
-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;
-};
+if (!properties) {
+  log.warn('No properties provided. Exiting process.');
+  process.exit(1);
+}
 
-let a;
+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', () => {
-  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);
+  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 {
-        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);
+        log.error('\x1b[31m%s\x1b[0m', '\n\nFAILURE: All tests failed.');
       }
+      done();
     });
 
-    after((done) => {
-      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');
     });
 
-    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);
+      log.warn('No non-parameter GET calls found.');
+      process.exitCode = 0;
+      return;
     }
+
     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}`);
+    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);
             }
-            resolve(resp.metrics.code);
-          } else {
-            console.log('\x1b[31m', `call ${f} results in failure`);
-            reject(new Error(`${f} failed`));
+          } catch (err) {
+            log.error(`Unexpected error in test for ${fnName}: ${err}`);
+            done(err);
           }
-        };
-        ad[f](getRespCode, console.log);
+        }).timeout(attemptTimeout);
       });
-    };
-
-    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

@@ -7,14 +7,11 @@ const assert = require('assert');
 const https = require('https');
 const mocha = require('mocha');
 const ping = require('ping');
-const dnsLookup = require('dns-lookup-promise');
+const dns = require('dns');
+const { parseArgs } = require('../../utils/argParser');
 
-let host;
-process.argv.forEach((val) => {
-  if (val.indexOf('--HOST') === 0) {
-    [, host] = val.split('=');
-  }
-});
+const dnsPromises = dns.promises;
+const { host } = parseArgs();
 
 describe('[integration] Adapter Test', () => {
   context(`Testing network connection on ${host}`, () => {
@@ -23,10 +20,10 @@ describe('[integration] Adapter Test', () => {
     });
 
     it('DNS resolve', (done) => {
-      dnsLookup(host)
-        .then((addresses) => {
+      dnsPromises.lookup(host, { all: true })
+        .then((result) => {
           try {
-            assert.ok(addresses.length > 0);
+            assert.ok(result.length > 0);
             done();
           } catch (error) {
             done(error);
@@ -78,12 +75,13 @@ describe('[integration] Adapter Test', () => {
     it('Support IPv4', (done) => {
       const options = {
         family: 4,
-        hints: dnsLookup.ADDRCONFIG
+        hints: dns.ADDRCONFIG
       };
 
-      dnsLookup.lookup(host, options)
-        .then((address, family) => {
+      dnsPromises.lookup(host, options)
+        .then((result) => {
           try {
+            const { address, family } = result;
             assert.ok(address !== null && family === 4);
             done();
           } catch (error) {
@@ -98,12 +96,13 @@ describe('[integration] Adapter Test', () => {
     it('Support IPv6', (done) => {
       const options = {
         family: 6,
-        hints: dnsLookup.ADDRCONFIG
+        hints: dns.ADDRCONFIG
       };
 
-      dnsLookup.lookup(host, options)
-        .then((address, family) => {
+      dnsPromises.lookup(host, options)
+        .then((result) => {
           try {
+            const { address, family } = result;
             assert.ok(address !== null && family === 6);
             done();
           } catch (error) {