@contrail/cli 3.4.0 → 3.4.2-alpha.1

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 (235) hide show
  1. package/README.md +5 -4
  2. package/bin/dev +0 -0
  3. package/bin/run +0 -0
  4. package/dist/__mocks__/@contrail/sdk.d.ts +123 -123
  5. package/dist/__mocks__/@contrail/sdk.js +716 -716
  6. package/dist/api/app-extension-deployments.d.ts +2 -2
  7. package/dist/api/app-extension-deployments.js +11 -11
  8. package/dist/api/app-extension-packages.d.ts +2 -2
  9. package/dist/api/app-extension-packages.js +11 -11
  10. package/dist/api/apps.d.ts +10 -10
  11. package/dist/api/apps.js +63 -63
  12. package/dist/api/event-workflow-action-definition.d.ts +3 -3
  13. package/dist/api/event-workflow-action-definition.js +18 -18
  14. package/dist/api/event-workflow-template-definition.d.ts +7 -7
  15. package/dist/api/event-workflow-template-definition.js +26 -26
  16. package/dist/api/event-workflow-templates.d.ts +8 -8
  17. package/dist/api/event-workflow-templates.js +32 -32
  18. package/dist/api/schedules.d.ts +7 -7
  19. package/dist/api/schedules.js +32 -32
  20. package/dist/api/types.d.ts +11 -11
  21. package/dist/api/types.js +79 -79
  22. package/dist/api/users.d.ts +2 -2
  23. package/dist/api/users.js +18 -18
  24. package/dist/api/webhooks.d.ts +4 -4
  25. package/dist/api/webhooks.js +16 -16
  26. package/dist/auth/login.d.ts +3 -3
  27. package/dist/auth/login.js +221 -221
  28. package/dist/auth/login.spec.d.ts +1 -1
  29. package/dist/auth/login.spec.js +10 -10
  30. package/dist/baseFlags.d.ts +10 -10
  31. package/dist/baseFlags.js +25 -25
  32. package/dist/basecommand.d.ts +15 -15
  33. package/dist/basecommand.js +83 -83
  34. package/dist/commands/app/create.d.ts +10 -10
  35. package/dist/commands/app/create.js +96 -96
  36. package/dist/commands/app/delete.d.ts +11 -11
  37. package/dist/commands/app/delete.js +40 -40
  38. package/dist/commands/app/extension/deploy.d.ts +18 -18
  39. package/dist/commands/app/extension/deploy.js +127 -127
  40. package/dist/commands/app/extension/deployment/list.d.ts +14 -14
  41. package/dist/commands/app/extension/deployment/list.js +82 -82
  42. package/dist/commands/app/getApiKey.d.ts +11 -11
  43. package/dist/commands/app/getApiKey.js +49 -49
  44. package/dist/commands/app/init.d.ts +10 -10
  45. package/dist/commands/app/init.js +67 -67
  46. package/dist/commands/app/install.d.ts +13 -13
  47. package/dist/commands/app/install.js +135 -135
  48. package/dist/commands/app/publish.d.ts +14 -14
  49. package/dist/commands/app/publish.js +69 -69
  50. package/dist/commands/app/uninstall.d.ts +12 -12
  51. package/dist/commands/app/uninstall.js +68 -68
  52. package/dist/commands/app/upgrade.d.ts +14 -14
  53. package/dist/commands/app/upgrade.js +108 -108
  54. package/dist/commands/app/version/major.d.ts +11 -11
  55. package/dist/commands/app/version/major.js +39 -39
  56. package/dist/commands/app/version/minor.d.ts +11 -11
  57. package/dist/commands/app/version/minor.js +39 -39
  58. package/dist/commands/app/version/patch.d.ts +11 -11
  59. package/dist/commands/app/version/patch.js +39 -39
  60. package/dist/commands/config/create.d.ts +12 -12
  61. package/dist/commands/config/create.js +27 -27
  62. package/dist/commands/config/describe.d.ts +14 -14
  63. package/dist/commands/config/describe.js +46 -46
  64. package/dist/commands/config/list.d.ts +11 -11
  65. package/dist/commands/config/list.js +38 -38
  66. package/dist/commands/config/set.d.ts +16 -16
  67. package/dist/commands/config/set.js +46 -46
  68. package/dist/commands/config/use.d.ts +14 -14
  69. package/dist/commands/config/use.js +47 -47
  70. package/dist/commands/file/upload.d.ts +15 -15
  71. package/dist/commands/file/upload.js +69 -69
  72. package/dist/commands/groups/export.d.ts +14 -14
  73. package/dist/commands/groups/export.js +103 -103
  74. package/dist/commands/groups/import.d.ts +14 -14
  75. package/dist/commands/groups/import.js +190 -190
  76. package/dist/commands/instance/export.d.ts +12 -12
  77. package/dist/commands/instance/export.js +36 -36
  78. package/dist/commands/instance/import.d.ts +11 -11
  79. package/dist/commands/instance/import.js +34 -34
  80. package/dist/commands/load/colors.d.ts +14 -14
  81. package/dist/commands/load/colors.js +53 -53
  82. package/dist/commands/load/custom-entity.d.ts +14 -14
  83. package/dist/commands/load/custom-entity.js +55 -55
  84. package/dist/commands/load/line-sheet.d.ts +14 -14
  85. package/dist/commands/load/line-sheet.js +55 -55
  86. package/dist/commands/load/upload-and-load.d.ts +14 -14
  87. package/dist/commands/load/upload-and-load.js +46 -46
  88. package/dist/commands/projects/export.d.ts +13 -13
  89. package/dist/commands/projects/export.js +35 -35
  90. package/dist/commands/projects/list.d.ts +10 -10
  91. package/dist/commands/projects/list.js +36 -36
  92. package/dist/commands/projects/load.d.ts +25 -25
  93. package/dist/commands/projects/load.js +198 -198
  94. package/dist/commands/types/exportOptionSetHierarchies.d.ts +11 -11
  95. package/dist/commands/types/exportOptionSetHierarchies.js +133 -133
  96. package/dist/commands/types/getAll.d.ts +21 -21
  97. package/dist/commands/types/getAll.js +180 -180
  98. package/dist/commands/types/getOptionSets.d.ts +16 -16
  99. package/dist/commands/types/getOptionSets.js +170 -170
  100. package/dist/commands/types/loadAll.d.ts +12 -12
  101. package/dist/commands/types/loadAll.js +55 -55
  102. package/dist/commands/types/mergeOptionSets.d.ts +13 -13
  103. package/dist/commands/types/mergeOptionSets.js +116 -119
  104. package/dist/commands/types/mergeTypeProperties.d.ts +15 -15
  105. package/dist/commands/types/mergeTypeProperties.js +95 -95
  106. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.d.ts +14 -14
  107. package/dist/commands/types/parseOptionSetsHierarchyLocalFile.js +133 -133
  108. package/dist/commands/types/parseOptionSetsHierarchyValuesToKeysLocalFile.d.ts +14 -14
  109. package/dist/commands/types/parseOptionSetsHierarchyValuesToKeysLocalFile.js +102 -102
  110. package/dist/commands/types/parseOptionSetsLocalFiles.d.ts +39 -39
  111. package/dist/commands/types/parseOptionSetsLocalFiles.js +229 -229
  112. package/dist/commands/types/parseOptionSetsToFolderStructure.d.ts +13 -13
  113. package/dist/commands/types/parseOptionSetsToFolderStructure.js +68 -68
  114. package/dist/commands/types/parseTypesFromFiles.d.ts +14 -14
  115. package/dist/commands/types/parseTypesFromFiles.js +40 -40
  116. package/dist/commands/types/parseTypesFromLocalFiles.d.ts +14 -14
  117. package/dist/commands/types/parseTypesFromLocalFiles.js +37 -37
  118. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.d.ts +15 -15
  119. package/dist/commands/types/parseTypesFromTemplateAndDataFromLocalFiles.js +39 -39
  120. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.d.ts +14 -14
  121. package/dist/commands/types/parseTypesFromTemplateFromLocalFiles.js +38 -38
  122. package/dist/commands/types/uploadOptionSetHierarchies.d.ts +12 -12
  123. package/dist/commands/types/uploadOptionSetHierarchies.js +257 -257
  124. package/dist/commands/types/uploadOptionSets.d.ts +13 -13
  125. package/dist/commands/types/uploadOptionSets.js +155 -155
  126. package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.d.ts +15 -15
  127. package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.js +135 -135
  128. package/dist/commands/types/uploadRuleSets.d.ts +12 -12
  129. package/dist/commands/types/uploadRuleSets.js +197 -197
  130. package/dist/commands/types/uploadTypePolicies.d.ts +12 -12
  131. package/dist/commands/types/uploadTypePolicies.js +233 -233
  132. package/dist/commands/types/uploadTypePropertyPolicies.d.ts +13 -13
  133. package/dist/commands/types/uploadTypePropertyPolicies.js +286 -286
  134. package/dist/commands/types/uploadTypes.d.ts +13 -13
  135. package/dist/commands/types/uploadTypes.js +35 -35
  136. package/dist/commands/types/uploadUsageInfo.d.ts +12 -12
  137. package/dist/commands/types/uploadUsageInfo.js +172 -172
  138. package/dist/commands/users/export.d.ts +14 -14
  139. package/dist/commands/users/export.js +76 -76
  140. package/dist/commands/users/import.d.ts +14 -14
  141. package/dist/commands/users/import.js +68 -68
  142. package/dist/commands/webhooks/create.d.ts +11 -11
  143. package/dist/commands/webhooks/create.js +25 -25
  144. package/dist/commands/webhooks/delete.d.ts +14 -14
  145. package/dist/commands/webhooks/delete.js +53 -53
  146. package/dist/commands/webhooks/getWebhookTrigger.d.ts +13 -13
  147. package/dist/commands/webhooks/getWebhookTrigger.js +40 -40
  148. package/dist/commands/webhooks/list.d.ts +12 -12
  149. package/dist/commands/webhooks/list.js +31 -31
  150. package/dist/commands/workflow-template-definitions/install.d.ts +10 -10
  151. package/dist/commands/workflow-template-definitions/install.js +19 -19
  152. package/dist/commands/workflow-template-definitions/list.d.ts +10 -10
  153. package/dist/commands/workflow-template-definitions/list.js +19 -19
  154. package/dist/commands/workflow-templates/delete.d.ts +10 -10
  155. package/dist/commands/workflow-templates/delete.js +19 -19
  156. package/dist/commands/workflow-templates/export.d.ts +14 -14
  157. package/dist/commands/workflow-templates/export.js +78 -78
  158. package/dist/commands/workflow-templates/list.d.ts +10 -10
  159. package/dist/commands/workflow-templates/list.js +19 -19
  160. package/dist/commands/workflow-templates/load.d.ts +13 -13
  161. package/dist/commands/workflow-templates/load.js +26 -26
  162. package/dist/common.d.ts +4 -4
  163. package/dist/common.js +18 -18
  164. package/dist/helpers/app/actions-deployer.d.ts +11 -11
  165. package/dist/helpers/app/actions-deployer.js +123 -123
  166. package/dist/helpers/app/app-config-validators.d.ts +22 -22
  167. package/dist/helpers/app/app-config-validators.js +100 -100
  168. package/dist/helpers/app/app-config-validators.spec.d.ts +1 -1
  169. package/dist/helpers/app/app-config-validators.spec.js +310 -310
  170. package/dist/helpers/app/app-deployer.d.ts +12 -12
  171. package/dist/helpers/app/app-deployer.js +278 -278
  172. package/dist/helpers/app/app-template-parsers.d.ts +14 -14
  173. package/dist/helpers/app/app-template-parsers.js +106 -106
  174. package/dist/helpers/app/extension-package-deployer.d.ts +7 -7
  175. package/dist/helpers/app/extension-package-deployer.js +175 -175
  176. package/dist/helpers/app/extensions-deployer.d.ts +9 -9
  177. package/dist/helpers/app/extensions-deployer.js +95 -91
  178. package/dist/helpers/app/load-app-config.d.ts +4 -4
  179. package/dist/helpers/app/load-app-config.js +22 -22
  180. package/dist/helpers/app/metadata-extractor.d.ts +1 -1
  181. package/dist/helpers/app/metadata-extractor.js +100 -100
  182. package/dist/helpers/app/setup-template.d.ts +8 -8
  183. package/dist/helpers/app/setup-template.js +48 -48
  184. package/dist/helpers/app/update-app-config.d.ts +2 -2
  185. package/dist/helpers/app/update-app-config.js +20 -20
  186. package/dist/helpers/app/upgrade-version.d.ts +16 -16
  187. package/dist/helpers/app/upgrade-version.js +37 -37
  188. package/dist/helpers/app/upgrade-version.spec.d.ts +1 -1
  189. package/dist/helpers/app/upgrade-version.spec.js +33 -33
  190. package/dist/helpers/colors/helpers.d.ts +12 -12
  191. package/dist/helpers/colors/helpers.js +84 -84
  192. package/dist/helpers/config/config.d.ts +16 -16
  193. package/dist/helpers/config/config.js +223 -223
  194. package/dist/helpers/file-helpers.d.ts +2 -2
  195. package/dist/helpers/file-helpers.js +36 -36
  196. package/dist/helpers/load/helpers.d.ts +20 -20
  197. package/dist/helpers/load/helpers.js +141 -141
  198. package/dist/helpers/load/helpers.spec.d.ts +1 -1
  199. package/dist/helpers/load/helpers.spec.js +62 -62
  200. package/dist/helpers/load/validators.d.ts +14 -14
  201. package/dist/helpers/load/validators.js +182 -182
  202. package/dist/helpers/load/validators.spec.d.ts +1 -1
  203. package/dist/helpers/load/validators.spec.js +450 -450
  204. package/dist/helpers/projects/helpers.d.ts +3 -3
  205. package/dist/helpers/projects/helpers.js +167 -167
  206. package/dist/helpers/types/csv-parser.d.ts +1 -1
  207. package/dist/helpers/types/csv-parser.js +59 -59
  208. package/dist/helpers/types/option-set-helper.d.ts +9 -0
  209. package/dist/helpers/types/option-set-helper.js +48 -0
  210. package/dist/helpers/types/option-set-helper.spec.d.ts +1 -0
  211. package/dist/helpers/types/option-set-helper.spec.js +69 -0
  212. package/dist/helpers/types/parseOptionSetsLocalFiles.spec.d.ts +1 -1
  213. package/dist/helpers/types/parseOptionSetsLocalFiles.spec.js +285 -285
  214. package/dist/helpers/types/type-extractor.d.ts +1 -1
  215. package/dist/helpers/types/type-extractor.js +36 -36
  216. package/dist/helpers/types/type-parser.d.ts +4 -4
  217. package/dist/helpers/types/type-parser.js +119 -119
  218. package/dist/helpers/types/type-uploader.d.ts +20 -20
  219. package/dist/helpers/types/type-uploader.js +336 -336
  220. package/dist/helpers/types/type-uploader.spec.d.ts +1 -1
  221. package/dist/helpers/types/type-uploader.spec.js +266 -266
  222. package/dist/helpers/types/uploadOptionSets.spec.d.ts +1 -1
  223. package/dist/helpers/types/uploadOptionSets.spec.js +19 -19
  224. package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.d.ts +12 -12
  225. package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.js +158 -158
  226. package/dist/helpers/workflow-templates/helper.d.ts +20 -20
  227. package/dist/helpers/workflow-templates/helper.js +285 -285
  228. package/dist/index.d.ts +1 -1
  229. package/dist/index.js +5 -5
  230. package/dist/interfaces.d.ts +445 -443
  231. package/dist/interfaces.js +163 -163
  232. package/dist/logger.d.ts +3 -3
  233. package/dist/logger.js +33 -33
  234. package/oclif.manifest.json +3 -3
  235. package/package.json +2 -2
