@itentialopensource/adapter-apic 0.3.2 → 0.4.0

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 (51) hide show
  1. package/.eslintignore +1 -0
  2. package/.eslintrc.js +12 -12
  3. package/AUTH.md +39 -0
  4. package/BROKER.md +199 -0
  5. package/CALLS.md +169 -0
  6. package/CHANGELOG.md +46 -20
  7. package/CODE_OF_CONDUCT.md +12 -17
  8. package/CONTRIBUTING.md +88 -74
  9. package/ENHANCE.md +69 -0
  10. package/PROPERTIES.md +641 -0
  11. package/README.md +244 -392
  12. package/SUMMARY.md +9 -0
  13. package/SYSTEMINFO.md +11 -0
  14. package/TROUBLESHOOT.md +47 -0
  15. package/adapter.js +691 -42
  16. package/adapterBase.js +1331 -50
  17. package/entities/.generic/action.json +214 -0
  18. package/entities/.generic/schema.json +28 -0
  19. package/error.json +12 -0
  20. package/package.json +47 -23
  21. package/pronghorn.json +677 -28
  22. package/propertiesDecorators.json +14 -0
  23. package/propertiesSchema.json +505 -11
  24. package/refs?service=git-upload-pack +0 -0
  25. package/report/adapterInfo.json +10 -0
  26. package/report/updateReport1593819602461.json +95 -0
  27. package/report/updateReport1614354810622.json +95 -0
  28. package/report/updateReport1653418391508.json +120 -0
  29. package/sampleProperties.json +111 -7
  30. package/test/integration/adapterTestBasicGet.js +85 -0
  31. package/test/integration/adapterTestConnectivity.js +93 -0
  32. package/test/integration/adapterTestIntegration.js +40 -103
  33. package/test/unit/adapterBaseTestUnit.js +949 -0
  34. package/test/unit/adapterTestUnit.js +653 -114
  35. package/utils/adapterInfo.js +206 -0
  36. package/utils/addAuth.js +94 -0
  37. package/utils/artifactize.js +9 -14
  38. package/utils/basicGet.js +50 -0
  39. package/utils/checkMigrate.js +63 -0
  40. package/utils/entitiesToDB.js +179 -0
  41. package/utils/findPath.js +74 -0
  42. package/utils/modify.js +154 -0
  43. package/utils/packModificationScript.js +1 -1
  44. package/utils/patches2bundledDeps.js +90 -0
  45. package/utils/pre-commit.sh +4 -1
  46. package/utils/removeHooks.js +20 -0
  47. package/utils/tbScript.js +184 -0
  48. package/utils/tbUtils.js +469 -0
  49. package/utils/testRunner.js +16 -16
  50. package/utils/troubleshootingAdapter.js +190 -0
  51. package/gl-code-quality-report.json +0 -1
@@ -3,6 +3,8 @@
3
3
  // Set globals
4
4
  /* global describe it log pronghornProps */
5
5
  /* eslint no-unused-vars: warn */
6
+ /* eslint no-underscore-dangle: warn */
7
+ /* eslint import/no-dynamic-require:warn */
6
8
 
7
9
  // include required items for testing & logging
8
10
  const assert = require('assert');
@@ -13,25 +15,39 @@ const winston = require('winston');
13
15
  const { expect } = require('chai');
14
16
  const { use } = require('chai');
15
17
  const td = require('testdouble');
18
+ const util = require('util');
16
19
 
17
20
  const anything = td.matchers.anything();
18
21
 
19
22
  // stub and attemptTimeout are used throughout the code so set them here
20
23
  let logLevel = 'none';
21
- const stub = true;
22
24
  const isRapidFail = false;
23
25
  const isSaveMockData = false;
24
- const attemptTimeout = 10000;
26
+
27
+ // read in the properties from the sampleProperties files
28
+ let adaptdir = __dirname;
29
+ if (adaptdir.endsWith('/test/integration')) {
30
+ adaptdir = adaptdir.substring(0, adaptdir.length - 17);
31
+ } else if (adaptdir.endsWith('/test/unit')) {
32
+ adaptdir = adaptdir.substring(0, adaptdir.length - 10);
33
+ }
34
+ const samProps = require(`${adaptdir}/sampleProperties.json`).properties;
25
35
 
26
36
  // these variables can be changed to run in integrated mode so easier to set them here
27
37
  // always check these in with bogus data!!!
