@itentialopensource/adapter-ciena_mcp 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 (89) hide show
  1. package/AUTH.md +9 -10
  2. package/BROKER.md +3 -3
  3. package/CALLS.md +10042 -22
  4. package/CHANGELOG.md +16 -0
  5. package/CONTRIBUTING.md +1 -160
  6. package/ENHANCE.md +2 -2
  7. package/PROPERTIES.md +19 -19
  8. package/README.md +41 -32
  9. package/SUMMARY.md +2 -2
  10. package/SYSTEMINFO.md +12 -5
  11. package/TROUBLESHOOT.md +6 -6
  12. package/adapter.js +163 -334
  13. package/adapterBase.js +549 -879
  14. package/changelogs/CHANGELOG.md +24 -0
  15. package/entities/000Configmgmtapiv1bulkOperations/schema.json +1 -1
  16. package/entities/000Nsiapicontrollers/schema.json +1 -1
  17. package/entities/000Nsiapiequipment/schema.json +2 -2
  18. package/entities/000NsiapiequipmentGroups/schema.json +3 -3
  19. package/entities/000NsiapiequipmentHolders/schema.json +1 -1
  20. package/entities/000NsiapiequipmentStaticSpecs/schema.json +3 -3
  21. package/entities/000Nsiapifres/schema.json +5 -5
  22. package/entities/000NsiapinetworkConstructs/schema.json +2 -2
  23. package/entities/000Nsiapitpes/schema.json +4 -4
  24. package/entities/994Nsiapiv6equipment/schema.json +2 -2
  25. package/entities/994Nsiapiv6fres/schema.json +5 -5
  26. package/entities/994Nsiapiv6networkConstructs/schema.json +2 -2
  27. package/entities/994Nsiapiv6tpes/schema.json +4 -4
  28. package/entities/995Nsiapiv2controllers/schema.json +1 -1
  29. package/entities/995Nsiapiv5equipment/schema.json +2 -2
  30. package/entities/995Nsiapiv5fres/schema.json +5 -5
  31. package/entities/995Nsiapiv5networkConstructs/schema.json +2 -2
  32. package/entities/995Nsiapiv5tpes/schema.json +3 -3
  33. package/entities/996Nsiapiv1controllers/schema.json +1 -1
  34. package/entities/996Nsiapiv1equipmentStaticSpecs/schema.json +3 -3
  35. package/entities/996Nsiapiv4equipment/schema.json +4 -4
  36. package/entities/996Nsiapiv4fres/schema.json +16 -16
  37. package/entities/996Nsiapiv4networkConstructs/schema.json +2 -2
  38. package/entities/996Nsiapiv4tpes/schema.json +4 -4
  39. package/entities/997Nsiapiv3equipment/schema.json +2 -2
  40. package/entities/997Nsiapiv3equipmentGroups/schema.json +3 -3
  41. package/entities/997Nsiapiv3equipmentHolders/schema.json +1 -1
  42. package/entities/997Nsiapiv3fres/schema.json +4 -4
  43. package/entities/997Nsiapiv3networkConstructs/schema.json +2 -2
  44. package/entities/997Nsiapiv3tpes/schema.json +3 -3
  45. package/entities/998Nsiapiv20equipmentGroups/schema.json +3 -3
  46. package/entities/998Nsiapiv20equipmentHolders/schema.json +1 -1
  47. package/entities/998Nsiapiv20fres/schema.json +4 -4
  48. package/entities/Equipment/schema.json +18 -18
  49. package/entities/EquipmentGroups/schema.json +3 -3
  50. package/entities/Fres/schema.json +66 -66
  51. package/entities/NetworkConstructs/schema.json +22 -22
  52. package/entities/Oam/schema.json +1 -1
  53. package/entities/RetrievesCreatesUpdatesAndDeletesAudits/schema.json +3 -3
  54. package/entities/TapiConnectivity/schema.json +2 -2
  55. package/entities/Tpes/schema.json +6 -6
  56. package/metadata.json +60 -0
  57. package/package.json +23 -25
  58. package/pronghorn.json +986 -647
  59. package/propertiesSchema.json +433 -33
  60. package/refs?service=git-upload-pack +0 -0
  61. package/report/adapter-openapi.json +218608 -0
  62. package/report/adapter-openapi.yaml +159470 -0
  63. package/report/adapterInfo.json +8 -8
  64. package/report/updateReport1691507600369.json +120 -0
  65. package/report/updateReport1692202602603.json +120 -0
  66. package/report/updateReport1694461981982.json +120 -0
  67. package/report/updateReport1698420997295.json +120 -0
  68. package/sampleProperties.json +65 -4
  69. package/test/integration/adapterTestBasicGet.js +2 -4
  70. package/test/integration/adapterTestConnectivity.js +91 -42
  71. package/test/integration/adapterTestIntegration.js +131 -3
  72. package/test/unit/adapterBaseTestUnit.js +388 -313
  73. package/test/unit/adapterTestUnit.js +339 -113
  74. package/utils/adapterInfo.js +1 -1
  75. package/utils/addAuth.js +1 -1
  76. package/utils/artifactize.js +1 -1
  77. package/utils/checkMigrate.js +1 -1
  78. package/utils/entitiesToDB.js +2 -2
  79. package/utils/findPath.js +1 -1
  80. package/utils/methodDocumentor.js +273 -0
  81. package/utils/modify.js +13 -15
  82. package/utils/packModificationScript.js +1 -1
  83. package/utils/pre-commit.sh +2 -0
  84. package/utils/taskMover.js +309 -0
  85. package/utils/tbScript.js +89 -34
  86. package/utils/tbUtils.js +41 -21
  87. package/utils/testRunner.js +1 -1
  88. package/utils/troubleshootingAdapter.js +9 -6
  89. package/workflows/README.md +0 -3
