@itentialopensource/adapter-jira 2.3.6 → 2.4.0

package/metadata.json

@@ -32,13 +32,24 @@
     "isDeprecated": false
   },
   "brokerSince": "",
+  "authMethods": [
+    {
+      "type": "Basic Auth",
+      "primary": true
+    }
+  ],
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-jira",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-jira",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/adapter-jira",
     "docLink": "https://docs.itential.com/opensource/docs/jira",
     "demoLinks": [],
-    "trainingLinks": [],
+    "trainingLinks": [
+      {
+        "title": "Itential Academy",
+        "link": "https://www.itential.com/itential-academy/"
+      }
+    ],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-jira",
-  "version": "2.3.6",
+  "version": "2.4.0",
   "description": "This adapter integrates with system Jira",
   "main": "adapter.js",
   "systemName": "Jira",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.10",
+  "engineVersion": "1.67.19",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -17,7 +17,6 @@
     "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
     "test:system": "nyc --reporter html --reporter text mocha test/integration/adapterTestIntegration.js --LOG=error -g \"System Integration Tests\"",
-    "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
     "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
@@ -46,15 +45,15 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 8.0.0",
+    "node": ">= 14.0.0",
     "npm": ">= 6.0.0"
   },
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:itentialopensource/adapters/itsm-testing/adapter-jira.git"
+    "url": "git@gitlab.com:itentialopensource/adapters/adapter-jira.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-jira#readme",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-jira#readme",
   "dependencies": {
     "@itentialopensource/adapter-utils": "^5.3.10",
     "acorn": "^8.10.0",
@@ -67,7 +66,6 @@
     "mocha": "^10.3.0",
     "mocha-param": "^2.0.1",
     "mongodb": "^4.16.0",
-    "nyc": "^15.1.0",
     "ping": "^0.4.4",
     "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",

package/propertiesSchema.json

@@ -945,6 +945,11 @@
     "devicebroker": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Whether or not the device broker calls have been mapped",
+          "default": false
+        },
         "getDevice": {
           "type": "array",
           "description": "Broker call(s) to getDevice",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "2.3.0",
-  "configLines": 48668,
+  "version": "2.3.6",
+  "configLines": 48673,
   "scriptLines": 1783,
   "codeLines": 39944,
-  "testLines": 37281,
+  "testLines": 37280,
   "testCases": 1748,
-  "totalCodeLines": 79008,
+  "totalCodeLines": 79007,
   "wfTasks": 528
 }

