From 22c898a2e17de25db15b1a5010b6e0a71062b210 Mon Sep 17 00:00:00 2001 From: Maximilian Wilhelm Date: Thu, 9 Nov 2023 03:25:34 +0100 Subject: [PATCH] Increase unit test coverage for netbox/utils Signed-off-by: Maximilian Wilhelm --- pkg/connector/netbox/netbox_test.go | 53 ------- pkg/connector/netbox/utils/utils.go | 4 +- pkg/connector/netbox/utils/utils_test.go | 170 +++++++++++++++++++++++ 3 files changed, 172 insertions(+), 55 deletions(-) create mode 100644 pkg/connector/netbox/utils/utils_test.go diff --git a/pkg/connector/netbox/netbox_test.go b/pkg/connector/netbox/netbox_test.go index 53cc4a1..8a8f597 100644 --- a/pkg/connector/netbox/netbox_test.go +++ b/pkg/connector/netbox/netbox_test.go @@ -16,7 +16,6 @@ import ( bnet "github.com/bio-routing/bio-rd/net" dbModel "github.com/cloudflare/octopus/pkg/connector/netbox/model" - nbUtils "github.com/cloudflare/octopus/pkg/connector/netbox/utils" octopuspb "github.com/cloudflare/octopus/proto/octopus" ) @@ -1020,55 +1019,3 @@ func TestEnrichment(t *testing.T) { assert.Equal(t, test.expected, test.t.ToProto(), test.name) } } - -func TestExtractInterfaceAndUnit(t *testing.T) { - tests := []struct { - name string - input string - expectedName string - expectedVLANTag model.VLANTag - wantFail bool - }{ - { - name: "dot1q", - input: "vlan.900", - expectedName: "vlan", - expectedVLANTag: model.NewVLANTag(0, 900), - }, - { - name: "Q-in-Q", - input: "xe-0/0/0.100.200", - expectedName: "xe-0/0/0", - expectedVLANTag: model.NewVLANTag(100, 200), - }, - { - name: "broken", - input: "xe-0/0/0", - expectedName: "xe-0/0/0", - expectedVLANTag: model.NewVLANTag(100, 200), - wantFail: true, - }, - } - - for _, test := range tests { - t.Run(test.name, func(t *testing.T) { - ifName, vt, err := nbUtils.ExtractInterfaceAndUnit(test.input) - if err != nil { - if test.wantFail { - return - } - - t.Errorf("unexpected failure of test %q: %v", test.name, err) - return - } - - if test.wantFail { - t.Errorf("unexpected success of test %q", test.name) - return - } - - assert.Equal(t, test.expectedName, ifName, test.name) - assert.Equal(t, test.expectedVLANTag, vt, test.name) - }) - } -} diff --git a/pkg/connector/netbox/utils/utils.go b/pkg/connector/netbox/utils/utils.go index bb52360..1f25911 100644 --- a/pkg/connector/netbox/utils/utils.go +++ b/pkg/connector/netbox/utils/utils.go @@ -85,7 +85,7 @@ func GetCustomFieldData(md *model.MetaData, customFieldData string) { func GetInterfaceAndVLANTag(name string) (ifName string, vt model.VLANTag, err error) { if isLogicalInterface(name) { - return ExtractInterfaceAndUnit(name) + return extractInterfaceAndUnit(name) } return name, model.VLANTag{}, nil @@ -95,7 +95,7 @@ func isLogicalInterface(name string) bool { return strings.Contains(name, ".") } -func ExtractInterfaceAndUnit(name string) (string, model.VLANTag, error) { +func extractInterfaceAndUnit(name string) (string, model.VLANTag, error) { extractedVars := reSubMatchMap(ifNameTagsRegexp, name) if _, exists := extractedVars["intf_name"]; !exists { return "", model.VLANTag{}, fmt.Errorf("unable to extract interface name from %q", name) diff --git a/pkg/connector/netbox/utils/utils_test.go b/pkg/connector/netbox/utils/utils_test.go new file mode 100644 index 0000000..241b165 --- /dev/null +++ b/pkg/connector/netbox/utils/utils_test.go @@ -0,0 +1,170 @@ +package utils + +import ( + "testing" + + "github.com/cloudflare/octopus/pkg/model" + "github.com/stretchr/testify/assert" +) + +func TestEnrichment(t *testing.T) { + tests := []struct { + name string + input string + wantFail bool + expected model.VLANTag + }{ + /* + * Errors + */ + { + name: "invalid unit string", + input: "a.b.c", + wantFail: true, + expected: model.VLANTag{}, + }, + { + name: "invalid outer tag", + input: "a.1", + wantFail: true, + expected: model.VLANTag{}, + }, + { + name: "invalid inner tag", + input: "1.a", + wantFail: true, + expected: model.VLANTag{}, + }, + { + name: "invalid single tag", + input: "something", + wantFail: true, + expected: model.VLANTag{}, + }, + { + name: "valid single tag", + input: "42", + wantFail: false, + expected: model.NewVLANTag(0, 42), + }, + { + name: "valid double tag", + input: "23.42", + wantFail: false, + expected: model.NewVLANTag(23, 42), + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + vt, err := ParseUnitStr(test.input) + if err != nil { + if test.wantFail { + return + } + + t.Errorf("unexpected failure of test %q: %v", test.name, err) + return + } + + if test.wantFail { + t.Errorf("unexpected success of test %q", test.name) + return + } + + assert.Equal(t, test.expected, vt, test.name) + }) + } +} + +func TestSanitizeIPAddress(t *testing.T) { + tests := []struct { + name string + input string + expected string + }{ + { + name: "address w/ prefix-length", + input: "192.0.2.42/24", + expected: "192.0.2.42/24", + }, + { + name: "IPv4 address w/o prefix-length", + input: "192.0.2.42", + expected: "192.0.2.42/32", + }, + { + name: "IPv6 address w/o prefix-length", + input: "2001:db8::42", + expected: "2001:db8::42/128", + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + assert.Equal(t, test.expected, SanitizeIPAddress(test.input), test.name) + }) + } +} + +func TestExtractInterfaceAndUnit(t *testing.T) { + tests := []struct { + name string + input string + expectedName string + expectedVLANTag model.VLANTag + wantFail bool + }{ + { + name: "dot1q", + input: "vlan.900", + expectedName: "vlan", + expectedVLANTag: model.NewVLANTag(0, 900), + }, + { + name: "Q-in-Q", + input: "xe-0/0/0.100.200", + expectedName: "xe-0/0/0", + expectedVLANTag: model.NewVLANTag(100, 200), + }, + { + name: "no unit", + input: "xe-0/0/0", + expectedName: "", + expectedVLANTag: model.NewVLANTag(0, 0), + wantFail: true, + }, + { + name: "invalid qot1q", + input: "xe-0/0/0.a", + expectedName: "", + expectedVLANTag: model.NewVLANTag(0, 0), + wantFail: true, + }, + { + name: "invalid qot1q", + input: "xe-0/0/0.0.a", + expectedName: "", + expectedVLANTag: model.NewVLANTag(0, 0), + wantFail: true, + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + ifName, vt, err := extractInterfaceAndUnit(test.input) + if err != nil && !test.wantFail { + t.Errorf("unexpected failure of test %q: %v", test.name, err) + return + } + + if err == nil && test.wantFail { + t.Errorf("unexpected success of test %q", test.name) + return + } + + assert.Equal(t, test.expectedName, ifName, test.name) + assert.Equal(t, test.expectedVLANTag, vt, test.name) + }) + } +}