@itentialopensource/adapter-splunk 0.3.0 → 0.4.1

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.4.1 [12-01-2023]
+
+* Update request data types to URLENCODE for post calls
+
+See merge request itentialopensource/adapters/telemetry-analytics/adapter-splunk!3
+
+---
+
+## 0.4.0 [11-07-2023]
+
+* More migration changes
+
+See merge request itentialopensource/adapters/telemetry-analytics/adapter-splunk!2
+
+---
+
 ## 0.3.0 [10-19-2023]
 
 * Adapter Engine has been updated and the changes are being migrated to the adapter

package/entities/Services/action.json

@@ -92,8 +92,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -112,8 +112,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -132,8 +132,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -173,8 +173,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -297,8 +297,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -317,8 +317,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -358,8 +358,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -420,8 +420,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -461,8 +461,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -522,8 +522,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -542,8 +542,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {
@@ -730,8 +730,8 @@
       "responseSchema": "schema.json",
       "timeout": 0,
       "sendEmpty": false,
-      "requestDatatype": "JSON",
-      "responseDatatype": "JSON",
+      "requestDatatype": "URLENCODE",
+      "responseDatatype": "XML2JSON",
       "headers": {},
       "responseObjects": [
         {

package/metadata.json

@@ -33,7 +33,7 @@
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-splunk",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/telemetry-analytics/adapter-splunk.git",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/telemetry-analytics/adapter-splunk",
     "docLink": "https://docs.itential.com/opensource/docs/splunk",
     "demoLinks": [],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-splunk",
-  "version": "0.3.0",
+  "version": "0.4.1",
   "description": "This adapter integrates with system described as: splunkAdapter.",
   "main": "adapter.js",
   "systemName": "Splunk",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.8",
+  "engineVersion": "1.67.10",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -55,7 +55,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/telemetry-analytics/adapter-splunk#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.7",
+    "@itentialopensource/adapter-utils": "^5.3.2",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",

package/propertiesSchema.json

@@ -109,6 +109,14 @@
     },
     "cache": {
       "$ref": "#/definitions/cache"
+    },
+    "service": {
+      "type": "string",
+      "description": "Service we are integrating with -- used with AWS Authentication",
+      "examples": [
+        "ec2",
+        "route53"
+      ]
     }
   },
   "required": [
@@ -131,7 +139,8 @@
             "jwt_token",
             "request_token",
             "no_authentication",
-            "multi_step_authentication"
+            "multi_step_authentication",
+            "aws_authentication"
           ]
         },
         "username": {

package/report/adapterInfo.json

@@ -1,6 +1,6 @@
 {
-  "version": "0.2.0",
-  "configLines": 5000,
+  "version": "0.4.0",
+  "configLines": 5009,
   "scriptLines": 1783,
   "codeLines": 6228,
   "testLines": 6639,

package/report/updateReport1698422928616.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 77
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 347
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 3793
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 215
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 1594
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 52
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 6840
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 267
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/utils/methodDocumentor.js

@@ -77,6 +77,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
   // parsing the file to get the function and class declarations.
   const aFileFuncArgs = acorn.parse(aFile, { ecmaVersion: 2020 });
 
+  let callName = 'identifyRequest';
   // Looping through all the declarations parsed:
   aFileFuncArgs.body.forEach((e) => {
     // Getting only the class declaration as it has our required functions.
@@ -89,8 +90,10 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         method.value.params.forEach((param) => {
           if (param.type === 'Identifier') {
             funcArgs.push(param.name);
+          } else if (param.type === 'RestElement') {
+            funcArgs.push(`...${param.argument.name}`);
           } else {
-            const args = `${param.left.name} = ${param.right.value}`;
+            const args = `${param.left.name} = ${param.right.raw}`;
             funcArgs.push(args);
           }
         });
@@ -102,7 +105,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         });
         const requests = [];
         for (let i = 0; i < callList.length; i += 1) {
-          if (callList[i].callee.property && callList[i].callee.property.name === 'identifyRequest') {
+          if (callList[i].callee.property && callList[i].callee.property.name === callName) {
             requests.push(callList[i]);
           }
         }
@@ -114,7 +117,16 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
           const entity = expr.arguments[0].value;
           const actionName = expr.arguments[1].value;
           if (expr !== undefined && (expr.arguments[0].type !== 'Literal' || expr.arguments[1].type !== 'Literal')) {
-            throw new Error(`Bad inputs in method ${funcName}`);
+            const param1 = method.value.params[0];
+            const param2 = method.value.params[1];
+            if (param1.type !== 'Identifier' || param2.type !== 'Identifier'
+                || expr.arguments[0].type !== 'Identifier' || expr.arguments[1].type !== 'Identifier'
+                || param1.name !== expr.arguments[0].name || param2.name !== expr.arguments[1].name) {
+              throw new Error(`identifyRequest proxy method ${funcName} unknown format`);
+            } else if (callName !== 'identifyRequest') {
+              throw new Error(`MethodDocumentor not yet programmed to handle multiple helper methods: 1) ${callName}, 2) ${funcName}`);
+            }
+            callName = funcName;
           }
           const entityPath = getPathFromEntity(entity, actionName);
 
@@ -197,6 +209,7 @@ function readMDFile(filename, functionList) {
   // Creating the tags for each method to be appended to the file.
   const tdBeginTag = '    <td style="padding:15px">';
   const tdEndTag = '</td>';
+
   functionList.forEach((func) => {
     const signCommand = `${tdBeginTag}${func.method_signature}${tdEndTag}`;
     const descCommand = `${tdBeginTag}${func.description}${tdEndTag}`;