package caddytest import ( "context" "crypto/tls" "encoding/json" "errors" "fmt" "io" "log" "net" "net/http" "net/http/cookiejar" "os" "path" "reflect" "runtime" "strings" "time" caddycmd "github.com/caddyserver/caddy/v2/cmd" "github.com/caddyserver/caddy/v2/caddyconfig" // plug in Caddy modules here _ "github.com/caddyserver/caddy/v2/modules/standard" ) // Defaults store any configuration required to make the tests run type Defaults struct { // Port we expect caddy to listening on AdminPort int // Certificates we expect to be loaded before attempting to run the tests Certificates []string // TestRequestTimeout is the time to wait for a http request to TestRequestTimeout time.Duration // LoadRequestTimeout is the time to wait for the config to be loaded against the caddy server LoadRequestTimeout time.Duration } // Default testing values var Default = Defaults{ AdminPort: 2999, // different from what a real server also running on a developer's machine might be Certificates: []string{"/caddy.localhost.crt", "/caddy.localhost.key"}, TestRequestTimeout: 5 * time.Second, LoadRequestTimeout: 5 * time.Second, } // Tester represents an instance of a test client. type Tester struct { Client *http.Client configLoaded bool configFileName string } // NewTester will create a new testing client with an attached cookie jar func NewTester() (*Tester, error) { jar, err := cookiejar.New(nil) if err != nil { return nil, fmt.Errorf("failed to create cookiejar: %w", err) } return &Tester{ Client: &http.Client{ Transport: CreateTestingTransport(), Jar: jar, Timeout: Default.TestRequestTimeout, }, configLoaded: false, }, nil } type configLoadError struct { Response string } func (e configLoadError) Error() string { return e.Response } func timeElapsed(start time.Time, name string) { elapsed := time.Since(start) log.Printf("%s took %s", name, elapsed) } // launch caddy will start the server func (tc *Tester) LaunchCaddy() error { if err := tc.startServer(); err != nil { return fmt.Errorf("failed to start server: %w", err) } return nil } func (tc *Tester) CleanupCaddy() error { // now shutdown the server, since the test is done. defer func() { // try to remove the tmp config file we created os.Remove(tc.configFileName) }() _, err := http.Post(fmt.Sprintf("http://localhost:%d/stop", Default.AdminPort), "", nil) if err != nil { return fmt.Errorf("couldn't stop caddytest server") } time.Sleep(200 * time.Millisecond) for retries := 0; retries < 10; retries++ { if isCaddyAdminRunning() != nil { return nil } time.Sleep(100 * time.Millisecond) } return fmt.Errorf("timed out waiting for caddytest server to stop") } // LoadConfig loads the config to the tester server and also ensures that the config was loaded func (tc *Tester) LoadConfig(rawConfig string, configType string) error { originalRawConfig := rawConfig // normalize JSON config if configType == "json" { var conf any if err := json.Unmarshal([]byte(rawConfig), &conf); err != nil { return err } c, err := json.Marshal(conf) if err != nil { return err } rawConfig = string(c) } client := &http.Client{ Timeout: Default.LoadRequestTimeout, } start := time.Now() req, err := http.NewRequest("POST", fmt.Sprintf("http://localhost:%d/load", Default.AdminPort), strings.NewReader(rawConfig)) if err != nil { return fmt.Errorf("failed to create request. %w", err) } if configType == "json" { req.Header.Add("Content-Type", "application/json") } else { req.Header.Add("Content-Type", "text/"+configType) } res, err := client.Do(req) if err != nil { return fmt.Errorf("unable to contact caddy server. %w", err) } timeElapsed(start, "caddytest: config load time") defer res.Body.Close() body, err := io.ReadAll(res.Body) if err != nil { return fmt.Errorf("unable to read response. %w", err) } if res.StatusCode != 200 { return configLoadError{Response: string(body)} } tc.configLoaded = true return tc.ensureConfigRunning(originalRawConfig, configType) } func (tc *Tester) ensureConfigRunning(rawConfig string, configType string) error { expectedBytes := []byte(rawConfig) if configType != "json" { adapter := caddyconfig.GetAdapter(configType) if adapter == nil { return fmt.Errorf("adapter of config type is missing: %s", configType) } expectedBytes, _, _ = adapter.Adapt([]byte(rawConfig), nil) } var expected any err := json.Unmarshal(expectedBytes, &expected) if err != nil { return err } client := &http.Client{ Timeout: Default.LoadRequestTimeout, } fetchConfig := func(client *http.Client) any { resp, err := client.Get(fmt.Sprintf("http://localhost:%d/config/", Default.AdminPort)) if err != nil { return nil } defer resp.Body.Close() actualBytes, err := io.ReadAll(resp.Body) if err != nil { return nil } var actual any err = json.Unmarshal(actualBytes, &actual) if err != nil { return nil } return actual } // TODO: does this really need to be tried more than once? // Caddy should block until the new config is loaded, which means needing to wait is a caddy bug for retries := 3; retries > 0; retries-- { if reflect.DeepEqual(expected, fetchConfig(client)) { return nil } time.Sleep(1 * time.Second) } return errors.New("EnsureConfigRunning: POSTed configuration isn't active") } const initConfig = `{ admin localhost:2999 } ` // launches caddy, and then ensures the Caddy sub-process is running. func (tc *Tester) startServer() error { if isCaddyAdminRunning() == nil { return fmt.Errorf("caddy test admin port still in use") } // setup the init config file, and set the cleanup afterwards f, err := os.CreateTemp("", "") if err != nil { return err } tc.configFileName = f.Name() if _, err := f.WriteString(initConfig); err != nil { return err } // start inprocess caddy server os.Args = []string{"caddy", "run", "--config", f.Name(), "--adapter", "caddyfile"} go func() { caddycmd.Main() }() // wait for caddy admin api to start. it should happen quickly. for retries := 3; retries > 0 && isCaddyAdminRunning() != nil; retries-- { time.Sleep(1 * time.Second) } // one more time to return the error return isCaddyAdminRunning() } func isCaddyAdminRunning() error { // assert that caddy is running client := &http.Client{ Timeout: Default.LoadRequestTimeout, } resp, err := client.Get(fmt.Sprintf("http://localhost:%d/config/", Default.AdminPort)) if err != nil { return fmt.Errorf("caddy integration test caddy server not running. Expected to be listening on localhost:%d", Default.AdminPort) } resp.Body.Close() return nil } func getIntegrationDir() string { _, filename, _, ok := runtime.Caller(1) if !ok { panic("unable to determine the current file path") } return path.Dir(filename) } // CreateTestingTransport creates a testing transport that forces call dialing connections to happen locally func CreateTestingTransport() *http.Transport { dialer := net.Dialer{ Timeout: 5 * time.Second, KeepAlive: 5 * time.Second, DualStack: true, } dialContext := func(ctx context.Context, network, addr string) (net.Conn, error) { parts := strings.Split(addr, ":") destAddr := fmt.Sprintf("127.0.0.1:%s", parts[1]) log.Printf("caddytest: redirecting the dialer from %s to %s", addr, destAddr) return dialer.DialContext(ctx, network, destAddr) } return &http.Transport{ Proxy: http.ProxyFromEnvironment, DialContext: dialContext, ForceAttemptHTTP2: true, MaxIdleConns: 100, IdleConnTimeout: 90 * time.Second, TLSHandshakeTimeout: 5 * time.Second, ExpectContinueTimeout: 1 * time.Second, TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, //nolint:gosec } }