From dc79bd60935b46c7a47b0e82d34db3912cca0083 Mon Sep 17 00:00:00 2001 From: beorn7 Date: Sat, 25 Apr 2020 15:59:53 +0200 Subject: [PATCH] Improve various comments Signed-off-by: beorn7 --- prometheus/testutil/lint.go | 6 +++--- prometheus/testutil/lint_test.go | 5 +++-- prometheus/testutil/promlint/promlint.go | 5 +++++ prometheus/testutil/testutil.go | 4 ++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/prometheus/testutil/lint.go b/prometheus/testutil/lint.go index 1e006f3..7681877 100644 --- a/prometheus/testutil/lint.go +++ b/prometheus/testutil/lint.go @@ -20,9 +20,9 @@ import ( "github.com/prometheus/client_golang/prometheus/testutil/promlint" ) -// CollectAndLint registers the provided Collector with a newly created -// pedantic Registry. It then does the same as GatherAndLint, gathering the -// metrics from the pedantic Registry. +// CollectAndLint registers the provided Collector with a newly created pedantic +// Registry. It then calls GatherAndLint with that Registry and with the +// provided metricNames. func CollectAndLint(c prometheus.Collector, metricNames ...string) ([]promlint.Problem, error) { reg := prometheus.NewPedanticRegistry() if err := reg.Register(c); err != nil { diff --git a/prometheus/testutil/lint_test.go b/prometheus/testutil/lint_test.go index 1230cc6..547465d 100644 --- a/prometheus/testutil/lint_test.go +++ b/prometheus/testutil/lint_test.go @@ -63,8 +63,9 @@ func TestCollectAndLintBad(t *testing.T) { if len(problems) < 5 { // The exact nature of the lint problems found is tested within // the promlint package itself. Here we only want to make sure - // that the collector successfully hit the linter and got enough - // problems flagged. + // that the collector successfully hits the linter and that at + // least the five problems that the linter could recognize at + // the time of writing this test are flagged. t.Error("Not enough lint problems found.") } } diff --git a/prometheus/testutil/promlint/promlint.go b/prometheus/testutil/promlint/promlint.go index 18ca942..e48e4d4 100644 --- a/prometheus/testutil/promlint/promlint.go +++ b/prometheus/testutil/promlint/promlint.go @@ -29,6 +29,11 @@ import ( // A Linter is a Prometheus metrics linter. It identifies issues with metric // names, types, and metadata, and reports them to the caller. type Linter struct { + // The linter will read metrics in the Prometheus text format from r and + // then lint it, _and_ it will lint the metrics provided directly as + // MetricFamily proto messages in mfs. Note, however, that the current + // constructor functions New and NewWithMetricFamilies only ever set one + // of them. r io.Reader mfs []*dto.MetricFamily } diff --git a/prometheus/testutil/testutil.go b/prometheus/testutil/testutil.go index 0e32d9d..c47373c 100644 --- a/prometheus/testutil/testutil.go +++ b/prometheus/testutil/testutil.go @@ -140,8 +140,8 @@ func CollectAndCount(c prometheus.Collector) int { } // CollectAndCompare registers the provided Collector with a newly created -// pedantic Registry. It then does the same as GatherAndCompare, gathering the -// metrics from the pedantic Registry. +// pedantic Registry. It then calls GatherAndCompare with that Registry and with +// the provided metricNames. func CollectAndCompare(c prometheus.Collector, expected io.Reader, metricNames ...string) error { reg := prometheus.NewPedanticRegistry() if err := reg.Register(c); err != nil {