@itentialopensource/adapter-nokia_altiplano 0.7.7 → 0.8.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 (45) hide show
  1. package/.eslintrc.js +1 -0
  2. package/AUTH.md +4 -4
  3. package/BROKER.md +4 -4
  4. package/CALLS.md +9 -9
  5. package/ENHANCE.md +3 -3
  6. package/PROPERTIES.md +24 -9
  7. package/README.md +24 -23
  8. package/SUMMARY.md +2 -2
  9. package/SYSTEMINFO.md +1 -1
  10. package/TAB1.md +2 -2
  11. package/TAB2.md +9 -5
  12. package/TROUBLESHOOT.md +10 -1
  13. package/UTILITIES.md +473 -0
  14. package/adapter.js +5 -5
  15. package/adapterBase.js +52 -16
  16. package/package.json +24 -28
  17. package/pronghorn.json +17 -15
  18. package/propertiesSchema.json +68 -7
  19. package/report/adapterInfo.json +7 -7
  20. package/report/auto-adapter-openapi.json +1023 -0
  21. package/report/updateReport1748555349501.json +120 -0
  22. package/sampleProperties.json +4 -0
  23. package/test/integration/adapterTestBasicGet.js +88 -54
  24. package/test/integration/adapterTestConnectivity.js +15 -16
  25. package/test/integration/adapterTestIntegration.js +1 -38
  26. package/test/unit/adapterBaseTestUnit.js +641 -39
  27. package/test/unit/adapterTestUnit.js +17 -54
  28. package/utils/adapterInfo.js +114 -164
  29. package/utils/argParser.js +44 -0
  30. package/utils/checkMigrate.js +77 -38
  31. package/utils/entitiesToDB.js +53 -42
  32. package/utils/logger.js +26 -0
  33. package/utils/modify.js +56 -55
  34. package/utils/mongoDbConnection.js +79 -0
  35. package/utils/mongoUtils.js +162 -0
  36. package/utils/taskMover.js +31 -32
  37. package/utils/tbScript.js +36 -172
  38. package/utils/tbUtils.js +84 -226
  39. package/utils/troubleshootingAdapter.js +68 -84
  40. package/utils/updateAdapterConfig.js +158 -0
  41. package/utils/addAuth.js +0 -94
  42. package/utils/artifactize.js +0 -146
  43. package/utils/basicGet.js +0 -50
  44. package/utils/packModificationScript.js +0 -35
  45. package/utils/patches2bundledDeps.js +0 -90
package/package.json CHANGED
@@ -1,13 +1,12 @@
1
1
  {
2
2
  "name": "@itentialopensource/adapter-nokia_altiplano",
3
- "version": "0.7.7",
3
+ "version": "0.8.0",
4
4
  "description": "This adapter integrates with system described as: Nokia Altiplano.",
5
5
  "main": "adapter.js",
6
6
  "wizardVersion": "2.44.7",
7
- "engineVersion": "1.68.2",
7
+ "engineVersion": "1.69.14",
8
8
  "adapterType": "http",
9
9
  "scripts": {
10
- "artifactize": "npm i && node utils/packModificationScript.js",
11
10
  "preinstall": "node utils/setup.js",
12
11
  "deinstall": "node utils/removeHooks.js",
13
12
  "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
@@ -16,7 +15,6 @@
16
15
  "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
17
16
  "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
18
17
  "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
19
- "adapter:install": "npm i && node utils/tbScript.js install",
20
18
  "adapter:checkMigrate": "node utils/checkMigrate.js",
21
19
  "adapter:findPath": "node utils/findPath.js",
22
20
  "adapter:migrate": "node utils/modify.js -m",
@@ -31,10 +29,9 @@
31
29
  },
32
30
  "keywords": [
33
31
  "Itential",
34
- "IAP",
32
+ "Itential Platform",
35
33
  "Automation",
36
34
  "Integration",
37
- "App-Artifacts",
38
35
  "Adapter",
39
36
  "Controller",
40
37
  "Orchestrator",
@@ -54,30 +51,29 @@
54
51
  "author": "Itential",
55
52
  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-nokia_altiplano#readme",
56
53
  "dependencies": {
57
- "@itentialopensource/adapter-utils": "^5.10.1",
58
- "acorn": "^8.14.0",
59
- "ajv": "^8.17.1",
60
- "axios": "^1.8.2",
61
- "commander": "^11.0.0",
62
- "dns-lookup-promise": "^1.0.4",
63
- "fs-extra": "^11.2.0",
64
- "json-query": "^2.2.2",
65
- "mocha": "^10.8.2",
66
- "mocha-param": "^2.0.1",
67
- "mongodb": "^4.17.2",
68
- "ping": "^0.4.4",
69
- "prompts": "^2.4.2",
70
- "readline-sync": "^1.4.10",
71
- "semver": "^7.6.3",
72
- "winston": "^3.17.0"
54
+ "@itentialopensource/adapter-utils": "5.10.16",
55
+ "acorn": "8.14.1",
56
+ "ajv": "8.17.1",
57
+ "axios": "1.9.0",
58
+ "commander": "11.1.0",
59
+ "fs-extra": "11.3.0",
60
+ "json-query": "2.2.2",
61
+ "mocha": "10.8.2",
62
+ "mocha-param": "2.0.1",
63
+ "mongodb": "4.17.2",
64
+ "ping": "0.4.4",
65
+ "prompts": "2.4.2",
66
+ "readline-sync": "1.4.10",
67
+ "semver": "7.7.2",
68
+ "winston": "3.17.0"
73
69
  },
74
70
  "devDependencies": {
75
- "chai": "^4.3.7",
76
- "eslint": "^8.44.0",
77
- "eslint-config-airbnb-base": "^15.0.0",
78
- "eslint-plugin-import": "^2.27.5",
79
- "eslint-plugin-json": "^3.1.0",
80
- "testdouble": "^3.18.0"
71
+ "chai": "4.5.0",
72
+ "eslint": "8.57.0",
73
+ "eslint-config-airbnb-base": "15.0.0",
74
+ "eslint-plugin-import": "2.31.0",
75
+ "eslint-plugin-json": "3.1.0",
76
+ "testdouble": "3.18.0"
81
77
  },
82
78
  "private": false
83
79
  }
package/pronghorn.json CHANGED
@@ -64,13 +64,13 @@
64
64
  }
