testutil

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 5, 2026 License: BSD-2-Clause Imports: 12 Imported by: 0

Documentation

Overview

Package testutil provides in-memory test doubles for dhcplt's component tests. A FakeRelay is an etherconn.PacketRelay that forwards Ethernet frames between registered EtherConns without touching a real interface or requiring root, so the real etherconn/nclient4/nclient6 stack can be exercised in-process.

Index

Constants

View Source
const FakeRelayIfName = "fakerelay0"

FakeRelayIfName is the interface name reported by a FakeRelay.

Variables

View Source
var (
	DefaultV6NAAddr   = net.ParseIP("2001:db8:1::1000")
	DefaultV6PDPrefix = &net.IPNet{IP: net.ParseIP("3000:1::"), Mask: net.CIDRMask(64, 128)}
)

Default IPv6 resources handed out by the built-in DHCPv6 handler.

View Source
var EncodedMACPrefix = []byte{0xaa, 0xbb}

EncodedMACPrefix is prepended to the assigned IPv4 address bytes to build the client MAC by MACFromAssignedIP. The default DHCPv4 handler assigns an address whose 4 bytes are the client MAC's last 4 bytes, so this prefix must match the first two bytes of the client MAC used in tests (aa:bb:...).

Functions

func EncodedDHCPv4Handler

func EncodedDHCPv4Handler(serverIP net.IP) server4.Handler

EncodedDHCPv4Handler returns a server4.Handler that hands out 192.0.2.0/24-style addresses encoded from the client MAC (the last 4 bytes), mirroring the manual test server in testsvr. serverIP is used as the DHCP server identifier.

func EncodedDHCPv6Handler

func EncodedDHCPv6Handler(serverMAC net.HardwareAddr) server6.Handler

EncodedDHCPv6Handler returns a server6.Handler that answers SOLICIT with ADVERTISE and REQUEST/RENEW/REBIND with REPLY, always including an IA_NA and an IA_PD so that clients requesting either are satisfied.

func MACFromAssignedIP

func MACFromAssignedIP(ip net.IP) net.HardwareAddr

MACFromAssignedIP reverses the address assignment done by EncodedDHCPv4Handler: it maps an assigned address back to the client MAC so a server can address its reply to the right client without ARP.

Types

type DHCPv4Server

type DHCPv4Server struct {
	EtherConn *etherconn.EtherConn
	Conn      *etherconn.RUDPConn
	Server    *server4.Server
}

DHCPv4Server is an in-process DHCPv4 server bound to a FakeRelay. It uses the real etherconn stack (EtherConn + RUDPConn) plus insomniacslk's server4, so it exercises the same code path as a real server minus the wire.

func StartDHCPv4Server

func StartDHCPv4Server(relay etherconn.PacketRelay, serverMAC net.HardwareAddr,
	vlans etherconn.VLANs, serverIP net.IP, handler server4.Handler) (*DHCPv4Server, error)

StartDHCPv4Server starts a DHCPv4 server on relay using serverMAC and vlans. If handler is nil, EncodedDHCPv4Handler(serverIP) is used.

func (*DHCPv4Server) Close

func (s *DHCPv4Server) Close() error

Close stops the server and releases its relay registration.

type DHCPv6Server

type DHCPv6Server struct {
	EtherConn *etherconn.EtherConn
	Conn      *etherconn.RUDPConn
	Server    *server6.Server
}

DHCPv6Server is an in-process DHCPv6 server bound to a FakeRelay.

func StartDHCPv6Server

func StartDHCPv6Server(relay etherconn.PacketRelay, serverMAC net.HardwareAddr,
	vlans etherconn.VLANs, serverIP net.IP,
	resolve func(net.IP) net.HardwareAddr, handler server6.Handler) (*DHCPv6Server, error)

StartDHCPv6Server starts a DHCPv6 server on relay using serverMAC and vlans. resolve maps a reply's destination IP back to a destination MAC; for a single-client test it can simply return the client's MAC. If handler is nil, EncodedDHCPv6Handler(serverMAC) is used.

func (*DHCPv6Server) Close

func (s *DHCPv6Server) Close() error

Close stops the server and releases its relay registration.

type FakeRelay

type FakeRelay struct {
	// contains filtered or unexported fields
}

FakeRelay is an in-memory etherconn.PacketRelay. Frames written by one registered EtherConn are parsed and delivered to the registration whose L2EndpointKey matches the frame's destination MAC/VLANs/EtherType; frames sent to a broadcast/multicast MAC are fanned out to all matching registrations.

func NewFakeRelay

func NewFakeRelay() *FakeRelay

NewFakeRelay creates an empty in-memory relay.

func (*FakeRelay) Deregister

func (f *FakeRelay) Deregister(ks []etherconn.L2EndpointKey)

Deregister implements etherconn.PacketRelay.

func (*FakeRelay) GetStats

func (f *FakeRelay) GetStats() *etherconn.RelayPacketStats

GetStats implements etherconn.PacketRelay.

func (*FakeRelay) IfName

func (f *FakeRelay) IfName() string

IfName implements etherconn.PacketRelay.

func (*FakeRelay) Register

func (f *FakeRelay) Register(ks []etherconn.L2EndpointKey, _ bool) (chan *etherconn.RelayReceival, chan []byte, chan struct{})

Register implements etherconn.PacketRelay.

func (*FakeRelay) RegisterDefault

func (f *FakeRelay) RegisterDefault() (chan *etherconn.RelayReceival, chan []byte, chan struct{})

RegisterDefault implements etherconn.PacketRelay.

func (*FakeRelay) Stop

func (f *FakeRelay) Stop()

Stop implements etherconn.PacketRelay.

func (*FakeRelay) Type

func (f *FakeRelay) Type() etherconn.RelayType

Type implements etherconn.PacketRelay.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL