github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/aggregation/type_test.go

// Copyright (c) 2017 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 aggregation

import (
	"encoding/json"
	"fmt"
	"testing"

	"github.com/m3db/m3/src/x/pool"
	"github.com/m3db/m3/src/x/test/testmarshal"

	"github.com/stretchr/testify/require"
	yaml "gopkg.in/yaml.v2"
)

func TestTypeIsValid(t *testing.T) {
	require.True(t, P75.IsValid())
	require.False(t, Type(int(P75)+1).IsValid())
}

func TestTypeMaxID(t *testing.T) {
	require.Equal(t, maxTypeID, P75.ID())
	require.Equal(t, P75, Type(maxTypeID))
	require.Equal(t, maxTypeID, len(ValidTypes))
}

func TestTypeUnmarshalYAML(t *testing.T) {
	inputs := []struct {
		str         string
		expected    Type
		expectedErr bool
	}{
		{
			str:      "Min",
			expected: Min,
		},
		{
			str:         "Mean,",
			expectedErr: true,
		},
		{
			str:         "asd",
			expectedErr: true,
		},
	}
	for _, input := range inputs {
		var aggtype Type
		err := yaml.Unmarshal([]byte(input.str), &aggtype)

		if input.expectedErr {
			require.Error(t, err)
			continue
		}

		require.NoError(t, err)
		require.Equal(t, input.expected, aggtype)
	}
}

func TestTypesIsDefault(t *testing.T) {
	require.True(t, DefaultTypes.IsDefault())

	require.False(t, Types{Max}.IsDefault())
}

func TestTypesMarshalJSON(t *testing.T) {
	inputs := []struct {
		types       Types
		expected    string
		expectedErr bool
	}{
		{
			types:    Types{},
			expected: `[]`,
		},
		{
			types:    Types{Min},
			expected: `["Min"]`,
		},
		{
			types:    Types{Mean, Max, P99, P9999},
			expected: `["Mean","Max","P99","P9999"]`,
		},
		{
			types:       Types{Type(1000)},
			expectedErr: true,
		},
	}
	for _, input := range inputs {
		b, err := json.Marshal(input.types)
		if input.expectedErr {
			require.Error(t, err)
			continue
		}
		require.NoError(t, err)
		require.Equal(t, input.expected, string(b))
	}
}

func TestTypesUnMarshalJSON(t *testing.T) {
	inputs := []struct {
		str         string
		expected    Types
		expectedErr bool
	}{
		{
			str:      `[]`,
			expected: Types{},
		},
		{
			str:      `["Min"]`,
			expected: Types{Min},
		},
		{
			str:      `["Mean","Max","P99","P9999"]`,
			expected: Types{Mean, Max, P99, P9999},
		},
		{
			str:         `[P100]`,
			expectedErr: true,
		},
	}
	for _, input := range inputs {
		var aggTypes Types
		err := json.Unmarshal([]byte(input.str), &aggTypes)
		if input.expectedErr {
			require.Error(t, err)
			continue
		}
		require.NoError(t, err)
		require.Equal(t, input.expected, aggTypes)
	}
}

func TestTypesMarshalRoundTrip(t *testing.T) {
	inputs := []Types{
		{},
		{Min},
		{Mean, Max, P99, P9999},
	}

	testmarshal.TestMarshalersRoundtrip(t, inputs, []testmarshal.Marshaler{
		testmarshal.JSONMarshaler,
		testmarshal.YAMLMarshaler,
	})
}

func TestTypesMarshalText(t *testing.T) {
	cases := []struct {
		In       Type
		Expected string
	}{{
		In:       Mean,
		Expected: "Mean",
	}, {
		In:       Last,
		Expected: "Last",
	}}

	for _, tc := range cases {
		t.Run(tc.Expected, func(t *testing.T) {
			testmarshal.AssertMarshals(t, testmarshal.TextMarshaler, tc.In, []byte(tc.Expected))
		})
	}
}

func TestTypesUnmarshalTextError(t *testing.T) {
	cases := []string{
		"unknown_at",
		`"Mean"`, // double JSON encoded
	}

	for _, tc := range cases {
		t.Run(tc, func(t *testing.T) {
			var target Type
			require.EqualError(t, target.UnmarshalText([]byte(tc)), fmt.Sprintf("invalid aggregation type: %s", tc))
		})
	}
}

