opentelemetry-go/sdk/metric/aggregator/array/array_test.go

// Copyright 2019, OpenTelemetry Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package array

import (
	"context"
	"fmt"
	"math"
	"testing"

	"github.com/stretchr/testify/require"

	"go.opentelemetry.io/otel/api/core"
	"go.opentelemetry.io/otel/sdk/export"
	"go.opentelemetry.io/otel/sdk/metric/aggregator"
	"go.opentelemetry.io/otel/sdk/metric/aggregator/test"
)

type updateTest struct {
	count    int
	absolute bool
}

func (ut *updateTest) run(t *testing.T, profile test.Profile) {
	ctx := context.Background()

	batcher, record := test.NewAggregatorTest(export.MeasureMetricKind, profile.NumberKind, !ut.absolute)

	agg := New()

	all := test.NewNumbers(profile.NumberKind)

	for i := 0; i < ut.count; i++ {
		x := profile.Random(+1)
		all.Append(x)
		agg.Update(ctx, x, record)

		if !ut.absolute {
			y := profile.Random(-1)
			all.Append(y)
			agg.Update(ctx, y, record)
		}
	}

	agg.Collect(ctx, record, batcher)

	all.Sort()

	require.InEpsilon(t,
		all.Sum().CoerceToFloat64(profile.NumberKind),
		agg.Sum().CoerceToFloat64(profile.NumberKind),
		0.0000001,
		"Same sum - absolute")
	require.Equal(t, all.Count(), agg.Count(), "Same count - absolute")

	min, err := agg.Min()
	require.Nil(t, err)
	require.Equal(t, all.Min(), min, "Same min - absolute")

	max, err := agg.Max()
	require.Nil(t, err)
	require.Equal(t, all.Max(), max, "Same max - absolute")

	qx, err := agg.Quantile(0.5)
	require.Nil(t, err)
	require.Equal(t, all.Median(), qx, "Same median - absolute")
}

func TestArrayUpdate(t *testing.T) {
	// Test with an odd an even number of measurements
	for count := 999; count <= 1000; count++ {
		t.Run(fmt.Sprint("Odd=", count%2 == 1), func(t *testing.T) {
			// Test absolute and non-absolute
			for _, absolute := range []bool{false, true} {
				t.Run(fmt.Sprint("Absolute=", absolute), func(t *testing.T) {
					ut := updateTest{
						count:    count,
						absolute: absolute,
					}

					// Test integer and floating point
					test.RunProfiles(t, ut.run)
				})
			}
		})
	}
}

type mergeTest struct {
	count    int
	absolute bool
}

func (mt *mergeTest) run(t *testing.T, profile test.Profile) {
	ctx := context.Background()

	batcher, record := test.NewAggregatorTest(export.MeasureMetricKind, profile.NumberKind, !mt.absolute)

	agg1 := New()
	agg2 := New()

	all := test.NewNumbers(profile.NumberKind)

	for i := 0; i < mt.count; i++ {
		x1 := profile.Random(+1)
		all.Append(x1)
		agg1.Update(ctx, x1, record)

		x2 := profile.Random(+1)
		all.Append(x2)
		agg2.Update(ctx, x2, record)

		if !mt.absolute {
			y1 := profile.Random(-1)
			all.Append(y1)
			agg1.Update(ctx, y1, record)

			y2 := profile.Random(-1)
			all.Append(y2)
			agg2.Update(ctx, y2, record)
		}
	}

	agg1.Collect(ctx, record, batcher)
	agg2.Collect(ctx, record, batcher)

	agg1.Merge(agg2, record.Descriptor())

	all.Sort()

	require.InEpsilon(t,
		all.Sum().CoerceToFloat64(profile.NumberKind),
		agg1.Sum().CoerceToFloat64(profile.NumberKind),
		0.0000001,
		"Same sum - absolute")
	require.Equal(t, all.Count(), agg1.Count(), "Same count - absolute")

	min, err := agg1.Min()
	require.Nil(t, err)
	require.Equal(t, all.Min(), min, "Same min - absolute")

	max, err := agg1.Max()
	require.Nil(t, err)
	require.Equal(t, all.Max(), max, "Same max - absolute")

	qx, err := agg1.Quantile(0.5)
	require.Nil(t, err)
	require.Equal(t, all.Median(), qx, "Same median - absolute")
}

