mirror of
https://github.com/traefik/traefik.git
synced 2026-05-05 12:26:25 +02:00
416 lines
15 KiB
Go
416 lines
15 KiB
Go
package customerrors
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/http/httptrace"
|
|
"net/textproto"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/traefik/traefik/v3/pkg/config/dynamic"
|
|
"github.com/traefik/traefik/v3/pkg/testhelpers"
|
|
)
|
|
|
|
func TestHandler(t *testing.T) {
|
|
testCases := []struct {
|
|
desc string
|
|
errorPage *dynamic.ErrorPage
|
|
backendCode int
|
|
backendErrorHandler http.HandlerFunc
|
|
validate func(t *testing.T, recorder *httptest.ResponseRecorder)
|
|
requestHeaders map[string]string
|
|
}{
|
|
{
|
|
desc: "no error",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"500-501", "503-599"}},
|
|
backendCode: http.StatusOK,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = fmt.Fprintln(w, "My error page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusOK, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), http.StatusText(http.StatusOK))
|
|
},
|
|
},
|
|
{
|
|
desc: "no error, but not a 200",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"500-501", "503-599"}},
|
|
backendCode: http.StatusPartialContent,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = fmt.Fprintln(w, "My error page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusPartialContent, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), http.StatusText(http.StatusPartialContent))
|
|
},
|
|
},
|
|
{
|
|
desc: "a 304, so no Write called",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"500-501", "503-599"}},
|
|
backendCode: http.StatusNotModified,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = fmt.Fprintln(w, "whatever, should not be called")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusNotModified, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "")
|
|
},
|
|
},
|
|
{
|
|
desc: "in the range",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"500-501", "503-599"}},
|
|
backendCode: http.StatusInternalServerError,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = fmt.Fprintln(w, "My error page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusInternalServerError, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "My error page.")
|
|
},
|
|
},
|
|
{
|
|
desc: "not in the range",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"500-501", "503-599"}},
|
|
backendCode: http.StatusBadGateway,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = fmt.Fprintln(w, "My error page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusBadGateway, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), http.StatusText(http.StatusBadGateway))
|
|
},
|
|
},
|
|
{
|
|
desc: "query replacement",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/{status}", Status: []string{"503-503"}},
|
|
backendCode: http.StatusServiceUnavailable,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if r.RequestURI != "/503" {
|
|
return
|
|
}
|
|
|
|
_, _ = fmt.Fprintln(w, "My 503 page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusServiceUnavailable, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "My 503 page.")
|
|
},
|
|
},
|
|
{
|
|
desc: "single code and query replacement",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/{status}", Status: []string{"503"}},
|
|
backendCode: http.StatusServiceUnavailable,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if r.RequestURI != "/503" {
|
|
return
|
|
}
|
|
|
|
_, _ = fmt.Fprintln(w, "My 503 page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusServiceUnavailable, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "My 503 page.")
|
|
},
|
|
},
|
|
{
|
|
desc: "forward request host header",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"503"}},
|
|
backendCode: http.StatusServiceUnavailable,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = fmt.Fprintln(w, r.Host)
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusServiceUnavailable, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "localhost")
|
|
},
|
|
},
|
|
{
|
|
desc: "full query replacement",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/?status={status}&url={url}", Status: []string{"503"}},
|
|
backendCode: http.StatusServiceUnavailable,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
if r.RequestURI != "/?status=503&url=http%3A%2F%2Flocalhost%2Ftest%3Ffoo%3Dbar%26baz%3Dbuz" {
|
|
t.Log(r.RequestURI)
|
|
return
|
|
}
|
|
|
|
_, _ = fmt.Fprintln(w, "My 503 page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Equal(t, http.StatusServiceUnavailable, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "My 503 page.")
|
|
},
|
|
},
|
|
{
|
|
desc: "forward all headers by default",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"503"}},
|
|
requestHeaders: map[string]string{
|
|
"X-Request-Id": "trace-abc",
|
|
"Authorization": "Bearer secret",
|
|
},
|
|
backendCode: http.StatusServiceUnavailable,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
fmt.Fprintln(w, r.Header.Get("X-Request-Id"))
|
|
fmt.Fprintln(w, r.Header.Get("Authorization"))
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Contains(t, recorder.Body.String(), "trace-abc")
|
|
assert.Contains(t, recorder.Body.String(), "Bearer secret")
|
|
},
|
|
},
|
|
{
|
|
desc: "forward only allowlisted headers",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"503"}, ErrorRequestHeaders: []string{"X-Request-Id"}},
|
|
requestHeaders: map[string]string{
|
|
"X-Request-Id": "trace-abc",
|
|
"Authorization": "Bearer secret",
|
|
},
|
|
backendCode: http.StatusServiceUnavailable,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
fmt.Fprintln(w, r.Header.Get("X-Request-Id"))
|
|
fmt.Fprintln(w, r.Header.Get("Authorization"))
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.Contains(t, recorder.Body.String(), "trace-abc")
|
|
assert.NotContains(t, recorder.Body.String(), "Bearer secret")
|
|
},
|
|
},
|
|
{
|
|
desc: "forward no headers",
|
|
errorPage: &dynamic.ErrorPage{Service: "error", Query: "/test", Status: []string{"503"}, ErrorRequestHeaders: []string{}},
|
|
requestHeaders: map[string]string{
|
|
"X-Request-Id": "trace-abc",
|
|
"Authorization": "Bearer secret",
|
|
},
|
|
backendCode: http.StatusServiceUnavailable,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
fmt.Fprintln(w, r.Header.Get("X-Request-Id"))
|
|
fmt.Fprintln(w, r.Header.Get("Authorization"))
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
assert.NotContains(t, recorder.Body.String(), "trace-abc")
|
|
assert.NotContains(t, recorder.Body.String(), "Bearer secret")
|
|
},
|
|
},
|
|
{
|
|
desc: "nginx headers: backend status code preserved",
|
|
errorPage: &dynamic.ErrorPage{
|
|
Service: "error",
|
|
Query: "/test",
|
|
Status: []string{"500-599"},
|
|
NginxHeaders: &http.Header{
|
|
"X-Namespaces": {"default"},
|
|
"X-Ingress-Name": {"my-ingress"},
|
|
"X-Service-Name": {"my-service"},
|
|
"X-Service-Port": {"80"},
|
|
},
|
|
},
|
|
backendCode: http.StatusInternalServerError,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
// Error page backend returns 200 (the default when no WriteHeader is called).
|
|
_, _ = fmt.Fprintln(w, "Custom error page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
// In nginx mode, the error page backend's status code (200) is preserved,
|
|
// NOT overridden to the original error code (500).
|
|
assert.Equal(t, http.StatusOK, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "Custom error page.")
|
|
},
|
|
},
|
|
{
|
|
desc: "nginx headers: X-Code and nginx headers forwarded",
|
|
errorPage: &dynamic.ErrorPage{
|
|
Service: "error",
|
|
Query: "/test",
|
|
Status: []string{"500-599"},
|
|
NginxHeaders: &http.Header{
|
|
"X-Namespaces": {"default"},
|
|
"X-Ingress-Name": {"my-ingress"},
|
|
"X-Service-Name": {"my-service"},
|
|
"X-Service-Port": {"80"},
|
|
},
|
|
},
|
|
backendCode: http.StatusBadGateway,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
// Verify that nginx-specific headers are set on the request.
|
|
assert.Equal(t, "502", r.Header.Get("X-Code"))
|
|
assert.Equal(t, "default", r.Header.Get("X-Namespaces"))
|
|
assert.Equal(t, "my-ingress", r.Header.Get("X-Ingress-Name"))
|
|
assert.Equal(t, "my-service", r.Header.Get("X-Service-Name"))
|
|
assert.Equal(t, "80", r.Header.Get("X-Service-Port"))
|
|
assert.Equal(t, "/test?foo=bar&baz=buz", r.Header.Get("X-Original-Uri"))
|
|
// Return a custom status code.
|
|
w.WriteHeader(http.StatusNotFound)
|
|
_, _ = fmt.Fprintln(w, "Custom 404 page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
// Backend's chosen status code (404) is preserved in nginx mode.
|
|
assert.Equal(t, http.StatusNotFound, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "Custom 404 page.")
|
|
},
|
|
},
|
|
{
|
|
desc: "non-nginx: code modifier enforces original error code",
|
|
errorPage: &dynamic.ErrorPage{
|
|
Service: "error",
|
|
Query: "/test",
|
|
Status: []string{"500-599"},
|
|
},
|
|
backendCode: http.StatusInternalServerError,
|
|
backendErrorHandler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
// Error page backend returns 200 (the default).
|
|
_, _ = fmt.Fprintln(w, "Custom error page.")
|
|
}),
|
|
validate: func(t *testing.T, recorder *httptest.ResponseRecorder) {
|
|
t.Helper()
|
|
// Without nginx headers, newCodeModifier enforces the original error code (500),
|
|
// even though the error page backend returned 200.
|
|
assert.Equal(t, http.StatusInternalServerError, recorder.Code, "HTTP status")
|
|
assert.Contains(t, recorder.Body.String(), "Custom error page.")
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, test := range testCases {
|
|
t.Run(test.desc, func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
serviceBuilderMock := &mockServiceBuilder{handler: test.backendErrorHandler}
|
|
|
|
handler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
w.WriteHeader(test.backendCode)
|
|
|
|
if test.backendCode == http.StatusNotModified {
|
|
return
|
|
}
|
|
_, _ = fmt.Fprintln(w, http.StatusText(test.backendCode))
|
|
})
|
|
errorPageHandler, err := New(t.Context(), handler, *test.errorPage, serviceBuilderMock, "test")
|
|
require.NoError(t, err)
|
|
|
|
req := testhelpers.MustNewRequest(http.MethodGet, "http://localhost/test?foo=bar&baz=buz", nil)
|
|
for k, v := range test.requestHeaders {
|
|
req.Header.Set(k, v)
|
|
}
|
|
|
|
// Client like browser and curl will issue a relative HTTP request, which not have a host and scheme in the URL. But the http.NewRequest will set them automatically.
|
|
req.URL.Host = ""
|
|
req.URL.Scheme = ""
|
|
|
|
recorder := httptest.NewRecorder()
|
|
errorPageHandler.ServeHTTP(recorder, req)
|
|
|
|
test.validate(t, recorder)
|
|
})
|
|
}
|
|
}
|
|
|
|
// This test is an adapted version of net/http/httputil.Test1xxResponses test.
|
|
func Test1xxResponses(t *testing.T) {
|
|
next := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
h := w.Header()
|
|
h.Add("Link", "</style.css>; rel=preload; as=style")
|
|
h.Add("Link", "</script.js>; rel=preload; as=script")
|
|
w.WriteHeader(http.StatusEarlyHints)
|
|
|
|
h.Add("Link", "</foo.js>; rel=preload; as=script")
|
|
w.WriteHeader(http.StatusProcessing)
|
|
|
|
h.Add("User-Agent", "foobar")
|
|
_, _ = w.Write([]byte("Hello"))
|
|
w.WriteHeader(http.StatusBadGateway)
|
|
})
|
|
|
|
serviceBuilderMock := &mockServiceBuilder{handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
|
_, _ = fmt.Fprintln(w, "My error page.")
|
|
})}
|
|
|
|
config := dynamic.ErrorPage{Service: "error", Query: "/", Status: []string{"200"}}
|
|
|
|
errorPageHandler, err := New(t.Context(), next, config, serviceBuilderMock, "test")
|
|
require.NoError(t, err)
|
|
|
|
server := httptest.NewServer(errorPageHandler)
|
|
t.Cleanup(server.Close)
|
|
frontendClient := server.Client()
|
|
|
|
checkLinkHeaders := func(t *testing.T, expected, got []string) {
|
|
t.Helper()
|
|
|
|
if len(expected) != len(got) {
|
|
t.Errorf("Expected %d link headers; got %d", len(expected), len(got))
|
|
}
|
|
|
|
for i := range expected {
|
|
if i >= len(got) {
|
|
t.Errorf("Expected %q link header; got nothing", expected[i])
|
|
|
|
continue
|
|
}
|
|
|
|
if expected[i] != got[i] {
|
|
t.Errorf("Expected %q link header; got %q", expected[i], got[i])
|
|
}
|
|
}
|
|
}
|
|
|
|
var respCounter uint8
|
|
trace := &httptrace.ClientTrace{
|
|
Got1xxResponse: func(code int, header textproto.MIMEHeader) error {
|
|
switch code {
|
|
case http.StatusEarlyHints:
|
|
checkLinkHeaders(t, []string{"</style.css>; rel=preload; as=style", "</script.js>; rel=preload; as=script"}, header["Link"])
|
|
case http.StatusProcessing:
|
|
checkLinkHeaders(t, []string{"</style.css>; rel=preload; as=style", "</script.js>; rel=preload; as=script", "</foo.js>; rel=preload; as=script"}, header["Link"])
|
|
default:
|
|
t.Error("Unexpected 1xx response")
|
|
}
|
|
|
|
respCounter++
|
|
|
|
return nil
|
|
},
|
|
}
|
|
req, _ := http.NewRequestWithContext(httptrace.WithClientTrace(t.Context(), trace), http.MethodGet, server.URL, nil)
|
|
|
|
res, err := frontendClient.Do(req)
|
|
assert.NoError(t, err)
|
|
|
|
defer res.Body.Close()
|
|
|
|
if respCounter != 2 {
|
|
t.Errorf("Expected 2 1xx responses; got %d", respCounter)
|
|
}
|
|
checkLinkHeaders(t, []string{"</style.css>; rel=preload; as=style", "</script.js>; rel=preload; as=script", "</foo.js>; rel=preload; as=script"}, res.Header["Link"])
|
|
|
|
body, _ := io.ReadAll(res.Body)
|
|
assert.Equal(t, "My error page.\n", string(body))
|
|
}
|
|
|
|
type mockServiceBuilder struct {
|
|
handler http.Handler
|
|
}
|
|
|
|
func (m *mockServiceBuilder) BuildHTTP(_ context.Context, _ string) (http.Handler, error) {
|
|
return m.handler, nil
|
|
}
|