Files
akvorado/outlet/core/enricher_test.go
Vincent Bernat ac68c5970e inlet: split inlet into new inlet and outlet
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
2025-07-27 21:44:28 +02:00

846 lines
29 KiB
Go

// SPDX-FileCopyrightText: 2022 Free Mobile
// SPDX-License-Identifier: AGPL-3.0-only
package core
import (
"bytes"
"encoding/gob"
"fmt"
"net/netip"
"sync"
"testing"
"time"
"github.com/gin-gonic/gin"
"github.com/go-viper/mapstructure/v2"
"google.golang.org/protobuf/proto"
"akvorado/common/daemon"
"akvorado/common/helpers"
"akvorado/common/httpserver"
"akvorado/common/pb"
"akvorado/common/reporter"
"akvorado/common/schema"
"akvorado/outlet/clickhouse"
"akvorado/outlet/flow"
"akvorado/outlet/kafka"
"akvorado/outlet/metadata"
"akvorado/outlet/routing"
)
func TestEnrich(t *testing.T) {
cases := []struct {
Name string
Configuration gin.H
InputFlow func() *schema.FlowMessage
OutputFlow *schema.FlowMessage
}{
{
Name: "no rule",
Configuration: gin.H{},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "no rule, override sampling rate",
Configuration: gin.H{"overridesamplingrate": gin.H{
"192.0.2.0/24": 100,
"192.0.2.128/25": 500,
"192.0.2.141/32": 1000,
}},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 500,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "no rule, no sampling rate, default is one value",
Configuration: gin.H{"defaultsamplingrate": 500},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 500,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "no rule, no sampling rate, default is map",
Configuration: gin.H{"defaultsamplingrate": gin.H{
"192.0.2.0/24": 100,
"192.0.2.128/25": 500,
"192.0.2.141/32": 1000,
}},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 500,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "exporter rule",
Configuration: gin.H{
"exporterclassifiers": []string{
`Exporter.Name startsWith "hello" && ClassifyRegion("europe")`,
`Exporter.Name startsWith "192_" && ClassifyRegion("asia")`,
`ClassifyRegion("other") && ClassifySite("unknown") && ClassifyTenant("alfred")`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnExporterRegion: "asia",
schema.ColumnExporterTenant: "alfred",
schema.ColumnExporterSite: "unknown",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "exporter rule with an error",
Configuration: gin.H{
"exporterclassifiers": []string{
`ClassifyTenant("alfred")`,
`Exporter.Name > "hello"`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnExporterTenant: "alfred",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "exporter rule with reject",
Configuration: gin.H{
"exporterclassifiers": []string{
`Reject()`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: nil,
}, {
Name: "interface rule with reject",
Configuration: gin.H{
"interfaceclassifiers": []string{
`Reject()`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: nil,
}, {
Name: "interface rule with index",
Configuration: gin.H{
"interfaceclassifiers": []string{
`Interface.Index == 100 && ClassifyProvider("index1")`,
`Interface.Index == 200 && ClassifyProvider("index2")`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfProvider: "index1",
schema.ColumnOutIfProvider: "index2",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "interface rule with rename",
Configuration: gin.H{
"interfaceclassifiers": []string{
`Interface.Name == "Gi0/0/100" && SetName("eth100")`,
`Interface.Name == "Gi0/0/200" && SetDescription("Super Speed")`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "eth100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Super Speed",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "interface rule with VLAN",
Configuration: gin.H{
"interfaceclassifiers": []string{
`Interface.VLAN > 200 && SetName(Format("%s.%d", Interface.Name, Interface.VLAN))`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
SrcVlan: 10,
DstVlan: 300,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
SrcVlan: 10,
DstVlan: 300,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200.300",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
},
},
}, {
Name: "interface rule",
Configuration: gin.H{
"interfaceclassifiers": []string{
`
Interface.Description startsWith "Transit:" &&
ClassifyConnectivity("transit") &&
ClassifyExternal() &&
ClassifyProviderRegex(Interface.Description, "^Transit: ([^ ]+)", "$1")`,
`ClassifyInternal()`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
schema.ColumnInIfBoundary: schema.InterfaceBoundaryInternal,
schema.ColumnOutIfBoundary: schema.InterfaceBoundaryInternal,
},
},
}, {
Name: "configure twice boundary",
Configuration: gin.H{
"interfaceclassifiers": []string{
`ClassifyInternal()`,
`ClassifyExternal()`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
schema.ColumnInIfBoundary: 2, // Internal
schema.ColumnOutIfBoundary: 2,
},
},
}, {
Name: "configure twice provider",
Configuration: gin.H{
"interfaceclassifiers": []string{
`ClassifyProvider("telia")`,
`ClassifyProvider("cogent")`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
schema.ColumnInIfProvider: "telia",
schema.ColumnOutIfProvider: "telia",
},
},
}, {
Name: "classify depending on description",
Configuration: gin.H{
"interfaceclassifiers": []string{
`ClassifyProvider("Othello")`,
`ClassifyConnectivityRegex(Interface.Description, " (1\\d+)$", "P$1") && ClassifyExternal()`,
`ClassifyInternal() && ClassifyConnectivity("core")`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
schema.ColumnInIfConnectivity: "p100",
schema.ColumnOutIfConnectivity: "core",
schema.ColumnInIfProvider: "othello",
schema.ColumnOutIfProvider: "othello",
schema.ColumnInIfBoundary: 1, // external
schema.ColumnOutIfBoundary: 2, // internal
},
},
},
{
Name: "use metatada instead of classifier",
Configuration: gin.H{
"interfaceclassifiers": []string{
`ClassifyProvider("Othello")`,
`ClassifyConnectivityRegex(Interface.Description, " (1\\d+)$", "P$1") && ClassifyExternal()`,
`ClassifyInternal() && ClassifyConnectivity("core")`,
},
},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 1010,
OutIf: 2010,
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 1010,
OutIf: 2010,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnExporterGroup: "metadata group",
schema.ColumnExporterRegion: "metadata region",
schema.ColumnExporterRole: "metadata role",
schema.ColumnExporterSite: "metadata site",
schema.ColumnExporterTenant: "metadata tenant",
schema.ColumnInIfName: "Gi0/0/1010",
schema.ColumnOutIfName: "Gi0/0/2010",
schema.ColumnInIfDescription: "Interface 1010",
schema.ColumnOutIfDescription: "Interface 2010",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
schema.ColumnInIfConnectivity: "p1010",
schema.ColumnOutIfConnectivity: "metadata connectivity",
schema.ColumnInIfProvider: "othello",
schema.ColumnOutIfProvider: "metadata provider",
schema.ColumnInIfBoundary: schema.InterfaceBoundaryExternal,
schema.ColumnOutIfBoundary: schema.InterfaceBoundaryExternal,
},
},
},
{
Name: "use data from routing",
Configuration: gin.H{},
InputFlow: func() *schema.FlowMessage {
return &schema.FlowMessage{
SamplingRate: 1000,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
InIf: 100,
OutIf: 200,
SrcAddr: netip.MustParseAddr("::ffff:192.0.2.142"),
DstAddr: netip.MustParseAddr("::ffff:192.0.2.10"),
}
},
OutputFlow: &schema.FlowMessage{
SamplingRate: 1000,
InIf: 100,
OutIf: 200,
ExporterAddress: netip.MustParseAddr("::ffff:192.0.2.142"),
SrcAddr: netip.MustParseAddr("::ffff:192.0.2.142"),
DstAddr: netip.MustParseAddr("::ffff:192.0.2.10"),
SrcAS: 1299,
DstAS: 174,
SrcNetMask: 27,
DstNetMask: 27,
OtherColumns: map[schema.ColumnKey]interface{}{
schema.ColumnExporterName: "192_0_2_142",
schema.ColumnInIfName: "Gi0/0/100",
schema.ColumnOutIfName: "Gi0/0/200",
schema.ColumnInIfDescription: "Interface 100",
schema.ColumnOutIfDescription: "Interface 200",
schema.ColumnInIfSpeed: 1000,
schema.ColumnOutIfSpeed: 1000,
schema.ColumnDstASPath: []uint32{64200, 1299, 174},
schema.ColumnDstCommunities: []uint32{100, 200, 400},
schema.ColumnDstLargeCommunities: []schema.UInt128{
{High: 64200, Low: (uint64(2) << 32) + uint64(3)},
},
},
},
},
}
for _, tc := range cases {
t.Run(tc.Name, func(t *testing.T) {
r := reporter.NewMock(t)
// Prepare all components.
daemonComponent := daemon.NewMock(t)
metadataComponent := metadata.NewMock(t, r, metadata.DefaultConfiguration(),
metadata.Dependencies{Daemon: daemonComponent})
flowComponent, err := flow.New(r, flow.Dependencies{Schema: schema.NewMock(t)})
if err != nil {
t.Fatalf("flow.New() error:\n%+v", err)
}
httpComponent := httpserver.NewMock(t, r)
routingComponent := routing.NewMock(t, r)
routingComponent.PopulateRIB(t)
kafkaComponent, incoming := kafka.NewMock(t, kafka.DefaultConfiguration())
var clickhouseMessages []*schema.FlowMessage
var clickhouseMessagesMutex sync.Mutex
clickhouseComponent := clickhouse.NewMock(t, func(msg *schema.FlowMessage) {
clickhouseMessagesMutex.Lock()
defer clickhouseMessagesMutex.Unlock()
clickhouseMessages = append(clickhouseMessages, msg)
})
// Prepare a configuration
configuration := DefaultConfiguration()
decoder, err := mapstructure.NewDecoder(helpers.GetMapStructureDecoderConfig(&configuration))
if err != nil {
t.Fatalf("NewDecoder() error:\n%+v", err)
}
if err := decoder.Decode(tc.Configuration); err != nil {
t.Fatalf("Decode() error:\n%+v", err)
}
// Instantiate and start core
c, err := New(r, configuration, Dependencies{
Daemon: daemonComponent,
Flow: flowComponent,
Metadata: metadataComponent,
Kafka: kafkaComponent,
ClickHouse: clickhouseComponent,
HTTP: httpComponent,
Routing: routingComponent,
Schema: schema.NewMock(t),
})
if err != nil {
t.Fatalf("New() error:\n%+v", err)
}
helpers.StartStop(t, c)
clickhouseMessagesMutex.Lock()
clickhouseMessages = clickhouseMessages[:0]
clickhouseMessagesMutex.Unlock()
inputFlow := tc.InputFlow()
var buf bytes.Buffer
encoder := gob.NewEncoder(&buf)
if err := encoder.Encode(inputFlow); err != nil {
t.Fatalf("gob.Encode() error: %v", err)
}
rawFlow := &pb.RawFlow{
TimeReceived: uint64(time.Now().Unix()),
Payload: buf.Bytes(),
SourceAddress: inputFlow.ExporterAddress.AsSlice(),
UseSourceAddress: false,
Decoder: pb.RawFlow_DECODER_GOB,
TimestampSource: pb.RawFlow_TS_INPUT,
}
data, err := proto.Marshal(rawFlow)
if err != nil {
t.Fatalf("proto.Marshal() error: %v", err)
}
// Test twice to check cache behavior
incoming <- data
time.Sleep(100 * time.Millisecond)
incoming <- data
time.Sleep(100 * time.Millisecond)
clickhouseMessagesMutex.Lock()
clickhouseMessagesLen := len(clickhouseMessages)
var lastMessage *schema.FlowMessage
if clickhouseMessagesLen > 0 {
lastMessage = clickhouseMessages[clickhouseMessagesLen-1]
}
clickhouseMessagesMutex.Unlock()
if tc.OutputFlow != nil && clickhouseMessagesLen > 0 {
if diff := helpers.Diff(lastMessage, tc.OutputFlow); diff != "" {
t.Errorf("Enriched flow differs (-got, +want):\n%s", diff)
}
}
gotMetrics := r.GetMetrics("akvorado_outlet_core_", "-processing_", "flows_", "received_", "forwarded_")
expectedMetrics := map[string]string{
`flows_errors_total{error="SNMP cache miss",exporter="192.0.2.142"}`: "1",
`flows_http_clients`: "0",
`received_flows_total{exporter="192.0.2.142"}`: "2",
`received_raw_flows_total`: "2",
}
if tc.OutputFlow != nil {
expectedMetrics[`forwarded_flows_total{exporter="192.0.2.142"}`] = "1"
}
if diff := helpers.Diff(gotMetrics, expectedMetrics); diff != "" {
t.Fatalf("Metrics (-got, +want):\n%s", diff)
}
})
}
}
func TestGetASNumber(t *testing.T) {
cases := []struct {
Pos helpers.Pos
Addr string
FlowAS uint32
BMPAS uint32
Providers []ASNProvider
Expected uint32
}{
// 1
{helpers.Mark(), "1.0.0.1", 12322, 0, []ASNProvider{ASNProviderFlow}, 12322},
{helpers.Mark(), "::ffff:1.0.0.1", 12322, 0, []ASNProvider{ASNProviderFlow}, 12322},
{helpers.Mark(), "1.0.0.1", 65536, 0, []ASNProvider{ASNProviderFlow}, 65536},
{helpers.Mark(), "1.0.0.1", 65536, 0, []ASNProvider{ASNProviderFlowExceptPrivate}, 0},
{helpers.Mark(), "1.0.0.1", 4_200_000_121, 0, []ASNProvider{ASNProviderFlowExceptPrivate}, 0},
{helpers.Mark(), "1.0.0.1", 65536, 0, []ASNProvider{ASNProviderFlowExceptPrivate, ASNProviderFlow}, 65536},
{helpers.Mark(), "1.0.0.1", 12322, 0, []ASNProvider{ASNProviderFlowExceptPrivate}, 12322},
// 10
{helpers.Mark(), "192.0.2.2", 12322, 174, []ASNProvider{ASNProviderRouting}, 174},
{helpers.Mark(), "192.0.2.129", 12322, 1299, []ASNProvider{ASNProviderRouting}, 1299},
{helpers.Mark(), "192.0.2.254", 12322, 0, []ASNProvider{ASNProviderRouting}, 0},
{helpers.Mark(), "1.0.0.1", 12322, 65300, []ASNProvider{ASNProviderRouting}, 65300},
{helpers.Mark(), "1.0.0.1", 12322, 65300, []ASNProvider{ASNProviderGeoIP, ASNProviderRouting}, 0},
}
for _, tc := range cases {
t.Run(fmt.Sprintf("case %s", tc.Pos), func(t *testing.T) {
r := reporter.NewMock(t)
// We don't need all components as we won't start the component.
configuration := DefaultConfiguration()
configuration.ASNProviders = tc.Providers
routingComponent := routing.NewMock(t, r)
routingComponent.PopulateRIB(t)
c, err := New(r, configuration, Dependencies{
Daemon: daemon.NewMock(t),
Routing: routingComponent,
Schema: schema.NewMock(t),
})
if err != nil {
t.Fatalf("%sNew() error:\n%+v", tc.Pos, err)
}
got := c.getASNumber(tc.FlowAS, tc.BMPAS)
if diff := helpers.Diff(got, tc.Expected); diff != "" {
t.Fatalf("%sgetASNumber() (-got, +want):\n%s", tc.Pos, diff)
}
})
}
}
func TestGetNetMask(t *testing.T) {
cases := []struct {
Pos helpers.Pos
FlowNetMask uint8
BMPNetMask uint8
Providers []NetProvider
Expected uint8
}{
// Flow
{helpers.Mark(), 0, 0, []NetProvider{NetProviderFlow}, 0},
{helpers.Mark(), 32, 0, []NetProvider{NetProviderFlow}, 32},
{helpers.Mark(), 0, 16, []NetProvider{NetProviderFlow}, 0},
// BMP
{helpers.Mark(), 0, 0, []NetProvider{NetProviderRouting}, 0},
{helpers.Mark(), 32, 12, []NetProvider{NetProviderRouting}, 12},
{helpers.Mark(), 0, 16, []NetProvider{NetProviderRouting}, 16},
{helpers.Mark(), 24, 0, []NetProvider{NetProviderRouting}, 0},
// Both, the first provider with a non-default route is taken
{helpers.Mark(), 0, 0, []NetProvider{NetProviderRouting, NetProviderFlow}, 0},
{helpers.Mark(), 12, 0, []NetProvider{NetProviderRouting, NetProviderFlow}, 12},
{helpers.Mark(), 0, 13, []NetProvider{NetProviderRouting, NetProviderFlow}, 13},
{helpers.Mark(), 12, 0, []NetProvider{NetProviderRouting, NetProviderFlow}, 12},
{helpers.Mark(), 12, 24, []NetProvider{NetProviderRouting, NetProviderFlow}, 24},
{helpers.Mark(), 0, 0, []NetProvider{NetProviderFlow, NetProviderRouting}, 0},
{helpers.Mark(), 12, 0, []NetProvider{NetProviderFlow, NetProviderRouting}, 12},
{helpers.Mark(), 0, 13, []NetProvider{NetProviderFlow, NetProviderRouting}, 13},
{helpers.Mark(), 12, 0, []NetProvider{NetProviderFlow, NetProviderRouting}, 12},
{helpers.Mark(), 12, 24, []NetProvider{NetProviderFlow, NetProviderRouting}, 12},
}
for _, tc := range cases {
t.Run(fmt.Sprintf("case %s", tc.Pos), func(t *testing.T) {
r := reporter.NewMock(t)
// We don't need all components as we won't start the component.
configuration := DefaultConfiguration()
configuration.NetProviders = tc.Providers
routingComponent := routing.NewMock(t, r)
routingComponent.PopulateRIB(t)
c, err := New(r, configuration, Dependencies{
Daemon: daemon.NewMock(t),
Routing: routingComponent,
Schema: schema.NewMock(t),
})
if err != nil {
t.Fatalf("New() error:\n%+v", err)
}
got := c.getNetMask(tc.FlowNetMask, uint8(tc.BMPNetMask))
if diff := helpers.Diff(got, tc.Expected); diff != "" {
t.Fatalf("getNetMask() (-got, +want):\n%s", diff)
}
})
}
}
func TestGetNextHop(t *testing.T) {
nh1 := netip.MustParseAddr("2001:db8::1")
nh2 := netip.MustParseAddr("2001:db8::2")
cases := []struct {
Pos helpers.Pos
FlowNextHop netip.Addr
RoutingNextHop netip.Addr
Providers []NetProvider
Expected netip.Addr
}{
// Flow
{helpers.Mark(), netip.IPv6Unspecified(), netip.IPv6Unspecified(), []NetProvider{NetProviderFlow}, netip.IPv6Unspecified()},
{helpers.Mark(), nh1, netip.IPv6Unspecified(), []NetProvider{NetProviderFlow}, nh1},
{helpers.Mark(), netip.IPv6Unspecified(), nh1, []NetProvider{NetProviderFlow}, netip.IPv6Unspecified()},
// Routing
{helpers.Mark(), netip.IPv6Unspecified(), netip.IPv6Unspecified(), []NetProvider{NetProviderRouting}, netip.IPv6Unspecified()},
{helpers.Mark(), nh1, netip.IPv6Unspecified(), []NetProvider{NetProviderRouting}, netip.IPv6Unspecified()},
{helpers.Mark(), netip.IPv6Unspecified(), nh1, []NetProvider{NetProviderRouting}, nh1},
// Both
{helpers.Mark(), netip.IPv6Unspecified(), netip.IPv6Unspecified(), []NetProvider{NetProviderRouting, NetProviderFlow}, netip.IPv6Unspecified()},
{helpers.Mark(), nh1, netip.IPv6Unspecified(), []NetProvider{NetProviderRouting, NetProviderFlow}, nh1},
{helpers.Mark(), netip.IPv6Unspecified(), nh2, []NetProvider{NetProviderRouting, NetProviderFlow}, nh2},
{helpers.Mark(), nh1, netip.IPv6Unspecified(), []NetProvider{NetProviderRouting, NetProviderFlow}, nh1},
{helpers.Mark(), nh1, nh2, []NetProvider{NetProviderRouting, NetProviderFlow}, nh2},
{helpers.Mark(), netip.IPv6Unspecified(), netip.IPv6Unspecified(), []NetProvider{NetProviderFlow, NetProviderRouting}, netip.IPv6Unspecified()},
{helpers.Mark(), nh1, netip.IPv6Unspecified(), []NetProvider{NetProviderFlow, NetProviderRouting}, nh1},
{helpers.Mark(), netip.IPv6Unspecified(), nh2, []NetProvider{NetProviderFlow, NetProviderRouting}, nh2},
{helpers.Mark(), nh1, netip.IPv6Unspecified(), []NetProvider{NetProviderFlow, NetProviderRouting}, nh1},
{helpers.Mark(), nh1, nh2, []NetProvider{NetProviderFlow, NetProviderRouting}, nh1},
}
for _, tc := range cases {
t.Run(fmt.Sprintf("case %s", tc.Pos), func(t *testing.T) {
r := reporter.NewMock(t)
// We don't need all components as we won't start the component.
configuration := DefaultConfiguration()
configuration.NetProviders = tc.Providers
routingComponent := routing.NewMock(t, r)
routingComponent.PopulateRIB(t)
c, err := New(r, configuration, Dependencies{
Daemon: daemon.NewMock(t),
Routing: routingComponent,
Schema: schema.NewMock(t),
})
if err != nil {
t.Fatalf("New() error:\n%+v", err)
}
got := c.getNextHop(tc.FlowNextHop, tc.RoutingNextHop)
if diff := helpers.Diff(got, tc.Expected); diff != "" {
t.Fatalf("getNextHop() (-got, +want):\n%s", diff)
}
})
}
}