@@ -3,9 +3,12 @@
3
3
  /* global describe it context before after */
4
4
  /* eslint no-unused-vars: warn */
5
5
 
6
- const mocha = require('mocha');
7
6
  const assert = require('assert');
8
- const diagnostics = require('network-diagnostics');
7
+ const http = require('http');
8
+ const https = require('https');
9
+ const mocha = require('mocha');
10
+ const ping = require('ping');
11
+ const dnsLookup = require('dns-lookup-promise');
9
12
 
10
13
  let host;
11
14
  process.argv.forEach((val) => {
@@ -16,78 +19,124 @@ process.argv.forEach((val) => {
16
19
 
17
20
  describe('[integration] Adapter Test', () => {
18
21
  context(`Testing network connection on ${host}`, () => {
19
- before(() => {
20
- diagnostics.setTestURL(host);
21
- });
22
-
23
22
  after((done) => {
24
23
  done();
25
24
  });
26
25
 
27
26
  it('DNS resolve', (done) => {
28
- diagnostics.haveDNS((result) => {
29
- try {
30
- assert.equal(result, true);
31
- done();
32
- } catch (error) {
33
- done(error);
34
- }
35
- });
27
+ dnsLookup(host)
28
+ .then((addresses) => {
29
+ try {
30
+ assert.ok(addresses.length > 0);
31
+ done();
32
+ } catch (error) {
33
+ done(error);
34
+ }
35
+ })
36
+ .catch((err) => {
37
+ done(err);
38
+ });
36
39
  });
37
40
 
38
41
  it('Responds to ping', (done) => {
39
- diagnostics.havePing((result) => {
40
- try {
41
- assert.equal(result, true);
42
- done();
43
- } catch (error) {
44
- done(error);
45
- }
46
- });
42
+ ping.promise.probe(host)
43
+ .then((result) => {
44
+ try {
45
+ assert.ok(result.alive);
46
+ done();
47
+ } catch (error) {
48
+ done(error);
49
+ }
50
+ })
51
+ .catch((err) => {
52
+ done(err);
53
+ });
47
54
  });
48
55
 
49
56
  it('Support HTTP on port 80', (done) => {
50
- diagnostics.haveHTTP((result) => {
57
+ const requestOptions = {
58
+ host,
59
+ port: 80,
60
+ method: 'HEAD'
61
+ };
62
+
63
+ const req = http.request(requestOptions, (res) => {
51
64
  try {
52
- assert.equal(result, true);
65
+ assert.ok(res.statusCode >= 200 && res.statusCode < 400);
53
66
  done();
54
67
  } catch (error) {
55
68
  done(error);
56
69
  }
57
70
  });
71
+
72
+ req.on('error', (err) => {
73
+ done(err);
74
+ });
75
+
76
+ req.end();
58
77
  });
59
78
 
60
79
  it('Support HTTPS on port 443', (done) => {
61
- diagnostics.haveHTTPS((result) => {
80
+ const requestOptions = {
81
+ host,
82
+ port: 443,
83
+ method: 'HEAD'
84
+ };
85
+
86
+ const req = https.request(requestOptions, (res) => {
62
87
  try {
63
- assert.equal(result, true);
88
+ assert.ok(res.statusCode >= 200 && res.statusCode < 400);
64
89
  done();
65
90
  } catch (error) {
66
91
  done(error);
67
92
  }
68
93
  });
94
+
95
+ req.on('error', (err) => {
96
+ done(err);
97
+ });
98
+
99
+ req.end();
69
100
  });
70
101
 
71
102
  it('Support IPv4', (done) => {
72
- diagnostics.haveIPv4Async((result) => {
73
- try {
74
- assert.equal(result, true);
75
- done();
76
- } catch (error) {
77
- done(error);
78
- }
79
- });
103
+ const options = {
104
+ family: 4,
105
+ hints: dnsLookup.ADDRCONFIG
106
+ };
107
+
108
+ dnsLookup.lookup(host, options)
109
+ .then((address, family) => {
110
+ try {
111
+ assert.ok(address !== null && family === 4);
112
+ done();
113
+ } catch (error) {
114
+ done(error);
115
+ }
116
+ })
117
+ .catch((err) => {
118
+ done(err);
119
+ });
80
120
  });
81
121
 
82
122
  it('Support IPv6', (done) => {
83
- diagnostics.haveIPv6Async((result) => {
84
- try {
85
- assert.equal(result, true);
86
- done();
87
- } catch (error) {
88
- done(error);
89
- }
90
- });
123
+ const options = {
124
+ family: 6,
125
+ hints: dnsLookup.ADDRCONFIG
126
+ };
127
+
128
+ dnsLookup.lookup(host, options)
129
+ .then((address, family) => {
130
+ try {
131
+ assert.ok(address !== null && family === 6);
132
+ done();
133
+ } catch (error) {
134
+ done(error);
135
+ }
136
+ })
137
+ .catch((err) => {
138
+ done(err);
139
+ });
91
140
  });
92
141
  });
93
142
  });
@@ -9,13 +9,13 @@
9
9
  // include required items for testing & logging
10
10
  const assert = require('assert');
11
11
  const fs = require('fs');
12
- const mocha = require('mocha');
13
12
  const path = require('path');
13
+ const util = require('util');
14
+ const mocha = require('mocha');
14
15
  const winston = require('winston');
15
16
  const { expect } = require('chai');
16
17
  const { use } = require('chai');
17
18
  const td = require('testdouble');
18
- const util = require('util');
19
19
 
20
20
  const anything = td.matchers.anything();
21
21
 
@@ -237,7 +237,7 @@ function saveMockData(entityName, actionName, descriptor, responseData) {
237
237
  const CienaMcp = require('../../adapter');
238
238
 
239
239
  // begin the testing - these should be pretty well defined between the describe and the it!
240
- describe('[integration] Ciena_mcp Adapter Test', () => {
240
+ describe('[integration] CienaMcp Adapter Test', () => {
241
241
  describe('CienaMcp Class Tests', () => {
242
242
  const a = new CienaMcp(
243
243
  pronghornProps.adapterProps.adapters[0].id,
@@ -335,6 +335,134 @@ describe('[integration] Ciena_mcp Adapter Test', () => {
335
335
  }).timeout(attemptTimeout);
336
336
  });
337
337
 
338
+ // broker tests
339
+ describe('#getDevicesFiltered - errors', () => {
340
+ it('should work if integrated but since no mockdata should error when run standalone', (done) => {
341
+ try {
342
+ const opts = {
343
+ filter: {
344
+ name: 'deviceName'
345
+ }
346
+ };
347
+ a.getDevicesFiltered(opts, (data, error) => {
348
+ try {
349
+ if (stub) {
350
+ if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
351
+ assert.equal(null, error);
352
+ assert.notEqual(undefined, data);
353
+ assert.notEqual(null, data);
354
+ assert.equal(0, data.total);
355
+ assert.equal(0, data.list.length);
356
+ } else {
357
+ const displayE = 'Error 400 received on request';
358
+ runErrorAsserts(data, error, 'AD.500', 'Test-ciena_mcp-connectorRest-handleEndResponse', displayE);
359
+ }
360
+ } else {
361
+ runCommonAsserts(data, error);
362
+ }
363
+ done();
364
+ } catch (err) {
365
+ log.error(`Test Failure: ${err}`);
366
+ done(err);
367
+ }
368
+ });
369
+ } catch (error) {
370
+ log.error(`Adapter Exception: ${error}`);
371
+ done(error);
372
+ }
373
+ }).timeout(attemptTimeout);
374
+ });
375
+
376
+ describe('#iapGetDeviceCount - errors', () => {
377
+ it('should work if integrated but since no mockdata should error when run standalone', (done) => {
378
+ try {
379
+ const opts = {
380
+ filter: {
381
+ name: 'deviceName'
382
+ }
383
+ };
384
+ a.iapGetDeviceCount((data, error) => {
385
+ try {
386
+ if (stub) {
387
+ if (samProps.devicebroker.getDevicesFiltered[0].handleFailure === 'ignore') {
388
+ assert.equal(null, error);
389
+ assert.notEqual(undefined, data);
390
+ assert.notEqual(null, data);
391
+ assert.equal(0, data.count);
392
+ } else {
393
+ const displayE = 'Error 400 received on request';
394
+ runErrorAsserts(data, error, 'AD.500', 'Test-ciena_mcp-connectorRest-handleEndResponse', displayE);
395
+ }
396
+ } else {
397
+ runCommonAsserts(data, error);
398
+ }
399
+ done();
400
+ } catch (err) {
401
+ log.error(`Test Failure: ${err}`);
402
+ done(err);
403
+ }
404
+ });
405
+ } catch (error) {
406
+ log.error(`Adapter Exception: ${error}`);
407
+ done(error);
408
+ }
409
+ }).timeout(attemptTimeout);
410
+ });
411
+
412
+ // exposed cache tests
413
+ describe('#iapPopulateEntityCache - errors', () => {
414
+ it('should work if integrated but since no mockdata should error when run standalone', (done) => {
415
+ try {
416
+ a.iapPopulateEntityCache('Device', (data, error) => {
417
+ try {
418
+ if (stub) {
419
+ assert.equal(null, data);
420
+ assert.notEqual(undefined, error);
421
+ assert.notEqual(null, error);
422
+ done();
423
+ } else {
424
+ assert.equal(undefined, error);
425
+ assert.equal('success', data[0]);
426
+ done();
427
+ }
428
+ } catch (err) {
429
+ log.error(`Test Failure: ${err}`);
430
+ done(err);
431
+ }
432
+ });
433
+ } catch (error) {
434
+ log.error(`Adapter Exception: ${error}`);
435
+ done(error);
436
+ }
437
+ }).timeout(attemptTimeout);
438
+ });
439
+
440
+ describe('#iapRetrieveEntitiesCache - errors', () => {
441
+ it('should work if integrated but since no mockdata should error when run standalone', (done) => {
442
+ try {
443
+ a.iapRetrieveEntitiesCache('Device', {}, (data, error) => {
444
+ try {
445
+ if (stub) {
446
+ assert.equal(null, data);
447
+ assert.notEqual(null, error);
448
+ assert.notEqual(undefined, error);
449
+ } else {
450
+ assert.equal(undefined, error);
451
+ assert.notEqual(null, data);
452
+ assert.notEqual(undefined, data);
453
+ }
454
+ done();
455
+ } catch (err) {
456
+ log.error(`Test Failure: ${err}`);
457
+ done(err);
458
+ }
459
+ });
460
+ } catch (error) {
461
+ log.error(`Adapter Exception: ${error}`);
462
+ done(error);
463
+ }
464
+ }).timeout(attemptTimeout);
465
+ });
338
466
  /*
339
467
  -----------------------------------------------------------------------
340
468
  -----------------------------------------------------------------------