@itentialopensource/adapter-jira 1.7.2 → 1.7.5

package/entities/WorkflowTransitionRules/mockdatafiles/deleteWorkflowTransitionRuleConfigurations-default.json

@@ -0,0 +1,34 @@
+{
+  "updateResults": [
+    {
+      "workflowId": {
+        "name": "Workflow with one rule not updated",
+        "draft": false
+      },
+      "ruleUpdateErrors": {
+        "example-rule-id": [
+          "The rule with this id does not exist: example-rule-id"
+        ]
+      },
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Workflow with all rules successfully updated",
+        "draft": true
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Non-existing workflow",
+        "draft": false
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": [
+        "Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}"
+      ]
+    }
+  ]
+}

package/entities/WorkflowTransitionRules/mockdatafiles/getWorkflowTransitionRuleConfigurations-default.json

@@ -0,0 +1,56 @@
+{
+  "maxResults": 10,
+  "startAt": 0,
+  "total": 1,
+  "isLast": true,
+  "values": [
+    {
+      "workflowId": {
+        "name": "My Workflow name",
+        "draft": false
+      },
+      "postFunctions": [
+        {
+          "id": "b4d6cbdc-59f5-11e9-8647-d663bd873d93",
+          "key": "postfunction-key",
+          "configuration": {
+            "value": "{ \"color\": \"red\" }",
+            "disabled": false
+          },
+          "transition": {
+            "id": 1,
+            "name": "Open"
+          }
+        }
+      ],
+      "conditions": [
+        {
+          "id": "d663bd873d93-59f5-11e9-8647-b4d6cbdc",
+          "key": "condition-key",
+          "configuration": {
+            "value": "{ \"size\": \"medium\" }",
+            "disabled": false
+          },
+          "transition": {
+            "id": 1,
+            "name": "Open"
+          }
+        }
+      ],
+      "validators": [
+        {
+          "id": "11e9-59f5-b4d6cbdc-8647-d663bd873d93",
+          "key": "validator-key",
+          "configuration": {
+            "value": "\"{ \\\"shape\\\": \\\"square\\\" }\"",
+            "disabled": false
+          },
+          "transition": {
+            "id": 1,
+            "name": "Open"
+          }
+        }
+      ]
+    }
+  ]
+}

package/entities/WorkflowTransitionRules/mockdatafiles/updateWorkflowTransitionRuleConfigurations-default.json

@@ -0,0 +1,34 @@
+{
+  "updateResults": [
+    {
+      "workflowId": {
+        "name": "Workflow with one rule not updated",
+        "draft": false
+      },
+      "ruleUpdateErrors": {
+        "example-rule-id": [
+          "The rule with this id does not exist: example-rule-id"
+        ]
+      },
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Workflow with all rules successfully updated",
+        "draft": true
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": []
+    },
+    {
+      "workflowId": {
+        "name": "Non-existing workflow",
+        "draft": false
+      },
+      "ruleUpdateErrors": {},
+      "updateErrors": [
+        "Workflow not found: WorkflowIdBean{name=Non-existing workflow, draft=false}"
+      ]
+    }
+  ]
+}

package/entities/WorkflowTransitionRules/schema.json

@@ -0,0 +1,21 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "getWorkflowTransitionRuleConfigurations",
+        "updateWorkflowTransitionRuleConfigurations",
+        "deleteWorkflowTransitionRuleConfigurations"
+      ],
+      "external_name": "ph_request_type"
+    }
+  },
+  "definitions": {}
+}

package/entities/Workflows/action.json

