model/value_test.go

// Copyright 2013 The Prometheus 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 model

import (
	"encoding/json"
	"math"
	"sort"
	"testing"

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

func TestEqualSamples(t *testing.T) {
	testSample := &Sample{}

	tests := map[string]struct {
		in1, in2 *Sample
		want     bool
	}{
		"equal pointers": {
			in1:  testSample,
			in2:  testSample,
			want: true,
		},
		"different metrics": {
			in1:  &Sample{Metric: Metric{"foo": "bar"}},
			in2:  &Sample{Metric: Metric{"foo": "biz"}},
			want: false,
		},
		"different timestamp": {
			in1:  &Sample{Timestamp: 0},
			in2:  &Sample{Timestamp: 1},
			want: false,
		},
		"different value": {
			in1:  &Sample{Value: 0},
			in2:  &Sample{Value: 1},
			want: false,
		},
		"equal samples": {
			in1: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Value:     1,
			},
			in2: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Value:     1,
			},
			want: true,
		},
		"equal histograms": {
			in1: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: genSampleHistogram(),
			},
			in2: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: genSampleHistogram(),
			},
			want: true,
		},
		"different histogram counts": {
			in1: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: &SampleHistogram{
					Count: 2,
					Sum:   4500,
					Buckets: HistogramBuckets{
						{
							Boundaries: 0,
							Lower:      4466.7196729968955,
							Upper:      4870.992343051145,
							Count:      1,
						},
					},
				},
			},
			in2: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: genSampleHistogram(),
			},
			want: false,
		},
		"different histogram sums": {
			in1: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: &SampleHistogram{
					Count: 1,
					Sum:   4500.01,
					Buckets: HistogramBuckets{
						{
							Boundaries: 0,
							Lower:      4466.7196729968955,
							Upper:      4870.992343051145,
							Count:      1,
						},
					},
				},
			},
			in2: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: genSampleHistogram(),
			},
			want: false,
		},
		"different histogram inner counts": {
			in1: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: &SampleHistogram{
					Count: 1,
					Sum:   4500,
					Buckets: HistogramBuckets{
						{
							Boundaries: 0,
							Lower:      4466.7196729968955,
							Upper:      4870.992343051145,
							Count:      2,
						},
					},
				},
			},
			in2: &Sample{
				Metric:    Metric{"foo": "bar"},
				Timestamp: 0,
				Histogram: genSampleHistogram(),
			},
			want: false,
		},
	}

	for name, test := range tests {
		got := test.in1.Equal(test.in2)
		if got != test.want {
			t.Errorf("Comparing %s, %v and %v: got %t, want %t", name, test.in1, test.in2, got, test.want)
		}
	}
}

func TestScalarJSON(t *testing.T) {
	input := []struct {
		plain string
		value Scalar
	}{
		{
			plain: `[123.456,"456"]`,
			value: Scalar{
				Timestamp: 123456,
				Value:     456,
			},
		},
		{
			plain: `[123123.456,"+Inf"]`,
			value: Scalar{
				Timestamp: 123123456,
				Value:     SampleValue(math.Inf(1)),
			},
		},
		{
			plain: `[123123.456,"-Inf"]`,
			value: Scalar{
				Timestamp: 123123456,
				Value:     SampleValue(math.Inf(-1)),
			},
		},
	}

	for _, test := range input {
		b, err := json.Marshal(test.value)
		if err != nil {
			t.Error(err)
			continue
		}

		if string(b) != test.plain {
			t.Errorf("encoding error: expected %q, got %q", test.plain, b)
			continue
		}

		var sv Scalar
		err = json.Unmarshal(b, &sv)
		if err != nil {
			t.Error(err)
			continue
		}

		if sv != test.value {
			t.Errorf("decoding error: expected %v, got %v", test.value, sv)
		}
	}
}

func TestStringJSON(t *testing.T) {
	input := []struct {
		plain string
		value String
	}{
		{
			plain: `[123.456,"test"]`,
			value: String{
				Timestamp: 123456,
				Value:     "test",
			},
		},
		{
			plain: `[123123.456,"台北"]`,
			value: String{
				Timestamp: 123123456,
				Value:     "台北",
			},
		},
	}

	for _, test := range input {
		b, err := json.Marshal(test.value)
		if err != nil {
			t.Error(err)
			continue
		}

		if string(b) != test.plain {
			t.Errorf("encoding error: expected %q, got %q", test.plain, b)
			continue
		}

		var sv String
		err = json.Unmarshal(b, &sv)
		if err != nil {
			t.Error(err)
			continue
		}

		if sv != test.value {
			t.Errorf("decoding error: expected %v, got %v", test.value, sv)
		}
	}
}

func TestVectorSort(t *testing.T) {
	input := Vector{
		&Sample{
			Metric: Metric{
				MetricNameLabel: "A",
			},
			Timestamp: 1,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "A",
			},
			Timestamp: 2,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "C",
			},
			Timestamp: 1,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "C",
			},
			Timestamp: 2,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "B",
			},
			Timestamp: 3,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "B",
			},
			Timestamp: 2,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "B",
			},
			Timestamp: 1,
		},
	}

	expected := Vector{
		&Sample{
			Metric: Metric{
				MetricNameLabel: "A",
			},
			Timestamp: 1,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "A",
			},
			Timestamp: 2,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "B",
			},
			Timestamp: 1,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "B",
			},
			Timestamp: 2,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "B",
			},
			Timestamp: 3,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "C",
			},
			Timestamp: 1,
		},
		&Sample{
			Metric: Metric{
				MetricNameLabel: "C",
			},
			Timestamp: 2,
		},
	}

	sort.Sort(input)

	for i, actual := range input {
		actualFp := actual.Metric.Fingerprint()
		expectedFp := expected[i].Metric.Fingerprint()

		require.Equalf(t, expectedFp, actualFp, "%d. Incorrect fingerprint. Got %s; want %s", i, actualFp.String(), expectedFp.String())

		require.Equalf(t, actual.Timestamp, expected[i].Timestamp, "%d. Incorrect timestamp. Got %s; want %s", i, actual.Timestamp, expected[i].Timestamp)
	}
}