@itentialopensource/adapter-jira 1.7.2 → 1.7.5

package/report/updateReport1659707107792.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 2
+    },
+    {
+      "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": 29
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 14
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 7
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^4.45.6"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 338
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "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": 16041
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1007
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 15682
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 444
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1789
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 33512
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1451
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -1,5 +1,5 @@
 {
-  "id": "Jira",
+  "id": "jira",
   "type": "Jira",
   "properties": {
     "host": "your_host.atlassian.net",
@@ -8,7 +8,8 @@
     "version": "2",
     "cache_location": "none",
     "encode_pathvars": true,
-    "save_metric": true,
+    "encode_queryvars": true,
+    "save_metric": false,
     "stub": true,
     "protocol": "https",
     "authentication": {
@@ -20,11 +21,16 @@
       "token_cache": "local",
       "invalid_token_error": 401,
       "auth_field": "header.headers.Authorization",
-      "auth_field_format": "Basic {b64}{username}:{password}{/b64}"
+      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
+      "auth_logging": false,
+      "client_id": "",
+      "client_secret": "",
+      "grant_type": ""
     },
     "healthcheck": {
       "type": "intermittent",
-      "frequency": 60000
+      "frequency": 60000,
+      "query_object": {}
     },
     "throttle": {
       "throttle_enabled": false,
@@ -55,13 +61,16 @@
       },
       "healthcheck_on_timeout": true,
       "return_raw": false,
-      "archiving": false
+      "archiving": false,
+      "return_request": false
     },
     "proxy": {
       "enabled": false,
       "host": "",
       "port": 1,
-      "protocol": "http"
+      "protocol": "http",
+      "username": "",
+      "password": ""
     },
     "ssl": {
       "ecdhCurve": "",
@@ -87,6 +96,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

@@ -0,0 +1,85 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe context 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 */
+
+const mocha = require('mocha');
+const path = require('path');
+const assert = require('assert');
+const itParam = require('mocha-param');
+
+const utils = require('../../utils/tbUtils');
+const basicGet = require('../../utils/basicGet');
+const { name } = require('../../package.json');
+const { methods } = require('../../pronghorn.json');
+
+const getPronghornProps = (iapDir) => {
+  const { Discovery } = require('@itential/itential-utils');
+  console.log('Retrieving properties.json file...');
+  const rawProps = require(path.join(iapDir, 'properties.json'));
+  console.log('Decrypting properties...');
+  const discovery = new Discovery();
+  const pronghornProps = utils.decryptProperties(rawProps, path.join(__dirname, '..'), discovery);
+  console.log('Found properties.\n');
+  return pronghornProps;
+};
+
+let a;
+
+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);
+      } 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);
+      }
+    });
+
+    after((done) => {
+      done();
+    });
+
+    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);
+    }
+    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}`);
+            }
+            resolve(resp.metrics.code);
+          } else {
+            console.log('\x1b[31m', `call ${f} results in failure`);
+            reject(new Error(`${f} failed`));
+          }
+        };
+        ad[f](getRespCode, console.log);
+      });
+    };
+
+    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

@@ -0,0 +1,93 @@
+/* @copyright Itential, LLC 2020 */
+
+/* global describe it context before after */
+/* eslint no-unused-vars: warn */
+
+const mocha = require('mocha');
+const assert = require('assert');
+const diagnostics = require('network-diagnostics');
+
+let host;
+process.argv.forEach((val) => {
+  if (val.indexOf('--HOST') === 0) {
+    [, host] = val.split('=');
+  }
+});
+
+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);
+        }
+      });
+    });
+
+    it('Responds to ping', (done) => {
+      diagnostics.havePing((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support HTTP on port 80', (done) => {
+      diagnostics.haveHTTP((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support HTTPS on port 443', (done) => {
+      diagnostics.haveHTTPS((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support IPv4', (done) => {
+      diagnostics.haveIPv4Async((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+
+    it('Support IPv6', (done) => {
+      diagnostics.haveIPv6Async((result) => {
+        try {
+          assert.equal(result, true);
+          done();
+        } catch (error) {
+          done(error);
+        }
+      });
+    });
+  });
+});