File: promlint_test.go

package info (click to toggle)
golang-k8s-component-base 0.32.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,432 kB
  • sloc: makefile: 4
file content (104 lines) | stat: -rw-r--r-- 2,538 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*
Copyright 2020 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 testutil

import (
	"strings"
	"testing"
)

func TestLinter(t *testing.T) {
	var tests = []struct {
		name   string
		metric string
		expect string
	}{
		{
			name: "problematic metric should be reported",
			metric: `
				# HELP test_problematic_total [ALPHA] non-counter metrics should not have total suffix
				# TYPE test_problematic_total gauge
				test_problematic_total{some_label="some_value"} 1
				`,
			expect: `non-counter metrics should not have "_total" suffix`,
		},
		// Don't need to test metrics in exception list, they will be covered by e2e test.
		// In addition, we don't need to update this test when we remove metrics from exception list in the future.
	}

	for _, test := range tests {
		tc := test
		t.Run(tc.name, func(t *testing.T) {
			linter := NewPromLinter(strings.NewReader(tc.metric))
			problems, err := linter.Lint()
			if err != nil {
				t.Fatalf("unexpected error: %v", err)
			}

			if len(problems) == 0 {
				t.Fatalf("expecte a problem but got none")
			}

			if problems[0].Text != tc.expect {
				t.Fatalf("expect: %s, but got: %s", tc.expect, problems[0])
			}
		})
	}
}

func TestMergeProblems(t *testing.T) {
	problemOne := Problem{
		Metric: "metric_one",
		Text:   "problem one",
	}
	problemTwo := Problem{
		Metric: "metric_two",
		Text:   "problem two",
	}

	var tests = []struct {
		name     string
		problems []Problem
		expected string
	}{
		{
			name:     "no problem",
			problems: nil,
			expected: "",
		},
		{
			name:     "one problem",
			problems: []Problem{problemOne},
			expected: "metric_one:problem one",
		},
		{
			name:     "more than one problem",
			problems: []Problem{problemOne, problemTwo},
			expected: "metric_one:problem one,metric_two:problem two",
		},
	}

	for _, test := range tests {
		tc := test
		t.Run(tc.name, func(t *testing.T) {
			got := mergeProblems(tc.problems)
			if tc.expected != got {
				t.Errorf("expected: %s, but got: %s", tc.expected, got)
			}
		})
	}
}