Added basic tests for parsers

Author: shadowy-pycoder

Makefile

@@ -10,15 +10,38 @@ build:
 setcap:
 	sudo setcap cap_net_raw+ep ./bin/${APP_NAME}
 
-.PHONY: create
-create:
-	go test -c -race && sudo setcap cap_net_raw+ep mshark.test
+mshark.test:
+	go test -c  -race && sudo setcap cap_net_raw+ep mshark.test
 
 .PHONY: bench
-bench: create
+bench: mshark.test
 	./mshark.test -test.bench=. -test.benchmem -test.run=^$$ -test.benchtime 1000x \
 	-test.cpuprofile='cpu.prof' -test.memprofile='mem.prof'
 
+.PHONY: benchall
+benchall:
+	for package in $$(go list ./... | tail -n +2); do \
+	go test $${package} -bench=. -benchmem -run=^$$ -benchtime 1000x \
+	-cpuprofile="$$(basename $${package})/cpu.prof" -memprofile="$$(basename $${package})/mem.prof"; done
+
+.PHONY: test
+test:
+	go test ./... -v -count=1 
+
+.PHONY: test100
+test100:
+	go test ./... -count=100 
+
+.PHONY: race
+race:
+	go test ./... -v -race -count=1 
+
+.PHONY: cover
+cover:
+	go test ./... -short -count=1 -race -coverprofile=coverage.out
+	go tool cover -html=coverage.out
+	rm coverage.out
+
 .PHONY: clean
 clean:
 	rm -v *.txt *.pcap*

go.mod

@@ -5,12 +5,16 @@ go 1.23.0
 require (
 	github.com/mdlayher/packet v1.1.2
 	github.com/packetcap/go-pcap v0.0.0-20240528124601-8c87ecf5dbc5
+	github.com/stretchr/testify v1.9.0
 	golang.org/x/net v0.28.0
 )
 
 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/josharian/native v1.1.0 // indirect
 	github.com/mdlayher/socket v0.4.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	golang.org/x/sync v0.1.0 // indirect
 	golang.org/x/sys v0.24.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,3 +1,5 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
 github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/gopacket/gopacket v1.2.0 h1:eXbzFad7f73P1n2EJHQlsKuvIMJjVXK5tXoSca78I3A=
@@ -10,9 +12,17 @@ github.com/mdlayher/socket v0.4.1 h1:eM9y2/jlbs1M615oshPQOHZzj6R6wMT7bX5NPiQvn2U
 github.com/mdlayher/socket v0.4.1/go.mod h1:cAqeGjoufqdxWkD7DkpyS+wcefOtmu5OQ8KuoJGIReA=
 github.com/packetcap/go-pcap v0.0.0-20240528124601-8c87ecf5dbc5 h1:p4VuaitqUAqSZSomd7Wb4BPV/Jj7Hno2/iqtfX7DZJI=
 github.com/packetcap/go-pcap v0.0.0-20240528124601-8c87ecf5dbc5/go.mod h1:zIAoVKeWP0mz4zXY50UYQt6NLg2uwKRswMDcGEqOms4=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 golang.org/x/net v0.28.0 h1:a9JDOJc5GMUJ0+UDqmLT86WiEy7iWyIhz8gz8E4e5hE=
 golang.org/x/net v0.28.0/go.mod h1:yqtgsTWOOnlGLG9GFRrK3++bGOUEkNBoHZc8MEDWPNg=
 golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
 golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.24.0 h1:Twjiwq9dn6R1fQcyiK+wQyHWfaz/BJB+YIpzU/Cv3Xg=
 golang.org/x/sys v0.24.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

layers/arp.go

@@ -79,11 +79,11 @@ func (ap *ARPPacket) Parse(data []byte) error {
 	}
 	ap.HardwareType = binary.BigEndian.Uint16(data[0:2])
 	ap.ProtocolType = binary.BigEndian.Uint16(data[2:4])
