mirror of
https://github.com/akvorado/akvorado.git
synced 2025-12-12 06:24:10 +01:00
ac68c5970e
This change split the inlet component into a simpler inlet and a new outlet component. The new inlet component receive flows and put them in Kafka, unparsed. The outlet component takes them from Kafka and resume the processing from here (flow parsing, enrichment) and puts them in ClickHouse. The main goal is to ensure the inlet does a minimal work to not be late when processing packets (and restart faster). It also brings some simplification as the number of knobs to tune everything is reduced: for inlet, we only need to tune the queue size for UDP, the number of workers and a few Kafka parameters; for outlet, we need to tune a few Kafka parameters, the number of workers and a few ClickHouse parameters. The outlet component features a simple Kafka input component. The core component becomes just a callback function. There is also a new ClickHouse component to push data to ClickHouse using the low-level ch-go library with batch inserts. This processing has an impact on the internal representation of a FlowMessage. Previously, it was tailored to dynamically build the protobuf message to be put in Kafka. Now, it builds the batch request to be sent to ClickHouse. This makes the FlowMessage structure hides the content of the next batch request and therefore, it should be reused. This also changes the way we decode flows as they don't output FlowMessage anymore, they reuse one that is provided to each worker. The ClickHouse tables are slightly updated. Instead of using Kafka engine, the Null engine is used instead. Fix #1122
322 lines
11 KiB
Go
322 lines
11 KiB
Go
// SPDX-FileCopyrightText: 2022 Free Mobile
|
|
// SPDX-License-Identifier: AGPL-3.0-only
|
|
|
|
package core
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"akvorado/common/helpers"
|
|
"akvorado/common/schema"
|
|
)
|
|
|
|
func TestExporterClassifier(t *testing.T) {
|
|
cases := []struct {
|
|
Description string
|
|
Program string
|
|
ExporterInfo exporterInfo
|
|
ExpectedClassification exporterClassification
|
|
ExpectedErr bool
|
|
}{
|
|
{
|
|
Description: "trivial classifier",
|
|
Program: "false",
|
|
}, {
|
|
Description: "constant classifier",
|
|
Program: `Classify("europe")`,
|
|
ExpectedClassification: exporterClassification{Group: "europe"},
|
|
}, {
|
|
Description: "constant classifier (group)",
|
|
Program: `ClassifyGroup("europe")`,
|
|
ExpectedClassification: exporterClassification{Group: "europe"},
|
|
}, {
|
|
Description: "constant classifier (site)",
|
|
Program: `ClassifySite("paris")`,
|
|
ExpectedClassification: exporterClassification{Site: "paris"},
|
|
}, {
|
|
Description: "constant classifier (role)",
|
|
Program: `ClassifyRole("edge")`,
|
|
ExpectedClassification: exporterClassification{Role: "edge"},
|
|
}, {
|
|
Description: "constant classifier (region)",
|
|
Program: `ClassifyRegion("europe")`,
|
|
ExpectedClassification: exporterClassification{Region: "europe"},
|
|
}, {
|
|
Description: "constant classifier (tenant)",
|
|
Program: `ClassifyTenant("mobile")`,
|
|
ExpectedClassification: exporterClassification{Tenant: "mobile"},
|
|
}, {
|
|
Description: "use format in classifier",
|
|
Program: `ClassifyTenant(Format("tenant-%s", Exporter.Name))`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "roger"},
|
|
ExpectedClassification: exporterClassification{Tenant: "tenant-roger"},
|
|
}, {
|
|
Description: "access to exporter name",
|
|
Program: `Exporter.Name startsWith "expo" && Classify("europe")`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{Group: "europe"},
|
|
}, {
|
|
Description: "matches",
|
|
Program: `Exporter.Name matches "^e.p.r" && Classify("europe")`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{Group: "europe"},
|
|
}, {
|
|
Description: "multiline",
|
|
Program: `Exporter.Name matches "^e.p.r" &&
|
|
Classify("europe")`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{Group: "europe"},
|
|
}, {
|
|
Description: "regex",
|
|
Program: `ClassifyRegex(Exporter.Name, "^(e.p+).r", "europe-$1")`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{Group: "europe-exp"},
|
|
}, {
|
|
Description: "regex with class",
|
|
Program: `ClassifyRegex(Exporter.Name, "^(\\w+).r", "europe-$1")`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{Group: "europe-export"},
|
|
}, {
|
|
Description: "non-matching regex",
|
|
Program: `ClassifyRegex(Exporter.Name, "^(ebp+).r", "europe-$1")`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{Group: ""},
|
|
}, {
|
|
Description: "reject",
|
|
Program: `ClassifyTenant("mobile") && Reject()`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{Tenant: "mobile", Reject: true},
|
|
}, {
|
|
Description: "selective reject",
|
|
Program: `Exporter.Name startsWith "nothing" && Reject()`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedClassification: exporterClassification{},
|
|
}, {
|
|
Description: "faulty regex",
|
|
Program: `ClassifyRegex(Exporter.Name, "^(ebp+.r", "europe-$1")`,
|
|
ExporterInfo: exporterInfo{"127.0.0.1", "exporter"},
|
|
ExpectedErr: true,
|
|
}, {
|
|
Description: "syntax error",
|
|
Program: `Classify("europe"`,
|
|
ExpectedErr: true,
|
|
}, {
|
|
Description: "incorrect typing",
|
|
Program: `Classify(1)`,
|
|
ExpectedErr: true,
|
|
}, {
|
|
Description: "another incorrect typing",
|
|
Program: `"hello"`,
|
|
ExpectedErr: true,
|
|
}, {
|
|
Description: "inexistant function",
|
|
Program: `ClassifyStuff("blip")`,
|
|
ExpectedErr: true,
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.Description, func(t *testing.T) {
|
|
var scr ExporterClassifierRule
|
|
err := scr.UnmarshalText([]byte(tc.Program))
|
|
if !tc.ExpectedErr && err != nil {
|
|
t.Fatalf("UnmarshalText(%q) error:\n%+v", tc.Program, err)
|
|
}
|
|
if tc.ExpectedErr && err != nil {
|
|
return
|
|
}
|
|
var classification exporterClassification
|
|
err = scr.exec(tc.ExporterInfo, &classification)
|
|
if !tc.ExpectedErr && err != nil {
|
|
t.Fatalf("exec(%q) error:\n%+v", tc.Program, err)
|
|
}
|
|
if tc.ExpectedErr && err == nil {
|
|
t.Fatalf("exec(%q) no error", tc.Program)
|
|
}
|
|
if diff := helpers.Diff(classification, tc.ExpectedClassification); diff != "" {
|
|
t.Fatalf("exec(%q) (-got, +want):\n%s", tc.Program, diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestInterfaceClassifier(t *testing.T) {
|
|
cases := []struct {
|
|
Description string
|
|
Program string
|
|
ExporterInfo exporterInfo
|
|
InterfaceInfo interfaceInfo
|
|
ExpectedClassification interfaceClassification
|
|
ExpectedErr bool
|
|
}{
|
|
{
|
|
Description: "trivial classifier",
|
|
Program: "false",
|
|
}, {
|
|
Description: "constant classifier for connectivity",
|
|
Program: `ClassifyConnectivity("Transit")`,
|
|
ExpectedClassification: interfaceClassification{Connectivity: "transit"},
|
|
}, {
|
|
Description: "constant classifier for provider",
|
|
Program: `ClassifyProvider("Telia")`,
|
|
ExpectedClassification: interfaceClassification{Provider: "telia"},
|
|
}, {
|
|
Description: "constant classifier for boundary external",
|
|
Program: `ClassifyExternal()`,
|
|
ExpectedClassification: interfaceClassification{Boundary: schema.InterfaceBoundaryExternal},
|
|
}, {
|
|
Description: "constant classifier for boundary internal",
|
|
Program: `ClassifyInternal()`,
|
|
ExpectedClassification: interfaceClassification{Boundary: schema.InterfaceBoundaryInternal},
|
|
}, {
|
|
Description: "set name and description",
|
|
Program: `SetName("newname") && SetDescription("newdescription")`,
|
|
ExpectedClassification: interfaceClassification{
|
|
Name: "newname",
|
|
Description: "newdescription",
|
|
},
|
|
}, {
|
|
Description: "classify with form",
|
|
Program: `ClassifyProvider(Format("II-%s", Interface.Name))`,
|
|
InterfaceInfo: interfaceInfo{Name: "Gi0/0/0"},
|
|
ExpectedClassification: interfaceClassification{
|
|
Provider: "ii-gi000",
|
|
},
|
|
}, {
|
|
Description: "reject",
|
|
Program: `Reject()`,
|
|
ExpectedClassification: interfaceClassification{Reject: true},
|
|
}, {
|
|
Description: "use index",
|
|
InterfaceInfo: interfaceInfo{
|
|
Index: 200,
|
|
Name: "Gi0/0/0",
|
|
},
|
|
Program: `Interface.Index == 200 && Reject()`,
|
|
ExpectedClassification: interfaceClassification{Reject: true},
|
|
}, {
|
|
Description: "complex example",
|
|
Program: `
|
|
Interface.Description startsWith "Transit:" &&
|
|
ClassifyConnectivity("transit") &&
|
|
ClassifyExternal() &&
|
|
ClassifyProviderRegex(Interface.Description, "^Transit: ([^ ]+)", "$1")
|
|
`,
|
|
InterfaceInfo: interfaceInfo{
|
|
Name: "Gi0/0/0",
|
|
Description: "Transit: Telia (GWDM something something)",
|
|
Speed: 1000,
|
|
},
|
|
ExpectedClassification: interfaceClassification{
|
|
Connectivity: "transit",
|
|
Provider: "telia",
|
|
Boundary: schema.InterfaceBoundaryExternal,
|
|
},
|
|
}, {
|
|
Description: "faulty regex",
|
|
Program: `ClassifyProviderRegex(Interface.Description, "^(ebp+.r", "europe-$1")`,
|
|
InterfaceInfo: interfaceInfo{
|
|
Name: "Gi0/0/0",
|
|
Description: "Transit: Telia (GWDM something something)",
|
|
Speed: 1000,
|
|
},
|
|
ExpectedErr: true,
|
|
}, {
|
|
Description: "classify with VLANs",
|
|
Program: `Interface.VLAN == 100 && ClassifyExternal()`,
|
|
InterfaceInfo: interfaceInfo{
|
|
Name: "Gi0/0/0",
|
|
Description: "Transit: Telia (GWDM something something)",
|
|
Speed: 1000,
|
|
VLAN: 100,
|
|
},
|
|
ExpectedClassification: interfaceClassification{
|
|
Boundary: schema.InterfaceBoundaryExternal,
|
|
},
|
|
}, {
|
|
Description: "classify with another VLAN",
|
|
Program: `Interface.VLAN == 100 && ClassifyExternal()`,
|
|
InterfaceInfo: interfaceInfo{
|
|
Name: "Gi0/0/0",
|
|
Description: "Transit: Telia (GWDM something something)",
|
|
Speed: 1000,
|
|
VLAN: 200,
|
|
},
|
|
ExpectedClassification: interfaceClassification{
|
|
Boundary: schema.InterfaceBoundaryUndefined,
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.Description, func(t *testing.T) {
|
|
var scr InterfaceClassifierRule
|
|
err := scr.UnmarshalText([]byte(tc.Program))
|
|
if !tc.ExpectedErr && err != nil {
|
|
t.Fatalf("UnmarshalText(%q) error:\n%+v", tc.Program, err)
|
|
}
|
|
if tc.ExpectedErr && err != nil {
|
|
return
|
|
}
|
|
var gotClassification interfaceClassification
|
|
err = scr.exec(tc.ExporterInfo, tc.InterfaceInfo, &gotClassification)
|
|
if !tc.ExpectedErr && err != nil {
|
|
t.Fatalf("exec(%q) error:\n%+v", tc.Program, err)
|
|
}
|
|
if tc.ExpectedErr && err == nil {
|
|
t.Fatalf("exec(%q) no error", tc.Program)
|
|
}
|
|
if diff := helpers.Diff(gotClassification, tc.ExpectedClassification); diff != "" {
|
|
t.Fatalf("exec(%q) (-got, +want):\n%s", tc.Program, diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestRegexValidation(t *testing.T) {
|
|
cases := []struct {
|
|
Classifier string
|
|
Error bool
|
|
}{
|
|
{`ClassifyRegex("something", "^(ebp+).r", "europe-$1")`, false},
|
|
{`ClassifyRegex("something", "^(ebp+.r", "europe-$1")`, true},
|
|
// When non-constant string is used, we cannot detect the error
|
|
{`ClassifyRegex("something", Exporter.Name + "^(ebp+.r", "europe-$1")`, false},
|
|
}
|
|
for _, tc := range cases {
|
|
var scr ExporterClassifierRule
|
|
err := scr.UnmarshalText([]byte(tc.Classifier))
|
|
if err == nil && tc.Error {
|
|
t.Errorf("UnmarshalText(%q) should have returned an error", tc.Classifier)
|
|
}
|
|
if err != nil && !tc.Error {
|
|
t.Errorf("UnmarshalText(%q) error:\n%+v", tc.Classifier, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func BenchmarkClassifier(b *testing.B) {
|
|
program := `
|
|
Interface.Description startsWith "Transit:" &&
|
|
ClassifyConnectivity("transit") &&
|
|
ClassifyExternal() &&
|
|
ClassifyProviderRegex(Interface.Description, "^Transit: ([^ ]+)", "$1")
|
|
`
|
|
var scr InterfaceClassifierRule
|
|
if err := scr.UnmarshalText([]byte(program)); err != nil {
|
|
b.Fatalf("UnmarshalText() error:\n%+v", err)
|
|
}
|
|
ei := exporterInfo{}
|
|
ii := interfaceInfo{
|
|
Name: "Gi0/0/0",
|
|
Description: "Transit: Telia (GWDM something something)",
|
|
Speed: 1000,
|
|
}
|
|
var err error
|
|
var gotClassification interfaceClassification
|
|
for b.Loop() {
|
|
err = scr.exec(ei, ii, &gotClassification)
|
|
}
|
|
if err != nil {
|
|
b.Fatalf("exec() error:\n%+v", err)
|
|
}
|
|
}
|