Function TestEchoRewriteReplacementEscaping

middleware/rewrite_test.go:276–317

Ensure correct escaping as defined in replacement (issue #1798)

(t *testing.T)

// Ensure correct escaping as defined in replacement (issue #1798)
func TestEchoRewriteReplacementEscaping(t *testing.T) {
	e := echo.New()

	// NOTE: these are incorrect regexps as they do not factor in that URI we are replacing could contain ? (query) and # (fragment) parts
	// so in reality they append query and fragment part as `$1` matches everything after that prefix
	e.Pre(RewriteWithConfig(RewriteConfig{
		Rules: map[string]string{
			"^/a/*": "/$1?query=param",
			"^/b/*": "/$1;part#one",
		},
		RegexRules: map[*regexp.Regexp]string{
			regexp.MustCompile("^/x/(.*)"): "/$1?query=param",
			regexp.MustCompile("^/y/(.*)"): "/$1;part#one",
			regexp.MustCompile("^/z/(.*)"): "/$1?test=1#escaped%20test",
		},
	}))

	var rec *httptest.ResponseRecorder
	var req *http.Request

	testCases := []struct {
		requestPath string
		expect      string
	}{
		{"/unmatched", "/unmatched"},
		{"/a/test", "/test?query=param"},
		{"/b/foo/bar", "/foo/bar;part#one"},
		{"/x/test", "/test?query=param"},
		{"/y/foo/bar", "/foo/bar;part#one"},
		{"/z/foo/b%20ar", "/foo/b%20ar?test=1#escaped%20test"},
		{"/z/foo/b%20ar?nope=1#yes", "/foo/b%20ar?nope=1#yes?test=1%23escaped%20test"}, // example of appending
	}

	for _, tc := range testCases {
		t.Run(tc.requestPath, func(t *testing.T) {
			req = httptest.NewRequest(http.MethodGet, tc.requestPath, nil)
			rec = httptest.NewRecorder()
			e.ServeHTTP(rec, req)
			assert.Equal(t, tc.expect, req.URL.String())
		})
	}
}