-
Notifications
You must be signed in to change notification settings - Fork 59
/
shared.go
264 lines (221 loc) · 7.37 KB
/
shared.go
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
package handlers
import (
"encoding/json"
"errors"
"fmt"
"net/http"
"regexp"
"strings"
"code.cloudfoundry.org/korifi/api/apierrors"
"code.cloudfoundry.org/korifi/api/payloads"
"code.cloudfoundry.org/bytefmt"
"github.com/go-playground/locales/en"
ut "github.com/go-playground/universal-translator"
"github.com/go-playground/validator/v10"
en_translations "github.com/go-playground/validator/v10/translations/en"
"golang.org/x/text/cases"
"golang.org/x/text/language"
"gopkg.in/yaml.v3"
)
//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
type DecoderValidator struct {
validator *validator.Validate
translator ut.Translator
}
func NewDefaultDecoderValidator() (*DecoderValidator, error) {
validator, translator, err := wireValidator()
if err != nil {
return nil, err
}
return &DecoderValidator{
validator: validator,
translator: translator,
}, nil
}
func (dv *DecoderValidator) DecodeAndValidateJSONPayload(r *http.Request, object interface{}) error {
decoder := json.NewDecoder(r.Body)
defer r.Body.Close()
decoder.DisallowUnknownFields()
err := decoder.Decode(object)
if err != nil {
var unmarshalTypeError *json.UnmarshalTypeError
switch {
case errors.As(err, &unmarshalTypeError):
titler := cases.Title(language.AmericanEnglish)
return apierrors.NewUnprocessableEntityError(err, fmt.Sprintf("%v must be a %v", titler.String(unmarshalTypeError.Field), unmarshalTypeError.Type))
case strings.HasPrefix(err.Error(), "json: unknown field"):
// check whether the message matches an "unknown field" error. If so, 422. Else, 400
return apierrors.NewUnprocessableEntityError(err, fmt.Sprintf("invalid request body: %s", err.Error()))
default:
return apierrors.NewMessageParseError(err)
}
}
return dv.validatePayload(object)
}
func (dv *DecoderValidator) DecodeAndValidateYAMLPayload(r *http.Request, object interface{}) error {
decoder := yaml.NewDecoder(r.Body)
defer r.Body.Close()
decoder.KnownFields(false) // TODO: change this to true once we've added all manifest fields to payloads.Manifest
err := decoder.Decode(object)
if err != nil {
return apierrors.NewMessageParseError(err)
}
return dv.validatePayload(object)
}
func (dv *DecoderValidator) validatePayload(object interface{}) error {
err := dv.validator.Struct(object)
if err != nil {
errorMessage := err.Error()
var typedErr validator.ValidationErrors
if errors.As(err, &typedErr) {
errorMap := typedErr.Translate(dv.translator)
var errorMessages []string
for _, msg := range errorMap {
errorMessages = append(errorMessages, msg)
}
if len(errorMessages) > 0 {
errorMessage = strings.Join(errorMessages, ",")
}
}
return apierrors.NewUnprocessableEntityError(err, errorMessage)
}
return nil
}
func wireValidator() (*validator.Validate, ut.Translator, error) {
v := validator.New()
trans, err := registerDefaultTranslator(v)
if err != nil {
return nil, nil, err
}
// Register custom validators
err = v.RegisterValidation("megabytestring", megabyteFormattedString, true)
if err != nil {
return nil, nil, err
}
err = v.RegisterValidation("route", routeString)
if err != nil {
return nil, nil, err
}
err = v.RegisterValidation("routepathstartswithslash", routePathStartsWithSlash)
if err != nil {
return nil, nil, err
}
err = v.RegisterValidation("serviceinstancetaglength", serviceInstanceTagLength)
if err != nil {
return nil, nil, err
}
v.RegisterStructValidation(checkRandomRouteAndDefaultRouteConflict, payloads.ManifestApplication{})
v.RegisterStructValidation(checkRoleTypeAndOrgSpace, payloads.RoleCreate{})
err = v.RegisterTranslation("cannot_have_both_org_and_space_set", trans, func(ut ut.Translator) error {
return ut.Add("cannot_have_both_org_and_space_set", "Cannot pass both 'organization' and 'space' in a create role request", false)
}, func(ut ut.Translator, fe validator.FieldError) string {
t, _ := ut.T("cannot_have_both_org_and_space_set", fe.Field())
return t
})
if err != nil {
return nil, nil, err
}
err = v.RegisterTranslation("valid_role", trans, func(ut ut.Translator) error {
return ut.Add("valid_role", "{0} is not a valid role", false)
}, func(ut ut.Translator, fe validator.FieldError) string {
t, _ := ut.T("valid_role", fmt.Sprintf("%v", fe.Value()))
return t
})
if err != nil {
return nil, nil, err
}
err = v.RegisterTranslation("route", trans, func(ut ut.Translator) error {
return ut.Add("invalid_route", `"{0}" is not a valid route URI`, false)
}, func(ut ut.Translator, fe validator.FieldError) string {
t, _ := ut.T("invalid_route", fmt.Sprintf("%v", fe.Value()))
return t
})
if err != nil {
return nil, nil, err
}
return v, trans, nil
}
func registerDefaultTranslator(v *validator.Validate) (ut.Translator, error) {
en := en.New()
uni := ut.New(en, en)
trans, _ := uni.GetTranslator("en")
err := en_translations.RegisterDefaultTranslations(v, trans)
if err != nil {
return nil, err
}
return trans, nil
}
func checkRandomRouteAndDefaultRouteConflict(sl validator.StructLevel) {
manifestApplication := sl.Current().Interface().(payloads.ManifestApplication)
if manifestApplication.DefaultRoute && manifestApplication.RandomRoute {
sl.ReportError(manifestApplication.DefaultRoute, "defaultRoute", "DefaultRoute", "Random-route and Default-route may not be used together", "")
}
}
func checkRoleTypeAndOrgSpace(sl validator.StructLevel) {
roleCreate := sl.Current().Interface().(payloads.RoleCreate)
if roleCreate.Relationships.Organization != nil && roleCreate.Relationships.Space != nil {
sl.ReportError(roleCreate.Relationships.Organization, "relationships.organization", "Organization", "cannot_have_both_org_and_space_set", "")
}
roleType := RoleName(roleCreate.Type)
switch roleType {
case RoleSpaceManager:
fallthrough
case RoleSpaceAuditor:
fallthrough
case RoleSpaceDeveloper:
fallthrough
case RoleSpaceSupporter:
if roleCreate.Relationships.Space == nil {
sl.ReportError(roleCreate.Relationships.Space, "relationships.space", "Space", "required", "")
}
case RoleOrganizationUser:
fallthrough
case RoleOrganizationAuditor:
fallthrough
case RoleOrganizationManager:
fallthrough
case RoleOrganizationBillingManager:
if roleCreate.Relationships.Organization == nil {
sl.ReportError(roleCreate.Relationships.Organization, "relationships.organization", "Organization", "required", "")
}
case RoleName(""):
default:
sl.ReportError(roleCreate.Type, "type", "Role type", "valid_role", "")
}
}
// Custom field validators
func routePathStartsWithSlash(fl validator.FieldLevel) bool {
if fl.Field().String() == "" {
return true
}
if fl.Field().String()[0:1] != "/" {
return false
}
return true
}
func megabyteFormattedString(fl validator.FieldLevel) bool {
val, ok := fl.Field().Interface().(string)
if !ok {
return true // the value is optional, and is set to nil
}
_, err := bytefmt.ToMegabytes(val)
return err == nil
}
func routeString(fl validator.FieldLevel) bool {
val := fl.Field().String()
routeRegex := regexp.MustCompile(
`^(?:https?://|tcp://)?(?:(?:[\w-]+\.)|(?:[*]\.))+\w+(?:\:\d+)?(?:/.*)*(?:\.\w+)?$`,
)
return routeRegex.MatchString(val)
}
func serviceInstanceTagLength(fl validator.FieldLevel) bool {
tags, ok := fl.Field().Interface().([]string)
if !ok {
return true // the value is optional, and is set to nil
}
tagLen := 0
for _, tag := range tags {
tagLen += len(tag)
}
return tagLen < 2048
}