28
- const host = 'replace.hostorip.here';
29
- const username = 'username';
30
- const password = 'password';
31
- const protocol = 'http';
32
- const port = 80;
33
- const sslenable = false;
34
- const sslinvalid = false;
38
+ samProps.stub = true;
39
+ samProps.host = 'replace.hostorip.here';
40
+ samProps.authentication.username = 'username';
41
+ samProps.authentication.password = 'password';
42
+ samProps.protocol = 'http';
43
+ samProps.port = 80;
44
+ samProps.ssl.enabled = false;
45
+ samProps.ssl.accept_invalid_cert = false;
46
+ if (samProps.request.attempt_timeout < 30000) {
47
+ samProps.request.attempt_timeout = 30000;
48
+ }
49
+ const attemptTimeout = samProps.request.attempt_timeout;
50
+ const { stub } = samProps;
35
51
 
36
52
  // these are the adapter properties. You generally should not need to alter
37
53
  // any of these after they are initially set up
@@ -41,89 +57,9 @@ global.pronghornProps = {
41
57
  },
42
58
  adapterProps: {
43
59
  adapters: [{
44
- id: 'test-apic',
60
+ id: 'Test-apic',
45
61
  type: 'Apic',
46
- properties: {
47
- host,
48
- port,
49
- base_path: '/',
50
- version: '',
51
- cache_location: 'none',
52
- save_metric: false,
53
- stub,
54
- protocol,
55
- authentication: {
56
- auth_method: 'basic user_password',
57
- username,
58
- password,
59
- token: '',
60
- invalid_token_error: 401,
61
- token_timeout: -1,
62
- token_cache: 'local',
63
- auth_field: 'header.auth',
64
- auth_field_format: '{username}:{password}'
65
- },
66
- healthcheck: {
67
- type: 'startup',
68
- frequency: 60000
69
- },
70
- throttle: {
71
- throttle_enabled: false,
72
- number_pronghorns: 1,
73
- sync_async: 'sync',
74
- max_in_queue: 1000,
75
- concurrent_max: 1,
76
- expire_timeout: 0,
77
- avg_runtime: 200
78
- },
79
- request: {
80
- number_redirects: 0,
81
- number_retries: 3,
82
- limit_retry_error: 0,
83
- failover_codes: [],
84
- attempt_timeout: attemptTimeout,
85
- global_request: {
86
- payload: {},
87
- uriOptions: {},
88
- addlHeaders: {},
89
- authData: {}
90
- },
91
- healthcheck_on_timeout: true,
92
- return_raw: true,
93
- archiving: false
94
- },
95
- proxy: {
96
- enabled: false,
97
- host: '',
98
- port: 1,
99
- protocol: 'http'
100
- },
101
- ssl: {
102
- ecdhCurve: '',
103
- enabled: sslenable,
104
- accept_invalid_cert: sslinvalid,
105
- ca_file: '',
106
- key_file: '',
107
- cert_file: '',
108
- secure_protocol: '',
109
- ciphers: ''
110
- },
111
- mongo: {
112
- host: '',
113
- port: 0,
114
- database: '',
115
- username: '',
116
- password: '',
117
- replSet: '',
118
- db_ssl: {
119
- enabled: false,
120
- accept_invalid_cert: false,
121
- ca_file: '',
122
- key_file: '',
123
- cert_file: ''
124
- }
125
- }
126
- }
62
+ properties: samProps
127
63
  }]
128
64
  }
129
65
  };
@@ -159,7 +95,7 @@ process.argv.forEach((val) => {
159
95
  });
160
96
 
161
97
  // need to set global logging
