prometheus/util/annotations/annotations_test.go
Jeanette Tan 023c062588 make annotations use an interface
Signed-off-by: Jeanette Tan <jeanette.tan@grafana.com>
2024-12-11 15:09:37 +08:00

109 lines
3.1 KiB
Go

// Copyright 2024 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 annotations
import (
"errors"
"fmt"
"testing"
"github.com/stretchr/testify/require"
"github.com/prometheus/prometheus/promql/parser/posrange"
)
func TestAnnotations_AsStrings(t *testing.T) {
var annos Annotations
pos := posrange.PositionRange{Start: 3, End: 8}
annos.AddRaw(errors.New("this is a non-annotation error"))
annos.Add(NewInvalidRatioWarning(1.1, 100, pos))
annos.Add(NewInvalidRatioWarning(1.2, 123, pos))
annos.Add(newTestCustomWarning(1.5, pos, 12, 14))
annos.Add(newTestCustomWarning(1.5, pos, 10, 20))
annos.Add(newTestCustomWarning(1.5, pos, 5, 15))
annos.Add(newTestCustomWarning(1.5, pos, 12, 14))
annos.Add(NewHistogramIgnoredInAggregationInfo("sum", pos))
warnings, infos := annos.AsStrings("lorem ipsum dolor sit amet", 0, 0)
require.ElementsMatch(t, warnings, []string{
"this is a non-annotation error",
"PromQL warning: ratio value should be between -1 and 1, got 1.1, capping to 100 (1:4)",
"PromQL warning: ratio value should be between -1 and 1, got 1.2, capping to 123 (1:4)",
"PromQL warning: custom value set to 1.5, 4 instances with smallest 5 and biggest 20 (1:4)",
})
require.ElementsMatch(t, infos, []string{
"PromQL info: ignored histogram in sum aggregation (1:4)",
})
}
type testCustomError struct {
PositionRange posrange.PositionRange
Err error
Query string
Min []float64
Max []float64
Count int
}
func (e *testCustomError) merge(other annoErr) annoErr {
o, ok := other.(*testCustomError)
if !ok {
return e
}
if e.Err.Error() != o.Err.Error() || len(e.Min) != len(o.Min) || len(e.Max) != len(o.Max) {
return e
}
for i, aMin := range e.Min {
if aMin < o.Min[i] {
o.Min[i] = aMin
}
}
for i, aMax := range e.Max {
if aMax > o.Max[i] {
o.Max[i] = aMax
}
}
o.Count += e.Count + 1
return o
}
func (e *testCustomError) setQuery(query string) {
e.Query = query
}
func (e *testCustomError) Error() string {
if e.Query == "" {
return e.Err.Error()
}
return fmt.Sprintf("%s, %d instances with smallest %g and biggest %g (%s)", e.Err, e.Count+1, e.Min[0], e.Max[0], e.PositionRange.StartPosInput(e.Query, 0))
}
func (e *testCustomError) Unwrap() error {
return e.Err
}
func newTestCustomWarning(q float64, pos posrange.PositionRange, smallest, largest float64) annoErr {
testCustomWarning := fmt.Errorf("%w: custom value set to", PromQLWarning)
return &testCustomError{
PositionRange: pos,
Err: fmt.Errorf("%w %g", testCustomWarning, q),
Min: []float64{smallest},
Max: []float64{largest},
}
}