badnet

README

badnet

badnet is a lightweight TCP proxy that sits in the middle of your tests and what they're trying to connect to. badnet sits outside of your application or tests to help simulate real network failures without modifying application code.

1. Setup a proxy
2. Connect your application
3. Run typical tests

Future Ideas

• Add channel / helpers to modify proxy behavior in the middle of an integration test

Related

• https://pkg.go.dev/go4.org/net/throttle#Rate
• https://pkg.go.dev/io#LimitReader
• https://pkg.go.dev/golang.org/x/net@v0.14.0/netutil
• https://pkg.go.dev/golang.org/x/net@v0.14.0/proxy
• https://github.com/Shopify/toxiproxy
• https://pkg.go.dev/github.com/cevatbarisyilmaz/lossy#section-readme

Documentation

Index

• type Config
• type Direction
• type Proxy
  • func ForTest(t *testing.T, conf Config) *Proxy
  • func (p *Proxy) BindAddr() string
  • func (p *Proxy) FailureRatio() float64
  • func (p *Proxy) Port() int

Types

type Config

type Config struct {
	Listen, Target string

	Read  Direction
	Write Direction
}

type Direction

type Direction struct {
	MaxKBps      int // set 0 for unlimited
	Latency      time.Duration
	FailureRatio int
}

type Proxy

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

func ForTest

func ForTest(t *testing.T, conf Config) *Proxy

func (*Proxy) BindAddr

func (p *Proxy) BindAddr() string

func (*Proxy) FailureRatio

func (p *Proxy) FailureRatio() float64

FailureRatio is a ratio of the injected failures and failures to connect with the target against the overall number of connections made to the proxy.

func (*Proxy) Port

func (p *Proxy) Port() int