162
- global.log = new (winston.Logger)({
98
+ global.log = winston.createLogger({
163
99
  level: logLevel,
164
100
  levels: myCustomLevels.levels,
165
101
  transports: [
@@ -253,7 +189,7 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
253
189
  };
254
190
 
255
191
  // get the object for method we're trying to change.
256
- const currentMethodAction = parsedJson.actions.find(obj => obj.name === actionName);
192
+ const currentMethodAction = parsedJson.actions.find((obj) => obj.name === actionName);
257
193
 
258
194
  // if the method was not found - should never happen but...
259
195
  if (!currentMethodAction) {
@@ -261,12 +197,12 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
261
197
  }
262
198
 
263
199
  // if there is a response object, we want to replace the Response object. Otherwise we'll create one.
264
- const actionResponseObj = currentMethodAction.responseObjects.find(obj => obj.type === descriptor);
200
+ const actionResponseObj = currentMethodAction.responseObjects.find((obj) => obj.type === descriptor);
265
201
 
266
202
  // Add the action responseObj back into the array of response objects.
267
203
  if (!actionResponseObj) {
268
204
  // if there is a default response object, we want to get the key.
269
- const defaultResponseObj = currentMethodAction.responseObjects.find(obj => obj.type === 'default');
205
+ const defaultResponseObj = currentMethodAction.responseObjects.find((obj) => obj.type === 'default');
270
206
 
271
207
  // save the default key into the new response object
272
208
  if (defaultResponseObj) {
@@ -297,9 +233,8 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
297
233
  return false;
298
234
  }
299
235
 
300
-
301
236
  // require the adapter that we are going to be using
302
- const Apic = require('../../adapter.js');
237
+ const Apic = require('../../adapter');
303
238
 
304
239
  // begin the testing - these should be pretty well defined between the describe and the it!
305
240
  describe('[integration] Apic Adapter Test', () => {
@@ -330,6 +265,8 @@ describe('[integration] Apic Adapter Test', () => {
330
265
  try {
331
266
  assert.notEqual(null, a);
332
267
  assert.notEqual(undefined, a);
268
+ const checkId = global.pronghornProps.adapterProps.adapters[0].id;
269
+ assert.equal(checkId, a.id);
333
270
  assert.notEqual(null, a.allProps);
334
271
  const check = global.pronghornProps.adapterProps.adapters[0].properties.healthcheck.type;
335
272
  assert.equal(check, a.healthcheckType);
@@ -418,7 +355,7 @@ describe('[integration] Apic Adapter Test', () => {
418
355
  try {
419
356
  if (stub) {
420
357
  const displayE = 'Error 400 received on request';
421
- runErrorAsserts(data, error, 'AD.500', 'test-apic-connectorRest-handleEndResponse', displayE);
358
+ runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
422
359
  } else {
423
360
  runCommonAsserts(data, error);
424
361
  }
@@ -443,7 +380,7 @@ describe('[integration] Apic Adapter Test', () => {
443
380
  try {
444
381
  if (stub) {
445
382
  const displayE = 'Error 400 received on request';
446
- runErrorAsserts(data, error, 'AD.500', 'test-apic-connectorRest-handleEndResponse', displayE);
383
+ runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
447
384
  } else {
448
385
  runCommonAsserts(data, error);
449
386
  }
@@ -468,7 +405,7 @@ describe('[integration] Apic Adapter Test', () => {
468
405
  try {
469
406
  if (stub) {
470
407
  const displayE = 'Error 400 received on request';
471
- runErrorAsserts(data, error, 'AD.500', 'test-apic-connectorRest-handleEndResponse', displayE);
408
+ runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
472
409
  } else {
473
410
  runCommonAsserts(data, error);
474
411
  }
@@ -493,7 +430,7 @@ describe('[integration] Apic Adapter Test', () => {
493
430
  try {
494
431
  if (stub) {
495
432
  const displayE = 'Error 400 received on request';
496
- runErrorAsserts(data, error, 'AD.500', 'test-apic-connectorRest-handleEndResponse', displayE);
433
+ runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
497
434
  } else {
498
435
  runCommonAsserts(data, error);
499
436
  }
@@ -518,7 +455,7 @@ describe('[integration] Apic Adapter Test', () => {
518
455
  try {
519
456
  if (stub) {
520
457
  const displayE = 'Error 400 received on request';
521
- runErrorAsserts(data, error, 'AD.500', 'test-apic-connectorRest-handleEndResponse', displayE);
458
+ runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
522
459
  } else {
523
460
  runCommonAsserts(data, error);
524
461
  }
@@ -543,7 +480,7 @@ describe('[integration] Apic Adapter Test', () => {
543
480
  try {
544
481
  if (stub) {
545
482
  const displayE = 'Error 400 received on request';
546
- runErrorAsserts(data, error, 'AD.500', 'test-apic-connectorRest-handleEndResponse', displayE);
483
+ runErrorAsserts(data, error, 'AD.500', 'Test-apic-connectorRest-handleEndResponse', displayE);
547
484
  } else {
548
485
  runCommonAsserts(data, error);
549
486
  }