Merge pull request #130 from splunk/release/1.10.0

release/1.10.0

Author: vmalaviya-splunk

.env

@@ -0,0 +1 @@
+SPLUNK_HOME="/opt/splunk"

.github/workflows/release.yml

@@ -0,0 +1,18 @@
+name: Create Release
+
+on:
+  release:
+    types: [published]
+    
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,57 @@
+name: Node.js CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        node:
+          - 14
+          - 8.17.0
+        splunk-version:
+          - "8.0"
+          - "latest" 
+          
+    services:
+      splunk:
+        image: splunk/splunk:${{matrix.splunk-version}}
+        env:
+          SPLUNK_START_ARGS: --accept-license
+          SPLUNK_HEC_TOKEN: 11111111-1111-1111-1111-1111111111113
+          SPLUNK_PASSWORD: changed!
+          SPLUNK_APPS_URL: https://github.com/splunk/sdk-app-collection/releases/download/v1.0.0/sdk-app-collection.tgz
+        ports:
+          - 8000:8000
+          - 8088:8088
+          - 8089:8089
+          
+    steps:
+      - uses: actions/checkout@v2
+      
+      - name: Use node ${{ matrix.node }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+          
+      - name: Create .splunkrc file
+        run: |
+          cd ~
+          echo host=localhost > .splunkrc
+          echo port=8089 >> .splunkrc
+          echo username=admin >> .splunkrc
+          echo password=changed! >> .splunkrc
+          echo scheme=https >> .splunkrc
+          echo version=${{ matrix.splunk }} >> .splunkrc
+        
+      - name: Run npm install
+        run: npm install  
+        
+      - name: Run make test
+        run: make test
+        env:
+          SPLUNK_HOME: /opt/splunk

.travis.yml

@@ -1,5 +1,29 @@
 # Splunk Enterprise SDK for JavaScript Changelog
 
+## v1.10.0
+
+### Major changes
+* Dropped support for deprecated request http client.
+* Added support for [needle](https://www.npmjs.com/package/needle) http client library.
+
+### Minor changes
+
+* Added support for Splunk Enterprise 8.2
+* Added support for Node v14.
+* Dropped support for deprecated nodeunit testing library.
+* Added support for [mocha](https://www.npmjs.com/package/mocha) for testing and [chai](https://www.npmjs.com/package/chai) for assertions.
+* Updated `cookie` dependency version to `0.4.1` 
+* Updated `elementtree` dependency version to `0.1.7`
+* Updated `browserify` dependency version to `17.0.0`
+* Updated `jshint` dependency version to `2.13.0`
+* Updated `mustache` dependency version to `4.2.0`
+* Updated `readable-stream` dependency version to `3.6.0`
+* Updated `uglify-js` dependency version to `3.13.8`
+* Added support for `dotenv@10.0.0` to declared env variables.
+* Added support for `mochawesome@6.2.2` to generate test report.
+* Fixed the Buffer and new Buffer() deprecation warnings appeared when running the tests.
+* Added support for running single test file and test case. Run `make test_specific` for more info.
+
 ## v1.9.1
 
 ### Minor changes

CHANGELOG.md

@@ -14,3 +14,7 @@ Some of the components included in the Splunk Enterprise SDK for JavaScript are
 | [commander](https://github.com/visionmedia/commander.js/) | Node.js command-line interfaces | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-COMMANDER) |
 | [script.js](https://github.com/ded/script.js/) | Asyncronous JavaScript loader and dependency manager | [Apache](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-SCRIPTJS) |
 | [base64.js](http://code.google.com/p/javascriptbase64/) | Fast base64 encoding/decoding | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-BASE64) |
+| [dotenv](https://github.com/motdotla/dotenv) | Loads environment varibles from .env file | [BSD 2-Clause](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-DOTENV) |
+| [cookie](https://github.com/jshttp/cookie) | HTTP cookie parser and serializer for HTTP servers | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-COOKIE) |
+| [elementtree](https://github.com/racker/node-elementtree) | Node.js XML parserer and serializer | [Apache-2.0](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-ELEMENTTREE) |
+| [needle](https://github.com/tomas/needle) | Node.js http client | [MIT](https://github.com/splunk/splunk-sdk-javascript/blob/master/licenses/LICENSE-NEEDLE) |

CREDITS.md

@@ -0,0 +1,47 @@
+# text reset
+NO_COLOR=\033[0m
+# green
+OK_COLOR=\033[32;01m
+# red
+ERROR_COLOR=\033[31;01m
+# cyan
+WARN_COLOR=\033[36;01m
+# yellow
+ATTN_COLOR=\033[33;01m
+
+ROOT_DIR := $(shell git rev-parse --show-toplevel)
+
+VERSION := `git describe --tags --dirty 2>/dev/null`
+COMMITHASH := `git rev-parse --short HEAD 2>/dev/null`
+DATE := `date "+%FT%T%z"`
+
+.PHONY: all
+all: init test
+
+init:
+	@echo "$(ATTN_COLOR)==> init $(NO_COLOR)"
+
+.PHONY: test
+test:
+	@echo "$(ATTN_COLOR)==> test $(NO_COLOR)"
+	@node sdkdo tests ${arg}
+
+.PHONY: test_specific
+test_specific:
+	@echo "$(ATTN_COLOR)==> test_specific $(NO_COLOR)"
+	@sh ./scripts/test_specific.sh
+
+.PHONY: up
+up:
+	@echo "$(ATTN_COLOR)==> up $(NO_COLOR)"
+	@docker-compose up -d
+
+.PHONY: wait_up
+wait_up:
+	@echo "$(ATTN_COLOR)==> wait_up $(NO_COLOR)"
+	@for i in `seq 0 180`; do if docker exec -it splunk /sbin/checkstate.sh &> /dev/null; then break; fi; printf "\rWaiting for Splunk for %s seconds..." $$i; sleep 1; done
+
+.PHONY: down
+down:
+	@echo "$(ATTN_COLOR)==> down $(NO_COLOR)"
+	@docker-compose stop

Makefile

@@ -1,21 +1,21 @@
 [![Build Status](https://travis-ci.org/splunk/splunk-sdk-javascript.svg?branch=master)](https://travis-ci.org/splunk/splunk-sdk-javascript)
 # The Splunk Enterprise Software Development Kit for JavaScript
 
-#### Version 1.9.1
+#### Version 1.10.0
 
 The Splunk Enterprise Software Development Kit (SDK) for JavaScript contains library code and examples designed to enable developers to build applications using the Splunk platform and JavaScript. This SDK supports server-side and client-side JavaScript.
 
 For more information, see [Splunk Enterprise SDK for JavaScript](https://dev.splunk.com/enterprise/docs/devtools/javascript/sdk-javascript/) on the Splunk Developer Portal.
 
 ## Requirements
 
-* Node.js v 0.12, or v4 or later
+* Node.js v 8.17.0, or v14 or later
 
-    The Splunk Enterprise SDK for JavaScript was tested with Node.js v.0.12, v4.2, and v10.0. 
+    The Splunk Enterprise SDK for JavaScript was tested with Node.js v8.17.0, v14. 
 
-* Splunk Enterprise 6.3.0 or later, or Splunk Cloud
+* Splunk Enterprise 8.0 or 8.2, or Splunk Cloud
 
-    The Splunk Enterprise SDK for JavaScript was tested with Splunk Enterprise 7.0 and 7.2. 
+    The Splunk Enterprise SDK for JavaScript was tested with Splunk Enterprise 8.0 or 8.2, or Splunk Cloud. 
 
 *  Splunk Enterprise SDK for JavaScript
 
@@ -61,13 +61,13 @@ The following examples show you how to list search jobs using client-side and se
 ### Client-side code example
 
 This HTML example uses the Splunk Enterprise SDK for JavaScript to list all jobs:
-
+```javascript
     <script type="text/javascript" src="splunk.js"></script>
     <script type="text/javascript" src="jquery.min.js"></script>
 
     <script type="text/javascript" charset="utf-8">
 
-        var service = new splunkjs.Service({username: "admin", password: "changeme"});
+        var service = new splunkjs.Service({username: "admin", password: "changed!"});
         service.login(function(err, success) {
             if (err) {
                 throw err;
@@ -83,14 +83,16 @@ This HTML example uses the Splunk Enterprise SDK for JavaScript to list all jobs
         });
 
     </script>
+```
 
 ### Node.js code example
 
 This example shows how to use the Splunk Enterprise SDK for JavaScript and Node.js to list all jobs:
 
+```javascript
     var splunkjs = require('splunk-sdk');
 
-    var service = new splunkjs.Service({username: "admin", password: "changeme"});
+    var service = new splunkjs.Service({username: "admin", password: "changed!"});
     service.login(function(err, success) {
         if (err) {
             throw err;
@@ -104,6 +106,7 @@ This example shows how to use the Splunk Enterprise SDK for JavaScript and Node.
             }
         });
     });
+```
 
 ## SDK examples
 
@@ -125,11 +128,11 @@ To use this convenience file, create a text file with the following format:
     # Splunk Enterprise username
     username=admin
     # Splunk Enterprise password
-    password=changeme
+    password=changed!
     # Access scheme (default: https)
     scheme=https
     # Your version of Splunk Enterprise
-    version=7.2
+    version=8.2
 
 Save the file as **.splunkrc** in the current user's home directory.
 
@@ -209,6 +212,10 @@ To run the HTTP and the Async tests, enter:
 
     node sdkdo tests http,async
 
+To run tests containing a particular string, enter:
+
+    node sdkdo tests --grep "While success"
+
 To run the browser tests, enter:
 
     node sdkdo tests-browser
@@ -217,9 +224,13 @@ To run all unit tests without log messages, enter:
 
     node sdkdo tests --quiet
 
-To run all the tests and generate JUnit compatible XML in **splunk-sdk-javascript/test_logs/junit_test_results.xml**, enter:
+To run all the tests and generate test report in **splunk-sdk-javascript/mochawesome-report/mochawesome.html**, enter:
+
+    node sdkdo tests --reporter mochawesome
+
+To get more info to run tests, enter:
 
-    node sdkdo tests --reporter junit
+    make test_specific
 
 ## Repository