mirror of
https://github.com/caddyserver/caddy.git
synced 2025-10-30 18:22:49 -04:00
a798e0c951
- Server types no longer need to store their own contexts; they are stored on the caddy.Instance, which means each context will be properly GC'ed when the instance is stopped. Server types should use type assertions to convert from caddy.Context to their concrete context type when they need to use it. - Pass the entire context into httpserver.GetConfig instead of only the Key field. - caddy.NewTestController now requires a server type string so it can create a controller with the proper concrete context associated with that server type. Tests still need more attention so that we can test the proper creation of startup functions, etc.
104 lines
2.8 KiB
Go
104 lines
2.8 KiB
Go
package root
|
|
|
|
import (
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/mholt/caddy"
|
|
"github.com/mholt/caddy/caddyhttp/httpserver"
|
|
)
|
|
|
|
func TestRoot(t *testing.T) {
|
|
// Predefined error substrings
|
|
parseErrContent := "Parse error:"
|
|
unableToAccessErrContent := "Unable to access root path"
|
|
|
|
existingDirPath, err := getTempDirPath()
|
|
if err != nil {
|
|
t.Fatalf("BeforeTest: Failed to find an existing directory for testing! Error was: %v", err)
|
|
}
|
|
|
|
nonExistingDir := filepath.Join(existingDirPath, "highly_unlikely_to_exist_dir")
|
|
|
|
existingFile, err := ioutil.TempFile("", "root_test")
|
|
if err != nil {
|
|
t.Fatalf("BeforeTest: Failed to create temp file for testing! Error was: %v", err)
|
|
}
|
|
defer func() {
|
|
existingFile.Close()
|
|
os.Remove(existingFile.Name())
|
|
}()
|
|
|
|
inaccessiblePath := getInaccessiblePath(existingFile.Name())
|
|
|
|
tests := []struct {
|
|
input string
|
|
shouldErr bool
|
|
expectedRoot string // expected root, set to the controller. Empty for negative cases.
|
|
expectedErrContent string // substring from the expected error. Empty for positive cases.
|
|
}{
|
|
// positive
|
|
{
|
|
fmt.Sprintf(`root %s`, nonExistingDir), false, nonExistingDir, "",
|
|
},
|
|
{
|
|
fmt.Sprintf(`root %s`, existingDirPath), false, existingDirPath, "",
|
|
},
|
|
// negative
|
|
{
|
|
`root `, true, "", parseErrContent,
|
|
},
|
|
{
|
|
fmt.Sprintf(`root %s`, inaccessiblePath), true, "", unableToAccessErrContent,
|
|
},
|
|
{
|
|
fmt.Sprintf(`root {
|
|
%s
|
|
}`, existingDirPath), true, "", parseErrContent,
|
|
},
|
|
}
|
|
|
|
for i, test := range tests {
|
|
c := caddy.NewTestController("http", test.input)
|
|
err := setupRoot(c)
|
|
cfg := httpserver.GetConfig(c)
|
|
|
|
if test.shouldErr && err == nil {
|
|
t.Errorf("Test %d: Expected error but found %s for input %s", i, err, test.input)
|
|
}
|
|
|
|
if err != nil {
|
|
if !test.shouldErr {
|
|
t.Errorf("Test %d: Expected no error but found one for input %s. Error was: %v", i, test.input, err)
|
|
}
|
|
|
|
if !strings.Contains(err.Error(), test.expectedErrContent) {
|
|
t.Errorf("Test %d: Expected error to contain: %v, found error: %v, input: %s", i, test.expectedErrContent, err, test.input)
|
|
}
|
|
}
|
|
|
|
// check root only if we are in a positive test.
|
|
if !test.shouldErr && test.expectedRoot != cfg.Root {
|
|
t.Errorf("Root not correctly set for input %s. Expected: %s, actual: %s", test.input, test.expectedRoot, cfg.Root)
|
|
}
|
|
}
|
|
}
|
|
|
|
// getTempDirPath returnes the path to the system temp directory. If it does not exists - an error is returned.
|
|
func getTempDirPath() (string, error) {
|
|
tempDir := os.TempDir()
|
|
_, err := os.Stat(tempDir)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return tempDir, nil
|
|
}
|
|
|
|
func getInaccessiblePath(file string) string {
|
|
return filepath.Join("C:", "file\x00name") // null byte in filename is not allowed on Windows AND unix
|
|
}
|