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

package timeShiftByMetric

import (
	"context"
	"math"
	"testing"
	"time"

	"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("")
)

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

func TestTimeShift(t *testing.T) {
	nan := math.NaN()
	now32 := time.Now().Unix()

	testCases := []th.EvalTestItem{
		// 1. Versions: 1_0, 1_1, 1_2, 1_3, 2_0, 2_1, 2_2, 3_0, 3_1. Each two consequential versions are have 1 time unit between them.
		// 2. Leading versions: 1_3, 2_2, 3_1.
		// 3. Version 2_2 is 2 time units behind version 3_1. Version 1_3 is 3 time units behind version 2_2 therefore 5 units behind version 3_1.
		{
			"timeShiftByMetric(apps.*.metric, apps.mark.*, 1)",
			map[parser.MetricRequest][]*types.MetricData{
				parser.MetricRequest{Metric: "apps.*.metric", From: 0, Until: 1}: {
					types.MakeMetricData("apps.1_3.metric", []float64{1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, nan, nan}, 1, now32),
					types.MakeMetricData("apps.2.metric", []float64{nan, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, nan}, 1, now32),
					types.MakeMetricData("apps.3.metric", []float64{nan, nan, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9}, 1, now32),
				},
				parser.MetricRequest{Metric: "apps.mark.*", From: 0, Until: 1}: {
					// leading versions
					types.MakeMetricData("apps.mark.1_3", []float64{nan, nan, nan, 1, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_2", []float64{nan, nan, nan, nan, nan, nan, 1, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.3_1", []float64{nan, nan, nan, nan, nan, nan, nan, nan, 1, nan, nan}, 1, now32),
					// rest
					types.MakeMetricData("apps.mark.1_0", []float64{1, nan, nan, nan, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.1_1", []float64{nan, 1, nan, nan, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.1_2", []float64{nan, nan, 1, nan, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_0", []float64{nan, nan, nan, nan, 1, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_1", []float64{nan, nan, nan, nan, nan, 1, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.3_0", []float64{nan, nan, nan, nan, nan, nan, nan, 1, nan, nan, nan}, 1, now32),
				},
			},
			[]*types.MetricData{
				types.MakeMetricData("timeShiftByMetric(apps.1_3.metric)", []float64{1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, nan, nan}, 1, now32+5),
				types.MakeMetricData("timeShiftByMetric(apps.2.metric)", []float64{nan, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, nan}, 1, now32+2),
				types.MakeMetricData("timeShiftByMetric(apps.3.metric)", []float64{nan, nan, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9}, 1, now32),
			},
		},
		// 1. Versions: 1_0, 1_1, 2_0.
		// 2. Leading versions: 1_1, 2_0.
		// 3. Version 1_1 is 4 time units behind versions 2_0.
		{
			"timeShiftByMetric(*.metric, apps.mark.*, 0)",
			map[parser.MetricRequest][]*types.MetricData{
				parser.MetricRequest{Metric: "*.metric", From: 0, Until: 1}: {
					types.MakeMetricData("1_1.metric", []float64{1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7}, 1, now32),
					types.MakeMetricData("2_0.metric", []float64{2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7}, 1, now32),
				},
				parser.MetricRequest{Metric: "apps.mark.*", From: 0, Until: 1}: {
					// leading versions
					types.MakeMetricData("apps.mark.1_1", []float64{nan, nan, 1, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_0", []float64{nan, nan, nan, nan, nan, nan, 1}, 1, now32),
					// rest
					types.MakeMetricData("apps.mark.1_0", []float64{1, nan, nan, nan, nan, nan, nan}, 1, now32),
				},
			},
			[]*types.MetricData{
				types.MakeMetricData("timeShiftByMetric(1_1.metric)", []float64{1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7}, 1, now32+4),
				types.MakeMetricData("timeShiftByMetric(2_0.metric)", []float64{2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7}, 1, now32),
			},
		},
	}

	for _, testCase := range testCases {
		testName := testCase.Target
		t.Run(testName, func(t *testing.T) {
			eval := th.EvaluatorFromFunc(md[0].F)
			th.TestEvalExpr(t, eval, &testCase)
		})
	}
}

func TestBadMarks(t *testing.T) {
	nan := math.NaN()
	now32 := time.Now().Unix()

	testCases := []th.EvalTestItemWithError{
		// we have only one major version here, it's not right
		{
			"timeShiftByMetric(apps.*.metric, apps.mark.*, 1)",
			map[parser.MetricRequest][]*types.MetricData{
				parser.MetricRequest{Metric: "apps.*.metric", From: 0, Until: 1}: {
					types.MakeMetricData("apps.1.metric", []float64{1, 2, 3}, 1, now32),
					types.MakeMetricData("apps.2.metric", []float64{1, 2, 3}, 1, now32),
					types.MakeMetricData("apps.3.metric", []float64{1, 2, 3}, 1, now32),
				},
				parser.MetricRequest{Metric: "apps.mark.*", From: 0, Until: 1}: {
					types.MakeMetricData("apps.mark.1_0", []float64{1, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.1_1", []float64{nan, 1, nan}, 1, now32),
					types.MakeMetricData("apps.mark.1_2", []float64{nan, nan, 1}, 1, now32),
				},
			},
			nil,
			errLessThan2Marks,
		},
	}

	for _, testCase := range testCases {
		testName := testCase.Target
		t.Run(testName, func(t *testing.T) {
			eval := th.EvaluatorFromFunc(md[0].F)
			th.TestEvalExprWithError(t, eval, &testCase)
		})
	}
}

func TestNotEnoughSeries(t *testing.T) {
	nan := math.NaN()
	now32 := time.Now().Unix()
	testCases := make([]th.EvalTestItemWithError, 0, 4)

	// enough metrics but not enough marks
	for i := 0; i < 2; i++ {
		marksData := make([]*types.MetricData, 0, 1)
		for j := 0; j < i; j++ {
			marksData = append(marksData, types.MakeMetricData("apps.mark.1_0", []float64{1, nan, nan, nan, nan}, 1, now32))
		}

		metricsData := []*types.MetricData{
			types.MakeMetricData("apps.1.metric", []float64{1, 2, 3, 4, 5}, 1, now32),
			types.MakeMetricData("apps.2.metric", []float64{1, 2, 3, 4, 5}, 1, now32),
		}

		testCases = append(testCases, th.EvalTestItemWithError{
			"timeShiftByMetric(apps.*.metric, apps.mark.*, 1)",
			map[parser.MetricRequest][]*types.MetricData{
				parser.MetricRequest{Metric: "apps.*.metric", From: 0, Until: 1}: metricsData,
				parser.MetricRequest{Metric: "apps.mark.*", From: 0, Until: 1}:   marksData,
			},
			nil,
			errTooFewDatasets,
		})
	}

	// enough marks but not enough metrics
	for i := 0; i < 2; i++ {
		metricsData := make([]*types.MetricData, 0, 1)
		for j := 0; j < i; j++ {
			metricsData = append(metricsData, types.MakeMetricData("apps.1.metric", []float64{1, 2, 3, 4, 5}, 1, now32))
		}

		marksData := []*types.MetricData{
			types.MakeMetricData("apps.mark.1_0", []float64{1, nan}, 1, now32),
			types.MakeMetricData("apps.mark.2_0", []float64{nan, 2}, 1, now32),
		}

		testCases = append(testCases, th.EvalTestItemWithError{
			"timeShiftByMetric(apps.*.metric, apps.mark.*, 1)",
			map[parser.MetricRequest][]*types.MetricData{
				parser.MetricRequest{Metric: "apps.*.metric", From: 0, Until: 1}: metricsData,
				parser.MetricRequest{Metric: "apps.mark.*", From: 0, Until: 1}:   marksData,
			},
			nil,
			errTooFewDatasets,
		})
	}

	for _, testCase := range testCases {
		testName := testCase.Target
		t.Run(testName, func(t *testing.T) {
			eval := th.EvaluatorFromFunc(md[0].F)
			th.TestEvalExprWithError(t, eval, &testCase)
		})
	}
}

func BenchmarkTimeShift(b *testing.B) {
	nan := math.NaN()
	now32 := time.Now().Unix()

	benchmarks := []struct {
		target string
		M      map[parser.MetricRequest][]*types.MetricData
	}{
		// 1. Versions: 1_0, 1_1, 1_2, 1_3, 2_0, 2_1, 2_2, 3_0, 3_1. Each two consequential versions are have 1 time unit between them.
		// 2. Leading versions: 1_3, 2_2, 3_1.
		// 3. Version 2_2 is 2 time units behind version 3_1. Version 1_3 is 3 time units behind version 2_2 therefore 5 units behind version 3_1.
		{
			target: "timeShiftByMetric(apps.*.metric, apps.mark.*, 1)",
			M: map[parser.MetricRequest][]*types.MetricData{
				parser.MetricRequest{Metric: "apps.*.metric", From: 0, Until: 1}: {
					types.MakeMetricData("apps.1_3.metric", []float64{1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, nan, nan}, 1, now32),
					types.MakeMetricData("apps.2.metric", []float64{nan, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, nan}, 1, now32),
					types.MakeMetricData("apps.3.metric", []float64{nan, nan, 3.1, 3.2, 3.3, 3.4, 3.5, 3.6, 3.7, 3.8, 3.9}, 1, now32),
				},
				parser.MetricRequest{Metric: "apps.mark.*", From: 0, Until: 1}: {
					// leading versions
					types.MakeMetricData("apps.mark.1_3", []float64{nan, nan, nan, 1, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_2", []float64{nan, nan, nan, nan, nan, nan, 1, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.3_1", []float64{nan, nan, nan, nan, nan, nan, nan, nan, 1, nan, nan}, 1, now32),
					// rest
					types.MakeMetricData("apps.mark.1_0", []float64{1, nan, nan, nan, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.1_1", []float64{nan, 1, nan, nan, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.1_2", []float64{nan, nan, 1, nan, nan, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_0", []float64{nan, nan, nan, nan, 1, nan, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_1", []float64{nan, nan, nan, nan, nan, 1, nan, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.3_0", []float64{nan, nan, nan, nan, nan, nan, nan, 1, nan, nan, nan}, 1, now32),
				},
			},
		},
		// 1. Versions: 1_0, 1_1, 2_0.
		// 2. Leading versions: 1_1, 2_0.
		// 3. Version 1_1 is 4 time units behind versions 2_0.
		{
			target: "timeShiftByMetric(*.metric, apps.mark.*, 0)",
			M: map[parser.MetricRequest][]*types.MetricData{
				{Metric: "*.metric", From: 0, Until: 1}: {
					types.MakeMetricData("1_1.metric", []float64{1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7}, 1, now32),
					types.MakeMetricData("2_0.metric", []float64{2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7}, 1, now32),
				},
				{Metric: "apps.mark.*", From: 0, Until: 1}: {
					// leading versions
					types.MakeMetricData("apps.mark.1_1", []float64{nan, nan, 1, nan, nan, nan, nan}, 1, now32),
					types.MakeMetricData("apps.mark.2_0", []float64{nan, nan, nan, nan, nan, nan, 1}, 1, now32),
					// rest
					types.MakeMetricData("apps.mark.1_0", []float64{1, nan, nan, nan, nan, nan, nan}, 1, now32),
				},
			},
		},
	}

	eval := th.EvaluatorFromFunc(md[0].F)

	for _, bm := range benchmarks {
		b.Run(bm.target, func(b *testing.B) {
			exp, _, err := parser.ParseExpr(bm.target)
			if err != nil {
				b.Fatalf("failed to parse %s: %+v", bm.target, err)
			}

			b.ResetTimer()

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