@@ -20,6 +20,67 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "createWorkflow",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/workflow?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/createWorkflow-default.json"
+        }
+      ]
+    },
+    {
+      "name": "getWorkflowsPaginated",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/workflow/search?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getWorkflowsPaginated-default.json"
+        }
+      ]
+    },
+    {
+      "name": "deleteInactiveWorkflow",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "{base_path}/{version}/workflow/{pathv1}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/Workflows/mockdatafiles/createWorkflow-default.json

@@ -0,0 +1,4 @@
+{
+  "name": "Workflow 1",
+  "entityId": "fb8731c5-aa05-4453-bf79-b583a1c87736"
+}

package/entities/Workflows/mockdatafiles/getWorkflowsPaginated-default.json

@@ -0,0 +1,140 @@
+{
+  "maxResults": 1,
+  "startAt": 0,
+  "total": 5,
+  "isLast": false,
+  "values": [
+    {
+      "id": {
+        "name": "SCRUM Workflow",
+        "entityId": "5ed312c5-f7a6-4a78-a1f6-8ff7f307d063"
+      },
+      "description": "A workflow used for Software projects in the SCRUM methodology",
+      "transitions": [
+        {
+          "id": "5",
+          "name": "In Progress",
+          "description": "Start working on the issue.",
+          "from": [
+            "10",
+            "13"
+          ],
+          "to": "14",
+          "type": "directed",
+          "screen": {
+            "id": "10000",
+            "name": "Issue screen"
+          },
+          "rules": {
+            "conditions": [
+              {
+                "type": "PermissionCondition",
+                "configuration": {
+                  "permissionKey": "WORK_ON_ISSUES"
+                }
+              },
+              {
+                "type": "PermissionCondition",
+                "configuration": {
+                  "permissionKey": "RESOLVE_ISSUES"
+                }
+              }
+            ],
+            "conditionsTree": {
+              "nodeType": "compound",
+              "operator": "AND",
+              "conditions": [
+                {
+                  "nodeType": "simple",
+                  "type": "PermissionCondition",
+                  "configuration": {
+                    "permissionKey": "WORK_ON_ISSUES"
+                  }
+                },
+                {
+                  "nodeType": "simple",
+                  "type": "PermissionCondition",
+                  "configuration": {
+                    "permissionKey": "RESOLVE_ISSUES"
+                  }
+                }
+              ]
+            },
+            "validators": [
+              {
+                "type": "FieldRequiredValidator",
+                "configuration": {
+                  "ignoreContext": true,
+                  "errorMessage": "A custom error message",
+                  "fields": [
+                    "description",
+                    "assignee"
+                  ]
+                }
+              }
+            ],
+            "postFunctions": [
+              {
+                "type": "UpdateIssueStatusFunction"
+              },
+              {
+                "type": "GenerateChangeHistoryFunction"
+              },
+              {
+                "type": "FireIssueEventFunction"
+              }
+            ]
+          },
+          "properties": {
+            "jira.fieldscreen.id": 1
+          }
+        }
+      ],
+      "statuses": [
+        {
+          "id": "3",
+          "name": "In Progress",
+          "properties": {
+            "jira.issue.editable": "false",
+            "issueEditable": false
+          }
+        }
+      ],
+      "isDefault": false,
+      "schemes": [
+        {
+          "id": "10001",
+          "name": "Test Workflow Scheme"
+        }
+      ],
+      "projects": [
+        {
+          "self": "project/EX",
+          "id": "10000",
+          "key": "EX",
+          "name": "Example",
+          "projectTypeKey": "ProjectTypeKey{key='software'}",
+          "simplified": false,
+          "avatarUrls": {
+            "48x48": "secure/projectavatar?size=large&pid=10000",
+            "24x24": "secure/projectavatar?size=small&pid=10000",
+            "16x16": "secure/projectavatar?size=xsmall&pid=10000",
+            "32x32": "secure/projectavatar?size=medium&pid=10000"
+          },
+          "projectCategory": {
+            "id": "10000",
+            "description": "Project category description",
+            "name": "A project category"
+          }
+        }
+      ],
+      "hasDraftWorkflow": true,
+      "operations": {
+        "canEdit": true,
+        "canDelete": false
+      },
+      "created": "2021-12-31T03:47:10.057+0000",
+      "updated": "2021-12-31T03:47:10.057+0000"
+    }
+  ]
+}

package/entities/Workflows/schema.json

@@ -10,7 +10,10 @@
       "description": "type of request (internal to adapter)",
       "default": "getRestapi2workflow",
       "enum": [
-        "getRestapi2workflow"
+        "getRestapi2workflow",
+        "createWorkflow",
+        "getWorkflowsPaginated",
+        "deleteInactiveWorkflow"
       ],
       "external_name": "ph_request_type"
     }

package/entities/Workflowschemedrafts/action.json

@@ -272,6 +272,26 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "publishDraftWorkflowScheme",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/workflowscheme/{pathv1}/draft/publish?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
     }
   ]
 }

package/entities/Workflowschemedrafts/schema.json

@@ -22,7 +22,8 @@
         "deleteRestapi2workflowschemeiddraftissuetypeissueType",
         "getRestapi2workflowschemeiddraftworkflow",
         "putRestapi2workflowschemeiddraftworkflow",
-        "deleteRestapi2workflowschemeiddraftworkflow"
+        "deleteRestapi2workflowschemeiddraftworkflow",
+        "publishDraftWorkflowScheme"
       ],
       "external_name": "ph_request_type"
     }

package/entities/Workflowschemes/action.json

@@ -272,6 +272,27 @@
           "mockFile": ""
         }
       ]
