Merge pull request #165 from newrelic/rc-ssl

SSL support for JMX

Author: varas

README.md

@@ -125,7 +125,7 @@ You can easily fetch it using:
 ### JMX support
 
 The Integrations Go lang SDK supports getting metrics through JMX by calling the
-`jmx.Open()`, `jmx.Query()` and `jmx.Close()` functions. This JMX support relies
+`jmx.Open()`, `jmx.OpenWithSSL`, `jmx.Query()` and `jmx.Close()` functions. This JMX support relies
 on the nrjmx tool. Follow the steps in
 the [nrjmx](https://github.com/newrelic/nrjmx) repository to build it and set
 the `NR_JMX_TOOL` environment variable to point to the location of the nrjmx

jmx/jmx.go

@@ -39,25 +39,38 @@ const (
 	jmxLineBuffer = 4 * 1024 * 1024 // Max 4MB per line. If single lines are outputting more JSON than that, we likely need smaller-scoped JMX queries
 )
 
-func getCommand(hostname, port, username, password string) []string {
-	var cliCommand []string
-
+func getCommand(hostname, port, username, password string) (c []string) {
 	if os.Getenv("NR_JMX_TOOL") != "" {
-		cliCommand = strings.Split(os.Getenv("NR_JMX_TOOL"), " ")
+		c = strings.Split(os.Getenv("NR_JMX_TOOL"), " ")
 	} else {
-		cliCommand = []string{jmxCommand}
+		c = []string{jmxCommand}
 	}
 
-	cliCommand = append(cliCommand, "--hostname", hostname, "--port", port)
+	c = append(c, "--hostname", hostname, "--port", port)
 	if username != "" && password != "" {
-		cliCommand = append(cliCommand, "--username", username, "--password", password)
+		c = append(c, "--username", username, "--password", password)
+	}
+
+	return
+}
+
+func getCommandWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword string) []string {
+	c := getCommand(hostname, port, username, password)
+
+	if keyStore != "" && keyStorePassword != "" && trustStore != "" && trustStorePassword != "" {
+		c = append(c, "--keyStore", keyStore, "--keyStorePassword", keyStorePassword, "--trustStore", trustStore, "--trustStorePassword", trustStorePassword)
 	}
 
-	return cliCommand
+	return c
 }
 
 // Open will start the nrjmx command with the provided connection parameters.
 func Open(hostname, port, username, password string) error {
+	return OpenWithSSL(hostname, port, username, password, "", "", "", "")
+}
+
+// OpenWithSSL will start the nrjmx command with the provided SSL connection parameters
+func OpenWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword string) error {
 	lock.Lock()
 	defer lock.Unlock()
 
@@ -75,7 +88,7 @@ func Open(hostname, port, username, password string) error {
 	var err error
 	var ctx context.Context
 
-	cliCommand := getCommand(hostname, port, username, password)
+	cliCommand := getCommandWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword)
 
 	ctx, cancel = context.WithCancel(context.Background())
 	cmd = exec.CommandContext(ctx, cliCommand[0], cliCommand[1:]...)

jmx/jmx_test.go

@@ -18,6 +18,12 @@ const (
 	openAttempts = 5
 )
 
+var query2IsErr = map[string]bool{
+	"empty":   false,
+	"crash":   true,
+	"invalid": true,
+}
+
 func TestMain(m *testing.M) {
 	var testType string
 	flag.StringVar(&testType, "test.type", "", "")
@@ -54,55 +60,53 @@ func TestMain(m *testing.M) {
 	}
 }
 
-func TestJmxOpen(t *testing.T) {
+func TestOpen_OnlyWorksWhenClosed(t *testing.T) {
 	defer Close()
 
-	if err := Open("", "", "", ""); err != nil {
-		t.Error(err)
-	}
-
-	if Open("", "", "", "") == nil {
-		t.Error()
-	}
+	assert.NoError(t, Open("", "", "", ""))
+	assert.Error(t, Open("", "", "", ""))
+	Close()
+	assert.NoError(t, Open("", "", "", ""))
 }
 
-func TestJmxQuery(t *testing.T) {
+func TestOpenWithSSL_OnlyWorksWhenClosed(t *testing.T) {
 	defer Close()
 
-	if err := openWait("", "", "", "", openAttempts); err != nil {
-		t.Error(err)
-	}
-
-	if _, err := Query("empty", timeout); err != nil {
-		t.Error(err)
-	}
+	assert.NoError(t, OpenWithSSL("", "", "", "", "", "", "", ""))
+	assert.Error(t, OpenWithSSL("", "", "", "", "", "", "", ""))
+	Close()
+	assert.NoError(t, OpenWithSSL("", "", "", "", "", "", "", ""))
 }
 
-func TestJmxCrashQuery(t *testing.T) {
-	defer Close()
+func TestQuery(t *testing.T) {
+	for q, isErr := range query2IsErr {
+		assert.NoError(t, openWait("", "", "", "", openAttempts), "error on opening for query %s", q)
 
-	if err := openWait("", "", "", "", openAttempts); err != nil {
-		t.Error(err)
-	}
-
-	if _, err := Query("crash", timeout); err == nil {
-		t.Error()
+		_, err := Query(q, timeout)
+		if isErr {
+			assert.Error(t, err)
+		} else {
+			assert.NoError(t, err)
+		}
+		Close()
 	}
 }
 
-func TestJmxInvalidQuery(t *testing.T) {
-	defer Close()
-
-	if err := openWait("", "", "", "", openAttempts); err != nil {
-		t.Error(err)
-	}
+func TestQuery_WithSSL(t *testing.T) {
+	for q, isErr := range query2IsErr {
+		assert.NoError(t, openWaitWithSSL("", "", "", "", "", "", "", "", openAttempts))
 
-	if _, err := Query("invalid", timeout); err == nil {
-		t.Error()
+		_, err := Query(q, timeout)
+		if isErr {
+			assert.Error(t, err)
+		} else {
+			assert.NoError(t, err)
+		}
+		Close()
 	}
 }
 
-func TestJmxTimeoutQuery(t *testing.T) {
+func TestQuery_TimeoutReturnsError(t *testing.T) {
 	defer Close()
 
 	if err := openWait("", "", "", "", openAttempts); err != nil {
@@ -152,12 +156,16 @@ func TestJmxTimeoutBigQuery(t *testing.T) {
 
 // tests can overlap, and as jmx-cmd is a singleton, waiting for it to be closed is mandatory
 func openWait(hostname, port, username, password string, attempts int) error {
-	err := Open(hostname, port, username, password)
+	return openWaitWithSSL(hostname, port, username, password, "", "", "", "", attempts)
+}
+
+func openWaitWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword string, attempts int) error {
+	err := OpenWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword)
 	if err == ErrJmxCmdRunning && attempts > 0 {
 		attempts--
 		time.Sleep(10 * time.Millisecond)
 
-		return openWait(hostname, port, username, password, attempts)
+		return openWaitWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword, attempts)
 	}
 
 	return err