github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/query/storage/index_test.go

// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package storage

import (
	"testing"
	"time"

	"github.com/m3db/m3/src/dbnode/storage/index"
	"github.com/m3db/m3/src/query/models"
	"github.com/m3db/m3/src/x/ident"
	xtime "github.com/m3db/m3/src/x/time"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

var (
	testID   = ident.StringID("test_id")
	testTags = []models.Tag{
		{Name: []byte("t1"), Value: []byte("v1")},
		{Name: []byte("t2"), Value: []byte("v2")},
	}
	now = time.Now()
)

func makeTagIter() ident.TagIterator {
	ts := models.EmptyTags().AddTags(testTags)
	return TagsToIdentTagIterator(ts)
}

func TestTagsToIdentTagIterator(t *testing.T) {
	tagIter := makeTagIter()
	defer tagIter.Close()

	tags := make([]models.Tag, len(testTags))
	for i := 0; tagIter.Next(); i++ {
		tags[i] = models.Tag{
			Name:  tagIter.Current().Name.Bytes(),
			Value: tagIter.Current().Value.Bytes(),
		}
	}

	assert.Equal(t, testTags, tags)
}

func TestFromM3IdentToMetric(t *testing.T) {
	tagIters := makeTagIter()
	name := []byte("foobarbaz")
	metric, err := FromM3IdentToMetric(testID, tagIters, models.NewTagOptions().SetMetricName(name))
	require.NoError(t, err)

	assert.Equal(t, testID.Bytes(), metric.ID)
	assert.Equal(t, testTags, metric.Tags.Tags)
	assert.Equal(t, name, metric.Tags.Opts.MetricName())
}

func TestFetchQueryToM3Query(t *testing.T) {
	tests := []struct {
		name     string
		expected string
		matchers models.Matchers
	}{
		{
			name:     "exact match",
			expected: "term(t1,v1)",
			matchers: models.Matchers{
				{
					Type:  models.MatchEqual,
					Name:  []byte("t1"),
					Value: []byte("v1"),
				},
			},
		},
		{
			name:     "exact match negated",
			expected: "negation(term(t1,v1))",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotEqual,
					Name:  []byte("t1"),
					Value: []byte("v1"),
				},
			},
		},
		{
			name:     "regexp match",
			expected: "regexp(t1,v1)",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("t1"),
					Value: []byte("v1"),
				},
			},
		},
		{
			name:     "regexp match dot star -> all",
			expected: "all()",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("t1"),
					Value: []byte(".*"),
				},
			},
		},
		{
			name:     "regexp match dot plus -> field",
			expected: "field(t1)",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("t1"),
					Value: []byte(".+"),
				},
			},
		},
		{
			name:     "regexp match negated",
			expected: "negation(regexp(t1,v1))",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotRegexp,
					Name:  []byte("t1"),
					Value: []byte("v1"),
				},
			},
		},
		{
			name:     "regexp match negated",
			expected: "negation(all())",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotRegexp,
					Name:  []byte("t1"),
					Value: []byte(".*"),
				},
			},
		},
		{
			name:     "field match",
			expected: "field(t1)",
			matchers: models.Matchers{
				{
					Type:  models.MatchField,
					Name:  []byte("t1"),
					Value: []byte("v1"),
				},
			},
		},
		{
			name:     "field match negated",
			expected: "negation(field(t1))",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotField,
					Name:  []byte("t1"),
					Value: []byte("v1"),
				},
			},
		},
		{
			name:     "all matchers",
			expected: "all()",
			matchers: models.Matchers{},
		},
		{
			name:     "all matchers",
			expected: "all()",
			matchers: models.Matchers{
				{
					Type: models.MatchAll,
				},
			},
		},
		{
			name:     "regexp match dot star with trailing characters -> regex",
			expected: "regexp(t1,.*foo)",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("t1"),
					Value: []byte(".*foo"),
				},
			},
		},
		{
			name:     "regexp match dot plus with trailing characters -> regex",
			expected: "regexp(t1,.+foo)",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("t1"),
					Value: []byte(".+foo"),
				},
			},
		},
		{
			name:     "not regexp match dot star with trailing characters -> regex",
			expected: "negation(regexp(t1,.*foo))",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotRegexp,
					Name:  []byte("t1"),
					Value: []byte(".*foo"),
				},
			},
		},
		{
			name:     "not regexp match dot plus with trailing characters -> regex",
			expected: "negation(regexp(t1,.+foo))",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotRegexp,
					Name:  []byte("t1"),
					Value: []byte(".+foo"),
				},
			},
		},
		{
			name:     "disjunction with empty (no field) match, no parens",
			expected: "disjunction(negation(field(env)), regexp(env,one|))",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("env"),
					Value: []byte("one|"),
				},
			},
		},
		{
			name:     "disjunction with empty (no field) match",
			expected: "disjunction(negation(field(env)), regexp(env,(|one|two)))",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("env"),
					Value: []byte("(|one|two)"),
				},
			},
		},
		{
			name:     "disjunction with non trivial empty (no field) match",
			expected: "disjunction(negation(field(env)), regexp(env,\\d*|one))",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("env"),
					Value: []byte("\\d*|one"),
				},
			},
		},
		{
			name:     "disjunction with both empty (no field) matches",
			expected: "disjunction(negation(field(env)), regexp(env,(|)))",
			matchers: models.Matchers{
				{
					Type:  models.MatchRegexp,
					Name:  []byte("env"),
					Value: []byte("(|)"),
				},
			},
		},
		{
			name:     "negated disjunction with empty (no field) match",
			expected: "conjunction(field(env),negation(regexp(env,(|one))))",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotRegexp,
					Name:  []byte("env"),
					Value: []byte("(|one)"),
				},
			},
		},
		{
			name:     "negated disjunction with both empty (no field) matches",
			expected: "conjunction(field(env),negation(regexp(env,(|))))",
			matchers: models.Matchers{
				{
					Type:  models.MatchNotRegexp,
					Name:  []byte("env"),
					Value: []byte("(|)"),
				},
			},
		},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			fetchQuery := &FetchQuery{
				Raw:         "up",
				TagMatchers: test.matchers,
				Start:       now.Add(-5 * time.Minute),
				End:         now,
				Interval:    15 * time.Second,
			}

			m3Query, err := FetchQueryToM3Query(fetchQuery, nil)
			require.NoError(t, err)
			assert.Equal(t, test.expected, m3Query.String())
		})
	}
}

