Merge pull request #163 from splunk/release/1.7.0

Release/1.7.0

Author: bparmar-splunk

.github/workflows/release.yml

@@ -0,0 +1,34 @@
+on:
+  release:
+    types: [published]
+
+name: Release
+
+jobs:
+  build:
+    name: Java SDK Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+          server-username: MAVEN_USERNAME
+          server-password: MAVEN_PASSWORD
+          server-id: splunk-artifactory
+      - name: build
+        run: mvn package --file pom.xml -DskipTests=true
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v1
+        with:
+#          body_path: ${{ github.workflow }}-CHANGELOG.txt
+          files: ./target/*.jar
+          draft: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Deploy to Artifactory
+        run: mvn --batch-mode deploy -DskipTests=true
+        env:
+          MAVEN_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }}
+          MAVEN_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }}

.github/workflows/test.yml

@@ -0,0 +1,65 @@
+name: Java SDK Test
+
+on:
+  [push, pull_request]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+        java-version:
+          - 1.8
+        splunk-version:
+          - "8.0"
+          - "8.2.0"
+    runs-on: ${{ matrix.os }}
+
+    services:
+      splunk:
+        image: splunk/splunk:${{matrix.splunk-version}}
+        env:
+          SPLUNK_START_ARGS: --accept-license
+          SPLUNK_PASSWORD: changed!
+          TEST_TCP_PORT: 10667
+          TEST_UDP_PORT: 10668
+          SPLUNK_HOME: "/opt/splunk"
+        ports:
+          - 8000:8000
+          - 8089:8089
+          - 8088:8088
+          - 10667:10667
+          - 10668:10668/udp
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+
+      - name: Cache local Maven repository
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-maven-
+
+      - 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: Test using maven
+        run: make test
+        env:
+          SPLUNK_HOME: "/opt/splunk"
+          TEST_TCP_PORT: 10667
+          TEST_UDP_PORT: 10668

.gitignore

@@ -8,13 +8,15 @@
 build
 dist
 out
+target/
 
 # Test & Coverage
 TEST-com.splunk.*.xml
 
 # IntelliJ
 .idea/workspace.xml
 .idea/misc.xml
+.idea/
 
 # Unknown
 *.swp

.idea/ant.xml

@@ -1,5 +1,20 @@
 # Splunk Enterprise SDK for Java Changelog
 
+## Version 1.7.0
+
+### New Features and APIs
+* Added Credits.md file along with licences. (Github PR [#162](https://github.com/splunk/splunk-sdk-java/pull/162)).
+* Improved TLS implementation as default behavior and turned on hostname verification for all hosts. (Github PR [#158](https://github.com/splunk/splunk-sdk-java/pull/158)).
+
+### Minor changes
+* Replaced Travis CI with Github actions (Github PR [#161](https://github.com/splunk/splunk-sdk-java/pull/161)).
+* Fixed Javadoc generation while project packaging. (Github PR [#159](https://github.com/splunk/splunk-sdk-java/pull/159)).
+* Fixed breaking change of **Index.getMaxHotBuckets()** method behavior to return as String instead of int.
+* SDK build is migrated from ant build tool to maven build tool (Github PR [#157](https://github.com/splunk/splunk-sdk-java/pull/157)).
+  * Dependencies directory for ant build is removed and maven dependencies are added using pom.xml.
+  * Dependencies are upgraded to its LTS version.
+  * Project structure is re-organized with respect to Maven.
+
 ## Version 1.6.5
 
 ### Bug Fixes

.travis.yml

@@ -0,0 +1,12 @@
+# Third-party software credits
+
+Some of the components included in the Splunk Enterprise SDK for Java are licensed under free or open source licenses. We wish to thank the contributors to those projects.
+
+| Contributor | Description | License |
+|:----------- |:----------- |:------- |
+| [opencsv](https://sourceforge.net/p/opencsv/source/ci/master/tree/) | For reading and writing CSV in Java | [Apache](https://github.com/splunk/splunk-sdk-java/blob/master/licenses/LICENSE-OPENCSV) |
+| [commons-cli](https://github.com/apache/commons-cli) | A package of Java utility classes for the classes that are in java.lang's hierarchy | [Apache](https://github.com/splunk/splunk-sdk-java/blob/master/licenses/LICENSE-COMMONS) |
+| [gson](https://github.com/google/gson) | Convert Java Objects into their JSON representation | [Apache](https://github.com/splunk/splunk-sdk-java/blob/master/licenses/LICENSE-GSON) |
+| [junit](https://github.com/junit-team/junit4) | Unit testing framework for Java | [Eclipse](https://github.com/splunk/splunk-sdk-java/blob/master/licenses/LICENSE-JUNIT) |
+| [jacoco](https://github.com/jacoco/jacoco) | JaCoCo runtime agent to your tests and allows basic report creation. | [Eclipse](https://github.com/splunk/splunk-sdk-java/blob/master/licenses/LICENSE-JACOCO) |
+| [netbeans-api](https://github.com/apache/netbeans) | OpenIDE Utilities | [Apache](https://github.com/splunk/splunk-sdk-java/blob/master/licenses/LICENSE-NETBEANS) |

CHANGELOG.md

@@ -0,0 +1,48 @@
+# 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)"
+#	@ant test
+	@mvn test
+
+.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