This ensures that docstring comments are wrapped to 80 chars. ffrank seemed to be making this mistake far too often, and it's a silly thing to look for manually. As it turns out, I've made it too, as have many others. Now we have a test that checks for most cases. There are still a few stray cases that aren't checked automatically, but this can be improved upon if someone is motivated to do so. Before anyone complains about the 80 character limit: this only checks docstring comments, not source code length or inline source code comments. There's no excuse for having docstrings that are badly reflowed or over 80 chars, particularly if you have an automated test.
78 lines
2.1 KiB
Go
78 lines
2.1 KiB
Go
// Mgmt
|
|
// Copyright (C) 2013-2020+ James Shubin and the project contributors
|
|
// Written by James Shubin <james@shubin.ca> and the project contributors
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// +build !root
|
|
|
|
package prometheus
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
// TestInitKindMetrics tests that we are initializing the Prometheus metrics
|
|
// correctly for all kinds of resources.
|
|
func TestInitKindMetrics(t *testing.T) {
|
|
var prom Prometheus
|
|
prom.Init()
|
|
prom.InitKindMetrics([]string{"file", "exec"})
|
|
|
|
// Get a list of metrics collected by Prometheus.
|
|
// This is the only way to get Prometheus metrics
|
|
// without implicitly creating them.
|
|
gatherer := prometheus.DefaultGatherer
|
|
metrics, err := gatherer.Gather()
|
|
if err != nil {
|
|
t.Errorf("error while gathering metrics: %s", err)
|
|
return
|
|
}
|
|
|
|
// expectedMetrics is a map: keys are metrics name and
|
|
// values are expected and actual count of metrics with
|
|
// that name.
|
|
expectedMetrics := map[string][2]int{
|
|
"mgmt_checkapply_total": {
|
|
16, 0,
|
|
},
|
|
"mgmt_failures_total": {
|
|
4, 0,
|
|
},
|
|
"mgmt_failures": {
|
|
4, 0,
|
|
},
|
|
"mgmt_resources": {
|
|
2, 0,
|
|
},
|
|
}
|
|
|
|
for _, metric := range metrics {
|
|
for name, count := range expectedMetrics {
|
|
if *metric.Name == name {
|
|
value := len(metric.Metric)
|
|
expectedMetrics[name] = [2]int{count[0], value}
|
|
}
|
|
}
|
|
}
|
|
|
|
for name, count := range expectedMetrics {
|
|
if count[1] != count[0] {
|
|
t.Errorf("with: %s, expected %d metrics, got %d metrics", name, count[0], count[1])
|
|
}
|
|
}
|
|
}
|