@@ -1,310 +1,310 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const app_config_validators_1 = require("./app-config-validators");
4
- const validResult = {
5
- errors: [],
6
- warnings: [],
7
- };
8
- describe('appVersionValidator', () => {
9
- it('should return an error if "version" field is missing', () => {
10
- const appDeclaration = {};
11
- const expectedError = {
12
- errors: [app_config_validators_1.ERROR_MESSAGES.missingVersionField],
13
- warnings: [],
14
- };
15
- const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
16
- expect(validationResult).toEqual(expectedError);
17
- });
18
- it('should return an error if app version is invalid', () => {
19
- const appDeclaration = {
20
- version: 'invalidVersion',
21
- };
22
- const expectedError = {
23
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
24
- warnings: [],
25
- };
26
- const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
27
- expect(validationResult).toEqual(expectedError);
28
- });
29
- it('should not return an error if app version is valid', () => {
30
- const appDeclaration = {
31
- version: '1.0.0',
32
- };
33
- const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
34
- expect(validationResult).toEqual(validResult);
35
- });
36
- it('should gracefully handle bad versions', () => {
37
- const appDeclaration = {
38
- version: '1',
39
- };
40
- const expectedError = {
41
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
42
- warnings: [],
43
- };
44
- const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
45
- expect(validationResult).toEqual(expectedError);
46
- });
47
- });
48
- it('should return an error if "version" field is not a string', () => {
49
- const appDeclaration = {
50
- version: 123,
51
- };
52
- const expectedError = {
53
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidVersionField],
54
- warnings: [],
55
- };
56
- const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
57
- expect(validationResult).toEqual(expectedError);
58
- });
59
- it('should return an error if "version" field is empty', () => {
60
- const appDeclaration = {
61
- version: '',
62
- };
63
- const expectedError = {
64
- errors: [app_config_validators_1.ERROR_MESSAGES.missingVersionField],
65
- warnings: [],
66
- };
67
- const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
68
- expect(validationResult).toEqual(expectedError);
69
- });
70
- it('should return an error if app version has invalid format', () => {
71
- const appDeclaration = {
72
- version: '1.0',
73
- };
74
- const expectedError = {
75
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
76
- warnings: [],
77
- };
78
- const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
79
- expect(validationResult).toEqual(expectedError);
80
- });
81
- describe('visibilityValidator', () => {
82
- it('should return an error if visibility is neither "public" nor "private"', () => {
83
- const appDeclaration = {
84
- visibility: 'invalidVisibility',
85
- };
86
- const expectedError = {
87
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidVisibility],
88
- warnings: [],
89
- };
90
- const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
91
- expect(validationResult).toEqual(expectedError);
92
- });
93
- it('should not return an error if visibility is "public"', () => {
94
- const appDeclaration = {
95
- visibility: 'public',
96
- };
97
- const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
98
- expect(validationResult).toEqual(validResult);
99
- });
100
- it('should warn if "hidden" field is present (deprecated)', () => {
101
- const appDeclaration = {
102
- visibility: 'public',
103
- hidden: true,
104
- };
105
- const warningResult = {
106
- errors: [],
107
- warnings: [app_config_validators_1.ERROR_MESSAGES.deprecatedHiddenField],
108
- };
109
- const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
110
- expect(validationResult).toEqual(warningResult);
111
- });
112
- });
113
- describe('validateAccessGrants', () => {
114
- it('should warn if app is set to public and "accessGrants" field is present', () => {
115
- const appDeclaration = {
116
- visibility: 'public',
117
- accessGrants: [
118
- {
119
- orgSlug: 'org1',
120
- permissions: ['install'],
121
- },
122
- ],
123
- };
124
- const warningResult = {
125
- errors: [],
126
- warnings: [app_config_validators_1.ERROR_MESSAGES.ignoredAccessGrants],
127
- };
128
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
129
- expect(validationResult).toEqual(warningResult);
130
- });
131
- it('should return an error if app is private and "accessGrants" field is present but invalid', () => {
132
- const appDeclaration = {
133
- visibility: 'private',
134
- accessGrants: [
135
- {
136
- orgSlug: '',
137
- permissions: ['install'],
138
- },
139
- {
140
- orgSlug: 'org2',
141
- permissions: ['install'],
142
- },
143
- ],
144
- };
145
- const expectedError = {
146
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
147
- warnings: [],
148
- };
149
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
150
- expect(validationResult).toEqual(expectedError);
151
- });
152
- it('should not return an error if app is private and "accessGrants" field is present and valid', () => {
153
- const appDeclaration = {
154
- visibility: 'private',
155
- accessGrants: [
156
- {
157
- orgSlug: 'org1',
158
- permissions: ['install'],
159
- },
160
- ],
161
- };
162
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
163
- expect(validationResult).toEqual(validResult);
164
- });
165
- it('should return valid if accessGrants is an empty array', () => {
166
- const appDeclaration = {
167
- visibility: 'private',
168
- accessGrants: [],
169
- };
170
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
171
- expect(validationResult).toEqual(validResult);
172
- });
173
- it('should return valid if accessGrants is an array with valid orgSlug and permissions', () => {
174
- const appDeclaration = {
175
- visibility: 'private',
176
- accessGrants: [
177
- {
178
- orgSlug: 'org1',
179
- permissions: ['install'],
180
- },
181
- ],
182
- };
183
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
184
- expect(validationResult).toEqual(validResult);
185
- });
186
- it('should return invalid if accessGrants is not an array', () => {
187
- const appDeclaration = {
188
- visibility: 'private',
189
- accessGrants: 'invalid',
190
- };
191
- const expectedError = {
192
- errors: [app_config_validators_1.ERROR_MESSAGES.accessGrantsArray],
193
- warnings: [],
194
- };
195
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
196
- expect(validationResult).toEqual(expectedError);
197
- });
198
- it('should return invalid if orgSlug is missing in one of the accessGrants objects', () => {
199
- const appDeclaration = {
200
- visibility: 'private',
201
- accessGrants: [
202
- {
203
- orgSlug: '',
204
- permissions: ['install'],
205
- },
206
- {
207
- orgSlug: 'org2',
208
- permissions: ['install'],
209
- },
210
- ],
211
- };
212
- const expectedError = {
213
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
214
- warnings: [],
215
- };
216
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
217
- expect(validationResult).toEqual(expectedError);
218
- });
219
- it('should return invalid if permissions is not an array or empty in one of the accessGrants objects', () => {
220
- const appDeclaration = {
221
- visibility: 'private',
222
- accessGrants: [
223
- {
224
- orgSlug: 'org1',
225
- permissions: 'invalid',
226
- },
227
- {
228
- orgSlug: 'org2',
229
- permissions: [],
230
- },
231
- ],
232
- };
233
- const expectedError = {
234
- errors: [app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray, app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray],
235
- warnings: [],
236
- };
237
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
238
- expect(validationResult).toEqual(expectedError);
239
- });
240
- it('should return invalid if invalid permission is found in one of the accessGrants objects', () => {
241
- const appDeclaration = {
242
- visibility: 'private',
243
- accessGrants: [
244
- {
245
- orgSlug: 'org1',
246
- permissions: ['install', 'invalid'],
247
- },
248
- {
249
- orgSlug: 'org2',
250
- permissions: ['install'],
251
- },
252
- ],
253
- };
254
- const expectedError = {
255
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidPermission('invalid')],
256
- warnings: [],
257
- };
258
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
259
- expect(validationResult).toEqual(expectedError);
260
- });
261
- it('should return error if case-insensitive permission is found in accessGrants object', () => {
262
- const appDeclaration = {
263
- visibility: 'private',
264
- accessGrants: [
265
- {
266
- orgSlug: 'org1',
267
- permissions: ['Install'],
268
- },
269
- ],
270
- };
271
- const expectedError = {
272
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidPermission('Install')],
273
- warnings: [],
274
- };
275
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
276
- expect(validationResult).toEqual(expectedError);
277
- });
278
- it('should return invalid if orgSlug is missing from the accessGrants object', () => {
279
- const appDeclaration = {
280
- visibility: 'private',
281
- accessGrants: [
282
- {
283
- permissions: ['install'],
284
- },
285
- ],
286
- };
287
- const expectedError = {
288
- errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
289
- warnings: [],
290
- };
291
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
292
- expect(validationResult).toEqual(expectedError);
293
- });
294
- it('should return invalid if permissions is missing from the accessGrants object', () => {
295
- const appDeclaration = {
296
- visibility: 'private',
297
- accessGrants: [
298
- {
299
- orgSlug: 'org2',
300
- },
301
- ],
302
- };
303
- const expectedError = {
304
- errors: [app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray],
305
- warnings: [],
306
- };
307
- const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
308
- expect(validationResult).toEqual(expectedError);
309
- });
310
- });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const app_config_validators_1 = require("./app-config-validators");
4
+ const validResult = {
5
+ errors: [],
6
+ warnings: [],
7
+ };
8
+ describe('appVersionValidator', () => {
9
+ it('should return an error if "version" field is missing', () => {
10
+ const appDeclaration = {};
11
+ const expectedError = {
12
+ errors: [app_config_validators_1.ERROR_MESSAGES.missingVersionField],
13
+ warnings: [],
14
+ };
15
+ const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
16
+ expect(validationResult).toEqual(expectedError);
17
+ });
18
+ it('should return an error if app version is invalid', () => {
19
+ const appDeclaration = {
20
+ version: 'invalidVersion',
21
+ };
22
+ const expectedError = {
23
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
24
+ warnings: [],
25
+ };
26
+ const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
27
+ expect(validationResult).toEqual(expectedError);
28
+ });
29
+ it('should not return an error if app version is valid', () => {
30
+ const appDeclaration = {
31
+ version: '1.0.0',
32
+ };
33
+ const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
34
+ expect(validationResult).toEqual(validResult);
35
+ });
36
+ it('should gracefully handle bad versions', () => {
37
+ const appDeclaration = {
38
+ version: '1',
39
+ };
40
+ const expectedError = {
41
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
42
+ warnings: [],
43
+ };
44
+ const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
45
+ expect(validationResult).toEqual(expectedError);
46
+ });
47
+ });
48
+ it('should return an error if "version" field is not a string', () => {
49
+ const appDeclaration = {
50
+ version: 123,
51
+ };
52
+ const expectedError = {
53
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidVersionField],
54
+ warnings: [],
55
+ };
56
+ const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
57
+ expect(validationResult).toEqual(expectedError);
58
+ });
59
+ it('should return an error if "version" field is empty', () => {
60
+ const appDeclaration = {
61
+ version: '',
62
+ };
63
+ const expectedError = {
64
+ errors: [app_config_validators_1.ERROR_MESSAGES.missingVersionField],
65
+ warnings: [],
66
+ };
67
+ const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
68
+ expect(validationResult).toEqual(expectedError);
69
+ });
70
+ it('should return an error if app version has invalid format', () => {
71
+ const appDeclaration = {
72
+ version: '1.0',
73
+ };
74
+ const expectedError = {
75
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
76
+ warnings: [],
77
+ };
78
+ const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
79
+ expect(validationResult).toEqual(expectedError);
80
+ });
81
+ describe('visibilityValidator', () => {
82
+ it('should return an error if visibility is neither "public" nor "private"', () => {
83
+ const appDeclaration = {
84
+ visibility: 'invalidVisibility',
85
+ };
86
+ const expectedError = {
87
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidVisibility],
88
+ warnings: [],
89
+ };
90
+ const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
91
+ expect(validationResult).toEqual(expectedError);
92
+ });
93
+ it('should not return an error if visibility is "public"', () => {
94
+ const appDeclaration = {
95
+ visibility: 'public',
96
+ };
97
+ const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
98
+ expect(validationResult).toEqual(validResult);
99
+ });
100
+ it('should warn if "hidden" field is present (deprecated)', () => {
101
+ const appDeclaration = {
102
+ visibility: 'public',
103
+ hidden: true,
104
+ };
105
+ const warningResult = {
106
+ errors: [],
107
+ warnings: [app_config_validators_1.ERROR_MESSAGES.deprecatedHiddenField],
108
+ };
109
+ const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
110
+ expect(validationResult).toEqual(warningResult);
111
+ });
112
+ });
113
+ describe('validateAccessGrants', () => {
114
+ it('should warn if app is set to public and "accessGrants" field is present', () => {
115
+ const appDeclaration = {
116
+ visibility: 'public',
117
+ accessGrants: [
118
+ {
119
+ orgSlug: 'org1',
120
+ permissions: ['install'],
121
+ },
122
+ ],
123
+ };
124
+ const warningResult = {
125
+ errors: [],
126
+ warnings: [app_config_validators_1.ERROR_MESSAGES.ignoredAccessGrants],
127
+ };
128
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
129
+ expect(validationResult).toEqual(warningResult);
130
+ });
131
+ it('should return an error if app is private and "accessGrants" field is present but invalid', () => {
132
+ const appDeclaration = {
133
+ visibility: 'private',
134
+ accessGrants: [
135
+ {
136
+ orgSlug: '',
137
+ permissions: ['install'],
138
+ },
139
+ {
140
+ orgSlug: 'org2',
141
+ permissions: ['install'],
142
+ },
143
+ ],
144
+ };
145
+ const expectedError = {
146
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
147
+ warnings: [],
148
+ };
149
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
150
+ expect(validationResult).toEqual(expectedError);
151
+ });
152
+ it('should not return an error if app is private and "accessGrants" field is present and valid', () => {
153
+ const appDeclaration = {
154
+ visibility: 'private',
155
+ accessGrants: [
156
+ {
157
+ orgSlug: 'org1',
158
+ permissions: ['install'],
159
+ },
160
+ ],
161
+ };
162
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
163
+ expect(validationResult).toEqual(validResult);
164
+ });
165
+ it('should return valid if accessGrants is an empty array', () => {
166
+ const appDeclaration = {
167
+ visibility: 'private',
168
+ accessGrants: [],
169
+ };
170
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
171
+ expect(validationResult).toEqual(validResult);
172
+ });
173
+ it('should return valid if accessGrants is an array with valid orgSlug and permissions', () => {
174
+ const appDeclaration = {
175
+ visibility: 'private',
176
+ accessGrants: [
177
+ {
178
+ orgSlug: 'org1',
179
+ permissions: ['install'],
180
+ },
181
+ ],
182
+ };
183
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
184
+ expect(validationResult).toEqual(validResult);
185
+ });
186
+ it('should return invalid if accessGrants is not an array', () => {
187
+ const appDeclaration = {
188
+ visibility: 'private',
189
+ accessGrants: 'invalid',
190
+ };
191
+ const expectedError = {
192
+ errors: [app_config_validators_1.ERROR_MESSAGES.accessGrantsArray],
193
+ warnings: [],
194
+ };
195
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
196
+ expect(validationResult).toEqual(expectedError);
197
+ });
198
+ it('should return invalid if orgSlug is missing in one of the accessGrants objects', () => {
199
+ const appDeclaration = {
200
+ visibility: 'private',
201
+ accessGrants: [
202
+ {
203
+ orgSlug: '',
204
+ permissions: ['install'],
205
+ },
206
+ {
207
+ orgSlug: 'org2',
208
+ permissions: ['install'],
209
+ },
210
+ ],
211
+ };
212
+ const expectedError = {
213
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
214
+ warnings: [],
215
+ };
216
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
217
+ expect(validationResult).toEqual(expectedError);
218
+ });
219
+ it('should return invalid if permissions is not an array or empty in one of the accessGrants objects', () => {
220
+ const appDeclaration = {
221
+ visibility: 'private',
222
+ accessGrants: [
223
+ {
224
+ orgSlug: 'org1',
225
+ permissions: 'invalid',
226
+ },
227
+ {
228
+ orgSlug: 'org2',
229
+ permissions: [],
230
+ },
231
+ ],
232
+ };
233
+ const expectedError = {
234
+ errors: [app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray, app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray],
235
+ warnings: [],
236
+ };
237
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
238
+ expect(validationResult).toEqual(expectedError);
239
+ });
240
+ it('should return invalid if invalid permission is found in one of the accessGrants objects', () => {
241
+ const appDeclaration = {
242
+ visibility: 'private',
243
+ accessGrants: [
244
+ {
245
+ orgSlug: 'org1',
246
+ permissions: ['install', 'invalid'],
247
+ },
248
+ {
249
+ orgSlug: 'org2',
250
+ permissions: ['install'],
251
+ },
252
+ ],
253
+ };
254
+ const expectedError = {
255
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidPermission('invalid')],
256
+ warnings: [],
257
+ };
258
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
259
+ expect(validationResult).toEqual(expectedError);
260
+ });
261
+ it('should return error if case-insensitive permission is found in accessGrants object', () => {
262
+ const appDeclaration = {
263
+ visibility: 'private',
264
+ accessGrants: [
265
+ {
266
+ orgSlug: 'org1',
267
+ permissions: ['Install'],
268
+ },
269
+ ],
270
+ };
271
+ const expectedError = {
272
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidPermission('Install')],
273
+ warnings: [],
274
+ };
275
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
276
+ expect(validationResult).toEqual(expectedError);
277
+ });
278
+ it('should return invalid if orgSlug is missing from the accessGrants object', () => {
279
+ const appDeclaration = {
280
+ visibility: 'private',
281
+ accessGrants: [
282
+ {
283
+ permissions: ['install'],
284
+ },
285
+ ],
286
+ };
287
+ const expectedError = {
288
+ errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
289
+ warnings: [],
290
+ };
291
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
292
+ expect(validationResult).toEqual(expectedError);
293
+ });
294
+ it('should return invalid if permissions is missing from the accessGrants object', () => {
295
+ const appDeclaration = {
296
+ visibility: 'private',
297
+ accessGrants: [
298
+ {
299
+ orgSlug: 'org2',
300
+ },
301
+ ],
302
+ };
303
+ const expectedError = {
304
+ errors: [app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray],
305
+ warnings: [],
306
+ };
307
+ const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
308
+ expect(validationResult).toEqual(expectedError);
309
+ });
310
+ });
@@ -1,12 +1,12 @@
1
- import { App, AppCodePackage, AppDeclaration } from '../../interfaces';
2
- export declare class AppDeployer {
3
- private debug;
4
- private dryRun;
5
- constructor(debug?: boolean, dryRun?: boolean);
6
- deploy(appDeclaration: AppDeclaration): Promise<App>;
7
- getExistingApp(appDeclaration: AppDeclaration): Promise<App>;
8
- private createNewApp;
9
- updateExistingApp(appDeclaration: AppDeclaration, existingApp: any): Promise<App>;
10
- remove(appDeclaration: AppDeclaration): Promise<void>;
11
- }
12
- export declare function createNodePackage(appIdentifier: string, debug: boolean, dryRun: boolean): Promise<AppCodePackage>;
1
+ import { App, AppCodePackage, AppDeclaration } from '../../interfaces';
2
+ export declare class AppDeployer {
3
+ private debug;
4
+ private dryRun;
5
+ constructor(debug?: boolean, dryRun?: boolean);
6
+ deploy(appDeclaration: AppDeclaration): Promise<App>;
7
+ getExistingApp(appDeclaration: AppDeclaration): Promise<App>;
8
+ private createNewApp;
9
+ updateExistingApp(appDeclaration: AppDeclaration, existingApp: any): Promise<App>;
10
+ remove(appDeclaration: AppDeclaration): Promise<void>;
11
+ }
12
+ export declare function createNodePackage(appIdentifier: string, debug: boolean, dryRun: boolean): Promise<AppCodePackage>;