@itentialopensource/adapter-splunk 0.4.1 → 0.4.3

package/CALLS.md

@@ -337,7 +337,7 @@ Specific adapter calls are built based on the API of the Splunk. The Adapter Bui
   <tr>
     <td style="padding:15px">postSearchJobsExport(body, callback)</td>
     <td style="padding:15px">postSearchJobsExport</td>
-    <td style="padding:15px">{base_path}/{version}/services/search/jobs/export?{query}</td>
+    <td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/export?{query} <br /> v2:{base_path}/{version}/services/search/v2/jobs/export?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
@@ -367,19 +367,19 @@ Specific adapter calls are built based on the API of the Splunk. The Adapter Bui
   <tr>
     <td style="padding:15px">getSearchJobsByIdEvents(searchId, count, maxLines, outputMode, truncationMode, callback)</td>
     <td style="padding:15px">getSearchJobsByIdEvents</td>
-    <td style="padding:15px">{base_path}/{version}/services/search/jobs/{pathv1}/events?{query}</td>
+    <td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/{pathv1}/events?{query} <br /> v2:{base_path}/services/search/v2/jobs/{pathv1}/events?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getSearchJobsByIdResults(searchId, count, addSummaryToMetadata, search, callback)</td>
-    <td style="padding:15px">getSearchJobsByIdResults</td>
-    <td style="padding:15px">{base_path}/{version}/services/search/jobs/{pathv1}/results?{query}</td>
+    <td style="padding:15px">getSearchJobsByIdResultsWithOptions(searchId, queryData, callback)</td>
+    <td style="padding:15px">getSearchJobsByIdResults with query data</td>
+    <td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/{pathv1}/results?{query} <br /> v2:{base_path}/services/search/v2/jobs/{pathv1}/results?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getSearchJobsByIdResultsPreview(searchId, count, addSummaryToMetadata, search, callback)</td>
-    <td style="padding:15px">getSearchJobsByIdResultsPreview</td>
-    <td style="padding:15px">{base_path}/{version}/services/search/jobs/{pathv1}/results_preview?{query}</td>
+    <td style="padding:15px">getSearchJobsByIdResultsPreviewWithOptions(searchId, queryData, callback)</td>
+    <td style="padding:15px">getSearchJobsByIdResultsPreviewWithOptions</td>
+    <td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/{pathv1}/results_preview?{query} <br /> v2:{base_path}/services/search/v2/jobs/{pathv1}/results_preview?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
@@ -403,7 +403,7 @@ Specific adapter calls are built based on the API of the Splunk. The Adapter Bui
   <tr>
     <td style="padding:15px">getSearchParser(q, callback)</td>
     <td style="padding:15px">getSearchParser</td>
-    <td style="padding:15px">{base_path}/{version}/services/search/parser?{query}</td>
+    <td style="padding:15px">v1:{base_path}/{version}/services/search/parser?{query} <br /> v2:{base_path}/services/search/v2/parser?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 0.4.3 [12-25-2023]
+
+* update metadata
+
+See merge request itentialopensource/adapters/telemetry-analytics/adapter-splunk!5
+
+---
+
+## 0.4.2 [12-20-2023]
+
+* Add v2 endpoints and add tasks with query data
+
+See merge request itentialopensource/adapters/telemetry-analytics/adapter-splunk!4
+
+---
+
 ## 0.4.1 [12-01-2023]
 
 * Update request data types to URLENCODE for post calls

package/adapter.js

