Refactor tests stylistically

This commit is contained in:
Herman Slatman 2022-11-17 23:54:58 +01:00
parent 36da484604
commit b8c306ebfa
No known key found for this signature in database
GPG key ID: F4D8A44EA0A75A4F
2 changed files with 54 additions and 46 deletions

View file

@ -21,6 +21,7 @@ type StackTracedError interface {
type fieldCarrier interface {
WithFields(map[string]any)
Fields() map[string]any
}
// Error adds to the response writer the given error if it implements

View file

@ -1,8 +1,8 @@
package log
import (
"net/http"
"net/http/httptest"
"strconv"
"testing"
"unsafe"
@ -12,51 +12,6 @@ import (
"github.com/smallstep/certificates/logging"
)
func TestError(t *testing.T) {
cases := []struct {
error
stepDebug bool
expectStackTrace bool
}{
0: {nil, false, false},
1: {nil, true, false},
2: {assert.AnError, false, false},
3: {assert.AnError, true, false},
4: {new(stackTracedError), false, false},
5: {new(stackTracedError), true, true},
}
for caseIndex := range cases {
kase := cases[caseIndex]
t.Run(strconv.Itoa(caseIndex), func(t *testing.T) {
if kase.stepDebug {
t.Setenv("STEPDEBUG", "1")
} else {
t.Setenv("STEPDEBUG", "0")
}
rw := logging.NewResponseLogger(httptest.NewRecorder())
Error(rw, kase.error)
fields := rw.Fields()
// expect the error field to be set and to be the same error that was fed to Error
if kase.error == nil {
assert.Nil(t, fields["error"])
} else {
assert.Same(t, kase.error, fields["error"])
}
if _, hasStackTrace := fields["stack-trace"]; kase.expectStackTrace && !hasStackTrace {
t.Error("stack-trace was not set")
} else if !kase.expectStackTrace && hasStackTrace {
t.Error("stack-trace was set")
}
})
}
}
type stackTracedError struct{}
func (stackTracedError) Error() string {
@ -70,3 +25,55 @@ func (stackTracedError) StackTrace() pkgerrors.StackTrace {
pkgerrors.Frame(unsafe.Pointer(&f)),
}
}
func TestError(t *testing.T) {
tests := []struct {
name string
error
rw http.ResponseWriter
isFieldCarrier bool
stepDebug bool
expectStackTrace bool
}{
{"noLogger", nil, nil, false, false, false},
{"noError", nil, logging.NewResponseLogger(httptest.NewRecorder()), true, false, false},
{"noErrorDebug", nil, logging.NewResponseLogger(httptest.NewRecorder()), true, true, false},
{"anError", assert.AnError, logging.NewResponseLogger(httptest.NewRecorder()), true, false, false},
{"anErrorDebug", assert.AnError, logging.NewResponseLogger(httptest.NewRecorder()), true, true, false},
{"stackTracedError", new(stackTracedError), logging.NewResponseLogger(httptest.NewRecorder()), true, true, true},
{"stackTracedErrorDebug", new(stackTracedError), logging.NewResponseLogger(httptest.NewRecorder()), true, true, true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.stepDebug {
t.Setenv("STEPDEBUG", "1")
} else {
t.Setenv("STEPDEBUG", "0")
}
Error(tt.rw, tt.error)
// return early if test case doesn't use logger
if !tt.isFieldCarrier {
return
}
fields := tt.rw.(logging.ResponseLogger).Fields()
// expect the error field to be (not) set and to be the same error that was fed to Error
if tt.error == nil {
assert.Nil(t, fields["error"])
} else {
assert.Same(t, tt.error, fields["error"])
}
// check if stack-trace is set when expected
if _, hasStackTrace := fields["stack-trace"]; tt.expectStackTrace && !hasStackTrace {
t.Error(`ResponseLogger["stack-trace"] not set`)
} else if !tt.expectStackTrace && hasStackTrace {
t.Error(`ResponseLogger["stack-trace"] was set`)
}
})
}
}