Add defaults processor to set default field values (#7370)

2020-05-22 14:44:13 -04:00
parent e6f06457ce
commit a7674b707b
4 changed files with 246 additions and 0 deletions
--- a/plugins/processors/defaults/defaults_test.go
+++ b/plugins/processors/defaults/defaults_test.go
@@ -0,0 +1,131 @@
+package defaults
+
+import (
+	"testing"
+	"time"
+
+	"github.com/influxdata/telegraf"
+	"github.com/influxdata/telegraf/testutil"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestDefaults(t *testing.T) {
+	scenarios := []struct {
+		name     string
+		defaults *Defaults
+		input    telegraf.Metric
+		expected []telegraf.Metric
+	}{
+		{
+			name: "Test that no values are changed since they are not nil or empty",
+			defaults: &Defaults{
+				DefaultFieldsSets: map[string]interface{}{
+					"usage":     30,
+					"wind_feel": "very chill",
+					"is_dead":   true,
+				},
+			},
+			input: testutil.MustMetric(
+				"CPU metrics",
+				map[string]string{},
+				map[string]interface{}{
+					"usage":     45,
+					"wind_feel": "a dragon's breath",
+					"is_dead":   false,
+				},
+				time.Unix(0, 0),
+			),
+			expected: []telegraf.Metric{
+				testutil.MustMetric(
+					"CPU metrics",
+					map[string]string{},
+					map[string]interface{}{
+						"usage":     45,
+						"wind_feel": "a dragon's breath",
+						"is_dead":   false,
+					},
+					time.Unix(0, 0),
+				),
+			},
+		},
+		{
+			name: "Tests that the missing fields are set on the metric",
+			defaults: &Defaults{
+				DefaultFieldsSets: map[string]interface{}{
+					"max_clock_gz":  6,
+					"wind_feel":     "Unknown",
+					"boost_enabled": false,
+					"variance":      1.2,
+				},
+			},
+			input: testutil.MustMetric(
+				"CPU metrics",
+				map[string]string{},
+				map[string]interface{}{
+					"usage":       45,
+					"temperature": 64,
+				},
+				time.Unix(0, 0),
+			),
+			expected: []telegraf.Metric{
+				testutil.MustMetric(
+					"CPU metrics",
+					map[string]string{},
+					map[string]interface{}{
+						"usage":         45,
+						"temperature":   64,
+						"max_clock_gz":  6,
+						"wind_feel":     "Unknown",
+						"boost_enabled": false,
+						"variance":      1.2,
+					},
+					time.Unix(0, 0),
+				),
+			},
+		},
+		{
+			name: "Tests that set but empty fields are replaced by specified defaults",
+			defaults: &Defaults{
+				DefaultFieldsSets: map[string]interface{}{
+					"max_clock_gz":  6,
+					"wind_feel":     "Unknown",
+					"fan_loudness":  "Inaudible",
+					"boost_enabled": false,
+				},
+			},
+			input: testutil.MustMetric(
+				"CPU metrics",
+				map[string]string{},
+				map[string]interface{}{
+					"max_clock_gz": "",
+					"wind_feel":    " ",
+					"fan_loudness": "         ",
+				},
+				time.Unix(0, 0),
+			),
+			expected: []telegraf.Metric{
+				testutil.MustMetric(
+					"CPU metrics",
+					map[string]string{},
+					map[string]interface{}{
+						"max_clock_gz":  6,
+						"wind_feel":     "Unknown",
+						"fan_loudness":  "Inaudible",
+						"boost_enabled": false,
+					},
+					time.Unix(0, 0),
+				),
+			},
+		},
+	}
+
+	for _, scenario := range scenarios {
+		t.Run(scenario.name, func(t *testing.T) {
+			defaults := scenario.defaults
+
+			resultMetrics := defaults.Apply(scenario.input)
+			assert.Len(t, resultMetrics, 1)
+			testutil.RequireMetricsEqual(t, scenario.expected, resultMetrics)
+		})
+	}
+}