@itentialopensource/adapter-jira 1.7.2 → 1.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. package/.eslintignore +1 -0
  2. package/AUTH.md +39 -0
  3. package/BROKER.md +199 -0
  4. package/CALLS.md +7365 -0
  5. package/CHANGELOG.md +24 -0
  6. package/CODE_OF_CONDUCT.md +12 -17
  7. package/CONTRIBUTING.md +88 -74
  8. package/ENHANCE.md +69 -0
  9. package/PROPERTIES.md +641 -0
  10. package/README.md +228 -420
  11. package/SUMMARY.md +9 -0
  12. package/SYSTEMINFO.md +11 -0
  13. package/TROUBLESHOOT.md +47 -0
  14. package/adapter.js +18753 -4899
  15. package/adapterBase.js +1274 -236
  16. package/entities/.generic/action.json +214 -0
  17. package/entities/.generic/schema.json +28 -0
  18. package/entities/Avatars/action.json +63 -0
  19. package/entities/Avatars/schema.json +4 -1
  20. package/entities/Dashboards/action.json +80 -0
  21. package/entities/Dashboards/mockdatafiles/copyDashboard-default.json +13 -0
  22. package/entities/Dashboards/mockdatafiles/createDashboard-default.json +13 -0
  23. package/entities/Dashboards/mockdatafiles/updateDashboard-default.json +13 -0
  24. package/entities/Dashboards/schema.json +5 -1
  25. package/entities/Groups/action.json +21 -0
  26. package/entities/Groups/mockdatafiles/bulkGetGroups-default.json +16 -0
  27. package/entities/Groups/schema.json +2 -1
  28. package/entities/InstanceInformation/action.json +25 -0
  29. package/entities/InstanceInformation/mockdatafiles/getLicense-default.json +20 -0
  30. package/entities/InstanceInformation/schema.json +19 -0
  31. package/entities/IssueCustomFieldConfigurationApps/action.json +45 -0
  32. package/entities/IssueCustomFieldConfigurationApps/mockdatafiles/getCustomFieldConfiguration-default.json +34 -0
  33. package/entities/IssueCustomFieldConfigurationApps/schema.json +20 -0
  34. package/entities/IssueCustomFieldContexts/action.json +268 -0
  35. package/entities/IssueCustomFieldContexts/mockdatafiles/createCustomFieldContext-default.json +9 -0
  36. package/entities/IssueCustomFieldContexts/mockdatafiles/getContextsForField-default.json +22 -0
  37. package/entities/IssueCustomFieldContexts/mockdatafiles/getCustomFieldContextsForProjectsAndIssueTypes-default.json +23 -0
  38. package/entities/IssueCustomFieldContexts/mockdatafiles/getDefaultValues-default.json +22 -0
  39. package/entities/IssueCustomFieldContexts/mockdatafiles/getIssueTypeMappingsForContexts-default.json +20 -0
  40. package/entities/IssueCustomFieldContexts/mockdatafiles/getProjectContextMapping-default.json +16 -0
  41. package/entities/IssueCustomFieldContexts/schema.json +31 -0
  42. package/entities/IssueCustomFieldOptions/action.json +105 -0
  43. package/entities/IssueCustomFieldOptions/mockdatafiles/createCustomFieldOption-default.json +20 -0
  44. package/entities/IssueCustomFieldOptions/mockdatafiles/getOptionsForContext-default.json +26 -0
  45. package/entities/IssueCustomFieldOptions/mockdatafiles/updateCustomFieldOption-default.json +19 -0
  46. package/entities/IssueCustomFieldOptions/schema.json +23 -0
  47. package/entities/IssueCustomFieldValuesApps/action.json +44 -0
  48. package/entities/IssueCustomFieldValuesApps/schema.json +20 -0
  49. package/entities/IssueFieldConfigurations/action.json +309 -0
  50. package/entities/IssueFieldConfigurations/mockdatafiles/createFieldConfiguration-default.json +5 -0
  51. package/entities/IssueFieldConfigurations/mockdatafiles/createFieldConfigurationScheme-default.json +5 -0
  52. package/entities/IssueFieldConfigurations/mockdatafiles/getAllFieldConfigurationSchemes-default.json +23 -0
  53. package/entities/IssueFieldConfigurations/mockdatafiles/getAllFieldConfigurations-default.json +19 -0
  54. package/entities/IssueFieldConfigurations/mockdatafiles/getFieldConfigurationItems-default.json +19 -0
  55. package/entities/IssueFieldConfigurations/mockdatafiles/getFieldConfigurationSchemeMappings-default.json +33 -0
  56. package/entities/IssueFieldConfigurations/mockdatafiles/getFieldConfigurationSchemeProjectMapping-default.json +26 -0
  57. package/entities/IssueFieldConfigurations/schema.json +33 -0
  58. package/entities/IssueTypeSchemes/action.json +207 -0
  59. package/entities/IssueTypeSchemes/mockdatafiles/createIssueTypeScheme-default.json +3 -0
  60. package/entities/IssueTypeSchemes/mockdatafiles/getAllIssueTypeSchemes-default.json +26 -0
  61. package/entities/IssueTypeSchemes/mockdatafiles/getIssueTypeSchemeForProjects-default.json +44 -0
  62. package/entities/IssueTypeSchemes/mockdatafiles/getIssueTypeSchemesMapping-default.json +24 -0
  63. package/entities/IssueTypeSchemes/schema.json +28 -0
  64. package/entities/IssueTypeScreenSchemes/action.json +228 -0
  65. package/entities/IssueTypeScreenSchemes/mockdatafiles/createIssueTypeScreenScheme-default.json +3 -0
  66. package/entities/IssueTypeScreenSchemes/mockdatafiles/getIssueTypeScreenSchemeMappings-default.json +28 -0
  67. package/entities/IssueTypeScreenSchemes/mockdatafiles/getIssueTypeScreenSchemeProjectAssociations-default.json +19 -0
  68. package/entities/IssueTypeScreenSchemes/mockdatafiles/getIssueTypeScreenSchemes-default.json +18 -0
  69. package/entities/IssueTypeScreenSchemes/mockdatafiles/getProjectsForIssueTypeScreenScheme-default.json +27 -0
  70. package/entities/IssueTypeScreenSchemes/schema.json +29 -0
  71. package/entities/Issueattachments/action.json +42 -0
  72. package/entities/Issueattachments/schema.json +3 -1
  73. package/entities/Issuefields/action.json +122 -0
  74. package/entities/Issuefields/mockdatafiles/getContextsForFieldDeprecated-default.json +12 -0
  75. package/entities/Issuefields/mockdatafiles/getFieldsPaginated-default.json +46 -0
  76. package/entities/Issuefields/schema.json +7 -1
  77. package/entities/Issueproperties/action.json +40 -0
  78. package/entities/Issueproperties/schema.json +3 -1
  79. package/entities/Issues/action.json +45 -0
  80. package/entities/Issues/mockdatafiles/getChangeLogsByIds-default.json +65 -0
  81. package/entities/Issues/mockdatafiles/getEvents-default.json +10 -0
  82. package/entities/Issues/schema.json +20 -0
  83. package/entities/Issuesearch/action.json +20 -0
  84. package/entities/Issuesearch/mockdatafiles/matchIssues-default.json +29 -0
  85. package/entities/Issuesearch/schema.json +2 -1
  86. package/entities/Issuesecuritylevel/action.json +21 -0
  87. package/entities/Issuesecuritylevel/mockdatafiles/getIssueSecurityLevelMembers-default.json +46 -0
  88. package/entities/Issuesecuritylevel/schema.json +2 -1
  89. package/entities/Issuetypes/action.json +21 -0
  90. package/entities/Issuetypes/mockdatafiles/getIssueTypesForProject-default.json +39 -0
  91. package/entities/Issuetypes/schema.json +2 -1
  92. package/entities/Issuewatchers/action.json +20 -0
  93. package/entities/Issuewatchers/mockdatafiles/getIsWatchingIssueBulk-default.json +7 -0
  94. package/entities/Issuewatchers/schema.json +2 -1
  95. package/entities/JQL/action.json +40 -0
  96. package/entities/JQL/mockdatafiles/getAutoCompletePost-default.json +89 -0
  97. package/entities/JQL/mockdatafiles/parseJqlQueries-default.json +119 -0
  98. package/entities/JQL/schema.json +3 -1
  99. package/entities/Jiraexpressions/action.json +20 -0
  100. package/entities/Jiraexpressions/mockdatafiles/analyseExpression-default.json +47 -0
  101. package/entities/Jiraexpressions/schema.json +2 -1
  102. package/entities/Labels/action.json +25 -0
  103. package/entities/Labels/mockdatafiles/getAllLabels-default.json +10 -0
  104. package/entities/Labels/schema.json +19 -0
  105. package/entities/ProjectEmail/action.json +45 -0
  106. package/entities/ProjectEmail/mockdatafiles/getProjectEmail-default.json +6 -0
  107. package/entities/ProjectEmail/schema.json +20 -0
  108. package/entities/ProjectFeatures/action.json +45 -0
  109. package/entities/ProjectFeatures/mockdatafiles/getFeaturesForProject-default.json +24 -0
  110. package/entities/ProjectFeatures/mockdatafiles/toggleFeatureForProject-default.json +24 -0
  111. package/entities/ProjectFeatures/schema.json +20 -0
  112. package/entities/Projects/action.json +102 -0
  113. package/entities/Projects/mockdatafiles/getHierarchy-default.json +50 -0
  114. package/entities/Projects/mockdatafiles/getRecent-default.json +50 -0
  115. package/entities/Projects/mockdatafiles/restore-default.json +139 -0
  116. package/entities/Projects/schema.json +6 -1
  117. package/entities/Projecttypes/action.json +21 -0
  118. package/entities/Projecttypes/mockdatafiles/getAllAccessibleProjectTypes-default.json +16 -0
  119. package/entities/Projecttypes/schema.json +2 -1
  120. package/entities/ScreenSchemes/action.json +85 -0
  121. package/entities/ScreenSchemes/mockdatafiles/createScreenScheme-default.json +3 -0
  122. package/entities/ScreenSchemes/mockdatafiles/getScreenSchemes-default.json +28 -0
  123. package/entities/ScreenSchemes/schema.json +22 -0
  124. package/entities/Screens/action.json +81 -0
  125. package/entities/Screens/mockdatafiles/createScreen-default.json +5 -0
  126. package/entities/Screens/mockdatafiles/getScreensForField-default.json +17 -0
  127. package/entities/Screens/mockdatafiles/updateScreen-default.json +5 -0
  128. package/entities/Screens/schema.json +5 -1
  129. package/entities/Users/action.json +84 -0
  130. package/entities/Users/mockdatafiles/getAllUsers-default.json +32 -0
  131. package/entities/Users/mockdatafiles/getAllUsersDefault-default.json +32 -0
  132. package/entities/Users/mockdatafiles/getUserEmail-default.json +1 -0
  133. package/entities/Users/schema.json +5 -1
  134. package/entities/Webhooks/action.json +106 -0
  135. package/entities/Webhooks/mockdatafiles/getDynamicWebhooksForApp-default.json +40 -0
  136. package/entities/Webhooks/mockdatafiles/getFailedWebhooks-default.json +17 -0
  137. package/entities/Webhooks/mockdatafiles/refreshWebhooks-default.json +3 -0
  138. package/entities/Webhooks/mockdatafiles/registerDynamicWebhooks-default.json +15 -0
  139. package/entities/Webhooks/schema.json +23 -0
  140. package/entities/WorkflowSchemeProjectAssociations/action.json +45 -0
  141. package/entities/WorkflowSchemeProjectAssociations/mockdatafiles/getWorkflowSchemeProjectAssociations-default.json +21 -0
  142. package/entities/WorkflowSchemeProjectAssociations/schema.json +20 -0
  143. package/entities/WorkflowTransitionRules/action.json +65 -0
  144. package/entities/WorkflowTransitionRules/mockdatafiles/deleteWorkflowTransitionRuleConfigurations-default.json +34 -0
  145. package/entities/WorkflowTransitionRules/mockdatafiles/getWorkflowTransitionRuleConfigurations-default.json +56 -0
  146. package/entities/WorkflowTransitionRules/mockdatafiles/updateWorkflowTransitionRuleConfigurations-default.json +34 -0
  147. package/entities/WorkflowTransitionRules/schema.json +21 -0
  148. package/entities/Workflows/action.json +61 -0
  149. package/entities/Workflows/mockdatafiles/createWorkflow-default.json +4 -0
  150. package/entities/Workflows/mockdatafiles/getWorkflowsPaginated-default.json +140 -0
  151. package/entities/Workflows/schema.json +4 -1
  152. package/entities/Workflowschemedrafts/action.json +20 -0
  153. package/entities/Workflowschemedrafts/schema.json +2 -1
  154. package/entities/Workflowschemes/action.json +21 -0
  155. package/entities/Workflowschemes/mockdatafiles/getAllWorkflowSchemes-default.json +30 -0
  156. package/entities/Workflowschemes/schema.json +2 -1
  157. package/error.json +12 -0
  158. package/package.json +42 -18
  159. package/pronghorn.json +27769 -74
  160. package/propertiesDecorators.json +14 -0
  161. package/propertiesSchema.json +472 -4
  162. package/refs?service=git-upload-pack +0 -0
  163. package/report/adapterInfo.json +10 -0
  164. package/report/updateReport1615159462702.json +95 -0
  165. package/report/updateReport1659707107792.json +120 -0
  166. package/sampleProperties.json +103 -6
  167. package/test/integration/adapterTestBasicGet.js +85 -0
  168. package/test/integration/adapterTestConnectivity.js +93 -0
  169. package/test/integration/adapterTestIntegration.js +3633 -101
  170. package/test/unit/adapterBaseTestUnit.js +949 -0
  171. package/test/unit/adapterTestUnit.js +4766 -109
  172. package/utils/adapterInfo.js +206 -0
  173. package/utils/addAuth.js +94 -0
  174. package/utils/basicGet.js +50 -0
  175. package/utils/checkMigrate.js +63 -0
  176. package/utils/entitiesToDB.js +179 -0
  177. package/utils/findPath.js +74 -0
  178. package/utils/methodDocumentor.js +225 -0
  179. package/utils/modify.js +154 -0
  180. package/utils/packModificationScript.js +1 -1
  181. package/utils/patches2bundledDeps.js +90 -0
  182. package/utils/pre-commit.sh +5 -0
  183. package/utils/removeHooks.js +20 -0
  184. package/utils/tbScript.js +184 -0
  185. package/utils/tbUtils.js +469 -0
  186. package/utils/testRunner.js +16 -16
  187. package/utils/troubleshootingAdapter.js +190 -0
  188. package/versions.json +142 -0
  189. package/img/adapter.png +0 -0
