Release 1.6.4

Shakeel Mohamed · Shakeel Mohamed · commit 530599564a4c · 2018-03-08T15:07:56.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,7 @@ TEST-com.splunk.*.xml
 
 # IntelliJ
 .idea/workspace.xml
+.idea/misc.xml
 
 # Unknown
 *.swp
diff --git a/.travis.yml b/.travis.yml
@@ -28,14 +28,19 @@ before_install:
     - sleep 30
 
 env:
-    - SPLUNK_VERSION=6.2.6-sdk
-    - SPLUNK_VERSION=6.3.1-sdk
+    - SPLUNK_VERSION=6.6-sdk
+    - SPLUNK_VERSION=7.0-sdk
 
 language: java
 
+addons:
+  apt:
+    packages:
+      - ant-optional
+
 jdk:
   - oraclejdk8
-  - oraclejdk7
+  - openjdk7
 
 before_script:
     - ant
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # Splunk SDK for Java Changelog
 
+## Version 1.6.4
+
+### Bug Fixes
+
+* Fixed bug in modinput Windows shims that caused Splunk Enterprise to fail to restart (GitHub PR [#120](https://github.com/splunk/splunk-sdk-java/pull/120)).
+* Fixed bug with data model endpoint on Splunk Enterprise 7+ (GitHub PR [#117](https://github.com/splunk/splunk-sdk-java/pull/117)).
+* Fixed bug with invalid `Index.submit()` forming an invalid REST API path for namespaced services ([#118](https://github.com/splunk/splunk-sdk-java/pull/118)).
+* Fixed bug with `Value.toDate(string value)` not being thread safe (GitHub PR [#109](https://github.com/splunk/splunk-sdk-java/pull/109)).
+
 ## Version 1.6.3
 
 ### New features and APIs
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 [![Build Status](https://travis-ci.org/splunk/splunk-sdk-java.svg?branch=master)](https://travis-ci.org/splunk/splunk-sdk-java)
 # The Splunk Software Development Kit for Java
 
-#### Version 1.6.3
+#### Version 1.6.4
 
 The Splunk Software Development Kit (SDK) for Java contains library code and
 examples designed to enable developers to build applications using Splunk.
diff --git a/build.xml b/build.xml
@@ -18,7 +18,7 @@
 
 <project name="splunk-sdk-java" basedir="." default="dist" xmlns:jacoco="antlib:org.jacoco.ant"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="antlib:org.jacoco.ant ">
-    <property name="version.number" value="1.6.3"/>
+    <property name="version.number" value="1.6.4"/>
 
     <!-- Paths within the repository that are referenced
          multiple times. -->
diff --git a/deploy b/deploy
@@ -2,7 +2,7 @@
 
 declare -r scriptDirectory="$(dirname $(readlink -e $0))"
 declare -r scriptName="$(basename $0)"
-declare -r version="1.6.3"
+declare -r version="1.6.4"
 
 if [[ $# -ne 1 ]]; then
     echo 1>&2 "Usage: ${scriptName} {local|staging||production}"
diff --git a/deploy.md b/deploy.md
@@ -9,8 +9,8 @@ deploy \<repository-name>
 
 ##DESCRIPTION
 
-Deploy transmits **dist/splunk-1.6.3.jar**, **dist/splunk-1.6.3-javadoc.jar**, and 
-**dist/splunk-1.6.3-sources.jar** to the **local**, **staging**, or **production**
+Deploy transmits **dist/splunk-1.6.4.jar**, **dist/splunk-1.6.4-javadoc.jar**, and 
+**dist/splunk-1.6.4-sources.jar** to the **local**, **staging**, or **production**
 maven repository. Repository names are mapped to locations as follows.
 
 | repository-name | location                                                       |
@@ -21,18 +21,18 @@ maven repository. Repository names are mapped to locations as follows.
 
 After deployment you should find this tree structure at the location of your repository
 
-    com/splunk/splunk/1.6.3/
-    ├── splunk-1.6.3-javadoc.jar
-    ├── splunk-1.6.3-javadoc.jar.md5
-    ├── splunk-1.6.3-javadoc.jar.sha1
-    ├── splunk-1.6.3-sources.jar
-    ├── splunk-1.6.3-sources.jar.md5
-    ├── splunk-1.6.3-sources.jar.sha1
-    ├── splunk-1.6.3.jar
-    ├── splunk-1.6.3.jar.md5
-    ├── splunk-1.6.3.jar.sha1
-    ├── splunk-1.6.3.pom
-    ├── splunk-1.6.3.pom.md5
-    └── splunk-1.6.3.pom.sha1
+    com/splunk/splunk/1.6.4/
+    ├── splunk-1.6.4-javadoc.jar
+    ├── splunk-1.6.4-javadoc.jar.md5
+    ├── splunk-1.6.4-javadoc.jar.sha1
+    ├── splunk-1.6.4-sources.jar
+    ├── splunk-1.6.4-sources.jar.md5
+    ├── splunk-1.6.4-sources.jar.sha1
+    ├── splunk-1.6.4.jar
+    ├── splunk-1.6.4.jar.md5
+    ├── splunk-1.6.4.jar.sha1
+    ├── splunk-1.6.4.pom
+    ├── splunk-1.6.4.pom.md5
+    └── splunk-1.6.4.pom.sha1
 
 Verify this structure prior to release.
diff --git a/launchers/shim-windows_x86.exe b/launchers/shim-windows_x86.exe
diff --git a/launchers/shim-windows_x86_64.exe b/launchers/shim-windows_x86_64.exe
diff --git a/launchers/shim/shim/shim.cpp b/launchers/shim/shim/shim.cpp
@@ -27,8 +27,7 @@ int _tmain(int argc, _TCHAR* argv[])
     HANDLE &jvmHandle = processHandles[1];
     HANDLE ghJob = NULL;
     PTSTR customizedJavaCmd = NULL, jarPath = NULL, jvmOptions = NULL, jvmCommandLine = NULL;
-    DWORD waitOutcome, exitCode;
-
+    DWORD waitOutcome;
     DWORD returnCode = 0;
 
     STARTUPINFO si;
@@ -74,7 +73,7 @@ int _tmain(int argc, _TCHAR* argv[])
     jvmOptions = readJvmOptions(jarPath);
     jvmCommandLine = assembleJvmCommand(customizedJavaCmd, jarPath, jvmOptions, argc, argv);
 
-    if (!CreateProcess(NULL, jvmCommandLine, NULL, NULL, FALSE, 0, NULL, NULL, &si, &pi)) {
+    if (!CreateProcess(NULL, jvmCommandLine, NULL, NULL, FALSE, CREATE_NEW_PROCESS_GROUP, NULL, NULL, &si, &pi)) {
         // Process creation failed.
         printErrorMessage(GetLastError(), jvmCommandLine);
 
@@ -155,7 +154,7 @@ void printErrorMessage(DWORD errorCode, ...) {
 
 
 PTSTR readJvmOptions(PTSTR jarPath) {
-    DWORD jarPathLen = _tcslen(jarPath);
+    size_t jarPathLen = _tcslen(jarPath);
     // vmoptsPath is the same as jarPath, but ending with .vmopts instead of .jar. We allocate
     // 3 additional TCHARs for the additional length of .vmopts, and 1 more TCHAR for a NULL
     // terminator, so jarPathLen+4.
@@ -297,7 +296,7 @@ PTSTR getPathToJar() {
     PCTSTR jarSuffix = TEXT(".jar");
     const DWORD jarSuffixLen = 5;
     const size_t N = 1024;
-    DWORD baseNameLen;
+    size_t baseNameLen;
 
     thisPath = (PTSTR)malloc(N*sizeof(TCHAR));
     if (N == GetModuleFileName(NULL, thisPath, N) && ERROR_INSUFFICIENT_BUFFER == GetLastError()) {
@@ -325,7 +324,7 @@ PTSTR getPathToJar() {
     *endPtr = NULL;
     endPtr = _tcsrchr(thisPath, '\\');
 
-    if (baseName-endPtr < _tcslen(TEXT("\\jars\\"))) {
+    if ((size_t)(baseName-endPtr) < _tcslen(TEXT("\\jars\\"))) {
         return NULL; // Not enough space to copy the path fragment in without clobbering the jar name.
     }
 
@@ -347,7 +346,6 @@ PTSTR getCustomizedJavaCmd() {
     PCTSTR javaHomeFragment = TEXT("\\customized.java.path");
     const DWORD javaHomeFragmentLen = 22;
     const size_t N = 1024;
-    DWORD baseNameLen;
 
     javaHomePath = (PTSTR)malloc(N*sizeof(TCHAR));
     if (N == GetModuleFileName(NULL, javaHomePath, N) && ERROR_INSUFFICIENT_BUFFER == GetLastError()) {
@@ -402,4 +400,4 @@ PTSTR getCustomizedJavaCmd() {
 #else
     return buffer;
 #endif
-}
+}
diff --git a/splunk/com/splunk/DataModelField.java b/splunk/com/splunk/DataModelField.java
@@ -121,7 +121,12 @@ public static DataModelField parse(JsonElement fieldJson) {
             } else if (entry.getKey().equals("displayName")) {
                 field.displayName = entry.getValue().getAsString();
             } else if (entry.getKey().equals("comment")) {
-                field.comment = entry.getValue().getAsString();
+                //Before Splunk 7, comment value was just a string but now, its JSON ("comment": {"description": "The body of a message."})
+                if(entry.getValue().isJsonObject()) {
+                    field.comment = entry.getValue().getAsJsonObject().get("description").getAsString();
+                } else {
+                    field.comment = entry.getValue().getAsString();
+                }
             } else if (entry.getKey().equals("editable")) {
                 field.editable = entry.getValue().getAsBoolean();
             } else if (entry.getKey().equals("fieldSearch")) {
diff --git a/splunk/com/splunk/HttpService.java b/splunk/com/splunk/HttpService.java
@@ -73,7 +73,7 @@ public boolean verify(String s, SSLSession sslSession) {
     private String prefix = null;
 
     static Map<String, String> defaultHeader = new HashMap<String, String>() {{
-        put("User-Agent", "splunk-sdk-java/1.6.3");
+        put("User-Agent", "splunk-sdk-java/1.6.4");
         put("Accept", "*/*");
     }};
 
diff --git a/splunk/com/splunk/Service.java b/splunk/com/splunk/Service.java
@@ -58,7 +58,7 @@ public class Service extends BaseService {
     protected String password = null;
 
     /** The default simple receiver endpoint. */
-    protected String simpleReceiverEndPoint = "receivers/simple";
+    protected String simpleReceiverEndPoint = "/services/receivers/simple";
 
     /** The default password endpoint, can change over Splunk versions. */
     protected String passwordEndPoint = "admin/passwords";
diff --git a/splunk/com/splunk/Value.java b/splunk/com/splunk/Value.java
@@ -80,7 +80,7 @@ else if (value.endsWith("GB"))
      * @param value Value to convert.
      * @return Date value.
      */
-    static Date toDate(String value) {
+    static synchronized Date toDate(String value) {
         if (dateFormat == null) {
             dateFormat = new SimpleDateFormat[6];
             dateFormat[0] = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssZ");
diff --git a/tests/com/splunk/ApplicationTest.java b/tests/com/splunk/ApplicationTest.java
@@ -74,17 +74,9 @@ public boolean predicate() {
 
     @Test
     public void testForEmptySetup() {
-        // Newly created applications have no setup.
-        try {
-            application.setup().getSetupXml();
-            Assert.fail("Expected HTTP 500.");
-        }
-        catch (HttpException e) {
-            Assert.assertEquals(500, e.getStatus());
-            Assert.assertTrue(
-                    e.getMessage().contains("does not exits") ||    // 4.3.2
-                            e.getMessage().contains("does not exist"));     // 5.0rc5
-        }
+        final String setupXml = application.setup().getSetupXml();
+        // Newly created applications now has a setup stub.
+        Assert.assertTrue(setupXml.contains("stub"));
     }
 
     @Test
diff --git a/tests/com/splunk/DistributedPeerTest.java b/tests/com/splunk/DistributedPeerTest.java
@@ -16,11 +16,13 @@
 
 package com.splunk;
 
-import org.junit.After;
-import org.junit.Assert;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.*;
 
+@Ignore
+/**
+ * To execute these test we need a separate splunk instance. Post splunk6.4, it is no longer allowed to connect to
+ * self as a peer because of name conflicts.
+ */
 public class DistributedPeerTest extends SDKTestCase {
     EntityCollection<DistributedPeer> peers;
     String temporaryUsername;
diff --git a/tests/com/splunk/IndexTest.java b/tests/com/splunk/IndexTest.java
@@ -26,6 +26,8 @@
 
 import java.io.*;
 import java.net.Socket;
+import java.util.HashMap;
+import java.util.Map;
 
 public class IndexTest extends SDKTestCase {
     private String indexName;
@@ -440,6 +442,45 @@ public boolean predicate() {
             }
         });
     }
+    
+    @Test
+    public void testSubmitOneWithNamespacedService() {
+        Map<String, Object> opts = new HashMap<String, Object>(command.opts);
+        opts.put("app", "search");
+        final Service service = Service.connect(opts);
+        Assert.assertNotNull(service);
+        
+        final String indexName = createTemporaryName();
+        final Index index = service.getIndexes().create(indexName);
+
+        Assert.assertTrue(getResultCountOfIndex(service) == 0);
+        Assert.assertTrue(index.getTotalEventCount() == 0);
+        index.submit(createTimestamp() + " This is a test of the emergency broadcasting system.");
+        
+        assertEventuallyTrue(new EventuallyTrueBehavior() {
+
+            @Override
+            public boolean predicate() {
+                return getResultCountOfIndex(service, indexName) == 1;
+            }
+        });
+        
+        assertEventuallyTrue(new EventuallyTrueBehavior() {
+            @Override
+            public boolean predicate() {
+                index.refresh();
+                return index.getTotalEventCount() == 1;
+            }
+        });
+        try {
+            index.remove();
+        } catch (Exception e) {
+            System.out.println(
+                    "WARNING: index " + indexName + " cannot be deleted." +
+                            " Error: " + e.toString());
+        }
+    }
+    
 
     @Test
     public void testSubmitOneArgs() throws Exception {
@@ -689,9 +730,6 @@ public void testUploadArgsFailure() throws Exception{
     }
 
 
-
-
-
     @Test
     public void testUpload() throws Exception {
         if (!hasTestData()) {
@@ -785,6 +823,10 @@ public void testUpdateNameShouldFail() {
     // === Utility ===
 
     private int getResultCountOfIndex(Service s) {
+        return getResultCountOfIndex(s, indexName);
+    }
+    
+    private int getResultCountOfIndex(Service s, String indexName) {
         InputStream results = s.oneshotSearch("search index=" + indexName);
         try {
             ResultsReaderXml resultsReader = new ResultsReaderXml(results);
diff --git a/tests/com/splunk/SDKTestCase.java b/tests/com/splunk/SDKTestCase.java
@@ -89,7 +89,7 @@ public void setUp() throws Exception {
         //System.setProperty("https.proxyHost", "127.0.0.1");
         //System.setProperty("https.proxyPort", "8888");
 
-        HttpService.setSslSecurityProtocol(SSLSecurityProtocol.TLSv1);
+        HttpService.setSslSecurityProtocol(SSLSecurityProtocol.TLSv1_2);
 
         command = Command.splunk();
         connect();
