Documentation
¶
Index ¶
- Constants
- Variables
- func ExecBackground(t *testing.T, processName string, netNS *os.File, name string, args []string) (<-chan error, func() error)
- func TestBigUDP(t *testing.T, logger slog.Logger, _ *url.URL, conn *tailnet.Conn, ...)
- func TestSuite(t *testing.T, _ slog.Logger, serverURL *url.URL, conn *tailnet.Conn, ...)
- type BasicClientStarter
- type Client
- type ClientNumber
- type ClientStarter
- type NGINXServerOptions
- type NetworkService
- type NetworkingLoopback
- type NetworkingNAT
- type NetworkingProvider
- type ServerStarter
- type SimpleServerOptions
- type TestNetworking
- type TestNetworkingClient
- type TestNetworkingProcess
- type TestNetworkingSTUN
- type TestNetworkingServer
- type TestTopology
- type TriangleNetwork
- type UDPEchoService
Constants ¶
const EchoPort = 2381
Variables ¶
var Client1 = Client{ Number: ClientNumber1, ID: uuid.MustParse("00000000-0000-0000-0000-000000000001"), ListenPort: client1Port, ShouldRunTests: true, TunnelSrc: true, }
var Client2 = Client{ Number: ClientNumber2, ID: uuid.MustParse("00000000-0000-0000-0000-000000000002"), ListenPort: client2Port, ShouldRunTests: false, TunnelSrc: false, }
Functions ¶
func ExecBackground ¶ added in v2.12.0
func ExecBackground(t *testing.T, processName string, netNS *os.File, name string, args []string) (<-chan error, func() error)
ExecBackground starts a subprocess with the given flags and returns a channel that will receive the error when the subprocess exits. The returned function can be used to close the subprocess.
processName is used to identify the subprocess in logs.
Optionally, a network namespace can be passed to run the subprocess in.
Do not call close then wait on the channel. Use the returned value from the function instead in this case.
Cleanup is handled automatically if you don't care about monitoring the process manually.
func TestBigUDP ¶ added in v2.24.0
Types ¶
type BasicClientStarter ¶ added in v2.24.0
type BasicClientStarter struct { BlockEndpoints bool DERPForceWebsockets bool // WaitForConnection means wait for (any) peer connection before returning from StartClient WaitForConnection bool // WaitForConnection means wait for a direct peer connection before returning from StartClient WaitForDirect bool // Service is a network service (e.g. an echo server) to start on the client. If Wait* is set, the service is // started prior to waiting. Service NetworkService LogPackets bool }
type ClientNumber ¶ added in v2.12.0
type ClientNumber int
const ( ClientNumber1 ClientNumber = 1 ClientNumber2 ClientNumber = 2 )
type ClientStarter ¶ added in v2.12.0
type NGINXServerOptions ¶ added in v2.12.0
type NGINXServerOptions struct {
SimpleServerOptions
}
func (NGINXServerOptions) StartServer ¶ added in v2.12.0
type NetworkService ¶ added in v2.24.0
type NetworkingLoopback ¶ added in v2.24.0
type NetworkingLoopback struct{}
NetworkingLoopback creates a network namespace with a loopback interface for all tests to share. This is the simplest networking setup. The network namespace only exists for isolation on the host and doesn't serve any routing purpose.
func (NetworkingLoopback) SetupNetworking ¶ added in v2.24.0
func (NetworkingLoopback) SetupNetworking(t *testing.T, _ slog.Logger) TestNetworking
type NetworkingNAT ¶ added in v2.24.0
NetworkingNAT creates a fake internet and sets up "NAT" forwarding rules, either easy or hard. See createFakeInternet. NAT is achieved through a single iptables masquerade rule.
func (NetworkingNAT) SetupNetworking ¶ added in v2.24.0
func (n NetworkingNAT) SetupNetworking(t *testing.T, l slog.Logger) TestNetworking
SetupNetworking creates a fake internet with multiple STUN servers and sets up NAT forwarding rules. Client NATs are controlled by the switches ClientXHard, which if true, sets up hard nat.
type NetworkingProvider ¶ added in v2.24.0
type NetworkingProvider interface { // SetupNetworking creates interfaces and network namespaces for the test. // The most simple implementation is NetworkSetupDefault, which only creates // a network namespace shared for all tests. SetupNetworking(t *testing.T, logger slog.Logger) TestNetworking }
type ServerStarter ¶ added in v2.12.0
type SimpleServerOptions ¶ added in v2.12.0
type SimpleServerOptions struct { // FailUpgradeDERP will make the DERP server fail to handle the initial DERP // upgrade in a way that causes the client to fallback to // DERP-over-WebSocket fallback automatically. // Incompatible with DERPWebsocketOnly. FailUpgradeDERP bool // DERPWebsocketOnly will make the DERP server only accept WebSocket // connections. If a DERP request is received that is not using WebSocket // fallback, the test will fail. // Incompatible with FailUpgradeDERP. DERPWebsocketOnly bool }
func (SimpleServerOptions) Router ¶ added in v2.12.0
func (o SimpleServerOptions) Router(t *testing.T, logger slog.Logger) *chi.Mux
func (SimpleServerOptions) StartServer ¶ added in v2.12.0
type TestNetworking ¶
type TestNetworking struct { Server TestNetworkingServer STUNs []TestNetworkingSTUN Client1 TestNetworkingClient Client2 TestNetworkingClient }
type TestNetworkingClient ¶ added in v2.12.0
type TestNetworkingClient struct { Process TestNetworkingProcess // ServerAccessURL is the hostname and port that the client uses to access // the server over HTTP for coordination. ServerAccessURL string // DERPMap is the DERP map that the client uses. If nil, a basic DERP map // containing only a single DERP with `ServerAccessURL` is used with no // STUN servers. DERPMap *tailcfg.DERPMap }
func (TestNetworkingClient) ResolveDERPMap ¶ added in v2.12.0
func (c TestNetworkingClient) ResolveDERPMap() (*tailcfg.DERPMap, error)
type TestNetworkingProcess ¶
type TestNetworkingProcess struct { // NetNS to enter. If nil, the current network namespace is used. NetNS *os.File }
func (TestNetworkingProcess) CapturePackets ¶ added in v2.24.0
func (p TestNetworkingProcess) CapturePackets(t *testing.T, name, dir string)
type TestNetworkingSTUN ¶ added in v2.12.0
type TestNetworkingSTUN struct { Process TestNetworkingProcess IP string ListenAddr string }
type TestNetworkingServer ¶ added in v2.12.0
type TestNetworkingServer struct { Process TestNetworkingProcess ListenAddr string }
type TestTopology ¶
type TestTopology struct { Name string NetworkingProvider NetworkingProvider // Server is the server starter for the test. It is executed in the server // subprocess. Server ServerStarter // ClientStarter.StartClient gets called in each client subprocess. It's expected to // create the tailnet.Conn and ensure connectivity to it's peer. ClientStarter ClientStarter // RunTests is the main test function. It's called in each of the client // subprocesses. If tests can only run once, they should check the client ID // and return early if it's not the expected one. RunTests func(t *testing.T, logger slog.Logger, serverURL *url.URL, conn *tailnet.Conn, me Client, peer Client) }
type TriangleNetwork ¶ added in v2.24.0
type TriangleNetwork struct {
Client1MTU int
}
func (TriangleNetwork) SetupNetworking ¶ added in v2.24.0
func (n TriangleNetwork) SetupNetworking(t *testing.T, l slog.Logger) TestNetworking
SetupNetworking creates multiple namespaces with a central router in the following topology . . ┌──────────────┐ . │ │ . │ Server ├─────────────────────────────────────┐ . │ │fdac:38fa:ffff:3::2 │ . └──────────────┘ │ fdac:38fa:ffff:3::1 . ┌──────────────┐ ┌─────┴───────┐ . │ │ fdac:38fa:ffff:1::1│ │ . │ Client 1 ├───────────────────────────────┤ Router │ . │ │fdac:38fa:ffff:1::2 │ │ . └──────────────┘ └─────┬───────┘ . ┌──────────────┐ │ fdac:38fa:ffff:2::1 . │ │ │ . │ Client 2 ├─────────────────────────────────────┘ . │ │fdac:38fa:ffff:2::2 . └──────────────┘ The veth link between Client 1 and the router has a configurable MTU via Client1MTU.
type UDPEchoService ¶ added in v2.24.0
type UDPEchoService struct{}