Skip to content

Add testcases for some BodyLimit middleware configuration options #2350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 25, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions middleware/body_limit_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,92 @@ func TestBodyLimitReader(t *testing.T) {
assert.Equal(t, 2, n)
assert.Equal(t, nil, err)
}

func TestBodyLimitWithConfig_Skipper(t *testing.T) {
e := echo.New()
h := func(c echo.Context) error {
body, err := io.ReadAll(c.Request().Body)
if err != nil {
return err
}
return c.String(http.StatusOK, string(body))
}
mw := BodyLimitWithConfig(BodyLimitConfig{
Skipper: func(c echo.Context) bool {
return true
},
Limit: "2B", // if not skipped this limit would make request to fail limit check
})

hw := []byte("Hello, World!")
req := httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(hw))
rec := httptest.NewRecorder()
c := e.NewContext(req, rec)

err := mw(h)(c)
assert.NoError(t, err)
assert.Equal(t, http.StatusOK, rec.Code)
assert.Equal(t, hw, rec.Body.Bytes())
}

func TestBodyLimitWithConfig(t *testing.T) {
var testCases = []struct {
name string
givenLimit string
whenBody []byte
expectBody []byte
expectError string
}{
{
name: "ok, body is less than limit",
givenLimit: "10B",
whenBody: []byte("123456789"),
expectBody: []byte("123456789"),
expectError: "",
},
{
name: "nok, body is more than limit",
givenLimit: "9B",
whenBody: []byte("1234567890"),
expectBody: []byte(nil),
expectError: "code=413, message=Request Entity Too Large",
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
e := echo.New()
h := func(c echo.Context) error {
body, err := io.ReadAll(c.Request().Body)
if err != nil {
return err
}
return c.String(http.StatusOK, string(body))
}
mw := BodyLimitWithConfig(BodyLimitConfig{
Limit: tc.givenLimit,
})

req := httptest.NewRequest(http.MethodPost, "/", bytes.NewReader(tc.whenBody))
rec := httptest.NewRecorder()
c := e.NewContext(req, rec)

err := mw(h)(c)
if tc.expectError != "" {
assert.EqualError(t, err, tc.expectError)
} else {
assert.NoError(t, err)
}
// not testing status as middlewares return error instead of committing it and OK cases are anyway 200
assert.Equal(t, tc.expectBody, rec.Body.Bytes())
})
}
}

func TestBodyLimit_panicOnInvalidLimit(t *testing.T) {
assert.PanicsWithError(
t,
"echo: invalid body-limit=",
func() { BodyLimit("") },
)
}