@@ -3409,7 +3409,28 @@ class Splunk extends AdapterBaseCl {
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
   getSearchJobsByIdResults(searchId, count, addSummaryToMetadata, search, callback) {
-    const meth = 'adapter-getSearchJobsByIdResults';
+    const queryData = { count, addSummaryToMetadata, search };
+    this.getSearchJobsByIdResultsWithOptions(searchId, queryData, callback);
+  }
+
+  /**
+   * @function getSearchJobsByIdResultsWithOptions
+   * @pronghornType method
+   * @name getSearchJobsByIdResultsWithOptions
+   * @summary getSearchJobsByIdResultsWithOptions
+   *
+   * @param {string} searchId - search_id
+   * @param {object} queryData - object of query data - addSummaryToMetadata, count, outputMode, f, offset
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getSearchJobsByIdResultsWithOptions
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getSearchJobsByIdResultsWithOptions(searchId, queryData, callback) {
+    const meth = 'adapter-getSearchJobsByIdResultsWithOptions';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -3425,24 +3446,9 @@ class Splunk extends AdapterBaseCl {
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
-    if (count === undefined || count === null || count === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['count'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-    if (addSummaryToMetadata === undefined || addSummaryToMetadata === null || addSummaryToMetadata === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['addSummaryToMetadata'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-    if (search === undefined || search === null || search === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['search'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { count, addSummaryToMetadata, search };
+    const queryParamsAvailable = queryData;
     const queryParams = {};
     const pathVars = [searchId];
     const bodyVars = {};
@@ -3509,7 +3515,28 @@ class Splunk extends AdapterBaseCl {
    */
   /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
   getSearchJobsByIdResultsPreview(searchId, count, addSummaryToMetadata, search, callback) {
-    const meth = 'adapter-getSearchJobsByIdResultsPreview';
+    const queryData = { count, addSummaryToMetadata, search };
+    this.getSearchJobsByIdResultsPreviewWithOptions(searchId, queryData, callback);
+  }
+
+  /**
+   * @function getSearchJobsByIdResultsPreviewWithOptions
+   * @pronghornType method
+   * @name getSearchJobsByIdResultsPreviewWithOptions
+   * @summary getSearchJobsByIdResultsPreviewWithOptions
+   *
+   * @param {string} searchId - search_id
+   * @param {object} queryData - object of query data - addSummaryToMetadata, count, f, offset, outputMode
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /getSearchJobsByIdResultsPreviewWithOptions
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  getSearchJobsByIdResultsPreviewWithOptions(searchId, queryData, callback) {
+    const meth = 'adapter-getSearchJobsByIdResultsPreviewWithOptions';
     const origin = `${this.id}-${meth}`;
     log.trace(origin);
 
@@ -3525,24 +3552,9 @@ class Splunk extends AdapterBaseCl {
       log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
       return callback(null, errorObj);
     }
-    if (count === undefined || count === null || count === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['count'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-    if (addSummaryToMetadata === undefined || addSummaryToMetadata === null || addSummaryToMetadata === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['addSummaryToMetadata'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
-    if (search === undefined || search === null || search === '') {
-      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['search'], null, null, null);
-      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
-      return callback(null, errorObj);
-    }
 
     /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
-    const queryParamsAvailable = { count, addSummaryToMetadata, search };
+    const queryParamsAvailable = queryData;
     const queryParams = {};
     const pathVars = [searchId];
     const bodyVars = {};

package/entities/Services/action.json

@@ -456,7 +456,10 @@
       "name": "postSearchJobsExport",
       "protocol": "REST",
       "method": "POST",
-      "entitypath": "{base_path}/{version}/services/search/jobs/export?{query}",
+      "entitypath": {
+        "v1": "{base_path}/{version}/services/search/jobs/export?{query}",
+        "v2": "{base_path}/{version}/services/search/v2/jobs/export?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -557,7 +560,10 @@
       "name": "getSearchJobsByIdEvents",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/services/search/jobs/{pathv1}/events?{query}",
+      "entitypath": {
+        "v1": "{base_path}/{version}/services/search/jobs/{pathv1}/events?{query}",
+        "v2": "{base_path}/services/search/v2/jobs/{pathv1}/events?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -578,7 +584,10 @@
       "name": "getSearchJobsByIdResults",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/services/search/jobs/{pathv1}/results?{query}",
+      "entitypath": {
+        "v1": "{base_path}/{version}/services/search/jobs/{pathv1}/results?{query}",
+        "v2": "{base_path}/services/search/v2/jobs/{pathv1}/results?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -599,7 +608,10 @@
       "name": "getSearchJobsByIdResultsPreview",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/services/search/jobs/{pathv1}/results_preview?{query}",
+      "entitypath": {
+        "v1": "{base_path}/{version}/services/search/jobs/{pathv1}/results_preview?{query}",
+        "v2": "{base_path}/services/search/v2/jobs/{pathv1}/results_preview?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -683,7 +695,10 @@
       "name": "getSearchParser",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/services/search/parser?{query}",
+      "entitypath": {
+        "v1": "{base_path}/{version}/services/search/parser?{query}",
+        "v2": "{base_path}/services/search/v2/parser?{query}"
+      },
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,

package/entities/Services/schema.json

@@ -178,7 +178,7 @@
       "external_name": "truncation_mode"
     },
     "addSummaryToMetadata": {
-      "type": "string",
+      "type": ["string", "boolean"],
       "description": "add_summary_to_metadata",
       "parse": false,
       "encode": false,

package/metadata.json

@@ -36,6 +36,7 @@
     "repoLink": "https://gitlab.com/itentialopensource/adapters/telemetry-analytics/adapter-splunk",
     "docLink": "https://docs.itential.com/opensource/docs/splunk",
     "demoLinks": [],
+    "trainingLinks": [],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
     "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
     "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-splunk",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "This adapter integrates with system described as: splunkAdapter.",
   "main": "adapter.js",
   "systemName": "Splunk",
@@ -58,7 +58,7 @@
     "@itentialopensource/adapter-utils": "^5.3.2",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
-    "axios": "^1.4.0",
+    "axios": "^1.6.2",
     "commander": "^11.0.0",
     "dns-lookup-promise": "^1.0.4",
     "fs-extra": "^11.1.1",

package/pronghorn.json

@@ -2477,6 +2477,50 @@
       },
       "task": true
     },
+    {
+      "name": "getSearchJobsByIdResultsWithOptions",
+      "summary": "getSearchJobsByIdResults with query data",
+      "description": "getSearchJobsByIdResults with query data",
+      "input": [
+        {
+          "name": "searchId",
+          "type": "string",
+          "info": "search_id: string",
+          "required": true,
+          "schema": {
+            "title": "searchId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "query options object (e.g. addSummaryToMetadata, count, outputMode, f, offset)",
+          "required": false,
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getSearchJobsByIdResultsWithOptions"
+      },
+      "task": true
+    },
     {
       "name": "getSearchJobsByIdResultsPreview",
       "summary": "getSearchJobsByIdResultsPreview",
@@ -2541,6 +2585,50 @@
       },
       "task": true
     },
+    {
+      "name": "getSearchJobsByIdResultsPreviewWithOptions",
+      "summary": "getSearchJobsByIdResultsPreviewWithOptions",
+      "description": "getSearchJobsByIdResultsPreviewWithOptions",
+      "input": [
+        {
+          "name": "searchId",
+          "type": "string",
+          "info": "search_id: string",
+          "required": true,
+          "schema": {
+            "title": "searchId",
+            "type": "string"
+          }
+        },
+        {
+          "name": "queryData",
+          "type": "object",
+          "info": "query options object (e.g. addSummaryToMetadata, count, f, offset, outputMode)",
+          "required": false,
+          "schema": {
+            "title": "queryData",
+            "type": "object"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/getSearchJobsByIdResultsPreviewWithOptions"
+      },
+      "task": true
+    },
     {
       "name": "getSearchJobsSearchLogs",
       "summary": "getSearchJobsSearchLogs",

package/report/adapterInfo.json

@@ -1,10 +1,10 @@
 {
-  "version": "0.4.0",
-  "configLines": 5009,
+  "version": "0.4.2",
+  "configLines": 5097,
   "scriptLines": 1783,
-  "codeLines": 6228,
-  "testLines": 6639,
-  "testCases": 337,
-  "totalCodeLines": 14650,
-  "wfTasks": 68
+  "codeLines": 6240,
+  "testLines": 6537,
+  "testCases": 331,
+  "totalCodeLines": 14560,
+  "wfTasks": 70
 }

package/test/unit/adapterTestUnit.js

@@ -316,7 +316,7 @@ describe('[unit] Splunk Adapter Test', () => {
           assert.notEqual(null, packageDotJson.dependencies);
           assert.notEqual('', packageDotJson.dependencies);
           assert.equal('^8.12.0', packageDotJson.dependencies.ajv);
-          assert.equal('^1.4.0', packageDotJson.dependencies.axios);
+          assert.equal('^1.6.2', packageDotJson.dependencies.axios);
           assert.equal('^11.0.0', packageDotJson.dependencies.commander);
           assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
           assert.equal('^10.2.0', packageDotJson.dependencies.mocha);
@@ -2995,58 +2995,7 @@ describe('[unit] Splunk Adapter Test', () => {
           a.getSearchJobsByIdResults(null, null, null, null, (data, error) => {
             try {
               const displayE = 'searchId is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResults', displayE);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-      it('should error if - missing count', (done) => {
-        try {
-          a.getSearchJobsByIdResults('fakeparam', null, null, null, (data, error) => {
-            try {
-              const displayE = 'count is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResults', displayE);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-      it('should error if - missing addSummaryToMetadata', (done) => {
-        try {
-          a.getSearchJobsByIdResults('fakeparam', 'fakeparam', null, null, (data, error) => {
-            try {
-              const displayE = 'addSummaryToMetadata is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResults', displayE);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-      it('should error if - missing search', (done) => {
-        try {
-          a.getSearchJobsByIdResults('fakeparam', 'fakeparam', 'fakeparam', null, (data, error) => {
-            try {
-              const displayE = 'search is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResults', displayE);
+              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsWithOptions', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);
@@ -3075,58 +3024,7 @@ describe('[unit] Splunk Adapter Test', () => {
           a.getSearchJobsByIdResultsPreview(null, null, null, null, (data, error) => {
             try {
               const displayE = 'searchId is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreview', displayE);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-      it('should error if - missing count', (done) => {
-        try {
-          a.getSearchJobsByIdResultsPreview('fakeparam', null, null, null, (data, error) => {
-            try {
-              const displayE = 'count is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreview', displayE);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-      it('should error if - missing addSummaryToMetadata', (done) => {
-        try {
-          a.getSearchJobsByIdResultsPreview('fakeparam', 'fakeparam', null, null, (data, error) => {
-            try {
-              const displayE = 'addSummaryToMetadata is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreview', displayE);
-              done();
-            } catch (err) {
-              log.error(`Test Failure: ${err}`);
-              done(err);
-            }
-          });
-        } catch (error) {
-          log.error(`Adapter Exception: ${error}`);
-          done(error);
-        }
-      }).timeout(attemptTimeout);
-      it('should error if - missing search', (done) => {
-        try {
-          a.getSearchJobsByIdResultsPreview('fakeparam', 'fakeparam', 'fakeparam', null, (data, error) => {
-            try {
-              const displayE = 'search is required';
-              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreview', displayE);
+              runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreviewWithOptions', displayE);
               done();
             } catch (err) {
               log.error(`Test Failure: ${err}`);