package/report/updateReport1716410728250.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": 16
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 21
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.10"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 78
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 344
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 647
+    },
+    {
+      "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": 18314
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1162
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 17714
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 514
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 37481
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1676
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -16,7 +16,7 @@
     "authentication": {
       "auth_method": "basic user_password",
       "username": "exampleUsername",
-      "password": "examplePassword",
+      "password": "apiKey",
       "token": "",
       "token_timeout": 1800000,
       "token_cache": "local",
@@ -114,30 +114,32 @@
       }
     },
     "devicebroker": {
+      "enabled": false,
       "getDevice": [
         {
-          "path": "/get/devices/{id}",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "insample": "{port}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}"
           }
         }
       ],
       "getDevicesFiltered": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "pagination": {
             "offsetVar": "",
@@ -152,42 +154,44 @@
           "requestFields": {},
           "responseDatakey": "",
           "responseFields": {
-            "name": "host",
-            "ostype": "os",
-            "ostypePrefix": "system-",
-            "ipaddress": "attributes.ipaddr",
-            "port": "443"
+            "name": "{this}{||}{that}",
+            "ostype": "{osfield}",
+            "ostypePrefix": "meraki-",
+            "port": "{port}",
+            "ipaddress": "{ip_addr}",
+            "serial" : "{serial}",
+            "id": "{myid}"
           }
         }
       ],
       "isAlive": [
         {
-          "path": "/get/devices/{id}/status",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {
-            "status": "status",
-            "statusValue": "online"
+            "status": "return2xx",
+            "statusValue": "AD.200"
           }
         }
       ],
       "getConfig": [
         {
-          "path": "/get/devices/{id}/configPart1",
+          "path": "/not/mapped/{devID}",
           "method": "GET",
           "query": {},
           "body": {},
           "headers": {},
           "handleFailure": "ignore",
           "requestFields": {
-            "id": "name"
+            "devID": "{id}"
           },
           "responseDatakey": "",
           "responseFields": {}
@@ -195,7 +199,7 @@
       ],
       "getCount": [
         {
-          "path": "/get/devices",
+          "path": "/not/mapped",
           "method": "GET",
           "query": {},
           "body": {},
@@ -211,15 +215,15 @@
       "enabled": false,
       "entities": [
         {
-          "entityType": "",
-          "frequency": 1440,
+          "entityType": "device",
+          "frequency": 3600,
           "flushOnFail": false,
-          "limit": 1000,
+          "limit": 10000,
           "retryAttempts": 5,
           "sort": true,
           "populate": [
             {
-              "path": "",
+              "path": "/not/mapped",
               "method": "GET",
               "pagination": {
                 "offsetVar": "",
@@ -233,7 +237,15 @@
               "handleFailure": "ignore",
               "requestFields": {},
               "responseDatakey": "",
-              "responseFields": {}
+              "responseFields": {
+                "name": "{this}{||}{that}",
+                "ostype": "{osfield}",
+                "ostypePrefix": "meraki-",
+                "port": "{port}",
+                "ipaddress": "{ip_addr}",
+                "serial" : "{serial}",
+                "id": "{myid}"
+              }
             }
           ],
           "cachedTasks": [

package/test/integration/adapterTestIntegration.js

@@ -1,7 +1,7 @@
 /* @copyright Itential, LLC 2019 (pre-modifications) */
 
 // Set globals
-/* global describe it before after log pronghornProps */
+/* global describe it log pronghornProps */
 /* eslint no-unused-vars: warn */
 /* eslint no-underscore-dangle: warn  */
 /* eslint import/no-dynamic-require:warn */
@@ -46,6 +46,7 @@ samProps.ssl.accept_invalid_cert = false;
 if (samProps.request.attempt_timeout < 30000) {
   samProps.request.attempt_timeout = 30000;
 }
+samProps.devicebroker.enabled = true;
 const attemptTimeout = samProps.request.attempt_timeout;
 const { stub } = samProps;
 
@@ -507,7 +508,7 @@ describe('[integration] Jira Adapter Test', () => {
     describe('System Integration Tests', () => {
       let testProjectId;
       let myUserId;
-      before(() => {
+      mocha.before(() => {
         let setupPromise;
         if (!stub) {
           setupPromise = new Promise((resolveAll) => {
@@ -544,7 +545,7 @@ describe('[integration] Jira Adapter Test', () => {
         return setupPromise;
       });
 
-      after(() => {
+      mocha.after(() => {
         let teardownPromise;
         if (!stub) {
           teardownPromise = new Promise((resolve) => {
@@ -1474,7 +1475,7 @@ describe('[integration] Jira Adapter Test', () => {
       describe('Issue Comment Entity', () => {
         let newIssueId;
         let newCommentId;
-        before(() => {
+        mocha.before(() => {
           if (!stub) {
             const body = {
               fields: {
@@ -1500,7 +1501,7 @@ describe('[integration] Jira Adapter Test', () => {
           return true;
         });
 
-        after(() => {
+        mocha.after(() => {
           if (!stub) {
             const issueIdOrKey = newIssueId;
             const deleteSubtasks = true;
@@ -1852,7 +1853,7 @@ describe('[integration] Jira Adapter Test', () => {
 
       describe('Issue Property Entity', () => {
         let newIssueId;
-        before(() => {
+        mocha.before(() => {
           if (!stub) {
             const body = {
               fields: {
@@ -1875,7 +1876,7 @@ describe('[integration] Jira Adapter Test', () => {
           return true;
         });
 
-        after(() => {
+        mocha.after(() => {
           if (!stub) {
             const issueIdOrKey = newIssueId;
             const deleteSubtasks = true;
@@ -2912,7 +2913,7 @@ describe('[integration] Jira Adapter Test', () => {
 
       describe('User Entity', () => {
         let newIssueKey;
-        before(() => {
+        mocha.before(() => {
           if (!stub) {
             const body = {
               fields: {
@@ -2936,7 +2937,7 @@ describe('[integration] Jira Adapter Test', () => {
           return true;
         });
 
-        after(() => {
+        mocha.after(() => {
           if (!stub) {
             const issueIdOrKey = newIssueKey;
             const deleteSubtasks = true;
@@ -3540,7 +3541,7 @@ describe('[integration] Jira Adapter Test', () => {
 
       describe('Permission Entity', () => {
         let newProjectId;
-        before(() => {
+        mocha.before(() => {
           if (!stub) {
             return new Promise((resolve) => {
               const body = {
@@ -3561,7 +3562,7 @@ describe('[integration] Jira Adapter Test', () => {
           return true;
         });
 
-        after(() => {
+        mocha.after(() => {
           if (!stub) {
             return new Promise((resolve) => {
               a.deleteRestapi2projectprojectIdOrKey(newProjectId, (data, error) => {

package/test/unit/adapterTestUnit.js

@@ -284,7 +284,6 @@ describe('[unit] Jira Adapter Test', () => {
           assert.equal('mocha test/unit/adapterBaseTestUnit.js --LOG=error', packageDotJson.scripts['test:baseunit']);
           assert.equal('mocha test/unit/adapterTestUnit.js --LOG=error', packageDotJson.scripts['test:unit']);
           assert.equal('mocha test/integration/adapterTestIntegration.js --LOG=error', packageDotJson.scripts['test:integration']);
-          assert.equal('nyc --reporter html --reporter text mocha --reporter dot test/*', packageDotJson.scripts['test:cover']);
           assert.equal('npm run test:baseunit && npm run test:unit && npm run test:integration', packageDotJson.scripts.test);
           assert.equal('npm publish --registry=https://registry.npmjs.org --access=public', packageDotJson.scripts.deploy);
           assert.equal('npm run deploy', packageDotJson.scripts.build);
@@ -321,7 +320,6 @@ describe('[unit] Jira Adapter Test', () => {
           assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
           assert.equal('^10.3.0', packageDotJson.dependencies.mocha);
           assert.equal('^2.0.1', packageDotJson.dependencies['mocha-param']);
-          assert.equal('^15.1.0', packageDotJson.dependencies.nyc);
           assert.equal('^0.4.4', packageDotJson.dependencies.ping);
           assert.equal('^1.4.10', packageDotJson.dependencies['readline-sync']);
           assert.equal('^7.5.3', packageDotJson.dependencies.semver);