65
65
  },
66
66
  {
67
- "name" : "replace",
67
+ "name": "replace",
68
68
  "type": "boolean",
69
69
  "info": "True to replace entire mock data, false to merge/append",
70
70
  "required": false,
71
71
  "schema": {
72
72
  "title": "replace",
73
- "type" : "boolean"
73
+ "type": "boolean"
74
74
  }
75
75
  }
76
76
  ],
@@ -226,16 +226,6 @@
226
226
  "title": "props",
227
227
  "type": "object"
228
228
  }
229
- },
230
- {
231
- "name": "persistFlag",
232
- "type": "boolean",
233
- "info": "Whether the input properties should be saved",
234
- "required": true,
235
- "schema": {
236
- "title": "persistFlag",
237
- "type": "boolean"
238
- }
239
229
  }
240
230
  ],
241
231
  "output": {
@@ -306,7 +296,19 @@
306
296
  "name": "iapRunAdapterBasicGet",
307
297
  "summary": "Runs basicGet script for adapter",
308
298
  "description": "Runs basicGet script for adapter",
309
- "input": [],
299
+ "input": [
300
+ {
301
+ "name": "maxCalls",
302
+ "required": false,
303
+ "type": "number",
304
+ "info": "How many GET endpoints to test (defaults to 5)",
305
+ "schema": {
306
+ "title": "maxCalls",
307
+ "type": "number",
308
+ "default": 5
309
+ }
310
+ }
311
+ ],
310
312
  "output": {
311
313
  "name": "result",
312
314
  "type": "object",
@@ -327,8 +329,8 @@
327
329
  },
328
330
  {
329
331
  "name": "iapMoveAdapterEntitiesToDB",
330
- "summary": "Moves entities from an adapter into the IAP database",
331
- "description": "Moves entities from an adapter into the IAP database",
332
+ "summary": "Moves entities from an adapter into the Itential Platform database",
333
+ "description": "Moves entities from an adapter into the Itential Platform database",
332
334
  "input": [],
333
335
  "output": {
334
336
  "name": "res",
@@ -787,6 +787,14 @@
787
787
  "security/ca.pem"
788
788
  ]
789
789
  },
790
+ "ca_file_content": {
791
+ "type": "string",
792
+ "description": "The content of the CA file used for SSL",
793
+ "default": "",
794
+ "examples": [
795
+ "-----BEGIN CERTIFICATE-----"
796
+ ]
797
+ },
790
798
  "key_file": {
791
799
  "type": "string",
792
800
  "description": "The fully qualified path name to the key file used for SSL",
@@ -876,32 +884,48 @@
876
884
  "mongo": {
877
885
  "type": "object",
878
886
  "properties": {
887
+ "url": {
888
+ "type": "string",
889
+ "description": "Mongo's complete connection URL. This property overrides host, port, database, username, password and replSet settings.",
890
+ "examples": [
891
+ "mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]",
892
+ "mongodb+srv://[username:password@]cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]",
893
+ "mongodb+srv://cluster0.xxxxx.mongodb.net/[defaultauthdb][?options]"
894
+ ]
895
+ },
879
896
  "host": {
880
897
  "type": "string",
881
- "description": "host where mongo database can be found",
898
+ "description": "Host information for the Mongo server",
882
899
  "default": "",
883
900
  "examples": [
884
- "localhost"
901
+ "localhost",
902
+ "cluster0.xxxxx.mongodb.net",
903
+ "my-cluster.example.com"
885
904
  ]
886
905
  },
887
906
  "port": {
888
907
  "type": "integer",
889
- "description": "port on which to connect to the mongo database",
908
+ "description": "Port information for the Mongo server. Not used when using mongodb+srv:// protocol",
890
909
  "default": 443,
891
910
  "minimum": 0,
892
911
  "maximum": 65535
893
912
  },
894
913
  "database": {
895
914
  "type": "string",
896
- "description": "The name of the database to store adapter information in",
915
+ "description": "The database for the adapter to use for its data.",
897
916
  "default": "",
898
917
  "examples": [
899
918
  "adapter-xyz"
900
919
  ]
901
920
  },
921
+ "dbAuth": {
922
+ "type": "boolean",
923
+ "description": "Whether to use authentication for MongoDB connection. Default is false.",
924
+ "default": false
925
+ },
902
926
  "username": {
903
927
  "type": "string",
904
- "description": "The user to connect to the database with",
928
+ "description": "If credentials are required to access Mongo, this is the user to login as.",
905
929
  "default": "",
906
930
  "examples": [
907
931
  "username"
@@ -909,7 +933,7 @@
909
933
  },
910
934
  "password": {
911
935
  "type": "string",
912
- "description": "The password to connect to the database with",
936
+ "description": "If credentials are required to access Mongo, this is the password to login with.",
913
937
  "default": "",
914
938
  "examples": [
915
939
  "password"
@@ -917,12 +941,17 @@
917
941
  },
918
942
  "replSet": {
919
943
  "type": "string",
920
- "description": "The replica set for the database",
944
+ "description": "If the database is set up to use replica sets, define it here so it can be added to the database connection. Not used when using mongodb+srv:// protocol",
921
945
  "default": "",
922
946
  "examples": [
923
947
  "my_repolica_set"
924
948
  ]
925
949
  },
950
+ "addSrv": {
951
+ "type": "boolean",
952
+ "description": "Whether the connection requires the mongodb+srv:// protocol. If true, uses mongodb+srv:// protocol. Note: mongodb+srv:// can also be used for non-Atlas deployments that support DNS SRV records",
953
+ "default": false
954
+ },
926
955
  "db_ssl": {
927
956
  "type": "object",
928
957
  "description": "SSL for mongo database connection",
@@ -963,6 +992,38 @@
963
992
  }
964
993
  }
965
994
  }
995
+ },
996
+ "dependencies": {
997
+ "dbAuth": {
998
+ "oneOf": [
999
+ {
1000
+ "properties": {
1001
+ "dbAuth": {
1002
+ "const": false
1003
+ }
1004
+ }
1005
+ },
1006
+ {
1007
+ "properties": {
1008
+ "dbAuth": {
1009
+ "const": true
1010
+ },
1011
+ "username": {
1012
+ "type": "string",
1013
+ "minLength": 1
1014
+ },
1015
+ "password": {
1016
+ "type": "string",
1017
+ "minLength": 1
1018
+ }
1019
+ },
1020
+ "required": [
1021
+ "username",
1022
+ "password"
1023
+ ]
1024
+ }
1025
+ ]
1026
+ }
966
1027
  }
967
1028
  },
968
1029
  "devicebroker": {
@@ -1,10 +1,10 @@
1
1
  {
2
- "version": "0.7.3",
3
- "configLines": 4375,
4
- "scriptLines": 1783,
5
- "codeLines": 4202,
6
- "testLines": 4724,
7
- "testCases": 227,
8
- "totalCodeLines": 10709,
2
+ "version": "0.7.7",
3
+ "configLines": 5523,
4
+ "scriptLines": 2498,
5
+ "codeLines": 4238,
6
+ "testLines": 5285,
7
+ "testCases": 240,
8
+ "totalCodeLines": 12021,
9
9
  "wfTasks": 49
10
10
  }