kubernetes gauge_test 源码
kubernetes gauge_test 代码
文件路径：/staging/src/k8s.io/component-base/metrics/gauge_test.go
/*
Copyright 2019 The Kubernetes 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 metrics
import (
"strings"
"testing"
"github.com/blang/semver/v4"
"github.com/prometheus/client_golang/prometheus/testutil"
"github.com/stretchr/testify/assert"
apimachineryversion "k8s.io/apimachinery/pkg/version"
)
func TestGauge(t *testing.T) {
v115 := semver.MustParse("1.15.0")
var tests = []struct {
desc string
*GaugeOpts
registryVersion *semver.Version
expectedMetricCount int
expectedHelp string
}{
{
desc: "Test non deprecated",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Name: "metric_test_name",
Subsystem: "subsystem",
Help: "gauge help",
},
registryVersion: &v115,
expectedMetricCount: 1,
expectedHelp: "[ALPHA] gauge help",
},
{
desc: "Test deprecated",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Name: "metric_test_name",
Subsystem: "subsystem",
Help: "gauge help",
DeprecatedVersion: "1.15.0",
},
registryVersion: &v115,
expectedMetricCount: 1,
expectedHelp: "[ALPHA] (Deprecated since 1.15.0) gauge help",
},
{
desc: "Test hidden",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Name: "metric_test_name",
Subsystem: "subsystem",
Help: "gauge help",
DeprecatedVersion: "1.14.0",
},
registryVersion: &v115,
expectedMetricCount: 0,
expectedHelp: "gauge help",
},
}
for _, test := range tests {
t.Run(test.desc, func(t *testing.T) {
registry := newKubeRegistry(apimachineryversion.Info{
Major: "1",
Minor: "15",
GitVersion: "v1.15.0-alpha-1.12345",
})
c := NewGauge(test.GaugeOpts)
registry.MustRegister(c)
ms, err := registry.Gather()
assert.Equalf(t, test.expectedMetricCount, len(ms), "Got %v metrics, Want: %v metrics", len(ms), test.expectedMetricCount)
assert.Nil(t, err, "Gather failed %v", err)
for _, metric := range ms {
assert.Equalf(t, test.expectedHelp, metric.GetHelp(), "Got %s as help message, want %s", metric.GetHelp(), test.expectedHelp)
}
// let's increment the counter and verify that the metric still works
c.Set(100)
c.Set(101)
expected := 101
ms, err = registry.Gather()
assert.Nil(t, err, "Gather failed %v", err)
for _, mf := range ms {
for _, m := range mf.GetMetric() {
assert.Equalf(t, expected, int(m.GetGauge().GetValue()), "Got %v, wanted %v as the count", m.GetGauge().GetValue(), expected)
t.Logf("%v\n", m.GetGauge().GetValue())
}
}
})
}
}
func TestGaugeVec(t *testing.T) {
v115 := semver.MustParse("1.15.0")
var tests = []struct {
desc string
*GaugeOpts
labels []string
registryVersion *semver.Version
expectedMetricCount int
expectedHelp string
}{
{
desc: "Test non deprecated",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Name: "metric_test_name",
Subsystem: "subsystem",
Help: "gauge help",
},
labels: []string{"label_a", "label_b"},
registryVersion: &v115,
expectedMetricCount: 1,
expectedHelp: "[ALPHA] gauge help",
},
{
desc: "Test deprecated",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Name: "metric_test_name",
Subsystem: "subsystem",
Help: "gauge help",
DeprecatedVersion: "1.15.0",
},
labels: []string{"label_a", "label_b"},
registryVersion: &v115,
expectedMetricCount: 1,
expectedHelp: "[ALPHA] (Deprecated since 1.15.0) gauge help",
},
{
desc: "Test hidden",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Name: "metric_test_name",
Subsystem: "subsystem",
Help: "gauge help",
DeprecatedVersion: "1.14.0",
},
labels: []string{"label_a", "label_b"},
registryVersion: &v115,
expectedMetricCount: 0,
expectedHelp: "gauge help",
},
}
for _, test := range tests {
t.Run(test.desc, func(t *testing.T) {
registry := newKubeRegistry(apimachineryversion.Info{
Major: "1",
Minor: "15",
GitVersion: "v1.15.0-alpha-1.12345",
})
c := NewGaugeVec(test.GaugeOpts, test.labels)
registry.MustRegister(c)
c.WithLabelValues("1", "2").Set(1.0)
ms, err := registry.Gather()
assert.Equalf(t, test.expectedMetricCount, len(ms), "Got %v metrics, Want: %v metrics", len(ms), test.expectedMetricCount)
assert.Nil(t, err, "Gather failed %v", err)
for _, metric := range ms {
assert.Equalf(t, test.expectedHelp, metric.GetHelp(), "Got %s as help message, want %s", metric.GetHelp(), test.expectedHelp)
}
// let's increment the counter and verify that the metric still works
c.WithLabelValues("1", "3").Set(1.0)
c.WithLabelValues("2", "3").Set(1.0)
ms, err = registry.Gather()
assert.Nil(t, err, "Gather failed %v", err)
for _, mf := range ms {
assert.Equalf(t, 3, len(mf.GetMetric()), "Got %v metrics, wanted 3 as the count", len(mf.GetMetric()))
}
})
}
}
func TestGaugeFunc(t *testing.T) {
currentVersion := apimachineryversion.Info{
Major: "1",
Minor: "17",
GitVersion: "v1.17.0-alpha-1.12345",
}
var function = func() float64 {
return 1
}
var tests = []struct {
desc string
*GaugeOpts
expectedMetrics string
}{
{
desc: "Test non deprecated",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Subsystem: "subsystem",
Name: "metric_non_deprecated",
Help: "gauge help",
},
expectedMetrics: `
# HELP namespace_subsystem_metric_non_deprecated [ALPHA] gauge help
# TYPE namespace_subsystem_metric_non_deprecated gauge
namespace_subsystem_metric_non_deprecated 1
`,
},
{
desc: "Test deprecated",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Subsystem: "subsystem",
Name: "metric_deprecated",
Help: "gauge help",
DeprecatedVersion: "1.17.0",
},
expectedMetrics: `
# HELP namespace_subsystem_metric_deprecated [ALPHA] (Deprecated since 1.17.0) gauge help
# TYPE namespace_subsystem_metric_deprecated gauge
namespace_subsystem_metric_deprecated 1
`,
},
{
desc: "Test hidden",
GaugeOpts: &GaugeOpts{
Namespace: "namespace",
Subsystem: "subsystem",
Name: "metric_hidden",
Help: "gauge help",
DeprecatedVersion: "1.16.0",
},
expectedMetrics: "",
},
}
for _, test := range tests {
tc := test
t.Run(test.desc, func(t *testing.T) {
registry := newKubeRegistry(currentVersion)
gauge := newGaugeFunc(tc.GaugeOpts, function, parseVersion(currentVersion))
if gauge != nil { // hidden metrics will not be initialize, register is not allowed
registry.RawMustRegister(gauge)
}
metricName := BuildFQName(tc.GaugeOpts.Namespace, tc.GaugeOpts.Subsystem, tc.GaugeOpts.Name)
if err := testutil.GatherAndCompare(registry, strings.NewReader(tc.expectedMetrics), metricName); err != nil {
t.Fatal(err)
}
})
}
}
func TestGaugeWithLabelValueAllowList(t *testing.T) {
labelAllowValues := map[string]string{
"namespace_subsystem_metric_allowlist_test,label_a": "allowed",
}
labels := []string{"label_a", "label_b"}
opts := &GaugeOpts{
Namespace: "namespace",
Name: "metric_allowlist_test",
Subsystem: "subsystem",
}
var tests = []struct {
desc string
labelValues [][]string
expectMetricValues map[string]float64
}{
{
desc: "Test no unexpected input",
labelValues: [][]string{{"allowed", "b1"}, {"allowed", "b2"}},
expectMetricValues: map[string]float64{
"allowed b1": 100.0,
"allowed b2": 100.0,
},
},
{
desc: "Test unexpected input",
labelValues: [][]string{{"allowed", "b1"}, {"not_allowed", "b1"}},
expectMetricValues: map[string]float64{
"allowed b1": 100.0,
"unexpected b1": 100.0,
},
},
}
for _, test := range tests {
t.Run(test.desc, func(t *testing.T) {
SetLabelAllowListFromCLI(labelAllowValues)
registry := newKubeRegistry(apimachineryversion.Info{
Major: "1",
Minor: "15",
GitVersion: "v1.15.0-alpha-1.12345",
})
g := NewGaugeVec(opts, labels)
registry.MustRegister(g)
for _, lv := range test.labelValues {
g.WithLabelValues(lv...).Set(100.0)
}
mfs, err := registry.Gather()
assert.Nil(t, err, "Gather failed %v", err)
for _, mf := range mfs {
if *mf.Name != BuildFQName(opts.Namespace, opts.Subsystem, opts.Name) {
continue
}
mfMetric := mf.GetMetric()
for _, m := range mfMetric {
var aValue, bValue string
for _, l := range m.Label {
if *l.Name == "label_a" {
aValue = *l.Value
}
if *l.Name == "label_b" {
bValue = *l.Value
}
}
labelValuePair := aValue + " " + bValue
expectedValue, ok := test.expectMetricValues[labelValuePair]
assert.True(t, ok, "Got unexpected label values, lable_a is %v, label_b is %v", aValue, bValue)
actualValue := m.GetGauge().GetValue()
assert.Equalf(t, expectedValue, actualValue, "Got %v, wanted %v as the gauge while setting label_a to %v and label b to %v", actualValue, expectedValue, aValue, bValue)
}
}
})
}
}
相关信息
相关文章
0
赞
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