func TestFetchOptionsToAggregateOptions(t *testing.T) {
	now := time.Now()

	tests := []struct {
		name                  string
		fetchOptions          *FetchOptions
		tagQuery              *CompleteTagsQuery
		expectedErr           bool
		expectedAdjustedStart *time.Time
		expectedAdjustedEnd   *time.Time
	}{
		{
			name: "all options",
			fetchOptions: &FetchOptions{
				SeriesLimit:       7,
				DocsLimit:         8,
				RangeLimit:        2 * time.Hour,
				RequireExhaustive: true,
			},
			tagQuery: &CompleteTagsQuery{
				Start: xtime.ToUnixNano(now.Add(-1 * time.Hour)),
				End:   xtime.ToUnixNano(now),
				TagMatchers: models.Matchers{
					models.Matcher{
						Type: models.MatchNotRegexp,
						Name: []byte("foo"), Value: []byte("bar"),
					},
				},
				FilterNameTags:   [][]byte{[]byte("filter")},
				CompleteNameOnly: true,
			},
		},
		{
			name: "range limit exceeded error",
			fetchOptions: &FetchOptions{
				RangeLimit:        30 * time.Minute,
				RequireExhaustive: true,
			},
			tagQuery: &CompleteTagsQuery{
				Start: xtime.ToUnixNano(now.Add(-1 * time.Hour)),
				End:   xtime.ToUnixNano(now),
				TagMatchers: models.Matchers{
					models.Matcher{
						Type: models.MatchNotRegexp,
						Name: []byte("foo"), Value: []byte("bar"),
					},
				},
			},
			expectedErr: true,
		},
		{
			name: "range limit truncate start/end",
			fetchOptions: &FetchOptions{
				RangeLimit:        30 * time.Minute,
				RequireExhaustive: false,
			},
			tagQuery: &CompleteTagsQuery{
				Start: xtime.ToUnixNano(now.Add(-1 * time.Hour)),
				End:   xtime.ToUnixNano(now),
				TagMatchers: models.Matchers{
					models.Matcher{
						Type: models.MatchNotRegexp,
						Name: []byte("foo"), Value: []byte("bar"),
					},
				},
			},
			expectedAdjustedStart: timePtr(now.Add(-30 * time.Minute)),
			expectedAdjustedEnd:   timePtr(now),
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			aggOpts, err := FetchOptionsToAggregateOptions(tt.fetchOptions, tt.tagQuery)

			if tt.expectedErr {
				require.Error(t, err)
				return
			}

			require.NoError(t, err)

			expectedStart := tt.tagQuery.Start
			expectedEnd := tt.tagQuery.End
			if v := tt.expectedAdjustedStart; v != nil {
				expectedStart = xtime.ToUnixNano(*v)
			}
			if v := tt.expectedAdjustedEnd; v != nil {
				expectedEnd = xtime.ToUnixNano(*v)
			}
			require.Equal(t, expectedStart, aggOpts.StartInclusive)
			require.Equal(t, expectedEnd, aggOpts.EndExclusive)

			if tt.tagQuery.CompleteNameOnly {
				require.Equal(t, index.AggregateTagNames, aggOpts.Type)
			} else {
				require.Equal(t, index.AggregateTagNamesAndValues, aggOpts.Type)
			}
			require.Equal(t, tt.tagQuery.FilterNameTags, [][]byte(aggOpts.FieldFilter))
			require.Equal(t, tt.fetchOptions.SeriesLimit, aggOpts.SeriesLimit)
			require.Equal(t, tt.fetchOptions.DocsLimit, aggOpts.DocsLimit)
			require.Equal(t, tt.fetchOptions.RequireExhaustive, aggOpts.RequireExhaustive)
		})
	}
}

func timePtr(t time.Time) *time.Time {
	return &t
}