func TestTypesUnmarshalYAML(t *testing.T) {
	inputs := []struct {
		str         string
		expected    Types
		expectedErr bool
	}{
		{
			str:      "",
			expected: Types(nil),
		},
		{
			str:      "[Min]",
			expected: Types{Min},
		},
		{
			str:      "[Mean,Max,P99,P9999]",
			expected: Types{Mean, Max, P99, P9999},
		},
		{
			str:         "[Min,Max,P99,P9999,P100]",
			expectedErr: true,
		},
		{
			str:         "[Min,Max,P99,P9999,P100]",
			expectedErr: true,
		},
		{
			str:         ",Mean",
			expectedErr: true,
		},
		{
			str:         "Mean,",
			expectedErr: true,
		},
		{
			str:         ",Mean,",
			expectedErr: true,
		},
	}
	for _, input := range inputs {
		var aggtypes Types
		err := yaml.Unmarshal([]byte(input.str), &aggtypes)

		if input.expectedErr {
			require.Error(t, err)
			continue
		}

		require.NoError(t, err)
		require.Equal(t, input.expected, aggtypes)
	}
}

func TestParseTypes(t *testing.T) {
	inputs := []struct {
		str      string
		expected Types
	}{
		{
			str:      "Min",
			expected: Types{Min},
		},
		{
			str:      "Min,Max",
			expected: Types{Min, Max},
		},
		{
			str:      "min,max",
			expected: Types{Min, Max},
		},
	}
	for _, input := range inputs {
		res, err := ParseTypes(input.str)
		require.NoError(t, err)
		require.Equal(t, input.expected, res)
	}
}

func TestQuantiles(t *testing.T) {
	res, ok := Types{Median, P95, P99}.PooledQuantiles(nil)
	require.Equal(t, []float64{0.5, 0.95, 0.99}, res)
	require.False(t, ok)

	p := pool.NewFloatsPool(
		[]pool.Bucket{
			pool.Bucket{Capacity: 10, Count: 1},
		},
		nil,
	)
	p.Init()
	res, ok = Types{Median, P95, P99}.PooledQuantiles(p)
	require.Equal(t, []float64{0.5, 0.95, 0.99}, res)
	require.True(t, ok)

	p.Put(res)

	res2, ok := Types{P90, P95, P99}.PooledQuantiles(p)
	require.Equal(t, []float64{0.9, 0.95, 0.99}, res2)
	require.Equal(t, res, res2)
	require.True(t, ok)
	p.Put(res2)

	res3, ok := Types{Count}.PooledQuantiles(p)
	require.Nil(t, res3)
	require.False(t, ok)

	res4, ok := Types{P10, P20, P25, P30, P40, P50, Median, P60, P70, P75, P80, P90, P95, P99, P999, P9999}.
		PooledQuantiles(p)
	require.Equal(
		t,
		[]float64{0.1, 0.2, 0.25, 0.3, 0.4, 0.5, 0.6, 0.7, 0.75, 0.8, 0.9, 0.95, 0.99, 0.999, 0.9999},
		res4)
	require.True(t, ok)
}

func TestIDContains(t *testing.T) {
	require.True(t, MustCompressTypes(P99).Contains(P99))
	require.True(t, MustCompressTypes(P99, P95).Contains(P99))
	require.True(t, MustCompressTypes(P99, P95).Contains(P95))
	require.True(t, MustCompressTypes(Sum, Last, P999).Contains(Sum))
	require.True(t, MustCompressTypes(Sum, Last, P999).Contains(Last))
	require.True(t, MustCompressTypes(Sum, Last, P999).Contains(P999))
	require.False(t, MustCompressTypes(Sum, Last, P999).Contains(P9999))
	require.False(t, MustCompressTypes().Contains(P99))
	require.False(t, MustCompressTypes(P99, P95).Contains(P9999))
}

func TestCompressedTypesIsDefault(t *testing.T) {
	var id ID
	require.True(t, id.IsDefault())

	id[0] = 8
	require.False(t, id.IsDefault())

	id[0] = 0
	require.True(t, id.IsDefault())
}