traefik/pkg/server/service/service_test.go

411 lines
9.8 KiB
Go
Raw Normal View History

2018-11-14 09:18:03 +00:00
package service
import (
"context"
"net/http"
"net/http/httptest"
"strings"
2018-11-14 09:18:03 +00:00
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
2023-02-03 14:24:05 +00:00
"github.com/traefik/traefik/v3/pkg/config/dynamic"
"github.com/traefik/traefik/v3/pkg/config/runtime"
"github.com/traefik/traefik/v3/pkg/server/provider"
"github.com/traefik/traefik/v3/pkg/testhelpers"
2018-11-14 09:18:03 +00:00
)
func TestGetLoadBalancer(t *testing.T) {
sm := Manager{
roundTripperManager: newRtMock(),
}
2018-11-14 09:18:03 +00:00
testCases := []struct {
desc string
serviceName string
service *dynamic.ServersLoadBalancer
2018-11-14 09:18:03 +00:00
fwd http.Handler
expectError bool
}{
{
desc: "Fails when provided an invalid URL",
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
Servers: []dynamic.Server{
2018-11-14 09:18:03 +00:00
{
2019-06-05 20:18:06 +00:00
URL: ":",
2018-11-14 09:18:03 +00:00
},
},
},
fwd: &MockForwarder{},
expectError: true,
},
{
desc: "Succeeds when there are no servers",
serviceName: "test",
service: &dynamic.ServersLoadBalancer{},
2018-11-14 09:18:03 +00:00
fwd: &MockForwarder{},
expectError: false,
},
{
desc: "Succeeds when sticky.cookie is set",
2018-11-14 09:18:03 +00:00
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
Sticky: &dynamic.Sticky{Cookie: &dynamic.Cookie{}},
2018-11-14 09:18:03 +00:00
},
fwd: &MockForwarder{},
expectError: false,
},
}
for _, test := range testCases {
test := test
t.Run(test.desc, func(t *testing.T) {
t.Parallel()
serviceInfo := &runtime.ServiceInfo{Service: &dynamic.Service{LoadBalancer: test.service}}
handler, err := sm.getLoadBalancerServiceHandler(context.Background(), test.serviceName, serviceInfo)
2018-11-14 09:18:03 +00:00
if test.expectError {
require.Error(t, err)
assert.Nil(t, handler)
} else {
require.NoError(t, err)
assert.NotNil(t, handler)
}
})
}
}
func TestGetLoadBalancerServiceHandler(t *testing.T) {
2020-09-11 13:40:03 +00:00
sm := NewManager(nil, nil, nil, &RoundTripperManager{
roundTrippers: map[string]http.RoundTripper{
"default@internal": http.DefaultTransport,
},
})
2018-11-14 09:18:03 +00:00
server1 := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("X-From", "first")
}))
defer server1.Close()
server2 := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("X-From", "second")
}))
defer server2.Close()
serverPassHost := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("X-From", "passhost")
assert.Equal(t, "callme", r.Host)
}))
defer serverPassHost.Close()
serverPassHostFalse := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("X-From", "passhostfalse")
assert.NotEqual(t, "callme", r.Host)
}))
defer serverPassHostFalse.Close()
type ExpectedResult struct {
StatusCode int
XFrom string
LoadBalanced bool
SecureCookie bool
HTTPOnlyCookie bool
2018-11-14 09:18:03 +00:00
}
testCases := []struct {
desc string
serviceName string
service *dynamic.ServersLoadBalancer
2018-11-14 09:18:03 +00:00
responseModifier func(*http.Response) error
cookieRawValue string
2018-11-14 09:18:03 +00:00
expected []ExpectedResult
}{
{
desc: "Load balances between the two servers",
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
PassHostHeader: Bool(true),
Servers: []dynamic.Server{
2018-11-14 09:18:03 +00:00
{
2019-06-05 20:18:06 +00:00
URL: server1.URL,
2018-11-14 09:18:03 +00:00
},
{
2019-06-05 20:18:06 +00:00
URL: server2.URL,
2018-11-14 09:18:03 +00:00
},
},
},
expected: []ExpectedResult{
{
StatusCode: http.StatusOK,
LoadBalanced: true,
2018-11-14 09:18:03 +00:00
},
{
StatusCode: http.StatusOK,
LoadBalanced: true,
2018-11-14 09:18:03 +00:00
},
},
},
{
desc: "StatusBadGateway when the server is not reachable",
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
Servers: []dynamic.Server{
2018-11-14 09:18:03 +00:00
{
2019-06-05 20:18:06 +00:00
URL: "http://foo",
2018-11-14 09:18:03 +00:00
},
},
},
expected: []ExpectedResult{
{
StatusCode: http.StatusBadGateway,
},
},
},
{
desc: "ServiceUnavailable when no servers are available",
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
Servers: []dynamic.Server{},
2018-11-14 09:18:03 +00:00
},
expected: []ExpectedResult{
{
StatusCode: http.StatusServiceUnavailable,
},
},
},
{
desc: "Always call the same server when sticky.cookie is true",
2018-11-14 09:18:03 +00:00
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
Sticky: &dynamic.Sticky{Cookie: &dynamic.Cookie{}},
Servers: []dynamic.Server{
2018-11-14 09:18:03 +00:00
{
2019-06-05 20:18:06 +00:00
URL: server1.URL,
2018-11-14 09:18:03 +00:00
},
{
2019-06-05 20:18:06 +00:00
URL: server2.URL,
2018-11-14 09:18:03 +00:00
},
},
},
expected: []ExpectedResult{
{
StatusCode: http.StatusOK,
},
{
StatusCode: http.StatusOK,
},
},
},
{
desc: "Sticky Cookie's options set correctly",
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
Sticky: &dynamic.Sticky{Cookie: &dynamic.Cookie{HTTPOnly: true, Secure: true}},
Servers: []dynamic.Server{
{
URL: server1.URL,
},
},
},
expected: []ExpectedResult{
{
StatusCode: http.StatusOK,
XFrom: "first",
SecureCookie: true,
HTTPOnlyCookie: true,
},
},
},
2018-11-14 09:18:03 +00:00
{
desc: "PassHost passes the host instead of the IP",
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
Sticky: &dynamic.Sticky{Cookie: &dynamic.Cookie{}},
PassHostHeader: func(v bool) *bool { return &v }(true),
Servers: []dynamic.Server{
2018-11-14 09:18:03 +00:00
{
2019-06-05 20:18:06 +00:00
URL: serverPassHost.URL,
2018-11-14 09:18:03 +00:00
},
},
},
expected: []ExpectedResult{
{
StatusCode: http.StatusOK,
XFrom: "passhost",
},
},
},
{
desc: "PassHost doesn't pass the host instead of the IP",
2018-11-14 09:18:03 +00:00
serviceName: "test",
service: &dynamic.ServersLoadBalancer{
PassHostHeader: Bool(false),
Sticky: &dynamic.Sticky{Cookie: &dynamic.Cookie{}},
Servers: []dynamic.Server{
2018-11-14 09:18:03 +00:00
{
2019-06-05 20:18:06 +00:00
URL: serverPassHostFalse.URL,
2018-11-14 09:18:03 +00:00
},
},
},
expected: []ExpectedResult{
{
StatusCode: http.StatusOK,
XFrom: "passhostfalse",
},
},
},
}
for _, test := range testCases {
test := test
t.Run(test.desc, func(t *testing.T) {
serviceInfo := &runtime.ServiceInfo{Service: &dynamic.Service{LoadBalancer: test.service}}
handler, err := sm.getLoadBalancerServiceHandler(context.Background(), test.serviceName, serviceInfo)
2018-11-14 09:18:03 +00:00
assert.NoError(t, err)
assert.NotNil(t, handler)
req := testhelpers.MustNewRequest(http.MethodGet, "http://callme", nil)
if test.cookieRawValue != "" {
req.Header.Set("Cookie", test.cookieRawValue)
}
var prevXFrom string
2018-11-14 09:18:03 +00:00
for _, expected := range test.expected {
recorder := httptest.NewRecorder()
handler.ServeHTTP(recorder, req)
assert.Equal(t, expected.StatusCode, recorder.Code)
if expected.XFrom != "" {
assert.Equal(t, expected.XFrom, recorder.Header().Get("X-From"))
}
xFrom := recorder.Header().Get("X-From")
if prevXFrom != "" {
if expected.LoadBalanced {
assert.NotEqual(t, prevXFrom, xFrom)
} else {
assert.Equal(t, prevXFrom, xFrom)
}
}
prevXFrom = xFrom
2018-11-14 09:18:03 +00:00
cookieHeader := recorder.Header().Get("Set-Cookie")
if len(cookieHeader) > 0 {
req.Header.Set("Cookie", cookieHeader)
assert.Equal(t, expected.SecureCookie, strings.Contains(cookieHeader, "Secure"))
assert.Equal(t, expected.HTTPOnlyCookie, strings.Contains(cookieHeader, "HttpOnly"))
assert.NotContains(t, cookieHeader, "://")
2018-11-14 09:18:03 +00:00
}
}
})
}
}
func TestManager_Build(t *testing.T) {
testCases := []struct {
desc string
serviceName string
configs map[string]*runtime.ServiceInfo
providerName string
}{
{
desc: "Simple service name",
serviceName: "serviceName",
configs: map[string]*runtime.ServiceInfo{
"serviceName": {
Service: &dynamic.Service{
LoadBalancer: &dynamic.ServersLoadBalancer{},
},
},
},
},
{
desc: "Service name with provider",
serviceName: "serviceName@provider-1",
configs: map[string]*runtime.ServiceInfo{
"serviceName@provider-1": {
Service: &dynamic.Service{
LoadBalancer: &dynamic.ServersLoadBalancer{},
},
},
},
},
{
desc: "Service name with provider in context",
serviceName: "serviceName",
configs: map[string]*runtime.ServiceInfo{
"serviceName@provider-1": {
Service: &dynamic.Service{
LoadBalancer: &dynamic.ServersLoadBalancer{},
},
},
},
providerName: "provider-1",
},
}
for _, test := range testCases {
test := test
t.Run(test.desc, func(t *testing.T) {
t.Parallel()
2020-09-11 13:40:03 +00:00
manager := NewManager(test.configs, nil, nil, &RoundTripperManager{
roundTrippers: map[string]http.RoundTripper{
"default@internal": http.DefaultTransport,
},
})
ctx := context.Background()
if len(test.providerName) > 0 {
ctx = provider.AddInContext(ctx, "foobar@"+test.providerName)
}
_, err := manager.BuildHTTP(ctx, test.serviceName)
require.NoError(t, err)
})
}
}
2019-08-26 17:00:04 +00:00
func TestMultipleTypeOnBuildHTTP(t *testing.T) {
services := map[string]*runtime.ServiceInfo{
2019-08-26 17:00:04 +00:00
"test@file": {
Service: &dynamic.Service{
LoadBalancer: &dynamic.ServersLoadBalancer{},
Weighted: &dynamic.WeightedRoundRobin{},
},
},
}
2020-09-11 13:40:03 +00:00
manager := NewManager(services, nil, nil, &RoundTripperManager{
roundTrippers: map[string]http.RoundTripper{
"default@internal": http.DefaultTransport,
},
})
2019-08-26 17:00:04 +00:00
_, err := manager.BuildHTTP(context.Background(), "test@file")
2019-08-26 17:00:04 +00:00
assert.Error(t, err, "cannot create service: multi-types service not supported, consider declaring two different pieces of service instead")
}
func Bool(v bool) *bool { return &v }
type MockForwarder struct{}
func (MockForwarder) ServeHTTP(http.ResponseWriter, *http.Request) {
panic("not available")
}
type rtMock struct{}
func newRtMock() RoundTripperGetter {
return &rtMock{}
}
func (r *rtMock) Get(_ string) (http.RoundTripper, error) {
return http.DefaultTransport, nil
}