549d39a89f
Go does not by default marshal `error` type fields to JSON. The manager
package therefore implemented a `pluginError` type that implements
[encoding.TextMarshaler]. However, the field was marked as a regular
`error`, which made it brittle; assining any other type of error would
result in the error being discarded in the marshaled JSON (as used in
`docker info` output), resulting in the error being marshaled as `{}`.
This patch adds a custom `MarshalJSON()` on the `Plugin` type itself
so that any error is rendered. It checks if the error used already
implements [encoding.TextMarshaler], otherwise wraps the error in
a `pluginError`.
[encoding.TextMarshaler]: https://pkg.go.dev/encoding#TextMarshaler
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
44 lines
902 B
Go
44 lines
902 B
Go
package manager
|
|
|
|
import (
|
|
"encoding/json"
|
|
"errors"
|
|
"testing"
|
|
|
|
"gotest.tools/v3/assert"
|
|
is "gotest.tools/v3/assert/cmp"
|
|
)
|
|
|
|
func TestPluginMarshal(t *testing.T) {
|
|
const jsonWithError = `{"Name":"some-plugin","Err":"something went wrong"}`
|
|
const jsonNoError = `{"Name":"some-plugin"}`
|
|
|
|
tests := []struct {
|
|
doc string
|
|
error error
|
|
expected string
|
|
}{
|
|
{
|
|
doc: "no error",
|
|
expected: jsonNoError,
|
|
},
|
|
{
|
|
doc: "regular error",
|
|
error: errors.New("something went wrong"),
|
|
expected: jsonWithError,
|
|
},
|
|
{
|
|
doc: "custom error",
|
|
error: NewPluginError("something went wrong"),
|
|
expected: jsonWithError,
|
|
},
|
|
}
|
|
for _, tc := range tests {
|
|
t.Run(tc.doc, func(t *testing.T) {
|
|
actual, err := json.Marshal(&Plugin{Name: "some-plugin", Err: tc.error})
|
|
assert.NilError(t, err)
|
|
assert.Check(t, is.Equal(string(actual), tc.expected))
|
|
})
|
|
}
|
|
}
|