github.com/m3db/m3@v1.5.0/src/query/functions/utils/group_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 utils

import (
	"testing"

	"github.com/m3db/m3/src/query/block"
	"github.com/m3db/m3/src/query/models"
	"github.com/m3db/m3/src/query/test/compare"
)

var collectTest = []struct {
	name                       string
	matching                   []string
	tagLists                   []models.Tags
	withTagsExpectedIndices    [][]int
	withTagsExpectedTags       []models.Tags
	withoutTagsExpectedIndices [][]int
	withoutTagsExpectedTags    []models.Tags
}{
	{
		"noMatching",
		[]string{},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1", "b": "2", "c": "4"},
			{"b": "2"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "d": "3"},
			{"c": "d"},
		}),
		[][]int{{0, 1, 2, 3, 4, 5}},
		[]models.Tags{models.EmptyTags()},
		[][]int{{0}, {3}, {1}, {4}, {2}, {5}},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "c": "4"},
			{"a": "1", "b": "2", "d": "3"},
			{"b": "2"},
			{"c": "d"},
		}),
	},
	{
		"no equal Matching",
		[]string{"f", "g", "h"},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1", "b": "2", "c": "4"},
			{"b": "2"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "d": "3"},
			{"c": "d"},
		}),
		[][]int{{0, 1, 2, 3, 4, 5}},
		multiTagsFromMaps([]map[string]string{{}}),
		[][]int{{0}, {3}, {1}, {4}, {2}, {5}},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "c": "4"},
			{"a": "1", "b": "2", "d": "3"},
			{"b": "2"},
			{"c": "d"},
		}),
	},
	{
		"one matching",
		[]string{"a"},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1", "b": "2", "c": "4"},
			{"b": "2"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "d": "3"},
			{"c": "d"},
		}),
		[][]int{{2, 5}, {0, 1, 3, 4}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"a": "1"},
		}),
		[][]int{{0}, {2}, {3}, {1}, {4}, {5}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"b": "2"},
			{"b": "2", "c": "3"},
			{"b": "2", "c": "4"},
			{"b": "2", "d": "3"},
			{"c": "d"},
		}),
	},
	{
		"same tag matching",
		[]string{"a", "a"},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1", "b": "2", "c": "4"},
			{"b": "2"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "d": "3"},
			{"c": "d"},
		}),
		[][]int{{2, 5}, {0, 1, 3, 4}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"a": "1"},
		}),
		[][]int{{0}, {2}, {3}, {1}, {4}, {5}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"b": "2"},
			{"b": "2", "c": "3"},
			{"b": "2", "c": "4"},
			{"b": "2", "d": "3"},
			{"c": "d"},
		}),
	},
	{
		"diffMatching",
		[]string{"a"},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "2", "b": "2", "c": "4"},
			{"a": "2"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "d": "3"},
			{"a": "d"},
		}),
		[][]int{{0, 3, 4}, {1, 2}, {5}},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "2"},
			{"a": "d"},
		}),
		[][]int{{0, 2, 5}, {3}, {1}, {4}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"b": "2", "c": "3"},
			{"b": "2", "c": "4"},
			{"b": "2", "d": "3"},
		}),
	},
	{
		"someMatching",
		[]string{"a", "b"},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1", "b": "2", "c": "4"},
			{"b": "2"},
			{"a": "1", "b": "2", "c": "3"},
			{"a": "1", "b": "2", "d": "3"},
			{"c": "3"},
		}),
		[][]int{{5}, {0}, {1, 3, 4}, {2}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"a": "1"},
			{"a": "1", "b": "2"},
			{"b": "2"},
		}),
		[][]int{{0, 2}, {3, 5}, {1}, {4}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"c": "3"},
			{"c": "4"},
			{"d": "3"},
		}),
	},
	{
		"functionMatching",
		[]string{"a"},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"a": "1"},
			{"a": "1", "b": "2"},
			{"a": "2", "b": "2"},
			{"b": "2"},
			{"c": "3"},
		}),
		[][]int{{4, 5}, {0, 1, 2}, {3}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"a": "1"},
			{"a": "2"},
		}),
		[][]int{{0, 1}, {2, 3, 4}, {5}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"b": "2"},
			{"c": "3"},
		}),
	},
	{
		"different matching",
		[]string{"a", "b"},
		multiTagsFromMaps([]map[string]string{
			{"a": "1", "c": "3", "d": "4"},
			{"b": "1", "c": "3", "d": "5"},
			{"b": "1", "c": "3", "d": "6"},
		}),
		[][]int{{0}, {1, 2}},
		multiTagsFromMaps([]map[string]string{
			{"a": "1"},
			{"b": "1"},
		}),
		[][]int{{0}, {1}, {2}},
		multiTagsFromMaps([]map[string]string{
			{"c": "3", "d": "4"},
			{"c": "3", "d": "5"},
			{"c": "3", "d": "6"},
		}),
	},
	{
		"metrics name",
		[]string{"a"},
		multiTagsFromMaps([]map[string]string{
			{"__name__": "foo", "a": "1"},
			{"__name__": "foo", "a": "1", "b": "2", "c": "4"},
			{"__name__": "foo", "b": "2"},
			{"__name__": "foo", "a": "1", "b": "2", "c": "3"},
			{"__name__": "foo", "a": "1", "b": "2", "d": "3"},
			{"__name__": "foo", "c": "d"},
		}),
		[][]int{{2, 5}, {0, 1, 3, 4}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"a": "1"},
		}),
		[][]int{{0}, {2}, {3}, {1}, {4}, {5}},
		multiTagsFromMaps([]map[string]string{
			{},
			{"b": "2"},
			{"b": "2", "c": "3"},
			{"b": "2", "c": "4"},
			{"b": "2", "d": "3"},
			{"c": "d"},
		}),
	},
}

func testCollect(t *testing.T, without bool) {
	for _, tt := range collectTest {
		name := tt.name + " with tags"
		if without {
			name = tt.name + " without tags"
		}

		t.Run(name, func(t *testing.T) {
			metas := make([]block.SeriesMeta, len(tt.tagLists))
			for i, tagList := range tt.tagLists {
				metas[i] = block.SeriesMeta{Tags: tagList}
			}

			match := make([][]byte, len(tt.matching))
			for i, m := range tt.matching {
				match[i] = []byte(m)
			}

			bName := []byte(name)
			buckets, collected := GroupSeries(match, without, bName, metas)
			expectedTags := tt.withTagsExpectedTags
			expectedIndicies := tt.withTagsExpectedIndices
			if without {
				expectedTags = tt.withoutTagsExpectedTags
				expectedIndicies = tt.withoutTagsExpectedIndices
			}

			expectedMetas := make([]block.SeriesMeta, len(expectedTags))
			for i, tags := range expectedTags {
				expectedMetas[i] = block.SeriesMeta{
					Tags: tags,
					Name: bName,
				}
			}

			compare.CompareListsInOrder(t, collected, expectedMetas, buckets, expectedIndicies)
		})
	}
}

func TestCollectWithTags(t *testing.T) {
	testCollect(t, false)
}

func TestCollectWithoutTags(t *testing.T) {
	testCollect(t, true)
}

func multiTagsFromMaps(tagMaps []map[string]string) []models.Tags {
	tags := make([]models.Tags, len(tagMaps))
	for i, m := range tagMaps {
		tags[i] = models.EmptyTags()
		for n, v := range m {
			tags[i] = tags[i].AddTag(models.Tag{Name: []byte(n), Value: []byte(v)})
		}
	}

	return tags
}