github.com/go-graphite/carbonapi@v0.17.0/expr/functions/groupByNode/function_test.go

package groupByNode

import (
	"context"
	"testing"
	"time"

	"github.com/go-graphite/carbonapi/expr/functions/aggregate"
	"github.com/go-graphite/carbonapi/expr/interfaces"
	"github.com/go-graphite/carbonapi/expr/metadata"
	"github.com/go-graphite/carbonapi/expr/types"
	"github.com/go-graphite/carbonapi/pkg/parser"
	th "github.com/go-graphite/carbonapi/tests"
)

var (
	md []interfaces.FunctionMetadata = New("")
	s  []interfaces.FunctionMetadata = aggregate.New("")
)

func init() {
	for _, m := range s {
		metadata.RegisterFunction(m.Name, m.F)
	}
	for _, m := range md {
		metadata.RegisterFunction(m.Name, m.F)
	}
}

// Note: some of these tests are influenced by the testcases for groupByNode and groupByNodes functions
// in Graphite-web. See: https://github.com/graphite-project/graphite-web/blob/master/webapp/tests/test_functions.py
func TestGroupByNode(t *testing.T) {
	now32 := int64(time.Now().Unix())

	mr := parser.MetricRequest{Metric: "metric1.foo.*.*", From: 0, Until: 1}

	tests := []th.MultiReturnEvalTestItem{
		{
			Target: "groupByNode(metric1.foo.*.*,3,\"sum\")",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.qux", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.baz", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.qux", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Name: "groupByNode",
			Results: map[string][]*types.MetricData{
				"baz": {types.MakeMetricData("baz", []float64{12, 14, 16, 18, 20}, 1, now32).SetTag("aggregatedBy", "sum")},
				"qux": {types.MakeMetricData("qux", []float64{13, 15, 17, 19, 21}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Name:   "groupByNode_with_tag",
			Target: `groupByNode(metric1.foo.*.*,"name","sum")`,
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
				},
			},
			Results: map[string][]*types.MetricData{
				"metric1.foo.bar1.baz": {types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Target: "groupByNode(metric1.foo.*.*,3,\"sum\")",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.01", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.10", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.01", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.10", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Name: "groupByNode_names_with_int",
			Results: map[string][]*types.MetricData{
				"01": {types.MakeMetricData("01", []float64{12, 14, 16, 18, 20}, 1, now32).SetTag("aggregatedBy", "sum")},
				"10": {types.MakeMetricData("10", []float64{13, 15, 17, 19, 21}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Target: "groupByNode(metric1.foo.*.*,3,\"sum\")",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.127_0_0_1:2003", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.127_0_0_1:2004", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.127_0_0_1:2003", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.127_0_0_1:2004", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Name: "groupByNode_names_with_colons",
			Results: map[string][]*types.MetricData{
				"127_0_0_1:2003": {types.MakeMetricData("127_0_0_1:2003", []float64{12, 14, 16, 18, 20}, 1, now32).SetTag("aggregatedBy", "sum")},
				"127_0_0_1:2004": {types.MakeMetricData("127_0_0_1:2004", []float64{13, 15, 17, 19, 21}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Target: "groupByNode(metric1.foo.*.*,-2,\"sum\")",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.qux", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.baz", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.qux", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Name: "groupByNode_with_negative_index",
			Results: map[string][]*types.MetricData{
				"bar1": {types.MakeMetricData("bar1", []float64{7, 9, 11, 13, 15}, 1, now32).SetTag("aggregatedBy", "sum")},
				"bar2": {types.MakeMetricData("bar2", []float64{18, 20, 22, 24, 26}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Target: "groupByNode(metric1.foo.*.*,2)",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.qux", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.baz", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.qux", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Name: "groupByNode_with_no_callback_arg",
			Results: map[string][]*types.MetricData{
				"bar1": {types.MakeMetricData("bar1", []float64{3.5, 4.5, 5.5, 6.5, 7.5}, 1, now32).SetTag("aggregatedBy", "avg")},
				"bar2": {types.MakeMetricData("bar2", []float64{9, 10, 11, 12, 13}, 1, now32).SetTag("aggregatedBy", "avg")},
			},
		},
		{
			Target: "groupByNodes(metric1.foo.*.*,\"sum\",0,1,3)",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.qux", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.baz", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.qux", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Name: "groupByNodes",
			Results: map[string][]*types.MetricData{
				"metric1.foo.baz": {types.MakeMetricData("metric1.foo.baz", []float64{12, 14, 16, 18, 20}, 1, now32).SetTag("aggregatedBy", "sum")},
				"metric1.foo.qux": {types.MakeMetricData("metric1.foo.qux", []float64{13, 15, 17, 19, 21}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Name:   "groupByNodes_out_of_range_node_is_ignored",
			Target: "groupByNodes(metric1.foo.*.*,\"sum\",0,5,2)",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
				},
			},
			Results: map[string][]*types.MetricData{
				"metric1.bar1": {types.MakeMetricData("metric1.bar1", []float64{1, 2, 3, 4, 5}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Name:   "groupByNodes_tags_and_nodes_combined",
			Target: `groupByNodes(metric1.foo.*.*,"sum","name",1)`,
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.bla", []float64{1, 2, 3, 4, 5}, 1, now32),
				},
			},
			Results: map[string][]*types.MetricData{
				"metric1.foo.bar1.baz.foo": {types.MakeMetricData("metric1.foo.bar1.baz.foo", []float64{1, 2, 3, 4, 5}, 1, now32).SetTag("aggregatedBy", "sum")},
				"metric1.foo.bar1.bla.foo": {types.MakeMetricData("metric1.foo.bar1.bla.foo", []float64{1, 2, 3, 4, 5}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Name:   "groupByNodes_no_nodes",
			Target: `groupByNodes(metric1.foo.*.*,"sum")`,
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.bla", []float64{1, 2, 3, 4, 5}, 1, now32),
				},
			},
			// If no nodes are specified, all metrics are combined to the empty string
			Results: map[string][]*types.MetricData{
				"": {types.MakeMetricData("", []float64{2, 4, 6, 8, 10}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Target: "groupByNode(metric1.foo.*.*,2,\"sum\")",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.Ab1==.lag", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bC2=.lag", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.Ab1==.lag", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bC2=.lag=", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Name: "groupByNode_names_with_special_symbol_equal",
			Results: map[string][]*types.MetricData{
				"Ab1==": {types.MakeMetricData("Ab1==", []float64{12, 14, 16, 18, 20}, 1, now32).SetTag("aggregatedBy", "sum")},
				"bC2=":  {types.MakeMetricData("bC2=", []float64{13, 15, 17, 19, 21}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Target: "groupByNode(metric1.foo.*.*,3,\"sum\")",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.Ab1==.lag;tag1=value1", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.Ab2.lag=;tag1=value1", []float64{1, 0, 3, 4, 5}, 1, now32),
				},
			},
			Name: "groupByNode_tagged_names_with_special_symbol_equal",
			Results: map[string][]*types.MetricData{
				"lag":  {types.MakeMetricData("lag", []float64{1, 2, 3, 4, 5}, 1, now32).SetTag("aggregatedBy", "sum")},
				"lag=": {types.MakeMetricData("lag=", []float64{1, 0, 3, 4, 5}, 1, now32).SetTag("aggregatedBy", "sum")},
			},
		},
		{
			Name:   "groupByNodes_range",
			Target: `groupByNodes(test.metric*.foo*,"range",1,0)`,
			M: map[parser.MetricRequest][]*types.MetricData{
				{Metric: "test.metric*.foo*", From: 0, Until: 1}: {
					types.MakeMetricData("test.metric1.foo1", []float64{0}, 1, now32),
					types.MakeMetricData("test.metric1.foo2", []float64{0}, 1, now32),
					types.MakeMetricData("test.metric2.foo1", []float64{0}, 1, now32),
					types.MakeMetricData("test.metric2.foo2", []float64{0}, 1, now32),
				},
			},
			Results: map[string][]*types.MetricData{
				"metric1.test": {types.MakeMetricData("metric1.test", []float64{0}, 1, now32).SetTag("aggregatedBy", "range")},
				"metric2.test": {types.MakeMetricData("metric2.test", []float64{0}, 1, now32).SetTag("aggregatedBy", "range")},
			},
		},
		{
			Name:   "groupByNodes_average_no_nodes",
			Target: `groupByNodes(test.metric*.foo*,"average")`,
			M: map[parser.MetricRequest][]*types.MetricData{
				{Metric: "test.metric*.foo*", From: 0, Until: 1}: {
					types.MakeMetricData("test.metric1.foo1", []float64{0}, 1, now32),
					types.MakeMetricData("test.metric1.foo2", []float64{0}, 1, now32),
					types.MakeMetricData("test.metric2.foo1", []float64{0}, 1, now32),
					types.MakeMetricData("test.metric2.foo2", []float64{0}, 1, now32),
				},
			},
			Results: map[string][]*types.MetricData{
				"": {types.MakeMetricData("", []float64{0}, 1, now32).SetTag("aggregatedBy", "average")},
			},
		},
	}

	for _, tt := range tests {
		testName := tt.Target
		t.Run(testName, func(t *testing.T) {
			eval := th.EvaluatorFromFuncWithMetadata(metadata.FunctionMD.Functions)
			th.TestMultiReturnEvalExpr(t, eval, &tt)
		})
	}

}

func TestGroupByNodeError(t *testing.T) {
	now32 := int64(time.Now().Unix())

	mr := parser.MetricRequest{Metric: "metric1.foo.*.*", From: 0, Until: 1}

	tests := []th.EvalTestItemWithError{
		{
			Target: "groupByNode(metric1.foo.*.*,3,\"4\")",
			M: map[parser.MetricRequest][]*types.MetricData{
				mr: {
					types.MakeMetricData("metric1.foo.bar1.baz", []float64{1, 2, 3, 4, 5}, 1, now32),
					types.MakeMetricData("metric1.foo.bar1.qux", []float64{6, 7, 8, 9, 10}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.baz", []float64{11, 12, 13, 14, 15}, 1, now32),
					types.MakeMetricData("metric1.foo.bar2.qux", []float64{7, 8, 9, 10, 11}, 1, now32),
				},
			},
			Error: parser.ErrInvalidArg,
		},
	}

	for _, tt := range tests {
		testName := tt.Target
		t.Run(testName, func(t *testing.T) {
			eval := th.EvaluatorFromFuncWithMetadata(metadata.FunctionMD.Functions)
			th.TestEvalExprWithError(t, eval, &tt)
		})
	}

}

func BenchmarkGroupByNode(b *testing.B) {
	target := "groupByNodes(metric1.foo.bar.*,\"sum\",0,2)"
	metrics := map[parser.MetricRequest][]*types.MetricData{
		{Metric: "metric1.foo.bar.*", From: 0, Until: 1}: {
			types.MakeMetricData("metric1.foo.bar.baz1", []float64{1, 2, 3, 4, 5}, 1, 1),
			types.MakeMetricData("metric1.foo.bar.baz2", []float64{1, 2, 3, 4, 5}, 1, 1),
			types.MakeMetricData("metric1.foo.bar.baz3", []float64{1, 2, 3, 4, 5}, 1, 1),
			types.MakeMetricData("metric1.foo.bar.baz4", []float64{1, 2, 3, 4, 5}, 1, 1),
		},
	}

	eval := th.EvaluatorFromFuncWithMetadata(metadata.FunctionMD.Functions)
	exp, _, err := parser.ParseExpr(target)
	if err != nil {
		b.Fatalf("failed to parse %s: %+v", target, err)
	}

	b.ResetTimer()
	for n := 0; n < b.N; n++ {
		g, err := eval.Eval(context.Background(), exp, 0, 1, metrics)
		if err != nil {
			b.Fatalf("failed to eval %s: %+v", target, err)
		}
		_ = g
	}
}