-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcustom_validation_error_test.go
More file actions
298 lines (248 loc) · 8.49 KB
/
custom_validation_error_test.go
File metadata and controls
298 lines (248 loc) · 8.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
package fiberoapi
import (
"bytes"
"encoding/json"
"io"
"net/http/httptest"
"testing"
"github.com/gofiber/fiber/v2"
"github.com/stretchr/testify/assert"
)
// CustomValidationError represents a custom error structure
type CustomValidationError struct {
Success bool `json:"success"`
Message string `json:"message"`
Code string `json:"code"`
}
func TestCustomValidationErrorHandler(t *testing.T) {
app := fiber.New()
// Configure with custom validation error handler
oapi := New(app, Config{
EnableValidation: true,
EnableOpenAPIDocs: false,
ValidationErrorHandler: func(c *fiber.Ctx, err error) error {
return c.Status(fiber.StatusBadRequest).JSON(CustomValidationError{
Success: false,
Message: err.Error(),
Code: "CUSTOM_VALIDATION_ERROR",
})
},
})
type TestInput struct {
Name string `json:"name" validate:"required,min=3"`
Email string `json:"email" validate:"required,email"`
}
type TestOutput struct {
Message string `json:"message"`
}
Post[TestInput, TestOutput, struct{}](
oapi,
"/test",
func(c *fiber.Ctx, input TestInput) (TestOutput, struct{}) {
return TestOutput{Message: "success"}, struct{}{}
},
OpenAPIOptions{},
)
// Test with invalid input (missing required field)
reqBody := map[string]interface{}{
"name": "ab", // Too short (min=3)
}
bodyBytes, _ := json.Marshal(reqBody)
req := httptest.NewRequest("POST", "/test", bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusBadRequest, resp.StatusCode)
// Verify custom error structure
body, _ := io.ReadAll(resp.Body)
t.Logf("Response body: %s", string(body))
var customErr CustomValidationError
err = json.Unmarshal(body, &customErr)
assert.NoError(t, err)
assert.False(t, customErr.Success)
assert.Equal(t, "CUSTOM_VALIDATION_ERROR", customErr.Code)
assert.NotEmpty(t, customErr.Message)
}
func TestDefaultValidationErrorWhenNoCustomHandler(t *testing.T) {
app := fiber.New()
// Configure without custom validation error handler
oapi := New(app, Config{
EnableValidation: true,
EnableOpenAPIDocs: false,
})
type TestInput struct {
Name string `json:"name" validate:"required"`
}
type TestOutput struct {
Message string `json:"message"`
}
Post[TestInput, TestOutput, struct{}](
oapi,
"/test",
func(c *fiber.Ctx, input TestInput) (TestOutput, struct{}) {
return TestOutput{Message: "success"}, struct{}{}
},
OpenAPIOptions{},
)
// Test with invalid input
reqBody := map[string]interface{}{}
bodyBytes, _ := json.Marshal(reqBody)
req := httptest.NewRequest("POST", "/test", bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusBadRequest, resp.StatusCode)
// Verify default error structure (ErrorResponse)
body, _ := io.ReadAll(resp.Body)
var defaultErr ErrorResponse
err = json.Unmarshal(body, &defaultErr)
assert.NoError(t, err)
assert.Equal(t, 400, defaultErr.Code)
assert.Equal(t, "validation_error", defaultErr.Type)
assert.NotEmpty(t, defaultErr.Details)
}
func TestCustomValidationErrorHandlerWithDisabledDocs(t *testing.T) {
app := fiber.New()
// Configure with custom validation error handler AND EnableOpenAPIDocs: false
// This tests that boolean config is properly respected when ValidationErrorHandler is set
oapi := New(app, Config{
EnableValidation: true,
EnableOpenAPIDocs: false, // This should be respected
ValidationErrorHandler: func(c *fiber.Ctx, err error) error {
return c.Status(fiber.StatusBadRequest).JSON(CustomValidationError{
Success: false,
Message: err.Error(),
Code: "CUSTOM_ERROR",
})
},
})
type TestInput struct {
Name string `json:"name" validate:"required"`
}
type TestOutput struct {
Message string `json:"message"`
}
Post[TestInput, TestOutput, struct{}](
oapi,
"/test",
func(c *fiber.Ctx, input TestInput) (TestOutput, struct{}) {
return TestOutput{Message: "success"}, struct{}{}
},
OpenAPIOptions{},
)
// Test validation error uses custom handler
reqBody := map[string]interface{}{}
bodyBytes, _ := json.Marshal(reqBody)
req := httptest.NewRequest("POST", "/test", bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusBadRequest, resp.StatusCode)
// Verify custom error structure
body, _ := io.ReadAll(resp.Body)
var customErr CustomValidationError
err = json.Unmarshal(body, &customErr)
assert.NoError(t, err)
assert.Equal(t, "CUSTOM_ERROR", customErr.Code)
// Verify that EnableOpenAPIDocs: false was respected
// The docs endpoint should not exist
req = httptest.NewRequest("GET", "/docs", nil)
resp, err = app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusNotFound, resp.StatusCode)
}
func TestValidationErrorHandlerImpliesValidationEnabled(t *testing.T) {
app := fiber.New()
// Configure ONLY ValidationErrorHandler without explicitly setting EnableValidation
// This should keep validation enabled by default since it makes sense
oapi := New(app, Config{
ValidationErrorHandler: func(c *fiber.Ctx, err error) error {
return c.Status(fiber.StatusBadRequest).JSON(CustomValidationError{
Success: false,
Message: err.Error(),
Code: "VALIDATION_HANDLER_ACTIVE",
})
},
})
type TestInput struct {
Name string `json:"name" validate:"required,min=3"`
}
type TestOutput struct {
Message string `json:"message"`
}
Post[TestInput, TestOutput, struct{}](
oapi,
"/test",
func(c *fiber.Ctx, input TestInput) (TestOutput, struct{}) {
return TestOutput{Message: "success"}, struct{}{}
},
OpenAPIOptions{},
)
// Test that validation is still active and uses custom handler
reqBody := map[string]interface{}{
"name": "ab", // Too short (min=3)
}
bodyBytes, _ := json.Marshal(reqBody)
req := httptest.NewRequest("POST", "/test", bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusBadRequest, resp.StatusCode)
// Verify validation is active and custom handler was used
body, _ := io.ReadAll(resp.Body)
var customErr CustomValidationError
err = json.Unmarshal(body, &customErr)
assert.NoError(t, err)
assert.Equal(t, "VALIDATION_HANDLER_ACTIVE", customErr.Code)
assert.Contains(t, customErr.Message, "min")
// Test with valid data to ensure endpoint works
reqBody = map[string]interface{}{
"name": "John Doe",
}
bodyBytes, _ = json.Marshal(reqBody)
req = httptest.NewRequest("POST", "/test", bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
resp, err = app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusOK, resp.StatusCode)
// Verify that OpenAPI docs are enabled by default (not silently disabled)
req = httptest.NewRequest("GET", "/docs", nil)
resp, err = app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusOK, resp.StatusCode, "OpenAPI docs should be enabled by default when only ValidationErrorHandler is configured")
}
// TestAuthErrorHandlerOnlyDoesNotDisableDefaults verifies that setting only AuthErrorHandler
// does not accidentally disable EnableValidation or EnableOpenAPIDocs (both default to true).
func TestAuthErrorHandlerOnlyDoesNotDisableDefaults(t *testing.T) {
app := fiber.New()
oapi := New(app, Config{
AuthErrorHandler: func(c *fiber.Ctx, err *AuthError) error {
return c.Status(err.StatusCode).JSON(fiber.Map{"custom": true})
},
})
type TestInput struct {
Name string `json:"name" validate:"required"`
}
type TestOutput struct {
Message string `json:"message"`
}
Post[TestInput, TestOutput, struct{}](
oapi,
"/test",
func(c *fiber.Ctx, input TestInput) (TestOutput, struct{}) {
return TestOutput{Message: "ok"}, struct{}{}
},
OpenAPIOptions{},
)
// Validation should still be enabled (default true)
req := httptest.NewRequest("POST", "/test", bytes.NewReader([]byte(`{}`)))
req.Header.Set("Content-Type", "application/json")
resp, err := app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusBadRequest, resp.StatusCode, "Validation should be enabled when only AuthErrorHandler is configured")
// OpenAPI docs should still be enabled (default true)
req = httptest.NewRequest("GET", "/docs", nil)
resp, err = app.Test(req)
assert.NoError(t, err)
assert.Equal(t, fiber.StatusOK, resp.StatusCode, "OpenAPI docs should be enabled when only AuthErrorHandler is configured")
}