func TestArrayMerge(t *testing.T) {
	// Test with an odd an even number of measurements
	for count := 999; count <= 1000; count++ {
		t.Run(fmt.Sprint("Odd=", count%2 == 1), func(t *testing.T) {
			// Test absolute and non-absolute
			for _, absolute := range []bool{false, true} {
				t.Run(fmt.Sprint("Absolute=", absolute), func(t *testing.T) {
					mt := mergeTest{
						count:    count,
						absolute: absolute,
					}

					// Test integer and floating point
					test.RunProfiles(t, mt.run)
				})
			}
		})
	}
}

func TestArrayErrors(t *testing.T) {
	test.RunProfiles(t, func(t *testing.T, profile test.Profile) {
		agg := New()

		_, err := agg.Max()
		require.Error(t, err)
		require.Equal(t, err, aggregator.ErrEmptyDataSet)

		_, err = agg.Min()
		require.Error(t, err)
		require.Equal(t, err, aggregator.ErrEmptyDataSet)

		_, err = agg.Quantile(0.1)
		require.Error(t, err)
		require.Equal(t, err, aggregator.ErrEmptyDataSet)

		ctx := context.Background()

		batcher, record := test.NewAggregatorTest(export.MeasureMetricKind, profile.NumberKind, false)

		agg.Update(ctx, core.Number(0), record)

		if profile.NumberKind == core.Float64NumberKind {
			agg.Update(ctx, core.NewFloat64Number(math.NaN()), record)
		}
		agg.Collect(ctx, record, batcher)

		require.Equal(t, int64(1), agg.Count(), "NaN value was not counted")

		num, err := agg.Quantile(0)
		require.Nil(t, err)
		require.Equal(t, num, core.Number(0))

		_, err = agg.Quantile(-0.0001)
		require.Error(t, err)
		require.Equal(t, err, aggregator.ErrInvalidQuantile)

		_, err = agg.Quantile(1.0001)
		require.Error(t, err)
		require.Equal(t, err, aggregator.ErrInvalidQuantile)
	})
}

func TestArrayFloat64(t *testing.T) {
	for _, absolute := range []bool{false, true} {
		t.Run(fmt.Sprint("Absolute=", absolute), func(t *testing.T) {
			batcher, record := test.NewAggregatorTest(export.MeasureMetricKind, core.Float64NumberKind, !absolute)

			fpsf := func(sign int) []float64 {
				// Check behavior of a bunch of odd floating
				// points except for NaN, which is invalid.
				return []float64{
					0,
					math.Inf(sign),
					1 / math.Inf(sign),
					1,
					2,
					1e100,
					math.MaxFloat64,
					math.SmallestNonzeroFloat64,
					math.MaxFloat32,
					math.SmallestNonzeroFloat32,
					math.E,
					math.Pi,
					math.Phi,
					math.Sqrt2,
					math.SqrtE,
					math.SqrtPi,
					math.SqrtPhi,
					math.Ln2,
					math.Log2E,
					math.Ln10,
					math.Log10E,
				}
			}

			all := test.NewNumbers(core.Float64NumberKind)

			ctx := context.Background()
			agg := New()

			for _, f := range fpsf(1) {
				all.Append(core.NewFloat64Number(f))
				agg.Update(ctx, core.NewFloat64Number(f), record)
			}

			if !absolute {
				for _, f := range fpsf(-1) {
					all.Append(core.NewFloat64Number(f))
					agg.Update(ctx, core.NewFloat64Number(f), record)
				}
			}

			agg.Collect(ctx, record, batcher)

			all.Sort()

			require.InEpsilon(t, all.Sum().AsFloat64(), agg.Sum().AsFloat64(), 0.0000001, "Same sum")

			require.Equal(t, all.Count(), agg.Count(), "Same count")

			min, err := agg.Min()
			require.Nil(t, err)
			require.Equal(t, all.Min(), min, "Same min")

			max, err := agg.Max()
			require.Nil(t, err)
			require.Equal(t, all.Max(), max, "Same max")

			qx, err := agg.Quantile(0.5)
			require.Nil(t, err)
			require.Equal(t, all.Median(), qx, "Same median")
		})
	}
}