VictoriaMetrics/lib/protoparser/graphite/parser_test.go
Aliaksandr Valialkin 74affa3aec
lib/protoparser/graphite: follow-up for 476faf5578
- Clarify the description of -graphite.sanitizeMetricName command-line flag at README.md
- Do not sanitize tag values - only metric names and tag names must be sanitized,
  since they are treated specially by Grafana. Grafana doesn't apply any restrictions on tag values.
- Properly replace more than two consecutive dots with a single dot.
- Disallow unicode letters in metric names and tag names, since neither Prometheus nor Grafana
  do not support them.

Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6489
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/6077
2024-07-17 12:41:55 +02:00

424 lines
7.3 KiB
Go

package graphite
import (
"reflect"
"testing"
)
func TestUnmarshalMetricAndTags_Failure(t *testing.T) {
f := func(s string) {
t.Helper()
var r Row
_, err := r.UnmarshalMetricAndTags(s, nil)
if err == nil {
t.Fatalf("expecting non-nil error for UnmarshalMetricAndTags(%q)", s)
}
}
f("")
f(";foo=bar")
}
func TestUnmarshalMetricAndTags_Success(t *testing.T) {
f := func(s string, rExpected *Row) {
t.Helper()
var r Row
_, err := r.UnmarshalMetricAndTags(s, nil)
if err != nil {
t.Fatalf("unexpected error in UnmarshalMetricAndTags(%q): %s", s, err)
}
if !reflect.DeepEqual(&r, rExpected) {
t.Fatalf("unexpected row;\ngot\n%+v\nwant\n%+v", &r, rExpected)
}
}
f(" ", &Row{
Metric: " ",
})
f("foo ;bar=baz", &Row{
Metric: "foo ",
Tags: []Tag{
{
Key: "bar",
Value: "baz",
},
},
})
f("f oo;bar=baz", &Row{
Metric: "f oo",
Tags: []Tag{
{
Key: "bar",
Value: "baz",
},
},
})
f("foo;bar=baz ", &Row{
Metric: "foo",
Tags: []Tag{
{
Key: "bar",
Value: "baz ",
},
},
})
f("foo;bar= baz", &Row{
Metric: "foo",
Tags: []Tag{
{
Key: "bar",
Value: " baz",
},
},
})
f("foo;bar=b az", &Row{
Metric: "foo",
Tags: []Tag{
{
Key: "bar",
Value: "b az",
},
},
})
f("foo;b ar=baz", &Row{
Metric: "foo",
Tags: []Tag{
{
Key: "b ar",
Value: "baz",
},
},
})
f("foo", &Row{
Metric: "foo",
})
f("foo;bar=123;baz=aa=bb", &Row{
Metric: "foo",
Tags: []Tag{
{
Key: "bar",
Value: "123",
},
{
Key: "baz",
Value: "aa=bb",
},
},
})
}
func TestRowsUnmarshal_Failure(t *testing.T) {
f := func(s string) {
t.Helper()
var rows Rows
rows.Unmarshal(s)
if len(rows.Rows) != 0 {
t.Fatalf("unexpected number of rows parsed; got %d; want 0", len(rows.Rows))
}
// Try again
rows.Unmarshal(s)
if len(rows.Rows) != 0 {
t.Fatalf("unexpected number of rows parsed; got %d; want 0", len(rows.Rows))
}
}
// Missing value
f("aaa")
// invalid value
f("aa bb")
// invalid timestamp
f("aa 123 bar")
}
func TestRowsUnmarshal_SanitizeMetricNamesSuccess(t *testing.T) {
f := func(s string, rowsExpected *Rows) {
t.Helper()
sanitizeMetricNameOrig := *sanitizeMetricName
*sanitizeMetricName = true
defer func() {
*sanitizeMetricName = sanitizeMetricNameOrig
}()
var rows Rows
rows.Unmarshal(s)
if !reflect.DeepEqual(rows.Rows, rowsExpected.Rows) {
t.Fatalf("unexpected rows;\ngot\n%+v;\nwant\n%+v", rows.Rows, rowsExpected.Rows)
}
}
// Only metric name.
f(`foo...b..a.r\a--baz 123`, &Rows{
Rows: []Row{{
Metric: `foo.b.a.r_a__baz`,
Value: 123,
}},
})
// Metric name with tags.
// Tag values shouldn't be sanitized.
f(`s a;ta g..1=a-b..c;tag2 123 456`, &Rows{
Rows: []Row{{
Metric: `s_a`,
Value: 123,
Timestamp: 456,
Tags: []Tag{
{
Key: "ta_g.1",
Value: "a-b..c",
},
},
}},
})
}
func TestRowsUnmarshal_Success(t *testing.T) {
f := func(s string, rowsExpected *Rows) {
t.Helper()
var rows Rows
rows.Unmarshal(s)
if !reflect.DeepEqual(rows.Rows, rowsExpected.Rows) {
t.Fatalf("unexpected rows;\ngot\n%+v;\nwant\n%+v", rows.Rows, rowsExpected.Rows)
}
// Try unmarshaling again
rows.Unmarshal(s)
if !reflect.DeepEqual(rows.Rows, rowsExpected.Rows) {
t.Fatalf("unexpected rows on second unmarshal;\ngot\n%+v;\nwant\n%+v", rows.Rows, rowsExpected.Rows)
}
rows.Reset()
if len(rows.Rows) != 0 {
t.Fatalf("non-empty rows after reset: %+v", rows.Rows)
}
}
// Empty line
f("", &Rows{})
f("\r", &Rows{})
f("\n\n", &Rows{})
f("\n\r\n", &Rows{})
// Single line
f(" 123 455", &Rows{
Rows: []Row{{
Metric: "123",
Value: 455,
}},
})
f("foobar -123.456 789", &Rows{
Rows: []Row{{
Metric: "foobar",
Value: -123.456,
Timestamp: 789,
}},
})
f("foo.bar 123.456 789\n", &Rows{
Rows: []Row{{
Metric: "foo.bar",
Value: 123.456,
Timestamp: 789,
}},
})
// Whitespace in metric name, tag name and tag value
// See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3102
f("s a;ta g1=aaa1;tag2=bb b2;tag3 1 23", &Rows{
Rows: []Row{{
Metric: "s a",
Value: 1,
Timestamp: 23,
Tags: []Tag{
{
Key: "ta g1",
Value: "aaa1",
},
{
Key: "tag2",
Value: "bb b2",
},
},
}},
})
// Missing timestamp
f("aaa 1123", &Rows{
Rows: []Row{{
Metric: "aaa",
Value: 1123,
}},
})
f("aaa 1123 -1", &Rows{
Rows: []Row{{
Metric: "aaa",
Value: 1123,
Timestamp: -1,
}},
})
// Timestamp bigger than 1<<31
f("aaa 1123 429496729600", &Rows{
Rows: []Row{{
Metric: "aaa",
Value: 1123,
Timestamp: 429496729600,
}},
})
// Floating-point timestamp
// See https://github.com/graphite-project/carbon/blob/b0ba62a62d40a37950fed47a8f6ae6d0f02e6af5/lib/carbon/protocols.py#L197
f("aaa 1123 4294.943", &Rows{
Rows: []Row{{
Metric: "aaa",
Value: 1123,
Timestamp: 4294,
}},
})
// Tags
f("foo;bar=baz 1 2", &Rows{
Rows: []Row{{
Metric: "foo",
Tags: []Tag{{
Key: "bar",
Value: "baz",
}},
Value: 1,
Timestamp: 2,
}},
})
// Empty tags
// See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1100
f("foo; 1", &Rows{
Rows: []Row{{
Metric: "foo",
Tags: []Tag{},
Value: 1,
}},
})
f("foo; 1 2", &Rows{
Rows: []Row{{
Metric: "foo",
Tags: []Tag{},
Value: 1,
Timestamp: 2,
}},
})
// Empty tag name or value
f("foo;bar 1 2", &Rows{
Rows: []Row{{
Metric: "foo",
Tags: []Tag{},
Value: 1,
Timestamp: 2,
}},
})
f("foo;bar=baz;aa=;x=y;=z 1 2", &Rows{
Rows: []Row{{
Metric: "foo",
Tags: []Tag{
{
Key: "bar",
Value: "baz",
},
{
Key: "x",
Value: "y",
},
},
Value: 1,
Timestamp: 2,
}},
})
// Multi lines
f("foo 0.3 2\naaa 3\nbar.baz 0.34 43\n", &Rows{
Rows: []Row{
{
Metric: "foo",
Value: 0.3,
Timestamp: 2,
},
{
Metric: "aaa",
Value: 3,
},
{
Metric: "bar.baz",
Value: 0.34,
Timestamp: 43,
},
},
})
// Multi lines with invalid line
f("foo 0.3 2\naaa\nbar.baz 0.34 43\n", &Rows{
Rows: []Row{
{
Metric: "foo",
Value: 0.3,
Timestamp: 2,
},
{
Metric: "bar.baz",
Value: 0.34,
Timestamp: 43,
},
},
})
// With tab as separator
// See https://github.com/grobian/carbon-c-relay/commit/f3ffe6cc2b52b07d14acbda649ad3fd6babdd528
f("foo.baz\t125.456\t1789\n", &Rows{
Rows: []Row{{
Metric: "foo.baz",
Value: 125.456,
Timestamp: 1789,
}},
})
// With tab as separator and tags
f("foo;baz=bar;bb=;y=x;=z\t1\t2", &Rows{
Rows: []Row{{
Metric: "foo",
Tags: []Tag{
{
Key: "baz",
Value: "bar",
},
{
Key: "y",
Value: "x",
},
},
Value: 1,
Timestamp: 2,
}},
})
// Whitespace after the timestamp
// See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1865
f("foo.baz 125 1789 \na 1.34 567\t ", &Rows{
Rows: []Row{
{
Metric: "foo.baz",
Value: 125,
Timestamp: 1789,
},
{
Metric: "a",
Value: 1.34,
Timestamp: 567,
},
},
})
// Multiple whitespaces as separators
f("foo.baz \t125 1789 \t\n", &Rows{
Rows: []Row{{
Metric: "foo.baz",
Value: 125,
Timestamp: 1789,
}},
})
}