Repository navigation
Expand file tree
/
Copy pathoapi_validate_test.go
More file actions
851 lines (739 loc) · 26.9 KB
/
Copy pathoapi_validate_test.go
File metadata and controls
851 lines (739 loc) · 26.9 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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
package echomiddleware
import (
"bytes"
"context"
_ "embed"
"encoding/json"
"errors"
"io"
"net/http"
"net/http/httptest"
"net/url"
"strings"
"testing"
"github.com/getkin/kin-openapi/openapi3"
"github.com/getkin/kin-openapi/openapi3filter"
"github.com/labstack/echo/v5"
echomiddleware "github.com/labstack/echo/v5/middleware"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
//go:embed test_spec.yaml
var testSchema []byte
func doGet(t *testing.T, e *echo.Echo, rawURL string) *httptest.ResponseRecorder {
u, err := url.Parse(rawURL)
if err != nil {
t.Fatalf("Invalid url: %s", rawURL)
}
r, err := http.NewRequest(http.MethodGet, u.String(), nil)
if err != nil {
t.Fatalf("Could not construct a request: %s", rawURL)
}
r.Header.Set("accept", "application/json")
r.Header.Set("host", u.Host)
tt := httptest.NewRecorder()
e.ServeHTTP(tt, r)
return tt
}
func doPost(t *testing.T, e *echo.Echo, rawURL string, jsonBody any) *httptest.ResponseRecorder {
u, err := url.Parse(rawURL)
if err != nil {
t.Fatalf("Invalid url: %s", rawURL)
}
body, err := json.Marshal(jsonBody)
if err != nil {
t.Fatalf("Could not marshal request body: %v", err)
}
r, err := http.NewRequest(http.MethodPost, u.String(), bytes.NewReader(body))
if err != nil {
t.Fatalf("Could not construct a request for URL %s: %v", rawURL, err)
}
r.Header.Set("accept", "application/json")
r.Header.Set("content-type", "application/json")
r.Header.Set("host", u.Host)
tt := httptest.NewRecorder()
e.ServeHTTP(tt, r)
return tt
}
func TestOapiRequestValidator(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err, "Error initializing OpenAPI spec")
// Create a new echo router
e := echo.New()
// Set up an authenticator to check authenticated function. It will allow
// access to "someScope", but disallow others.
options := Options{
ErrorHandler: func(c *echo.Context, err *echo.HTTPError) error {
return c.String(err.Code, "test: "+err.Error())
},
Options: openapi3filter.Options{
AuthenticationFunc: func(c context.Context, input *openapi3filter.AuthenticationInput) error {
// The echo context should be propagated into here.
eCtx := GetEchoContext(c)
assert.NotNil(t, eCtx)
// As should user data
assert.EqualValues(t, "hi!", GetUserData(c))
for _, s := range input.Scopes {
if s == "someScope" {
return nil
}
if s == "unauthorized" {
return echo.ErrUnauthorized
}
}
return errors.New("forbidden")
},
},
UserData: "hi!",
}
// Install our OpenApi based request validator
e.Use(OapiRequestValidatorWithOptions(spec, &options))
called := false
// Install a request handler for /resource. We want to make sure it doesn't
// get called.
e.GET("/resource", func(c *echo.Context) error {
called = true
return nil
})
// Let's send the request to the wrong server, this should return 404
{
rec := doGet(t, e, "http://not.test.hostname/resource")
assert.Equal(t, http.StatusNotFound, rec.Code)
assert.False(t, called, "Handler should not have been called")
}
// Let's send a good request, it should pass
{
rec := doGet(t, e, "http://test.hostname/resource")
assert.Equal(t, http.StatusOK, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Send an out-of-spec parameter
{
rec := doGet(t, e, "http://test.hostname/resource?id=500")
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, called, "Handler should not have been called")
called = false
}
// Send a bad parameter type
{
rec := doGet(t, e, "http://test.hostname/resource?id=foo")
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, called, "Handler should not have been called")
called = false
}
// Send a request with the wrong HTTP method
{
rec := doPost(t, e, "http://test.hostname/multiparamresource", nil)
assert.Equal(t, http.StatusMethodNotAllowed, rec.Code)
assert.False(t, called, "Handler should not have been called")
called = false
}
// Add a handler for the POST message
e.POST("/resource", func(c *echo.Context) error {
called = true
return c.NoContent(http.StatusNoContent)
})
called = false
// Send a good request body
{
body := struct {
Name string `json:"name"`
}{
Name: "Marcin",
}
rec := doPost(t, e, "http://test.hostname/resource", body)
assert.Equal(t, http.StatusNoContent, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Send a malformed body
{
body := struct {
Name int `json:"name"`
}{
Name: 7,
}
rec := doPost(t, e, "http://test.hostname/resource", body)
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, called, "Handler should not have been called")
called = false
}
e.GET("/protected_resource", func(c *echo.Context) error {
called = true
return c.NoContent(http.StatusNoContent)
})
// Call a protected function to which we have access
{
rec := doGet(t, e, "http://test.hostname/protected_resource")
assert.Equal(t, http.StatusNoContent, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
e.GET("/protected_resource2", func(c *echo.Context) error {
called = true
return c.NoContent(http.StatusNoContent)
})
// Call a protected function to which we dont have access
{
rec := doGet(t, e, "http://test.hostname/protected_resource2")
assert.Equal(t, http.StatusForbidden, rec.Code)
assert.False(t, called, "Handler should not have been called")
called = false
}
e.GET("/protected_resource_401", func(c *echo.Context) error {
called = true
return c.NoContent(http.StatusNoContent)
})
// Call a protected function without credentials
{
rec := doGet(t, e, "http://test.hostname/protected_resource_401")
assert.Equal(t, http.StatusUnauthorized, rec.Code)
assert.Equal(t, "test: code=401, message=Unauthorized", rec.Body.String())
assert.False(t, called, "Handler should not have been called")
called = false
}
}
func TestOapiRequestValidatorWithOptionsMultiError(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err, "Error initializing OpenAPI spec")
// Create a new echo router
e := echo.New()
// Set up an authenticator to check authenticated function. It will allow
// access to "someScope", but disallow others.
options := Options{
Options: openapi3filter.Options{
ExcludeRequestBody: false,
ExcludeResponseBody: false,
IncludeResponseStatus: true,
MultiError: true,
},
}
// register middleware
e.Use(OapiRequestValidatorWithOptions(spec, &options))
called := false
// Install a request handler for /resource. We want to make sure it doesn't
// get called.
e.GET("/multiparamresource", func(c *echo.Context) error {
called = true
return nil
})
// Let's send a good request, it should pass
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=50&id2=50")
assert.Equal(t, http.StatusOK, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Let's send a request with a missing parameter, it should return
// a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=50")
assert.Equal(t, http.StatusBadRequest, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "value is required but missing")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
// Let's send a request with a 2 missing parameters, it should return
// a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource")
assert.Equal(t, http.StatusBadRequest, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id\\\"")
assert.Contains(t, string(body), "value is required but missing")
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "value is required but missing")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
// Let's send a request with a 1 missing parameter, and another outside
// or the parameters. It should return a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=500")
assert.Equal(t, http.StatusBadRequest, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id\\\"")
assert.Contains(t, string(body), "number must be at most 100")
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "value is required but missing")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
// Let's send a request with a parameters that do not meet spec. It should
// return a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=abc&id2=1")
assert.Equal(t, http.StatusBadRequest, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id\\\"")
assert.Contains(t, string(body), "value abc: an invalid integer: invalid syntax")
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "number must be at least 10")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
}
func TestOapiRequestValidatorWithOptionsMultiErrorAndCustomHandler(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err, "Error initializing OpenAPI spec")
// Create a new echo router
e := echo.New()
// Set up an authenticator to check authenticated function. It will allow
// access to "someScope", but disallow others.
options := Options{
Options: openapi3filter.Options{
ExcludeRequestBody: false,
ExcludeResponseBody: false,
IncludeResponseStatus: true,
MultiError: true,
},
MultiErrorHandler: func(me openapi3.MultiError) *echo.HTTPError {
return &echo.HTTPError{
Code: http.StatusTeapot,
Message: me.Error(),
}
},
}
// register middleware
e.Use(OapiRequestValidatorWithOptions(spec, &options))
called := false
// Install a request handler for /resource. We want to make sure it doesn't
// get called.
e.GET("/multiparamresource", func(c *echo.Context) error {
called = true
return nil
})
// Let's send a good request, it should pass
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=50&id2=50")
assert.Equal(t, http.StatusOK, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Let's send a request with a missing parameter, it should return
// a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=50")
assert.Equal(t, http.StatusTeapot, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "value is required but missing")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
// Let's send a request with a 2 missing parameters, it should return
// a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource")
assert.Equal(t, http.StatusTeapot, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id\\\"")
assert.Contains(t, string(body), "value is required but missing")
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "value is required but missing")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
// Let's send a request with a 1 missing parameter, and another outside
// or the parameters. It should return a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=500")
assert.Equal(t, http.StatusTeapot, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id\\\"")
assert.Contains(t, string(body), "number must be at most 100")
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "value is required but missing")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
// Let's send a request with a parameters that do not meet spec. It should
// return a bad status
{
rec := doGet(t, e, "http://test.hostname/multiparamresource?id=abc&id2=1")
assert.Equal(t, http.StatusTeapot, rec.Code)
body, err := io.ReadAll(rec.Body)
if assert.NoError(t, err) {
assert.Contains(t, string(body), "parameter \\\"id\\\"")
assert.Contains(t, string(body), "value abc: an invalid integer: invalid syntax")
assert.Contains(t, string(body), "parameter \\\"id2\\\"")
assert.Contains(t, string(body), "number must be at least 10")
}
assert.False(t, called, "Handler should not have been called")
called = false
}
}
func TestOapiRequestValidatorWithPrefix(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err, "Error initializing OpenAPI spec")
// Create a new echo router
e := echo.New()
options := Options{
SilenceServersWarning: true,
Prefix: "/api",
}
// Install our OpenApi based request validator
e.Use(OapiRequestValidatorWithOptions(spec, &options))
called := false
// Register handler under the prefixed path (as echo sees it)
e.GET("/api/resource", func(c *echo.Context) error {
called = true
// The original request path should be preserved for the handler
assert.Equal(t, "/api/resource", c.Request().URL.Path)
return c.NoContent(http.StatusOK)
})
// A request to /api/resource should validate against /resource in the spec
{
rec := doGet(t, e, "http://test.hostname/api/resource")
assert.Equal(t, http.StatusOK, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// A request with query params should also validate correctly
{
rec := doGet(t, e, "http://test.hostname/api/resource?id=50")
assert.Equal(t, http.StatusOK, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// An out-of-spec parameter should still be rejected
{
rec := doGet(t, e, "http://test.hostname/api/resource?id=500")
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, called, "Handler should not have been called")
}
}
// newRawJSONPost builds a POST whose body is sent verbatim, so a test can
// compare the exact bytes that reach the handler.
func newRawJSONPost(target, body string) *http.Request {
r := httptest.NewRequest(http.MethodPost, target, strings.NewReader(body))
r.Header.Set("content-type", "application/json")
return r
}
// prefixedHandlerResult records what a handler mounted under a prefix saw.
type prefixedHandlerResult struct {
called bool
path string
rawPath string
body []byte
readErr error
// validated is the body's ValidatedValue(), when it has one.
validated any
hasValidated bool
}
func (r *prefixedHandlerResult) handler(status int) echo.HandlerFunc {
return func(c *echo.Context) error {
req := c.Request()
r.called = true
r.path, r.rawPath = req.URL.Path, req.URL.RawPath
if vv, ok := req.Body.(interface{ ValidatedValue() any }); ok {
r.validated, r.hasValidated = vv.ValidatedValue(), true
}
if req.Body != nil {
r.body, r.readErr = io.ReadAll(req.Body)
}
return c.NoContent(status)
}
}
// TestOapiRequestValidatorWithPrefixRequestBody checks that, with
// Options.Prefix set, the request body openapi3filter reads during validation
// is restored on the request the handler receives, rather than on a copy of it.
// See https://github.com/oapi-codegen/echo-v5-middleware/issues/16.
func TestOapiRequestValidatorWithPrefixRequestBody(t *testing.T) {
// Not JSON-canonical on purpose: the handler must see these exact bytes,
// not a re-encoding of the decoded value.
const body = `{ "name" : "x" }`
t.Run("body validation", func(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err)
e := echo.New()
e.Use(OapiRequestValidatorWithOptions(spec, &Options{
SilenceServersWarning: true,
Prefix: "/api",
}))
var got prefixedHandlerResult
e.POST("/api/resource", got.handler(http.StatusNoContent))
rec := httptest.NewRecorder()
e.ServeHTTP(rec, newRawJSONPost("http://test.hostname/api/resource", body))
require.Equal(t, http.StatusNoContent, rec.Code, rec.Body.String())
require.True(t, got.called, "handler should have been called")
require.NoError(t, got.readErr)
assert.Equal(t, body, string(got.body))
assert.Equal(t, "/api/resource", got.path)
// KeepValidatedValue is on by default.
require.True(t, got.hasValidated, "handler's body should expose ValidatedValue()")
assert.Equal(t, map[string]any{"name": "x"}, got.validated)
// A body that doesn't match the schema is still rejected.
got = prefixedHandlerResult{}
rec = httptest.NewRecorder()
e.ServeHTTP(rec, newRawJSONPost("http://test.hostname/api/resource", `{"name": 5}`))
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, got.called, "handler should not have been called")
})
t.Run("security validation with ExcludeRequestBody", func(t *testing.T) {
// openapi3filter's security validation reads the body even when body
// validation is excluded, which is how issue #16 was found.
const specYAML = `
openapi: "3.0.0"
info:
title: t
version: 1.0.0
paths:
/thing:
post:
operationId: createThing
security:
- BearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'204':
description: ok
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
`
spec, err := openapi3.NewLoader().LoadFromData([]byte(specYAML))
require.NoError(t, err)
e := echo.New()
e.Use(OapiRequestValidatorWithOptions(spec, &Options{
Prefix: "/api",
SilenceServersWarning: true,
Options: openapi3filter.Options{
ExcludeRequestBody: true,
AuthenticationFunc: func(context.Context, *openapi3filter.AuthenticationInput) error {
return nil
},
},
}))
var got prefixedHandlerResult
e.POST("/api/thing", got.handler(http.StatusNoContent))
r := newRawJSONPost("/api/thing", body)
r.Header.Set("authorization", "Bearer token")
rec := httptest.NewRecorder()
e.ServeHTTP(rec, r)
require.Equal(t, http.StatusNoContent, rec.Code, rec.Body.String())
require.True(t, got.called, "handler should have been called")
require.NoError(t, got.readErr)
assert.Equal(t, body, string(got.body))
assert.Equal(t, "/api/thing", got.path)
})
t.Run("KeepValidatedValue", func(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err)
e := echo.New()
e.Use(OapiRequestValidatorWithOptions(spec, &Options{
SilenceServersWarning: true,
Prefix: "/api",
Options: openapi3filter.Options{
KeepValidatedValue: true,
},
}))
var got prefixedHandlerResult
e.POST("/api/resource", got.handler(http.StatusNoContent))
rec := httptest.NewRecorder()
e.ServeHTTP(rec, newRawJSONPost("http://test.hostname/api/resource", body))
require.Equal(t, http.StatusNoContent, rec.Code, rec.Body.String())
require.True(t, got.called, "handler should have been called")
require.True(t, got.hasValidated, "handler's body should expose ValidatedValue()")
assert.Equal(t, map[string]any{"name": "x"}, got.validated)
require.NoError(t, got.readErr)
assert.Equal(t, body, string(got.body))
assert.Equal(t, "/api/resource", got.path)
})
}
// TestOapiRequestValidatorKeepValidatedValue checks that the middleware enables
// openapi3filter.Options.KeepValidatedValue unless Options.DiscardValidatedValue
// is set, so the handler's request body exposes the validated value through
// ValidatedValue() while remaining readable.
func TestOapiRequestValidatorKeepValidatedValue(t *testing.T) {
// Not JSON-canonical on purpose: the handler must see these exact bytes,
// not a re-encoding of the decoded value.
const body = `{ "name" : "x" }`
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err)
// serve sends body to POST /resource through mw and returns what the
// handler saw.
serve := func(t *testing.T, mw echo.MiddlewareFunc) prefixedHandlerResult {
t.Helper()
e := echo.New()
e.Use(mw)
var got prefixedHandlerResult
e.POST("/resource", got.handler(http.StatusNoContent))
rec := httptest.NewRecorder()
e.ServeHTTP(rec, newRawJSONPost("http://test.hostname/resource", body))
require.Equal(t, http.StatusNoContent, rec.Code, rec.Body.String())
require.True(t, got.called, "handler should have been called")
require.NoError(t, got.readErr)
assert.Equal(t, body, string(got.body), "body should still be readable with the original bytes")
return got
}
t.Run("default without options", func(t *testing.T) {
got := serve(t, OapiRequestValidator(spec))
require.True(t, got.hasValidated, "handler's body should expose ValidatedValue()")
assert.Equal(t, map[string]any{"name": "x"}, got.validated)
})
t.Run("default with empty options", func(t *testing.T) {
options := &Options{}
got := serve(t, OapiRequestValidatorWithOptions(spec, options))
require.True(t, got.hasValidated, "handler's body should expose ValidatedValue()")
assert.Equal(t, map[string]any{"name": "x"}, got.validated)
assert.False(t, options.Options.KeepValidatedValue, "the caller's options should not be modified")
})
t.Run("DiscardValidatedValue", func(t *testing.T) {
got := serve(t, OapiRequestValidatorWithOptions(spec, &Options{
DiscardValidatedValue: true,
}))
assert.False(t, got.hasValidated, "handler's body should not expose ValidatedValue()")
})
t.Run("DiscardValidatedValue overrides openapi3filter KeepValidatedValue", func(t *testing.T) {
got := serve(t, OapiRequestValidatorWithOptions(spec, &Options{
DiscardValidatedValue: true,
Options: openapi3filter.Options{
KeepValidatedValue: true,
},
}))
assert.False(t, got.hasValidated, "handler's body should not expose ValidatedValue()")
})
t.Run("ExcludeRequestBody", func(t *testing.T) {
got := serve(t, OapiRequestValidatorWithOptions(spec, &Options{
Options: openapi3filter.Options{
ExcludeRequestBody: true,
},
}))
// The body was not validated, so there is no validated value to keep.
assert.False(t, got.hasValidated, "handler's body should not expose ValidatedValue()")
})
}
// TestOapiRequestValidatorWithPrefixEncodedPathParams checks that the prefix
// is trimmed from URL.RawPath as well as URL.Path, and both are restored
// before the handler runs.
func TestOapiRequestValidatorWithPrefixEncodedPathParams(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err)
e := echo.New()
e.Use(OapiRequestValidatorWithOptions(spec, &Options{
SilenceServersWarning: true,
Prefix: "/api",
}))
var got prefixedHandlerResult
e.GET("/api/resource/maxlength/:param", got.handler(http.StatusNoContent))
// %2F decodes to a single "/", which satisfies maxLength: 1. The router
// matches on URL.EscapedPath(), which only uses RawPath while it is a valid
// encoding of Path; if the prefix were trimmed from Path alone, the router
// would see the decoded "//" and find no operation.
{
rec := doGet(t, e, "http://test.hostname/api/resource/maxlength/%2F")
require.Equal(t, http.StatusNoContent, rec.Code, rec.Body.String())
require.True(t, got.called, "handler should have been called")
assert.Equal(t, "/api/resource/maxlength//", got.path)
assert.Equal(t, "/api/resource/maxlength/%2F", got.rawPath)
}
// %2B%2B decodes to "++", which exceeds maxLength: 1.
{
got = prefixedHandlerResult{}
rec := doGet(t, e, "http://test.hostname/api/resource/maxlength/%2B%2B")
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, got.called, "handler should not have been called")
}
}
func TestEncodedPathParams(t *testing.T) {
spec, err := openapi3.NewLoader().LoadFromData(testSchema)
require.NoError(t, err, "Error initializing OpenAPI spec")
e := echo.New()
options := Options{
SilenceServersWarning: true,
}
e.Use(OapiRequestValidatorWithOptions(spec, &options))
called := false
// Register handlers for parameterized paths. These must be registered
// before any requests are made so echo allocates enough param slots.
e.GET("/resource/maxlength/:param", func(c *echo.Context) error {
called = true
return c.NoContent(http.StatusNoContent)
})
e.GET("/resource/pattern/:param", func(c *echo.Context) error {
called = true
return c.NoContent(http.StatusNoContent)
})
// Encoded "+" (%2B) — 3 chars encoded, but 1 char decoded.
// maxLength: 1 should pass because validation uses the decoded value.
{
rec := doGet(t, e, "http://test.hostname/resource/maxlength/%2B")
assert.Equal(t, http.StatusNoContent, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Unencoded "+" in the same path — should also pass.
{
rec := doGet(t, e, "http://test.hostname/resource/maxlength/+")
assert.Equal(t, http.StatusNoContent, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Two-char unencoded value exceeds maxLength: 1 — should be rejected.
{
rec := doGet(t, e, "http://test.hostname/resource/maxlength/ab")
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, called, "Handler should not have been called")
}
// Encoded value that decodes to two chars (%2B%2B -> "++") — should be rejected.
{
rec := doGet(t, e, "http://test.hostname/resource/maxlength/%2B%2B")
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, called, "Handler should not have been called")
}
// Pattern: ^\+[0-9]+$ — encoded "+1234" as "%2B1234" should pass.
{
rec := doGet(t, e, "http://test.hostname/resource/pattern/%2B1234")
assert.Equal(t, http.StatusNoContent, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Unencoded "+1234" should also pass.
{
rec := doGet(t, e, "http://test.hostname/resource/pattern/+1234")
assert.Equal(t, http.StatusNoContent, rec.Code)
assert.True(t, called, "Handler should have been called")
called = false
}
// Value that doesn't match pattern — should be rejected.
{
rec := doGet(t, e, "http://test.hostname/resource/pattern/nope")
assert.Equal(t, http.StatusBadRequest, rec.Code)
assert.False(t, called, "Handler should not have been called")
}
}
func TestGetSkipperFromOptions(t *testing.T) {
options := new(Options)
assert.NotNil(t, getSkipperFromOptions(options))
options = &Options{}
assert.NotNil(t, getSkipperFromOptions(options))
options = &Options{
Skipper: echomiddleware.DefaultSkipper,
}
assert.NotNil(t, getSkipperFromOptions(options))
}