Merge pull request #43 from splunk/42-index-datatype

42 index datatype

Author: micahkemp-splunk

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.6.1 (December 2, 2021)
+
+FEATURES:
+
+* **Schema Change**: Index has `datatype`.
+
 ## 1.6.0 (November 12, 2021)
 
 FEATURES:

docs/guides/schema.md

@@ -122,6 +122,7 @@ names. As per the `authorize.conf` specification:
 - **homePath** (String) homePath of the index. Defaults to `$SPLUNK_DB/<index name>/db`.
 - **coldPath** (String) coldPath of the index. Defaults to `$SPLUNK_DB/<index name>/colddb`.
 - **thawedPath** (String) thawedPath of the index. Defaults to `$SPLUNK_DB/<index name>/thaweddb`.
+- **datatype** (String, optional) The datatype of the index. Permitted values are `event`, and `metric`.
 
 <a id="lookup"></a>
 ## Schema for `lookup`

internal/splunkconfig/config/index.go

@@ -25,6 +25,7 @@ type Index struct {
 	HomePath           IndexPath  `yaml:"homePath"`
 	ColdPath           IndexPath  `yaml:"coldPath"`
 	ThawedPath         IndexPath  `yaml:"thawedPath"`
+	DataType           IndexDataType
 }
 
 // validate returns an error if the Index is invalid.
@@ -37,6 +38,10 @@ func (index Index) validate() error {
 		return err
 	}
 
+	if err := index.DataType.validate(); err != nil {
+		return err
+	}
+
 	return nil
 }
 
@@ -89,6 +94,10 @@ func (index Index) stanzaValues() StanzaValues {
 		stanzaValues["frozenTimePeriodInSecs"] = fmt.Sprintf("%d", index.FrozenTime.InSeconds())
 	}
 
+	if index.DataType != INDEXDATATYPEUNDEF {
+		stanzaValues["datatype"] = string(index.DataType)
+	}
+
 	// defaultIndexPath will return a valid IndexPath, so we throw away the ok return value, expecting it will never be false
 	stanzaValues["homePath"], _ = firstIndexPathString(index.HomePath, defaultIndexPath(index.Name, "db"))
 	stanzaValues["coldPath"], _ = firstIndexPathString(index.HomePath, defaultIndexPath(index.Name, "colddb"))

internal/splunkconfig/config/index_test.go

@@ -115,6 +115,18 @@ func TestIndex_stanza(t *testing.T) {
 				},
 			},
 		},
+		{
+			Index{Name: "index_a", DataType: "event"},
+			Stanza{
+				Name: "index_a",
+				Values: StanzaValues{
+					"homePath":   "$SPLUNK_DB/index_a/db",
+					"coldPath":   "$SPLUNK_DB/index_a/colddb",
+					"datatype":   "event",
+					"thawedPath": "$SPLUNK_DB/index_a/thaweddb",
+				},
+			},
+		},
 	}
 
 	tests.test(t)

internal/splunkconfig/config/indexdatatype.go

@@ -0,0 +1,39 @@
+// Copyright 2021 Splunk, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package config
+
+import "fmt"
+
+// IndexDataType represents the value of an Index's "datatype" field.
+type IndexDataType string
+
+const (
+	INDEXDATATYPEUNDEF  IndexDataType = ""
+	INDEXDATATYPEEVENT  IndexDataType = "event"
+	INDEXDATATYPEMETRIC IndexDataType = "metric"
+)
+
+// validate returns an error if IndexDataType is invalid. It is invalid if:
+// * it isn't one of the defined constants
+func (indexDataType IndexDataType) validate() error {
+	switch indexDataType {
+	case INDEXDATATYPEUNDEF, INDEXDATATYPEEVENT, INDEXDATATYPEMETRIC:
+		break
+	default:
+		return fmt.Errorf("invalid IndexDataType value: %s", indexDataType)
+	}
+
+	return nil
+}

internal/splunkconfig/config/indexdatatype_test.go

@@ -0,0 +1,40 @@
+// Copyright 2021 Splunk, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package config
+
+import "testing"
+
+func TestIndexDataType_validate(t *testing.T) {
+	tests := validatorTestCases{
+		{
+			validator: IndexDataType(""),
+			wantError: false,
+		},
+		{
+			validator: IndexDataType("event"),
+			wantError: false,
+		},
+		{
+			validator: IndexDataType("metric"),
+			wantError: false,
+		},
+		{
+			validator: IndexDataType("invalid"),
+			wantError: true,
+		},
+	}
+
+	tests.test(t)
+}