@@ -0,0 +1,225 @@
1
+ /* eslint global-require:warn */
2
+ /* eslint import/no-dynamic-require:warn */
3
+ /* eslint no-param-reassign:warn */
4
+
5
+ const fs = require('fs-extra');
6
+ const esprima = require('esprima');
7
+
8
+ // Getting the base directory:
9
+ let adaptdir = __dirname;
10
+ if (adaptdir.endsWith('/utils')) {
11
+ adaptdir = adaptdir.substring(0, adaptdir.length - 6);
12
+ }
13
+
14
+ function createObjectForFunction(
15
+ funcName,
16
+ funcArgs,
17
+ entityPath,
18
+ description,
19
+ workflow
20
+ ) {
21
+ const funcObject = {};
22
+ // if the entity path is not set, then the object is not created.
23
+ if (entityPath !== undefined) {
24
+ funcObject.method_signature = `${funcName}(${funcArgs.join(', ')})`;
25
+ funcObject.path = entityPath;
26
+ if (description === undefined) {
27
+ funcObject.description = '';
28
+ funcObject.workflow = 'No';
29
+ } else {
30
+ funcObject.description = description;
31
+ funcObject.workflow = workflow;
32
+ }
33
+ }
34
+ return funcObject;
35
+ }
36
+
37
+ function getPathFromEntity(entity, funcName) {
38
+ let epath;
39
+ if (entity === undefined || entity === '.generic') {
40
+ epath = undefined;
41
+ } else {
42
+ // Access the action.js file for the certain entity to get the path
43
+ const entityPath = `${adaptdir}/entities/${entity}/action.json`;
44
+ const actionJSON = require(entityPath);
45
+ actionJSON.actions.forEach((action) => {
46
+ if (action.name === funcName) {
47
+ epath = action.entitypath;
48
+ }
49
+ });
50
+ }
51
+ return epath;
52
+ }
53
+
54
+ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
55
+ // read the file
56
+ const aFile = fs.readFileSync(filename, 'utf8');
57
+ // parsing the file to get the function and class declarations.
58
+ const aFileFuncArgs = esprima.parseScript(aFile);
59
+
60
+ // Looping through all the declarations parsed:
61
+ aFileFuncArgs.body.forEach((e) => {
62
+ // Getting only the class declaration as it has our required functions.
63
+ if (e.type === 'ClassDeclaration') {
64
+ const methodDefinition = e.body;
65
+ methodDefinition.body.forEach((method) => {
66
+ // Getting method name and its params in the class.
67
+ const funcName = method.key.name;
68
+ const funcArgs = [];
69
+ method.value.params.forEach((param) => {
70
+ if (param.type === 'Identifier') {
71
+ funcArgs.push(param.name);
72
+ } else {
73
+ const args = `${param.left.name} = ${param.right.value}`;
74
+ funcArgs.push(args);
75
+ }
76
+ });
77
+
78
+ // Getting the entity for the method:
79
+ let entity;
80
+ method.value.body.body.forEach((statementType) => {
81
+ if (statementType.type === 'TryStatement') {
82
+ entity = statementType.block.body[0].argument.arguments[0].value;
83
+ }
84
+ });
85
+ const entityPath = getPathFromEntity(entity, funcName);
86
+
87
+ // Creating and storing the object for the method.
88
+ if (entityPath !== undefined) {
89
+ functionList.push(
90
+ createObjectForFunction(
91
+ funcName,
92
+ funcArgs,
93
+ entityPath,
94
+ descriptionObj[funcName],
95
+ workflowObj[funcName]
96
+ )
97
+ );
98
+ }
99
+ });
100
+ }
101
+ });
102
+ }
103
+
104
+ function readJSONFile(filename, descriptionObj, workflowObj) {
105
+ // Accessing the JSON file.
106
+ const phJSON = require(filename);
107
+ // Getting the methods array.
108
+ const methodArray = phJSON.methods;
109
+ methodArray.forEach((methodName) => {
110
+ // Getting the method description and workflow:
111
+ const funcName = methodName.name;
112
+ descriptionObj[funcName] = methodName.description;
113
+ workflowObj[funcName] = methodName.task ? 'Yes' : 'No';
114
+ });
115
+ }
116
+
117
+ function readMDFile(filename, functionList) {
118
+ // Reading in the .md file and creating an array with each line as an element.
119
+ const mdFile = fs.readFileSync(filename, 'utf-8');
120
+ const fileSplit = mdFile.split('\n');
121
+ // Storing the data that should added later to the updated data.
122
+ const linesToAddLater = [];
123
+ let index = fileSplit.length - 1;
124
+
125
+ // Removing all the blank lines at the end of the file.
126
+ if (fileSplit[index] === '') {
127
+ while (fileSplit[index] === '') {
128
+ linesToAddLater.push(fileSplit.pop());
129
+ index -= 1;
130
+ }
131
+ }
132
+
133
+ // Checking if the last 2 lines are <br> and </table>. If not, the file is corrupted and the
134
+ // data at the end of the file should be fixed.
135
+ if (fileSplit[index] === '<br>' || fileSplit[index - 1] === '</table>') {
136
+ // Storing <br> and </table> to add later.
137
+ linesToAddLater.push(fileSplit.pop());
138
+ linesToAddLater.push(fileSplit.pop());
139
+ index -= 2;
140
+ } else {
141
+ console.log('The file has bad content at the end.');
142
+ return;
143
+ }
144
+ // if (fileSplit[index] !== '<br>' && fileSplit[index - 1] !== '</table>') {
145
+ // console.log('The file has bad content at the end.');
146
+ // return;
147
+ // } else {
148
+ // // Storing <br> and </table> to add later.
149
+ // linesToAddLater.push(fileSplit.pop());
150
+ // linesToAddLater.push(fileSplit.pop());
151
+ // index -= 2;
152
+ // }
153
+
154
+ // Removing all the lines until the header tags are reached.
155
+ while (!fileSplit[index].includes('<th')) {
156
+ fileSplit.pop();
157
+ index -= 1;
158
+ }
159
+ // Adding </tr> for the header row, because it got removed in the above loop.
160
+ fileSplit.push(' </tr>');
161
+
162
+ // Creating the tags for each method to be appended to the file.
163
+ const tdBeginTag = ' <td style="padding:15px">';
164
+ const tdEndTag = '</td>';
165
+ functionList.forEach((func) => {
166
+ const signCommand = `${tdBeginTag}${func.method_signature}${tdEndTag}`;
167
+ const descCommand = `${tdBeginTag}${func.description}${tdEndTag}`;
168
+ const pathCommand = `${tdBeginTag}${func.path}${tdEndTag}`;
169
+ const workflowCommand = `${tdBeginTag}${func.workflow}${tdEndTag}`;
170
+ fileSplit.push(' <tr>');
171
+ fileSplit.push(signCommand);
172
+ fileSplit.push(descCommand);
173
+ fileSplit.push(pathCommand);
174
+ fileSplit.push(workflowCommand);
175
+ fileSplit.push(' </tr>');
176
+ });
177
+
178
+ // Adding </table> and <br> at the end of the file to complete the table and the file.
179
+ while (linesToAddLater.length > 0) {
180
+ fileSplit.push(linesToAddLater.pop());
181
+ }
182
+
183
+ // Writing all the content back into the file.
184
+ fs.writeFileSync(filename, fileSplit.join('\n'), {
185
+ encoding: 'utf-8',
186
+ flag: 'w'
187
+ });
188
+ }
189
+
190
+ function getFileInfo() {
191
+ // If files don't exist:
192
+ if (!fs.existsSync(`${adaptdir}/adapter.js`)) {
193
+ console.log('Missing - utils/adapter.js');
194
+ return;
195
+ }
196
+ if (!fs.existsSync(`${adaptdir}/pronghorn.json`)) {
197
+ console.log('Missing - pronghorn.json');
198
+ return;
199
+ }
200
+ if (!fs.existsSync(`${adaptdir}/CALLS.md`)) {
201
+ console.log('Missing - CALLS.md');
202
+ return;
203
+ }
204
+
205
+ const descriptionObj = {};
206
+ const workflowObj = {};
207
+
208
+ // Get the method descriptions and the workflow values from pronghorn.json file.
209
+ readJSONFile(`${adaptdir}/pronghorn.json`, descriptionObj, workflowObj);
210
+
211
+ // Get the method signature, entity path and create an object that contains all the info regarding
212
+ // the method and push it to the functionList array.
213
+ const functionList = [];
214
+ readFileUsingLib(
215
+ `${adaptdir}/adapter.js`,
216
+ descriptionObj,
217
+ workflowObj,
218
+ functionList
219
+ );
220
+
221
+ // createMarkDown(functionList);
222
+ readMDFile(`${adaptdir}/CALLS.md`, functionList);
223
+ }
224
+
225
+ getFileInfo();
@@ -0,0 +1,154 @@
1
+ const fs = require('fs-extra');
2
+ const Ajv = require('ajv');
3
+ const rls = require('readline-sync');
4
+ const { execSync } = require('child_process');
5
+ const { existsSync } = require('fs-extra');
6
+ const { getAdapterConfig } = require('./tbUtils');
7
+ const { name } = require('../package.json');
8
+ const propertiesSchema = require('../propertiesSchema.json');
9
+
10
+ const flags = process.argv[2];
11
+
12
+ /**
13
+ * @summary Updates database instance with new adapter properties
14
+ *
15
+ * @function updateServiceItem
16
+ */
17
+ async function updateServiceItem() {
18
+ const { database, serviceItem } = await getAdapterConfig();
19
+ const currentProps = serviceItem.properties.properties;
20
+ const ajv = new Ajv({ allErrors: true, useDefaults: true });
21
+ const validate = ajv.compile(propertiesSchema);
22
+ validate(currentProps);
23
+ console.log('Updating Properties...');
24
+ await database.collection('service_configs').updateOne(
25
+ { model: name }, { $set: serviceItem }
26
+ );
27
+ console.log('Properties Updated');
28
+ }
29
+
30
+ /**
31
+ * @summary Creates a backup zip file of current adapter
32
+ *
33
+ * @function backup
34
+ */
35
+ function backup() {
36
+ // zip all files except node_modules and package-lock
37
+ const backupCmd = 'zip -r previousVersion.zip .';
38
+ execSync(backupCmd, { encoding: 'utf-8' });
39
+ }
40
+
41
+ /**
42
+ * @summary Archives previous modifications and removes the modification package
43
+ *
44
+ * @function archiveMod
45
+ * @param {String} modType - update(UPD) or migrate(MIG)
46
+ */
47
+ function archiveMod(modType) {
48
+ if (!existsSync('./adapter_modifications/archive')) {
49
+ execSync('mkdir ./adapter_modifications/archive');
50
+ }
51
+ const zipFile = modType === 'UPD' ? 'updatePackage.zip' : 'migrationPackage.zip';
52
+ const now = new Date();
53
+ const archiveName = `${modType}-${now.toISOString()}`;
54
+ execSync(`mkdir adapter_modifications/archive/${archiveName}`);
55
+ const archiveCmd = 'mv adapter_modifications/archive .'
56
+ + ` && mv adapter_modifications/* archive/${archiveName}`
57
+ + ' && mv archive adapter_modifications'
58
+ + ` && rm ${zipFile}`;
59
+ execSync(archiveCmd, { encoding: 'utf-8' });
60
+ }
61
+
62
+ /**
63
+ * @summary Reverts modifications using backup zip file
64
+ *
65
+ * @function revertMod
66
+ */
67
+ function revertMod() {
68
+ const files = fs.readdirSync('./');
69
+ // remove all files except previousVersion
70
+ files.forEach((file) => {
71
+ if (file !== 'previousVersion.zip') {
72
+ fs.removeSync(file);
73
+ }
74
+ });
75
+ // // unzip previousVersion, reinstall dependencies and delete zipfile
76
+ execSync('unzip -o previousVersion.zip && rm -rf node_modules && rm package-lock.json && npm install');
77
+ execSync('rm previousVersion.zip');
78
+ console.log('Changes have been reverted');
79
+ }
80
+
81
+ // Main Script
82
+
83
+ // Migrate
84
+ if (flags === '-m') {
85
+ if (!fs.existsSync('migrationPackage.zip')) {
86
+ console.log('Migration Package not found. Download and place migrationPackage in the adapter root directory');
87
+ process.exit();
88
+ }
89
+ // Backup current adapter
90
+ backup();
91
+ console.log('Migrating adapter and running tests...');
92
+ const migrateCmd = 'unzip -o migrationPackage.zip'
93
+ + ' && cd adapter_modifications'
94
+ + ' && node migrate';
95
+ const migrateOutput = execSync(migrateCmd, { encoding: 'utf-8' });
96
+ console.log(migrateOutput);
97
+ if (migrateOutput.indexOf('Lint exited with code 1') >= 0
98
+ || migrateOutput.indexOf('Tests exited with code 1') >= 0) {
99
+ if (rls.keyInYN('Adapter failed tests or lint after migrating. Would you like to revert the changes?')) {
100
+ console.log('Reverting changes...');
101
+ revertMod();
102
+ process.exit();
103
+ }
104
+ console.log('Adapter Migration will continue. If you want to revert the changes, run the command npm run adapter:revert');
105
+ }
106
+ console.log('Installing new dependencies..');
107
+ const updatePackageCmd = 'rm -rf node_modules && rm package-lock.json && npm install';
108
+ const updatePackageOutput = execSync(updatePackageCmd, { encoding: 'utf-8' });
109
+ console.log(updatePackageOutput);
110
+ console.log('New dependencies installed');
111
+ console.log('Updating adapter properties..');
112
+ updateServiceItem().then(() => {
113
+ console.log('Adapter Successfully Migrated. Restart adapter in IAP to apply the changes');
114
+ archiveMod('MIG');
115
+ process.exit();
116
+ });
117
+ }
118
+
119
+ // Update
120
+ if (flags === '-u') {
121
+ if (!fs.existsSync('updatePackage.zip')) {
122
+ console.log('Update Package not found. Download and place updateAdapter.zip in the adapter root directory');
123
+ process.exit();
124
+ }
125
+ // Backup current adapter
126
+ backup();
127
+ const updateCmd = 'unzip -o updatePackage.zip'
128
+ + ' && cd adapter_modifications'
129
+ + ' && node update.js updateFiles';
130
+ execSync(updateCmd, { encoding: 'utf-8' });
131
+ const updateOutput = execSync(updateCmd, { encoding: 'utf-8' });
132
+ if (updateOutput.indexOf('Lint exited with code 1') >= 0
133
+ || updateOutput.indexOf('Tests exited with code 1') >= 0) {
134
+ if (rls.keyInYN('Adapter failed tests or lint after updating. Would you like to revert the changes?')) {
135
+ console.log('Reverting changes...');
136
+ revertMod();
137
+ process.exit();
138
+ }
139
+ console.log('Adapter Update will continue. If you want to revert the changes, run the command npm run adapter:revert');
140
+ }
141
+ console.log(updateOutput);
142
+ console.log('Adapter Successfully Updated. Restart adapter in IAP to apply the changes');
143
+ archiveMod('UPD');
144
+ process.exit();
145
+ }
146
+
147
+ // Revert
148
+ if (flags === '-r') {
149
+ if (!fs.existsSync('previousVersion.zip')) {
150
+ console.log('Previous adapter version not found. There are no changes to revert');
151
+ process.exit();
152
+ }
153
+ revertMod();
154
+ }
@@ -4,7 +4,7 @@
4
4
  const fs = require('fs-extra');
