Files
conduit/e2e_test.go
Evan Reichard 801f0f588f feat: add e2e tests, fix server shutdown and map race, update docs
- Add end-to-end test suite covering HTTP tunnel round-trip, POST
  forwarding, unknown tunnel 404, duplicate name rejection, unauthorized
  access, info endpoint, multi-tunnel routing, and graceful shutdown
- Fix server graceful shutdown by closing TCP listener on context cancel
- Fix data race in pkg/maps Entries() iterator by holding RLock
- Rewrite README with architecture, configuration, and usage docs
- Add AGENTS.md with project conventions and architecture guide
- Update flake.nix (add gopls) and flake.lock
2026-05-03 22:29:36 -04:00

508 lines
12 KiB
Go

package main
import (
"context"
"fmt"
"io"
"net"
"net/http"
"strings"
"sync"
"testing"
"time"
"reichard.io/conduit/config"
"reichard.io/conduit/server"
"reichard.io/conduit/store"
"reichard.io/conduit/tunnel"
"reichard.io/conduit/web"
)
// ---------- Helpers ----------
// startConduitServer creates and starts a conduit server on a random port.
// Returns the server address (host:port) and a cancel func for teardown.
func startConduitServer(t *testing.T, apiKey string) (string, context.CancelFunc) {
t.Helper()
// Find Free Port
port := getFreePort(t)
bindAddr := fmt.Sprintf("127.0.0.1:%d", port)
serverAddr := fmt.Sprintf("http://%s", bindAddr)
cfg := &config.ServerConfig{
BaseConfig: config.BaseConfig{
ServerAddress: serverAddr,
APIKey: apiKey,
LogLevel: "error",
LogFormat: "text",
},
BindAddress: bindAddr,
}
ctx, cancel := context.WithCancel(context.Background())
srv, err := server.NewServer(ctx, cfg)
if err != nil {
cancel()
t.Fatalf("failed to create server: %v", err)
}
// Start Server in Background
errCh := make(chan error, 1)
go func() { errCh <- srv.Start() }()
// Wait for Server to Accept
waitForPort(t, bindAddr, 3*time.Second)
// Check Early Errors
select {
case err := <-errCh:
cancel()
t.Fatalf("server exited early: %v", err)
default:
}
return bindAddr, cancel
}
// startHTTPTarget creates a simple HTTP server that echoes request info.
func startHTTPTarget(t *testing.T) (string, context.CancelFunc) {
t.Helper()
port := getFreePort(t)
addr := fmt.Sprintf("127.0.0.1:%d", port)
mux := http.NewServeMux()
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("X-Test-Header", "present")
w.WriteHeader(http.StatusOK)
fmt.Fprintf(w, "echo: %s %s", r.Method, r.URL.Path)
})
mux.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
w.Write([]byte("ok"))
})
mux.HandleFunc("/post", func(w http.ResponseWriter, r *http.Request) {
body, _ := io.ReadAll(r.Body)
w.WriteHeader(http.StatusOK)
fmt.Fprintf(w, "received: %s", string(body))
})
srv := &http.Server{Addr: addr, Handler: mux}
ctx, cancel := context.WithCancel(context.Background())
go func() { srv.ListenAndServe() }()
go func() { <-ctx.Done(); srv.Close() }()
waitForPort(t, addr, 3*time.Second)
return addr, cancel
}
// startTCPEchoTarget creates a TCP server that echoes back whatever it receives.
func startTCPEchoTarget(t *testing.T) (string, context.CancelFunc) {
t.Helper()
listener, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("failed to start tcp echo: %v", err)
}
addr := listener.Addr().String()
ctx, cancel := context.WithCancel(context.Background())
go func() {
<-ctx.Done()
listener.Close()
}()
go func() {
for {
conn, err := listener.Accept()
if err != nil {
return
}
go func(c net.Conn) {
defer c.Close()
io.Copy(c, c)
}(conn)
}
}()
return addr, cancel
}
// connectTunnel creates a conduit tunnel client and starts it.
func connectTunnel(t *testing.T, serverAddr, targetAddr, tunnelName, apiKey string) context.CancelFunc {
t.Helper()
cfg := &config.ClientConfig{
BaseConfig: config.BaseConfig{
ServerAddress: fmt.Sprintf("http://%s", serverAddr),
APIKey: apiKey,
LogLevel: "error",
LogFormat: "text",
},
TunnelName: tunnelName,
TunnelTarget: targetAddr,
}
// Create Tunnel Store
tunnelStore := store.NewTunnelStore(100)
// Create Forwarder
forwarder, err := tunnel.NewForwarder(cfg.TunnelTarget, tunnelStore)
if err != nil {
t.Fatalf("failed to create forwarder: %v", err)
}
var wg sync.WaitGroup
ctx, cancel := context.WithCancel(context.Background())
// Start Forwarder
wg.Add(1)
go func() {
defer wg.Done()
forwarder.Start(ctx)
}()
// Create & Start Tunnel
tun, err := tunnel.NewClientTunnel(cfg, forwarder)
if err != nil {
cancel()
t.Fatalf("failed to create tunnel: %v", err)
}
wg.Add(1)
go func() {
defer wg.Done()
tun.Start(ctx)
}()
// Start Web Server
webServer := web.NewWebServer(tunnelStore)
wg.Add(1)
go func() {
defer wg.Done()
webServer.Start(ctx)
}()
// Brief Settle Time
time.Sleep(100 * time.Millisecond)
cleanup := func() {
cancel()
wg.Wait()
}
return cleanup
}
// sendHTTPViaTunnel sends an HTTP request through the conduit server to a tunnel.
func sendHTTPViaTunnel(t *testing.T, serverAddr, tunnelName, method, path, body string) *http.Response {
t.Helper()
url := fmt.Sprintf("http://%s%s", serverAddr, path)
var bodyReader io.Reader
if body != "" {
bodyReader = strings.NewReader(body)
}
req, err := http.NewRequest(method, url, bodyReader)
if err != nil {
t.Fatalf("failed to create request: %v", err)
}
// Route via Subdomain
req.Host = fmt.Sprintf("%s.%s", tunnelName, serverAddr)
client := &http.Client{
Timeout: 10 * time.Second,
Transport: &http.Transport{DisableKeepAlives: true},
}
resp, err := client.Do(req)
if err != nil {
t.Fatalf("request failed: %v", err)
}
return resp
}
func readBody(t *testing.T, resp *http.Response) string {
t.Helper()
defer resp.Body.Close()
b, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatalf("failed to read body: %v", err)
}
return string(b)
}
func getFreePort(t *testing.T) int {
t.Helper()
l, err := net.Listen("tcp", "127.0.0.1:0")
if err != nil {
t.Fatalf("failed to get free port: %v", err)
}
port := l.Addr().(*net.TCPAddr).Port
l.Close()
return port
}
func waitForPort(t *testing.T, addr string, timeout time.Duration) {
t.Helper()
deadline := time.Now().Add(timeout)
for time.Now().Before(deadline) {
conn, err := net.DialTimeout("tcp", addr, 100*time.Millisecond)
if err == nil {
conn.Close()
return
}
time.Sleep(25 * time.Millisecond)
}
t.Fatalf("port %s not ready after %s", addr, timeout)
}
// ---------- Tests ----------
func TestHTTPTunnelRoundTrip(t *testing.T) {
apiKey := "test-key-http"
// Start Target HTTP Server
targetAddr, stopTarget := startHTTPTarget(t)
defer stopTarget()
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
defer stopServer()
// Connect Tunnel
stopTunnel := connectTunnel(t, serverAddr, fmt.Sprintf("http://%s", targetAddr), "http-test", apiKey)
defer stopTunnel()
// GET /
resp := sendHTTPViaTunnel(t, serverAddr, "http-test", "GET", "/", "")
body := readBody(t, resp)
if resp.StatusCode != http.StatusOK {
t.Errorf("expected 200, got %d", resp.StatusCode)
}
if !strings.Contains(body, "echo: GET /") {
t.Errorf("unexpected body: %s", body)
}
// GET /health
resp = sendHTTPViaTunnel(t, serverAddr, "http-test", "GET", "/health", "")
body = readBody(t, resp)
if resp.StatusCode != http.StatusOK {
t.Errorf("expected 200, got %d", resp.StatusCode)
}
if body != "ok" {
t.Errorf("expected 'ok', got %q", body)
}
}
func TestHTTPTunnelPOST(t *testing.T) {
apiKey := "test-key-post"
// Start Target HTTP Server
targetAddr, stopTarget := startHTTPTarget(t)
defer stopTarget()
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
defer stopServer()
// Connect Tunnel
stopTunnel := connectTunnel(t, serverAddr, fmt.Sprintf("http://%s", targetAddr), "post-test", apiKey)
defer stopTunnel()
// POST /post
resp := sendHTTPViaTunnel(t, serverAddr, "post-test", "POST", "/post", "hello world")
body := readBody(t, resp)
if resp.StatusCode != http.StatusOK {
t.Errorf("expected 200, got %d", resp.StatusCode)
}
if !strings.Contains(body, "received: hello world") {
t.Errorf("unexpected body: %s", body)
}
}
func TestUnknownTunnelReturns404(t *testing.T) {
apiKey := "test-key-404"
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
defer stopServer()
// Request to Non-Existent Tunnel
resp := sendHTTPViaTunnel(t, serverAddr, "no-such-tunnel", "GET", "/", "")
body := readBody(t, resp)
if resp.StatusCode != http.StatusNotFound {
t.Errorf("expected 404, got %d", resp.StatusCode)
}
if !strings.Contains(body, "unknown tunnel") {
t.Errorf("expected 'unknown tunnel' error, got: %s", body)
}
}
func TestDuplicateTunnelNameRejected(t *testing.T) {
apiKey := "test-key-dup"
// Start Target HTTP Server
targetAddr, stopTarget := startHTTPTarget(t)
defer stopTarget()
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
defer stopServer()
// Connect First Tunnel
stopTunnel1 := connectTunnel(t, serverAddr, fmt.Sprintf("http://%s", targetAddr), "dup-test", apiKey)
defer stopTunnel1()
// Attempt Duplicate — this should fail at WebSocket dial
cfg := &config.ClientConfig{
BaseConfig: config.BaseConfig{
ServerAddress: fmt.Sprintf("http://%s", serverAddr),
APIKey: apiKey,
LogLevel: "error",
LogFormat: "text",
},
TunnelName: "dup-test",
TunnelTarget: fmt.Sprintf("http://%s", targetAddr),
}
tunnelStore := store.NewTunnelStore(100)
forwarder, err := tunnel.NewForwarder(cfg.TunnelTarget, tunnelStore)
if err != nil {
t.Fatalf("failed to create forwarder: %v", err)
}
_, err = tunnel.NewClientTunnel(cfg, forwarder)
if err == nil {
t.Error("expected error for duplicate tunnel name, got nil")
}
}
func TestUnauthorizedControlAccess(t *testing.T) {
apiKey := "test-key-auth"
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
defer stopServer()
// Request Info with Wrong API Key
url := fmt.Sprintf("http://%s/_conduit/info?apiKey=wrong-key", serverAddr)
req, _ := http.NewRequest("GET", url, nil)
req.Host = serverAddr
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("request failed: %v", err)
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusUnauthorized {
t.Errorf("expected 401, got %d", resp.StatusCode)
}
}
func TestInfoEndpointListsTunnels(t *testing.T) {
apiKey := "test-key-info"
// Start Target HTTP Server
targetAddr, stopTarget := startHTTPTarget(t)
defer stopTarget()
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
defer stopServer()
// Connect Tunnel
stopTunnel := connectTunnel(t, serverAddr, fmt.Sprintf("http://%s", targetAddr), "info-test", apiKey)
defer stopTunnel()
// Query Info Endpoint
url := fmt.Sprintf("http://%s/_conduit/info?apiKey=%s", serverAddr, apiKey)
req, _ := http.NewRequest("GET", url, nil)
req.Host = serverAddr
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("request failed: %v", err)
}
body := readBody(t, resp)
if resp.StatusCode != http.StatusOK {
t.Errorf("expected 200, got %d", resp.StatusCode)
}
if !strings.Contains(body, "info-test") {
t.Errorf("expected tunnel 'info-test' in response: %s", body)
}
}
func TestMultipleTunnelsRouteCorrectly(t *testing.T) {
apiKey := "test-key-multi"
// Start Two Separate Target Servers
target1Addr, stopTarget1 := startHTTPTarget(t)
defer stopTarget1()
port2 := getFreePort(t)
addr2 := fmt.Sprintf("127.0.0.1:%d", port2)
mux2 := http.NewServeMux()
mux2.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
fmt.Fprint(w, "target-two")
})
srv2 := &http.Server{Addr: addr2, Handler: mux2}
go srv2.ListenAndServe()
defer srv2.Close()
waitForPort(t, addr2, 3*time.Second)
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
defer stopServer()
// Connect Two Tunnels
stopTunnel1 := connectTunnel(t, serverAddr, fmt.Sprintf("http://%s", target1Addr), "multi-one", apiKey)
defer stopTunnel1()
stopTunnel2 := connectTunnel(t, serverAddr, fmt.Sprintf("http://%s", addr2), "multi-two", apiKey)
defer stopTunnel2()
// Request to First Tunnel
resp1 := sendHTTPViaTunnel(t, serverAddr, "multi-one", "GET", "/", "")
body1 := readBody(t, resp1)
if !strings.Contains(body1, "echo: GET /") {
t.Errorf("tunnel one unexpected body: %s", body1)
}
// Request to Second Tunnel
resp2 := sendHTTPViaTunnel(t, serverAddr, "multi-two", "GET", "/", "")
body2 := readBody(t, resp2)
if body2 != "target-two" {
t.Errorf("tunnel two expected 'target-two', got: %s", body2)
}
}
func TestServerGracefulShutdown(t *testing.T) {
apiKey := "test-key-shutdown"
// Start Conduit Server
serverAddr, stopServer := startConduitServer(t, apiKey)
// Cancel Server
stopServer()
// Verify Port Is Closed
time.Sleep(200 * time.Millisecond)
conn, err := net.DialTimeout("tcp", serverAddr, 500*time.Millisecond)
if err == nil {
conn.Close()
t.Error("expected server port to be closed after shutdown")
}
}