+    },
+    {
+      "name": "getAllWorkflowSchemes",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/workflowscheme?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/getAllWorkflowSchemes-default.json"
+        }
+      ]
     }
   ]
 }

package/entities/Workflowschemes/mockdatafiles/getAllWorkflowSchemes-default.json

@@ -0,0 +1,30 @@
+{
+  "maxResults": 50,
+  "startAt": 0,
+  "total": 2,
+  "isLast": true,
+  "values": [
+    {
+      "id": 101010,
+      "name": "Example workflow scheme",
+      "description": "The description of the example workflow scheme.",
+      "defaultWorkflow": "jira",
+      "issueTypeMappings": {
+        "10000": "scrum workflow",
+        "10001": "builds workflow"
+      },
+      "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+    },
+    {
+      "id": 101011,
+      "name": "Another example workflow scheme",
+      "description": "The description of the another example workflow scheme.",
+      "defaultWorkflow": "jira",
+      "issueTypeMappings": {
+        "10000": "scrum workflow",
+        "10001": "builds workflow"
+      },
+      "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011"
+    }
+  ]
+}

package/entities/Workflowschemes/schema.json

@@ -22,7 +22,8 @@
         "deleteRestapi2workflowschemeidissuetypeissueType",
         "getRestapi2workflowschemeidworkflow",
         "putRestapi2workflowschemeidworkflow",
-        "deleteRestapi2workflowschemeidworkflow"
+        "deleteRestapi2workflowschemeidworkflow",
+        "getAllWorkflowSchemes"
       ],
       "external_name": "ph_request_type"
     }

package/error.json

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",
@@ -168,6 +174,12 @@
       "displayString": "Failure response received for $VARIABLE$",
       "recommendation": "Check the reason for failure in the stack trace"
     },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
     {
       "key": "Caught Exception",
       "icode": "AD.900",

package/package.json

@@ -1,21 +1,34 @@
 {
   "name": "@itentialopensource/adapter-jira",
-  "version": "1.7.2",
+  "version": "1.7.5",
   "description": "This adapter integrates with system Jira",
   "main": "adapter.js",
-  "wizardVersion": "2.41.25",
-  "engineVersion": "1.52.2",
+  "systemName": "Atlassian Jira",
+  "wizardVersion": "2.44.7",
+  "engineVersion": "1.61.10",
+  "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
-    "preinstall": "node utils/setup.js",
+    "preinstall": "node utils/setup.js && npm install --package-lock-only --ignore-scripts && npx npm-force-resolutions",
     "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
     "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
+    "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
     "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:unit && npm run test:integration",
-    "deploy": "npm publish --registry=http://registry.npmjs.org --access=public",
+    "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",
+    "adapter:findPath": "node utils/findPath.js",
+    "adapter:migrate": "node utils/modify.js -m",
+    "adapter:update": "node utils/modify.js -u",
+    "adapter:revert": "node utils/modify.js -r",
+    "troubleshoot": "node utils/tbScript.js",
+    "healthcheck": "node utils/tbScript.js healthcheck",
+    "basicget": "node utils/tbScript.js basicget",
+    "connectivity": "node utils/tbScript.js connectivity",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
     "build": "npm run deploy"
   },
   "keywords": [
@@ -42,22 +55,33 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-jira.git",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.34.4",
+    "@itentialopensource/adapter-utils": "^4.45.6",
     "ajv": "^6.12.0",
+    "axios": "^0.21.0",
+    "commander": "^2.20.0",
+    "esprima": "^4.0.1",
     "fs-extra": "^8.1.0",
-    "package-json-validator": "^0.6.3",
-    "readline-sync": "^1.4.10"
+    "json-query": "^2.2.2",
+    "mocha": "^9.0.1",
+    "mocha-param": "^2.0.1",
+    "mongodb": "^4.1.0",
+    "network-diagnostics": "^0.5.3",
+    "nyc": "^15.1.0",
+    "readline-sync": "^1.4.10",
+    "semver": "^7.3.2",
+    "winston": "^3.3.3"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^7.2.0",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.21.2",
-    "eslint-plugin-json": "^2.1.1",
-    "mocha": "^8.0.1",
-    "nyc": "^15.1.0",
-    "testdouble": "^3.16.0",
-    "winston": "^3.2.1"
+    "chai": "^4.3.4",
+    "eslint": "^7.29.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-json": "^3.0.0",
+    "package-json-validator": "^0.6.3",
+    "testdouble": "^3.16.1"
+  },
+  "resolutions": {
+    "minimist": "^1.2.5"
   },
   "private": false
 }