Add unit test nhcbparse_test.go

Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>

model/textparse/nhcbparse.go

@@ -124,7 +124,8 @@ func (p *NHCBParser) Exemplar(ex *exemplar.Exemplar) bool {
 }
 
 func (p *NHCBParser) CreatedTimestamp() *int64 {
-	return p.parser.CreatedTimestamp()
+	// TODO(krajorama) fix: return p.parser.CreatedTimestamp()
+	return nil
 }
 
 func (p *NHCBParser) Next() (Entry, error) {

model/textparse/nhcbparse_test.go

@@ -0,0 +1,337 @@
+// 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 textparse
+
+import (
+	"testing"
+
+	"github.com/prometheus/common/model"
+
+	"github.com/prometheus/prometheus/model/exemplar"
+	"github.com/prometheus/prometheus/model/histogram"
+	"github.com/prometheus/prometheus/model/labels"
+)
+
+func TestNhcbParserOnOpenMetricsParser(t *testing.T) {
+	input := `# HELP go_gc_duration_seconds A summary of the GC invocation durations.
+# TYPE go_gc_duration_seconds summary
+# UNIT go_gc_duration_seconds seconds
+go_gc_duration_seconds{quantile="0"} 4.9351e-05
+go_gc_duration_seconds{quantile="0.25"} 7.424100000000001e-05
+go_gc_duration_seconds{quantile="0.5",a="b"} 8.3835e-05
+# HELP nohelp1 
+# HELP help2 escape \ \n \\ \" \x chars
+# UNIT nounit 
+go_gc_duration_seconds{quantile="1.0",a="b"} 8.3835e-05
+go_gc_duration_seconds_count 99
+some:aggregate:rate5m{a_b="c"} 1
+# HELP go_goroutines Number of goroutines that currently exist.
+# TYPE go_goroutines gauge
+go_goroutines 33 123.123
+# TYPE hh histogram
+hh_bucket{le="+Inf"} 1
+# TYPE gh gaugehistogram
+gh_bucket{le="+Inf"} 1
+# TYPE hhh histogram
+hhh_bucket{le="+Inf"} 1 # {id="histogram-bucket-test"} 4
+hhh_count 1 # {id="histogram-count-test"} 4
+# TYPE ggh gaugehistogram
+ggh_bucket{le="+Inf"} 1 # {id="gaugehistogram-bucket-test",xx="yy"} 4 123.123
+ggh_count 1 # {id="gaugehistogram-count-test",xx="yy"} 4 123.123
+# TYPE smr_seconds summary
+smr_seconds_count 2.0 # {id="summary-count-test"} 1 123.321
+smr_seconds_sum 42.0 # {id="summary-sum-test"} 1 123.321
+# TYPE ii info
+ii{foo="bar"} 1
+# TYPE ss stateset
+ss{ss="foo"} 1
+ss{ss="bar"} 0
+ss{A="a"} 0
+# TYPE un unknown
+_metric_starting_with_underscore 1
+testmetric{_label_starting_with_underscore="foo"} 1
+testmetric{label="\"bar\""} 1
+# HELP foo Counter with and without labels to certify CT is parsed for both cases
+# TYPE foo counter
+foo_total 17.0 1520879607.789 # {id="counter-test"} 5
+foo_created 1520872607.123
+foo_total{a="b"} 17.0 1520879607.789 # {id="counter-test"} 5
+foo_created{a="b"} 1520872607.123
+# HELP bar Summary with CT at the end, making sure we find CT even if it's multiple lines a far
+# TYPE bar summary
+bar_count 17.0
+bar_sum 324789.3
+bar{quantile="0.95"} 123.7
+bar{quantile="0.99"} 150.0
+bar_created 1520872608.124
+# HELP baz Histogram with the same objective as above's summary
+# TYPE baz histogram
+baz_bucket{le="0.0"} 0
+baz_bucket{le="+Inf"} 17
+baz_count 17
+baz_sum 324789.3
+baz_created 1520872609.125
+# HELP fizz_created Gauge which shouldn't be parsed as CT
+# TYPE fizz_created gauge
+fizz_created 17.0
+# HELP something Histogram with _created between buckets and summary
+# TYPE something histogram
+something_count 18
+something_sum 324789.4
+something_created 1520430001
+something_bucket{le="0.0"} 1
+something_bucket{le="+Inf"} 18
+# HELP yum Summary with _created between sum and quantiles
+# TYPE yum summary
+yum_count 20
+yum_sum 324789.5
+yum_created 1520430003
+yum{quantile="0.95"} 123.7
+yum{quantile="0.99"} 150.0
+# HELP foobar Summary with _created as the first line
+# TYPE foobar summary
+foobar_count 21
+foobar_created 1520430004
+foobar_sum 324789.6
+foobar{quantile="0.95"} 123.8
+foobar{quantile="0.99"} 150.1`
+	
+	input += "\n# HELP metric foo\x00bar"
+	input += "\nnull_byte_metric{a=\"abc\x00\"} 1"
+	input += "\n# EOF\n"
+
+	exp := []expectedParse{
+		{
+			m:    "go_gc_duration_seconds",
+			help: "A summary of the GC invocation durations.",
+		}, {
+			m:   "go_gc_duration_seconds",
+			typ: model.MetricTypeSummary,
+		}, {
+			m:    "go_gc_duration_seconds",
+			unit: "seconds",
+		}, {
+			m:    `go_gc_duration_seconds{quantile="0"}`,
+			v:    4.9351e-05,
+			lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0"),
+		}, {
+			m:    `go_gc_duration_seconds{quantile="0.25"}`,
+			v:    7.424100000000001e-05,
+			lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0.25"),
+		}, {
+			m:    `go_gc_duration_seconds{quantile="0.5",a="b"}`,
+			v:    8.3835e-05,
+			lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "0.5", "a", "b"),
+		}, {
+			m:    "nohelp1",
+			help: "",
+		}, {
+			m:    "help2",
+			help: "escape \\ \n \\ \" \\x chars",
+		}, {
+			m:    "nounit",
+			unit: "",
+		}, {
+			m:    `go_gc_duration_seconds{quantile="1.0",a="b"}`,
+			v:    8.3835e-05,
+			lset: labels.FromStrings("__name__", "go_gc_duration_seconds", "quantile", "1.0", "a", "b"),
+		}, {
+			m:    `go_gc_duration_seconds_count`,
+			v:    99,
+			lset: labels.FromStrings("__name__", "go_gc_duration_seconds_count"),
+		}, {
+			m:    `some:aggregate:rate5m{a_b="c"}`,
+			v:    1,
+			lset: labels.FromStrings("__name__", "some:aggregate:rate5m", "a_b", "c"),
+		}, {
+			m:    "go_goroutines",
+			help: "Number of goroutines that currently exist.",
+		}, {
+			m:   "go_goroutines",
+			typ: model.MetricTypeGauge,
+		}, {
+			m:    `go_goroutines`,
+			v:    33,
+			t:    int64p(123123),
+			lset: labels.FromStrings("__name__", "go_goroutines"),
+		}, {
+			m:   "hh",
+			typ: model.MetricTypeHistogram,
+		}, {
+			m:    `hh{}`,
+			h:    &histogram.Histogram{
+				Schema: -53,  // Custom buckets.
+				Count: 1,
+				Sum: 0.0,
+				PositiveSpans: []histogram.Span{{Offset: 0, Length: 1}},
+				PositiveBuckets: []int64{1},
+				// Custom values are empty as we do not store the +Inf boundary.
+			},
+			lset: labels.FromStrings("__name__", "hh"),
+		}, {
+			m:   "gh",
+			typ: model.MetricTypeGaugeHistogram,
+		}, {
+			m:    `gh_bucket{le="+Inf"}`,
+			v:    1,
+			lset: labels.FromStrings("__name__", "gh_bucket", "le", "+Inf"),
+		}, {
+			m:   "hhh",
+			typ: model.MetricTypeHistogram,
+		}, {
+			m:    `hhh{}`,
+			h:    &histogram.Histogram{
+				Schema: -53,  // Custom buckets.
+				Count: 1,
+				Sum: 0.0,
+				PositiveSpans: []histogram.Span{{Offset: 0, Length: 1}},
+				PositiveBuckets: []int64{1},
+				// Custom values are empty as we do not store the +Inf boundary.
+			},
+			lset: labels.FromStrings("__name__", "hhh"),
+			// TODO(krajorama) e:    []*exemplar.Exemplar{{Labels: labels.FromStrings("id", "histogram-bucket-test"), Value: 4}},
+		}, {
+			m:   "ggh",
+			typ: model.MetricTypeGaugeHistogram,
+		}, {
+			m:    `ggh_bucket{le="+Inf"}`,
+			v:    1,
+			lset: labels.FromStrings("__name__", "ggh_bucket", "le", "+Inf"),
+			e:    []*exemplar.Exemplar{{Labels: labels.FromStrings("id", "gaugehistogram-bucket-test", "xx", "yy"), Value: 4, HasTs: true, Ts: 123123}},
+		}, {
+			m:    `ggh_count`,
+			v:    1,
+			lset: labels.FromStrings("__name__", "ggh_count"),
+			e:    []*exemplar.Exemplar{{Labels: labels.FromStrings("id", "gaugehistogram-count-test", "xx", "yy"), Value: 4, HasTs: true, Ts: 123123}},
+		}, {
+			m:   "smr_seconds",
+			typ: model.MetricTypeSummary,
+		}, {
+			m:    `smr_seconds_count`,
+			v:    2,
+			lset: labels.FromStrings("__name__", "smr_seconds_count"),
+			e:    []*exemplar.Exemplar{{Labels: labels.FromStrings("id", "summary-count-test"), Value: 1, HasTs: true, Ts: 123321}},
+		}, {
+			m:    `smr_seconds_sum`,
+			v:    42,
+			lset: labels.FromStrings("__name__", "smr_seconds_sum"),
+			e:    []*exemplar.Exemplar{{Labels: labels.FromStrings("id", "summary-sum-test"), Value: 1, HasTs: true, Ts: 123321}},
+		}, {
+			m:   "ii",
+			typ: model.MetricTypeInfo,
+		}, {
+			m:    `ii{foo="bar"}`,
+			v:    1,
+			lset: labels.FromStrings("__name__", "ii", "foo", "bar"),
+		}, {
+			m:   "ss",
+			typ: model.MetricTypeStateset,
+		}, {
+			m:    `ss{ss="foo"}`,
+			v:    1,
+			lset: labels.FromStrings("__name__", "ss", "ss", "foo"),
+		}, {
+			m:    `ss{ss="bar"}`,
+			v:    0,
+			lset: labels.FromStrings("__name__", "ss", "ss", "bar"),
+		}, {
+			m:    `ss{A="a"}`,
+			v:    0,
+			lset: labels.FromStrings("A", "a", "__name__", "ss"),
+		}, {
+			m:   "un",
+			typ: model.MetricTypeUnknown,
+		}, {
+			m:    "_metric_starting_with_underscore",
+			v:    1,
+			lset: labels.FromStrings("__name__", "_metric_starting_with_underscore"),
+		}, {
+			m:    "testmetric{_label_starting_with_underscore=\"foo\"}",
+			v:    1,
+			lset: labels.FromStrings("__name__", "testmetric", "_label_starting_with_underscore", "foo"),
+		}, {
+			m:    "testmetric{label=\"\\\"bar\\\"\"}",
+			v:    1,
+			lset: labels.FromStrings("__name__", "testmetric", "label", `"bar"`),
+		}, {
+			m:    "foo",
+			help: "Counter with and without labels to certify CT is parsed for both cases",
+		}, {
+			m:   "foo",
+			typ: model.MetricTypeCounter,
+		}, {
+			m:    "foo_total",
+			v:    17,
+			lset: labels.FromStrings("__name__", "foo_total"),
+			t:    int64p(1520879607789),
+			e:    []*exemplar.Exemplar{{Labels: labels.FromStrings("id", "counter-test"), Value: 5}},
+			ct:   int64p(1520872607123),
+		}, {
+			m:    `foo_total{a="b"}`,
+			v:    17.0,
+			lset: labels.FromStrings("__name__", "foo_total", "a", "b"),
+			t:    int64p(1520879607789),
+			e:    []*exemplar.Exemplar{{Labels: labels.FromStrings("id", "counter-test"), Value: 5}},
+			ct:   int64p(1520872607123),
+		}, {
+			m:    "bar",
+			help: "Summary with CT at the end, making sure we find CT even if it's multiple lines a far",
+		}, {
+			m:   "bar",
+			typ: model.MetricTypeSummary,
+		}, {
+			m:    "bar_count",
+			v:    17.0,
+			lset: labels.FromStrings("__name__", "bar_count"),
+			ct:   int64p(1520872608124),
+		}, {
+			m:    "bar_sum",
+			v:    324789.3,
+			lset: labels.FromStrings("__name__", "bar_sum"),
+			ct:   int64p(1520872608124),
+		}, {
+			m:    `bar{quantile="0.95"}`,
+			v:    123.7,
+			lset: labels.FromStrings("__name__", "bar", "quantile", "0.95"),
+			ct:   int64p(1520872608124),
+		}, {
+			m:    `bar{quantile="0.99"}`,
+			v:    150.0,
+			lset: labels.FromStrings("__name__", "bar", "quantile", "0.99"),
+			ct:   int64p(1520872608124),
+		}, {
+			m:    "baz",
+			help: "Histogram with the same objective as above's summary",
+		}, {
+			m:   "baz",
+			typ: model.MetricTypeHistogram,
+		}, {
+			m:    `baz{}`,
+			h:   	&histogram.Histogram{
+				Schema: -53,  // Custom buckets.
+				Count: 17,
+				Sum: 324789.3,
+				PositiveSpans: []histogram.Span{{Offset: 1, Length: 1}},  // The first bucket has 0 count so we don't store it and Offset is 1.
+				PositiveBuckets: []int64{17},
+				CustomValues: []float64{0.0},  // We do not store the +Inf boundary.
+			},
+			lset: labels.FromStrings("__name__", "baz"),
+			//ct:   int64p(1520872609125),
+		},
+	}
+
+	p := NewOpenMetricsParser([]byte(input), labels.NewSymbolTable(), WithOMParserCTSeriesSkipped())
+	p = NewNHCBParser(p, false)
+	checkParseResultsWithCT(t, p, exp, true)
+}