-	ap.ProtocolTypeDesc = ap.ptype()
+	ap.ProtocolTypeDesc = ptypedesc(ap.ProtocolType)
 	ap.Hlen = data[4]
 	ap.Plen = data[5]
 	ap.Op = binary.BigEndian.Uint16(data[6:8])
-	ap.OpDesc = ap.op()
+	ap.OpDesc = opdesc(ap.Op)
 	hoffset := 8 + ap.Hlen
 	ap.SenderMAC = net.HardwareAddr(data[8:hoffset])
 	poffset := hoffset + ap.Plen
@@ -104,9 +104,9 @@ func (ap *ARPPacket) NextLayer() (string, []byte) {
 	return "", nil
 }
 
-func (ap *ARPPacket) ptype() string {
+func ptypedesc(pt uint16) string {
 	var proto string
-	switch ap.ProtocolType {
+	switch pt {
 	case 0x0800:
 		proto = "IPv4"
 	case 0x86dd:
@@ -117,15 +117,15 @@ func (ap *ARPPacket) ptype() string {
 	return proto
 }
 
-func (ap *ARPPacket) op() string {
-	var op string
-	switch ap.Op {
+func opdesc(op uint16) string {
+	var opdesc string
+	switch op {
 	case 1:
-		op = "request"
+		opdesc = "request"
 	case 2:
-		op = "reply"
+		opdesc = "reply"
 	default:
-		op = "Unknown"
+		opdesc = "Unknown"
 	}
-	return op
+	return opdesc
 }

layers/arp_test.go

@@ -0,0 +1,77 @@
+package layers
+
+import (
+	"fmt"
+	"io"
+	"net"
+	"net/netip"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func openFile(path string) ([]byte, func(), error) {
+	f, err := os.Open(filepath.FromSlash(fmt.Sprintf("testdata/%s.bin", path)))
+	if err != nil {
+		return nil, nil, err
+	}
+	data, err := io.ReadAll(f)
+	if err != nil {
+		return nil, nil, err
+	}
+	return data, func() { f.Close() }, nil
+}
+
+func testPacket(t *testing.T, path string) ([]byte, func()) {
+	t.Helper()
+	packet, close, err := openFile(path)
+	if err != nil {
+		t.Fatal(err)
+	}
+	return packet, close
+}
+
+func testPacketBench(b *testing.B, path string) ([]byte, func()) {
+	b.Helper()
+	packet, close, err := openFile(path)
+	if err != nil {
+		b.Fatal(err)
+	}
+	return packet, close
+}
+
+func BenchmarkParseARP(b *testing.B) {
+	packet, close := testPacketBench(b, "arp")
+	defer close()
+	b.ResetTimer()
+	arp := &ARPPacket{}
+	for i := 0; i < b.N; i++ {
+		_ = arp.Parse(packet)
+		fmt.Fprint(io.Discard, arp.String())
+	}
+}
+
+func TestParseARP(t *testing.T) {
+	expected := &ARPPacket{
+		HardwareType:     0x0001,
+		ProtocolType:     0x0800,
+		ProtocolTypeDesc: "IPv4",
+		Hlen:             0x06,
+		Plen:             0x04,
+		Op:               0x0001,
+		OpDesc:           "request",
+		SenderMAC:        net.HardwareAddr{0x7b, 0x13, 0x0b, 0x87, 0xea, 0x51},
+		SenderIP:         netip.AddrFrom4([4]byte{0x7F, 0x00, 0x00, 0x01}),
+		TargetMAC:        net.HardwareAddr{0x43, 0x40, 0x8d, 0x28, 0xca, 0x0b},
+		TargetIP:         netip.AddrFrom4([4]byte{0x7F, 0x00, 0x00, 0x02}),
+	}
+	arp := &ARPPacket{}
+	packet, close := testPacket(t, "arp")
+	defer close()
+	if err := arp.Parse(packet); err != nil {
+		t.Fatal(err)
+	}
+	require.Equal(t, expected, arp)
+}

layers/ethernet_test.go

@@ -0,0 +1,38 @@
+package layers
+
+import (
+	"fmt"
+	"io"
+	"net"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func BenchmarkParseEthernet(b *testing.B) {
+	packet, close := testPacketBench(b, "ethernet")
+	defer close()
+	b.ResetTimer()
+	eth := &EthernetFrame{}
+	for i := 0; i < b.N; i++ {
+		_ = eth.Parse(packet)
+		fmt.Fprint(io.Discard, eth.String())
+	}
+}
+
+func TestParseEthernet(t *testing.T) {
+	expected := &EthernetFrame{
+		DstMAC:        net.HardwareAddr{0x7b, 0x13, 0x0b, 0x87, 0xea, 0x51},
+		SrcMAC:        net.HardwareAddr{0x43, 0x40, 0x8d, 0x28, 0xca, 0x0b},
+		EtherType:     0x0800,
+		EtherTypeDesc: "IPv4",
+		payload:       []byte{},
+	}
+	eth := &EthernetFrame{}
+	packet, close := testPacket(t, "ethernet")
+	defer close()
+	if err := eth.Parse(packet); err != nil {
+		t.Fatal(err)
+	}
+	require.Equal(t, expected, eth)
+}

layers/icmp_test.go

@@ -0,0 +1,43 @@
+package layers
+
+import (
+	"fmt"
+	"io"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func BenchmarkParseICMP(b *testing.B) {
+	packet, close := testPacketBench(b, "icmp")
+	defer close()
+	b.ResetTimer()
+	icmp := &ICMPSegment{}
+	for i := 0; i < b.N; i++ {
+		_ = icmp.Parse(packet)
+		fmt.Fprint(io.Discard, icmp.String())
+	}
+}
+
+func TestParseICMP(t *testing.T) {
+	expected := &ICMPSegment{
+		Type:     8,
+		TypeDesc: "Echo Request",
+		Code:     0,
+		CodeDesc: "Echo Request (Ping)",
+		Checksum: 9604,
+		Data: []byte{
+			0x00, 0x02, 0x00, 0x01, 0x70, 0x2A, 0xE5, 0x66, 0x00, 0x00, 0x00, 0x00,
+			0xB0, 0x14, 0x0E, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10, 0x11, 0x12, 0x13,
+			0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F,
+			0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B,
+			0x2C, 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37},
+	}
+	icmp := &ICMPSegment{}
+	packet, close := testPacket(t, "icmp")
+	defer close()
+	if err := icmp.Parse(packet); err != nil {
+		t.Fatal(err)
+	}
+	require.Equal(t, expected, icmp)
+}

layers/icmpv6_test.go

@@ -0,0 +1,44 @@
+package layers
+
+import (
+	"fmt"
+	"io"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func BenchmarkParseICMPv6(b *testing.B) {
+	packet, close := testPacketBench(b, "icmp")
+	defer close()
+	b.ResetTimer()
+	icmp := &ICMPv6Segment{}
+	for i := 0; i < b.N; i++ {
+		_ = icmp.Parse(packet)
+		fmt.Fprint(io.Discard, icmp.String())
+	}
+}
+
+func TestParseICMPv6(t *testing.T) {
+	expected := &ICMPv6Segment{
+		Type:     128,
+		TypeDesc: "Echo Request",
+		Code:     0,
+		CodeDesc: "Echo Request (Ping)",
+		Checksum: 48509,
+		Data: []byte{
+			0x00, 0x07, 0x00, 0x01, 0x3B, 0x2D, 0xE5, 0x66, 0x00, 0x00,
+			0x00, 0x00, 0xdd, 0x96, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00,
+			0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19,
+			0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, 0x23,
+			0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2A, 0x2B, 0x2C, 0x2D,
+			0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37},
+	}
+	icmp := &ICMPv6Segment{}
+	packet, close := testPacket(t, "icmpv6")
+	defer close()
+	if err := icmp.Parse(packet); err != nil {
+		t.Fatal(err)
+	}
+	require.Equal(t, expected, icmp)
+}