Repository navigation
Expand file tree
/
Copy pathinstance_codes_test.go
More file actions
266 lines (236 loc) · 9.75 KB
/
Copy pathinstance_codes_test.go
File metadata and controls
266 lines (236 loc) · 9.75 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
package api
import (
"encoding/json"
"fmt"
"net/http"
"sync"
"testing"
"github.com/jgolang/api/core"
"github.com/jgolang/errors"
"github.com/jgolang/errors/codes"
)
// planValidation is a service-declared code with an upper-case prefix.
var planValidation = codes.New("PLN-001", "title is required").WithKind(codes.KindValidation)
var codeWriters = map[string]http.HandlerFunc{
"WriteError": func(w http.ResponseWriter, r *http.Request) {
WriteError(w, r, errors.NewC(planValidation, "title"))
},
"Error400": func(w http.ResponseWriter, r *http.Request) {
Error400(errors.NewC(planValidation, "title")).Write(w, r)
},
"Error400 default code": func(w http.ResponseWriter, r *http.Request) { Error400().Write(w, r) },
"Success": func(w http.ResponseWriter, r *http.Request) { Success200().Write(w, r) },
"Warning": func(w http.ResponseWriter, r *http.Request) {
Warning{HTTPStatusCode: http.StatusOK}.Write(w, r)
},
"Informative": func(w http.ResponseWriter, r *http.Request) {
Informative{HTTPStatusCode: http.StatusOK}.Write(w, r)
},
}
// codeAndMessage decodes the code and message of a plain or envelope body. It
// returns empty values for any other body, and is safe to call from any
// goroutine.
func codeAndMessage(body []byte) (code, message string) {
var fields struct {
Code string `json:"code"`
Message string `json:"message"`
Header *struct {
Code string `json:"code"`
Message string `json:"message"`
} `json:"header"`
}
if err := json.Unmarshal(body, &fields); err != nil {
return "", ""
}
if fields.Header != nil {
return fields.Header.Code, fields.Header.Message
}
return fields.Code, fields.Message
}
// serveCode serves writer with a fixed event ID, wrapped by a unless a is nil.
func serveCode(t *testing.T, a *API, writer string) (code, message string) {
t.Helper()
var handler http.Handler = codeWriters[writer]
if a != nil {
handler = a.Handler(handler)
}
rec := serve(handler, http.MethodGet, "", map[string]string{EventIDHeaderKey: "evt-123456789"})
return codeAndMessage(rec.Body.Bytes())
}
func TestInstanceCodeCase(t *testing.T) {
tests := []struct {
name string
instance func(mode ResponseMode) *API
writer string
wantCode string
wantMessage string
}{
{"declared WriteError", declaredInstance, "WriteError", "PLN-001", "title is required (evt-12-PLN-001)"},
{"declared Error400", declaredInstance, "Error400", "PLN-001", "title is required (evt-12-PLN-001)"},
{"lowercase WriteError", lowercaseInstance, "WriteError", "pln-001", "title is required (evt-12-pln-001)"},
{"lowercase Error400", lowercaseInstance, "Error400", "pln-001", "title is required (evt-12-pln-001)"},
{"default instance WriteError", noInstance, "WriteError", "PLN-001", "title is required (evt-12-PLN-001)"},
{"default instance Error400", noInstance, "Error400", "PLN-001", "title is required (evt-12-PLN-001)"},
{"declared default error code", declaredInstance, "Error400 default code", "E001", "The service has not completed the operation! (evt-12-E001)"},
{"declared success", declaredInstance, "Success", "0000", ""},
{"declared warning", declaredInstance, "Warning", "0000", "The application has been successful but with potential problems! (evt-12-0000)"},
{"declared informative", declaredInstance, "Informative", "0000", "The request has been successful! (evt-12-0000)"},
}
for _, mode := range []ResponseMode{ResponseModePlain, ResponseModeEnvelope} {
for _, tt := range tests {
t.Run(string(mode)+"/"+tt.name, func(t *testing.T) {
usePackageModes(t, RequestModePlain, mode)
a := tt.instance(mode)
code, message := serveCode(t, a, tt.writer)
if code != tt.wantCode || message != tt.wantMessage {
t.Fatalf("code, message = %q, %q; want %q, %q", code, message, tt.wantCode, tt.wantMessage)
}
})
}
}
}
func declaredInstance(mode ResponseMode) *API { return New(WithResponseMode(mode)) }
func lowercaseInstance(mode ResponseMode) *API {
return New(WithResponseMode(mode), WithLowercaseCodes())
}
func noInstance(ResponseMode) *API { return nil }
func TestBuiltInFormatterPassedAsOptionTakesTheInstanceCodeCase(t *testing.T) {
tests := []struct {
name string
formatter core.APIResponseFormatter
lowercase bool
wantCode string
}{
{"value declared", ResponseFormatter{}, false, "PLN-001"},
{"pointer declared", &ResponseFormatter{}, false, "PLN-001"},
{"value lowercase", ResponseFormatter{}, true, "pln-001"},
{"pointer lowercase", &ResponseFormatter{}, true, "pln-001"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
opts := []Option{WithResponseFormatter(tt.formatter)}
if tt.lowercase {
opts = append(opts, WithLowercaseCodes())
}
code, message := serveCode(t, New(opts...), "WriteError")
if wantMessage := "title is required (evt-12-" + tt.wantCode + ")"; code != tt.wantCode || message != wantMessage {
t.Fatalf("code, message = %q, %q; want %q, %q", code, message, tt.wantCode, wantMessage)
}
})
}
}
func TestLowercaseCodesDoesNotApplyToACustomFormatter(t *testing.T) {
formatter := &fakeFormatter{}
a := New(WithResponseFormatter(formatter), WithLowercaseCodes())
serve(a.Handler(codeWriters["WriteError"]), http.MethodGet, "", nil)
if got := formatter.data.ResponseCode; got != "PLN-001" {
t.Fatalf("custom formatter got code %q, want PLN-001 as declared", got)
}
}
func TestInstancesServeConcurrentlyWithTheirOwnCodeCase(t *testing.T) {
handlers := map[string]http.Handler{
"PLN-001": New().Handler(codeWriters["WriteError"]),
"pln-001": New(WithLowercaseCodes()).Handler(codeWriters["WriteError"]),
}
// The default instance sends codes as declared, like New().
defaultHandler := codeWriters["WriteError"]
var wg sync.WaitGroup
for range 20 {
for want, handler := range handlers {
wg.Go(func() {
rec := serve(handler, http.MethodGet, "", nil)
if code, _ := codeAndMessage(rec.Body.Bytes()); code != want {
t.Errorf("code = %q, want %q", code, want)
}
})
}
wg.Go(func() {
rec := serve(defaultHandler, http.MethodGet, "", nil)
if code, _ := codeAndMessage(rec.Body.Bytes()); code != "PLN-001" {
t.Errorf("default instance code = %q, want PLN-001", code)
}
})
}
wg.Wait()
}
// usePackageFormatterSettings sets TraceVisibility, TraceIDLength and
// BlankSuccess for one test and restores them afterwards.
func usePackageFormatterSettings(t *testing.T, visibility, idLength int, blankSuccess bool) {
t.Helper()
oldVisibility, oldLength, oldBlank := TraceVisibility, TraceIDLength, BlankSuccess
TraceVisibility, TraceIDLength, BlankSuccess = visibility, idLength, blankSuccess
t.Cleanup(func() {
TraceVisibility, TraceIDLength, BlankSuccess = oldVisibility, oldLength, oldBlank
})
}
// An instance uses the v0 defaults (1, 6, true); only the default instance
// reads the package formatter settings (ADR 0001, owner Q13).
func TestInstanceIgnoresPackageFormatterSettings(t *testing.T) {
tests := []struct {
visibility, idLength int
blankSuccess bool
wantDefaultMessage string
}{
{1, 6, true, "title is required (evt-12-PLN-001)"},
{0, 6, true, "title is required"},
{2, 6, true, "title is required (PLN-001)"},
{3, 3, true, "title is required (evt)"},
{1, 3, false, "title is required (evt-PLN-001)"},
}
for _, tt := range tests {
t.Run(fmt.Sprintf("%d/%d/%t", tt.visibility, tt.idLength, tt.blankSuccess), func(t *testing.T) {
usePackageFormatterSettings(t, tt.visibility, tt.idLength, tt.blankSuccess)
for name, a := range map[string]*API{"New()": New(), "New(WithLowercaseCodes())": New(WithLowercaseCodes())} {
want := "title is required (evt-12-PLN-001)"
if name != "New()" {
want = "title is required (evt-12-pln-001)"
}
if _, message := serveCode(t, a, "WriteError"); message != want {
t.Errorf("%s message = %q, want %q", name, message, want)
}
if _, message := serveCode(t, a, "Success"); message != "" {
t.Errorf("%s success message = %q, want blank", name, message)
}
}
if _, message := serveCode(t, nil, "WriteError"); message != tt.wantDefaultMessage {
t.Errorf("default instance message = %q, want %q", message, tt.wantDefaultMessage)
}
if _, message := serveCode(t, nil, "Success"); (message == "") != tt.blankSuccess {
t.Errorf("default instance success message = %q, BlankSuccess %t", message, tt.blankSuccess)
}
})
}
}
// embeddedFormatter is a custom formatter that embeds the built-in one.
type embeddedFormatter struct{ ResponseFormatter }
func TestEmbeddedFormatterDeclaresCodesAndUsesThePackageMode(t *testing.T) {
usePackageModes(t, RequestModePlain, ResponseModePlain)
a := New(WithResponseMode(ResponseModeEnvelope), WithResponseFormatter(embeddedFormatter{}))
rec := serve(a.Handler(codeWriters["WriteError"]), http.MethodGet, "", nil)
if got := responseModeOf(rec.Body.Bytes()); got != ResponseModePlain {
t.Errorf("response mode = %q, want the package mode plain", got)
}
if code, _ := codeAndMessage(rec.Body.Bytes()); code != "PLN-001" {
t.Errorf("code = %q, want PLN-001", code)
}
}
func TestProcessRequestRejectionUsesTheInstanceCodeCase(t *testing.T) {
ok := func(w http.ResponseWriter, r *http.Request) { Success200().Write(w, r) }
tests := []struct {
name string
wrap func(http.Handler) http.Handler
wantCode string
}{
{"New()", New().Handler, "E002"},
{"New(WithLowercaseCodes())", New(WithLowercaseCodes()).Handler, "e002"},
{"default instance", func(h http.Handler) http.Handler { return h }, "E002"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
rec := serve(tt.wrap(ProcessRequest(ok)), http.MethodPost, `{"title":`, nil)
if code, _ := codeAndMessage(rec.Body.Bytes()); rec.Code != http.StatusBadRequest || code != tt.wantCode {
t.Fatalf("status, code = %d, %q; want 400, %q", rec.Code, code, tt.wantCode)
}
})
}
}