5
5
  const path = require('path');
6
6
  const { spawnSync } = require('child_process');
7
- const { createBundle } = require('./artifactize.js');
7
+ const { createBundle } = require('./artifactize');
8
8
 
9
9
  const nodeEntryPath = path.resolve('.');
10
10
  createBundle(nodeEntryPath).then((pathObj) => {
@@ -0,0 +1,90 @@
1
+ const fs = require('fs');
2
+ const semverSatisfies = require('semver/functions/satisfies');
3
+ const packageJson = require('../package.json');
4
+
5
+ try {
6
+ // pattern supplied by semver.org via https://regex101.com/r/vkijKf/1/ but removed gm from end to only match a single semver
7
+ // const semverPat = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
8
+ // pattern supplied by semver.org via https://regex101.com/r/Ly7O1x/3/ with following changes
9
+ // removed P's from before capturing group names and
10
+ // removed gm from end to only match a single semver
11
+ // const semverPat = /^(?<major>0|[1-9]\d*)\.(?<minor>0|[1-9]\d*)\.(?<patch>0|[1-9]\d*)(?:-(?<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
12
+
13
+ const patches = (fs.existsSync('./patches')) ? fs.readdirSync('./patches', { withFileTypes: true }) : [];
14
+ if (!patches.length) {
15
+ console.error('\nno patches - nothing to do\n');
16
+ process.exitCode = 1;
17
+ }
18
+
19
+ const dependencies = packageJson.dependencies || {};
20
+ if (!Object.keys(dependencies).length) {
21
+ console.error('\nno dependencies - nothing to do\n');
22
+ process.exitCode = 1;
23
+ }
24
+
25
+ let changed = false;
26
+ console.error('\nprocessing patches');
27
+ const bundledDependencies = packageJson.bundledDependencies || packageJson.bundleDependencies || [];
28
+
29
+ patches.forEach((patch) => {
30
+ if (!patch.isFile()) {
31
+ console.error(`${patch.name} skipped, is not a regular file`);
32
+ return;
33
+ }
34
+ if (!patch.name.endsWith('.patch')) {
35
+ console.error(`${patch.name} skipped, does not end with .patch`);
36
+ return;
37
+ }
38
+ const splits = patch.name.slice(0, -6).split('+');
39
+ if (splits.length > 4) {
40
+ console.error(`${patch.name} skipped, does not follow the naming convention (cannot use '+' other than to separate scope/package/semver and at most once within semver)`);
41
+ return;
42
+ }
43
+ const scope = splits[0][0] === '@' ? splits.shift() : null;
44
+ const packageName = splits.shift();
45
+ const semver = splits.join('+');
46
+ // const { groups } = semver.match(semverPat);
47
+ const file = scope ? `${scope}/${packageName}` : packageName;
48
+ if (dependencies[file] && semverSatisfies(semver, dependencies[file])) {
49
+ if (!bundledDependencies.includes(file)) {
50
+ bundledDependencies.push(file);
51
+ console.error(`added ${file} to bundledDependencies`);
52
+ changed = true;
53
+ } else {
54
+ console.error(`bundledDependencies already has ${file}`);
55
+ }
56
+ } else {
57
+ const depmsg = dependencies[file] ? `version mismatch (${dependencies[file]}) in dependencies` : 'not found in dependencies';
58
+ console.error(`patch ${patch.name} ${depmsg}`);
59
+ }
60
+ });
61
+
62
+ if (!packageJson.bundledDependencies && bundledDependencies.length) {
63
+ delete packageJson.bundleDependencies;
64
+ packageJson.bundledDependencies = bundledDependencies;
65
+ console.error('renaming bundleDependencies to bundledDependencies');
66
+ changed = true;
67
+ }
68
+ if (changed) {
69
+ fs.writeFileSync('./package.json.new', JSON.stringify(packageJson, null, 2));
70
+ console.error('wrote package.json.new');
71
+ fs.renameSync('./package.json', './package.json.old');
72
+ console.error('moved package.json to package.json.old');
73
+ fs.renameSync('./package.json.new', './package.json');
74
+ console.error('moved package.json.new to package.json');
75
+ } else {
76
+ console.error('no changes\n');
77
+ process.exitCode = 1;
78
+ }
79
+ } catch (e) {
80
+ if (e) {
81
+ // caught error, exit with status 2 to signify abject failure
82
+ console.error(`\ncaught exception - ${e}\n`);
83
+ process.exitCode = 2;
84
+ } else {
85
+ // caught false, exit with status 1 to signify nothing done
86
+ process.exitCode = 1;
87
+ }
88
+ } finally {
89
+ console.error('done\n');
90
+ }
@@ -17,6 +17,11 @@ printf "%b" "Running pre-commit hooks...\\n"
17
17
  # verify testing script is stubbed and no credentials
18
18
  node utils/testRunner.js -r
19
19
 
20
+ # update the adapter information file
21
+ node utils/adapterInfo.js
22
+ node utils/methodDocumentor.js
23
+ git add CALLS.md utils/methodDocumentor.js
24
+
20
25
  # security audit on the code
21
26
  npm audit --registry=https://registry.npmjs.org --audit-level=moderate
22
27
 
@@ -0,0 +1,20 @@
1
+ const fs = require('fs');
2
+
3
+ /**
4
+ * This script will uninstall pre-commit or pre-push hooks in case there's ever a need to
5
+ * commit/push something that has issues
6
+ */
7
+
8
+ const precommitPath = '.git/hooks/pre-commit';
9
+ const prepushPath = '.git/hooks/pre-push';
10
+ fs.unlink(precommitPath, (err) => {
11
+ if (err && err.code !== 'ENOENT') {
12
+ console.log(`${err.message}`);
13
+ }
14
+ });
15
+
16
+ fs.unlink(prepushPath, (err) => {
17
+ if (err && err.code !== 'ENOENT') {
18
+ console.log(`${err.message}`);
19
+ }
20
+ });
@@ -0,0 +1,184 @@
1
+ /* eslint-disable no-console */
2
+ /* eslint import/no-unresolved: warn */
3
+ /* eslint global-require: warn */
4
+
5
+ // suppress eslint rule in adapter
6
+ /* eslint arrow-parens: warn */
7
+ /* eslint import/no-extraneous-dependencies: warn */
8
+ /* eslint import/no-dynamic-require: warn */
9
+
10
+ const program = require('commander');
11
+ const rls = require('readline-sync');
12
+ const utils = require('./tbUtils');
13
+ const basicGet = require('./basicGet');
14
+ const { name } = require('../package.json');
15
+ const sampleProperties = require('../sampleProperties.json');
16
+ const adapterPronghorn = require('../pronghorn.json');
17
+ const { addAuthInfo } = require('./addAuth');
18
+
19
+ const { troubleshoot, offline } = require('./troubleshootingAdapter');
20
+
21
+ const executeInStandaloneMode = async (command) => {
22
+ console.info('\n> Executing the script outside of IAP installation directory');
23
+ console.info('> Using sampleProperties.json configuration');
24
+ switch (command) {
25
+ case 'install': {
26
+ console.error('Not currently in IAP directory - installation not possible');
27
+ break;
28
+ }
29
+ case 'connectivity': {
30
+ const { host } = sampleProperties.properties;
31
+ console.log(`perform networking diagnositics to ${host}`);
32
+ utils.runConnectivity(host);
33
+ break;
34
+ }
35
+ case 'healthcheck': {
36
+ const a = basicGet.getAdapterInstance({ properties: sampleProperties });
37
+ await utils.healthCheck(a);
38
+ break;
39
+ }
40
+ case 'basicget': {
41
+ utils.runBasicGet();
42
+ break;
43
+ }
44
+ default: {
45
+ if (rls.keyInYN('Troubleshooting without IAP?')) {
46
+ await offline();
47
+ }
48
+ }
49
+ }
50
+ process.exit(0);
51
+ };
52
+
53
+ const executeUnderIAPInstallationDirectory = async (command) => {
54
+ if (command === undefined) {
55
+ await troubleshoot({}, true, true);
56
+ } else if (command === 'install') {
57
+ const { database, serviceItem, pronghornProps } = await utils.getAdapterConfig();
58
+ const filter = { id: pronghornProps.id };
59
+ const profileItem = await database.collection(utils.IAP_PROFILES_COLLECTION).findOne(filter);
60
+ if (!profileItem) {
61
+ console.log(`Could not find IAP profile for id ${pronghornProps.id}`);
62
+ process.exit(0);
63
+ }
64
+ if (serviceItem) {
65
+ console.log(`A service by the name ${name} already exits!`);
66
+ if (rls.keyInYN(`Do you want to completely remove ${name}?`)) {
67
+ console.log(`Removing ${name} from db...`);
68
+ await database.collection(utils.SERVICE_CONFIGS_COLLECTION).deleteOne({ model: name });
69
+ console.log(`${name} removed from db.`);
70
+ if (profileItem.services.includes(serviceItem.name)) {
71
+ const serviceIndex = profileItem.services.indexOf(serviceItem.name);
72
+ profileItem.services.splice(serviceIndex, 1);
73
+ const update = { $set: { services: profileItem.services } };
74
+ await database.collection(utils.IAP_PROFILES_COLLECTION).updateOne(
75
+ { id: pronghornProps.id }, update
76
+ );
77
+ console.log(`${serviceItem.name} removed from profileItem.services.`);
78
+ console.log(`Rerun the script to reinstall ${serviceItem.name}.`);
79
+ process.exit(0);
80
+ } else {
81
+ process.exit(0);
82
+ }
83
+ } else {
84
+ console.log('Exiting...');
85
+ process.exit(0);
86
+ }
87
+ } else {
88
+ const dirname = utils.getCurrentExecutionPath();
89
+ utils.verifyInstallationDir(dirname, name);
90
+ utils.runTest();
91
+ if (rls.keyInYN(`Do you want to install ${name} to IAP?`)) {
92
+ console.log('Creating database entries...');
93
+ const adapter = utils.createAdapter(
94
+ pronghornProps, profileItem, sampleProperties, adapterPronghorn
95
+ );
96
+
97
+ adapter.properties.properties = await addAuthInfo(adapter.properties.properties);
98
+
99
+ await database.collection(utils.SERVICE_CONFIGS_COLLECTION).insertOne(adapter);
100
+ profileItem.services.push(adapter.name);
101
+ const update = { $set: { services: profileItem.services } };
102
+ await database.collection(utils.IAP_PROFILES_COLLECTION).updateOne(
103
+ { id: pronghornProps.id }, update
104
+ );
105
+ console.log('Database entry creation complete.');
106
+ }
107
+ console.log('Exiting...');
108
+ process.exit(0);
109
+ }
110
+ } else if (['healthcheck', 'basicget', 'connectivity'].includes(command)) {
111
+ const { serviceItem } = await utils.getAdapterConfig();
112
+ if (serviceItem) {
113
+ const adapter = serviceItem;
114
+ const a = basicGet.getAdapterInstance(adapter);
115
+ if (command === 'healthcheck') {
116
+ await utils.healthCheck(a);
117
+ process.exit(0);
118
+ } else if (command === 'basicget') {
119
+ await utils.runBasicGet(true);
120
+ } else if (command === 'connectivity') {
121
+ const { host } = adapter.properties.properties;
122
+ console.log(`perform networking diagnositics to ${host}`);
123
+ await utils.runConnectivity(host, true);
124
+ process.exit(0);
125
+ }
126
+ } else {
127
+ console.log(`${name} not installed. Run npm \`run install:adapter\` to install.`);
128
+ process.exit(0);
129
+ }
130
+ }
131
+ };
132
+
133
+ const main = async (command) => {
134
+ if (!utils.areWeUnderIAPinstallationDirectory()) {
135
+ executeInStandaloneMode(command); // configuration from sampleproperties.json
136
+ } else {
137
+ executeUnderIAPInstallationDirectory(command); // configuration from $IAP_HOME/properties.json
138
+ }
139
+ };
140
+
141
+ program
142
+ .command('connectivity')
143
+ .alias('c')
144
+ .description('networking diagnostics')
145
+ .action(() => {
146
+ main('connectivity');
147
+ });
148
+
149
+ program
150
+ .command('install')
151
+ .alias('i')
152
+ .description('install current adapter')
153
+ .action(() => {
154
+ main('install');
155
+ });
156
+
157
+ program
158
+ .command('healthcheck')
159
+ .alias('hc')
160
+ .description('perfom none interative healthcheck with current setting')
161
+ .action(() => {
162
+ main('healthcheck');
163
+ });
164
+
165
+ program
166
+ .command('basicget')
167
+ .alias('bg')
168
+ .description('perfom basicget')
169
+ .action(() => {
170
+ main('basicget');
171
+ });
172
+
173
+ // Allow commander to parse `process.argv`
174
+ program.parse(process.argv);
175
+
176
+ if (process.argv.length < 3) {
177
+ main();
178
+ }
179
+ const allowedParams = ['install', 'healthcheck', 'basicget', 'connectivity'];
180
+ if (process.argv.length === 3 && !allowedParams.includes(process.argv[2])) {
181
+ console.log(`unknown parameter ${process.argv[2]}`);
182
+ console.log('try `node troubleshootingAdapter.js -h` to see allowed parameters. Exiting...');
183
+ process.exit(0);
184
+ }