traefik/pkg/middlewares/stripprefixregex/strip_prefix_regex_test.go

package stripprefixregex

import (
	"context"
	"net/http"
	"net/http/httptest"
	"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/middlewares/stripprefix"
	"github.com/traefik/traefik/v3/pkg/testhelpers"
)

func TestStripPrefixRegex(t *testing.T) {
	testPrefixRegex := dynamic.StripPrefixRegex{
		Regex: []string{"/a/api/", "/b/([a-z0-9]+)/", "/c/[a-z0-9]+/[0-9]+/"},
	}

	testCases := []struct {
		path               string
		expectedStatusCode int
		expectedPath       string
		expectedRawPath    string
		expectedHeader     string
	}{
		{
			path:               "/a/test",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/a/test",
		},
		{
			path:               "/a/test/",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/a/test/",
		},
		{
			path:               "/a/api/",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "",
			expectedHeader:     "/a/api/",
		},
		{
			path:               "/a/api/test",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/test",
			expectedHeader:     "/a/api/",
		},
		{
			path:               "/a/api/test/",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/test/",
			expectedHeader:     "/a/api/",
		},
		{
			path:               "/b/api/",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "",
			expectedHeader:     "/b/api/",
		},
		{
			path:               "/b/api",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/b/api",
		},
		{
			path:               "/b/api/test1",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/test1",
			expectedHeader:     "/b/api/",
		},
		{
			path:               "/b/api2/test2",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/test2",
			expectedHeader:     "/b/api2/",
		},
		{
			path:               "/c/api/123/",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "",
			expectedHeader:     "/c/api/123/",
		},
		{
			path:               "/c/api/123",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/c/api/123",
		},
		{
			path:               "/c/api/123/test3",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/test3",
			expectedHeader:     "/c/api/123/",
		},
		{
			path:               "/c/api/abc/test4",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/c/api/abc/test4",
		},
		{
			path:               "/a/api/a%2Fb",
			expectedStatusCode: http.StatusOK,
			expectedPath:       "/a/b",
			expectedRawPath:    "/a%2Fb",
			expectedHeader:     "/a/api/",
		},
	}

	for _, test := range testCases {
		t.Run(test.path, func(t *testing.T) {
			t.Parallel()

			var actualPath, actualRawPath, actualHeader, requestURI string
			handlerPath := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
				actualPath = r.URL.Path
				actualRawPath = r.URL.RawPath
				actualHeader = r.Header.Get(stripprefix.ForwardedPrefixHeader)
				requestURI = r.RequestURI
			})
			handler, err := New(context.Background(), handlerPath, testPrefixRegex, "foo-strip-prefix-regex")
			require.NoError(t, err)

			req := testhelpers.MustNewRequest(http.MethodGet, "http://localhost"+test.path, nil)
			resp := &httptest.ResponseRecorder{Code: http.StatusOK}

			handler.ServeHTTP(resp, req)

			assert.Equal(t, test.expectedStatusCode, resp.Code, "Unexpected status code.")
			assert.Equal(t, test.expectedPath, actualPath, "Unexpected path.")
			assert.Equal(t, test.expectedRawPath, actualRawPath, "Unexpected raw path.")
			assert.Equal(t, test.expectedHeader, actualHeader, "Unexpected '%s' header.", stripprefix.ForwardedPrefixHeader)

			if test.expectedPath != test.path {
				expectedRequestURI := test.expectedPath
				if test.expectedRawPath != "" {
					// go HTTP uses the raw path when existent in the RequestURI
					expectedRequestURI = test.expectedRawPath
				}
				if test.expectedPath == "" {
					expectedRequestURI = "/"
				}
				assert.Equal(t, expectedRequestURI, requestURI, "Unexpected request URI.")
			}
		})
	}
}