Add Get/Update methods for Properties API

Author: Amey Bhide

clients/splunk/properties.go

@@ -0,0 +1,77 @@
+package splunk
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+	"reflect"
+	"strings"
+)
+
+// PropertiesService encapsulates Splunk Properties API
+
+type PropertiesService struct {
+	client *Client
+}
+
+func newPropertiesService(client *Client) *PropertiesService {
+	return &PropertiesService{
+		client: client,
+	}
+}
+
+type Entry struct {
+	Value string
+}
+
+// stringResponseDecoder decodes http response string
+// Properties API operates on particular key in the configuration file.
+// CRUD for properties API returns JSON/XML encoded response for error cases and returns a string response for success
+type stringResponseDecoder struct{
+}
+
+func getPropertiesUri(file string, stanza string, key string) (string) {
+	return fmt.Sprintf("properties/%s/%s/%s", url.PathEscape(file), url.PathEscape(stanza), url.PathEscape(key))
+}
+
+func (d stringResponseDecoder) Decode(resp *http.Response, v interface{}) error {
+	body, err := ioutil.ReadAll(resp.Body)
+	if err != nil {
+		return err
+	}
+	if 200 <= resp.StatusCode && resp.StatusCode <= 299 {
+		tempEntry := &Entry{
+			Value: string(body),
+		}
+		vVal, tempVal := reflect.ValueOf(v), reflect.ValueOf(tempEntry)
+		vVal.Elem().Set(tempVal.Elem())
+		return nil
+	}
+	return json.Unmarshal(body, v)
+}
+
+// UpdateKey updates value for specified key from the specified stanza in the configuration file
+func (p *PropertiesService) UpdateKey(file string, stanza string, key string, value string) (*string, *http.Response, error) {
+	apiError := &APIError{}
+	body := strings.NewReader(fmt.Sprintf("value=%s", value))
+	resp, err := p.client.New().Post(
+		getPropertiesUri(file, stanza, key)).Body(body).ResponseDecoder(stringResponseDecoder{}).Receive(nil, apiError)
+	if err != nil || !apiError.Empty() {
+		return nil, resp, relevantError(err, apiError)
+	}
+	return nil, resp, relevantError(err, apiError)
+}
+
+// GetKey returns value for the given key from the specified stanza in the configuration file
+func (p *PropertiesService) GetKey(file string, stanza string, key string) (*string, *http.Response, error) {
+	apiError := &APIError{}
+	output := &Entry{}
+	resp, err := p.client.New().Get(
+		getPropertiesUri(file, stanza, key)).ResponseDecoder(stringResponseDecoder{}).Receive(output, apiError)
+	if err != nil || !apiError.Empty() {
+		return nil, resp, relevantError(err, apiError)
+	}
+	return &output.Value, resp, relevantError(err, apiError)
+}

clients/splunk/properties_test.go

@@ -0,0 +1,35 @@
+package splunk
+
+import (
+	"gotest.tools/assert"
+	"testing"
+)
+
+func TestPropertiesService_GetKey(t *testing.T) {
+	propertiesSvc := TestGlobalSplunkClient(t).Properties
+
+	// Negative cases
+	_, response, err := propertiesSvc.GetKey("foo", "bar", "key")
+	assert.ErrorContains(t, err, "splunk: foo does not exist")
+	assert.Equal(t, response.StatusCode, 404)
+	_, response, err = propertiesSvc.GetKey("b/a/z","b-ar", "k-ey")
+	assert.ErrorContains(t, err, "ERROR splunk: Directory traversal risk in /nobody/system/b/a/z at segment \"b/a/z\"")
+	assert.Equal(t, response.StatusCode, 403)
+	_, response, err = propertiesSvc.GetKey("foo-bar", "b/a/z", "k-ey")
+	assert.ErrorContains(t, err, "splunk: foo-bar does not exist")
+	assert.Equal(t, response.StatusCode, 404)
+	_, response, err = propertiesSvc.UpdateKey("foo", "bar", "pass4SymmKey", "bar")
+	assert.ErrorContains(t, err, "splunk: bar does not exist")
+	assert.Equal(t, response.StatusCode, 404)
+
+
+	_, response, err = propertiesSvc.GetKey("server", "general", "pass4SymmKey")
+	assert.Equal(t, response.StatusCode, 200)
+
+	// Update value for pass4SymmKey and check if the new value is reflected
+	_, response, err = propertiesSvc.UpdateKey("server", "general", "pass4SymmKey", "bar")
+	assert.Equal(t, response.StatusCode, 200)
+	currentValue, response, err := propertiesSvc.GetKey("server", "general", "pass4SymmKey")
+	assert.Equal(t, response.StatusCode, 200)
+	assert.Equal(t, *currentValue, "bar")
+}

clients/splunk/splunk.go

@@ -19,6 +19,7 @@ type API struct {
 	client        *Client
 	Introspection *IntrospectionService
 	AccessControl *AccessControlService
+	Properties    *PropertiesService
 	// XXX ...
 }
 
@@ -37,6 +38,7 @@ func (params *APIParams) NewAPI(ctx context.Context) *API {
 		client:        client.Path("services/"),
 		Introspection: newIntrospectionService(client.New()),
 		AccessControl: newAccessControlService(client.New()),
+		Properties:    newPropertiesService(client.New()),
 	}
 }